- Home
- Resources
- UsersResource
GET /users
Returns a list of the user names configured in the system.
Request Parameters
| name |
type |
description |
default |
| view |
query |
|
summary |
Response Body
| media type |
data type |
description |
| application/json |
ApiUserList
(JSON) |
A list of users. |
GET /users
Returns a list of the user names configured in the system.
Request Parameters
| name |
type |
description |
default |
| view |
query |
|
summary |
Response Body
| media type |
data type |
description |
| application/json |
ApiUser2List
(JSON) |
A list of users. |
POST /users
Creates a list of users.
When creating new users, the password property of each user should
be their plain text password. The returned user information will not
contain any password information.
Request Body
| media type |
data type |
description |
| application/json |
ApiUserList
(JSON) |
List of users to create. |
Response Body
| media type |
data type |
description |
| application/json |
ApiUserList
(JSON) |
Information about created users. |
POST /users
Creates a list of users.
When creating new users, the password property of each user should
be their plain text password. The returned user information will not
contain any password information.
Request Body
| media type |
data type |
description |
| application/json |
ApiUser2List
(JSON) |
List of users to create. |
Response Body
| media type |
data type |
description |
| application/json |
ApiUser2List
(JSON) |
Information about created users. |
GET /users/sessions
Return a list of the sessions associated with interactive authenticated
users in Cloudera Manager.
Note that these sessions are only associated with users who log into the
web interface. API users will not appear.
Response Body
| media type |
data type |
description |
| application/json |
ApiUserSessionList
(JSON) |
A list of user sessions |
DELETE /users/{userName}
Deletes a user from the system.
Request Parameters
| name |
type |
description |
default |
| userName |
path |
The name of the user to delete. |
n/a |
Response Body
| media type |
data type |
description |
| application/json |
ApiUser
(JSON) |
The details of the deleted user. |
DELETE /users/{userName}
Deletes a user from the system.
Request Parameters
| name |
type |
description |
default |
| userName |
path |
The name of the user to delete. |
n/a |
Response Body
| media type |
data type |
description |
| application/json |
ApiUser2
(JSON) |
The details of the deleted user. |
GET /users/{userName}
Returns detailed information about a user.
Request Parameters
| name |
type |
description |
default |
| userName |
path |
The user to read. |
n/a |
Response Body
| media type |
data type |
description |
| application/json |
ApiUser
(JSON) |
The user's information. |
GET /users/{userName}
Returns detailed information about a user.
Request Parameters
| name |
type |
description |
default |
| userName |
path |
The user to read. |
n/a |
Response Body
| media type |
data type |
description |
| application/json |
ApiUser2
(JSON) |
The user's information. |
PUT /users/{userName}
Updates the given user's information. Note that the user's name cannot
be changed.
Request Parameters
| name |
type |
description |
default |
| userName |
path |
User name being updated. |
n/a |
Request Body
| media type |
data type |
description |
| application/json |
ApiUser
(JSON) |
The user information. |
Response Body
| media type |
data type |
description |
| application/json |
ApiUser
(JSON) |
|
PUT /users/{userName}
Updates the given user's information. Note that the user's name cannot
be changed.
Request Parameters
| name |
type |
description |
default |
| userName |
path |
User name being updated. |
n/a |
Request Body
| media type |
data type |
description |
| application/json |
ApiUser2
(JSON) |
The user information. |
Response Body
| media type |
data type |
description |
| application/json |
ApiUser2
(JSON) |
|
POST /users/expireSessions/{userName}
Expires the sessions associated with interactive authenticated
user in Cloudera Manager. This can be used by Full Admin/User Admin users only.
Note that these sessions are only associated with a user who log into the
web interface. Sessions of an API user will not be affected.
Request Parameters
| name |
type |
description |
default |
| userName |
path |
|
n/a |