v1/users
Use the v1/users API to create, update, or list users for your account. Only admin users can view or change all users for an account. Users without admin privileges can view or update their own user account, but they cannot change their security policy or role.
URI
http://<hostname>/ws/v1/users
Formats
| HTTP method | Format | Description | Parameters |
|---|---|---|---|
| GET | /ws/v1/users | Get summary of the users APIs. | None |
| GET | /ws/v1/users/bulk | Get a list of all users for the account in CSV format. | orderby query fields |
| POST, GET | /ws/v1/users/change_password/{uuid} | Change password for an existing user, or retrieve the accounts password complexity rules | validate_only |
| POST | /ws/v1/users/forgot_password/{username:.+} | Submit a forgot password request, the user is emailed a password reset token. | None |
| POST | /ws/v1/users/forgot_username/{email_address:.+} | Submit a forgot password request, the user is emailed a password reset token. | None |
| GET, POST | /ws/v1/users/inventory | Retrieve (GET) or change a list of all users in the account. | orderby cursor query size |
| GET, PUT, DELETE | /ws/v1/users/inventory/{username:.+} | Retrieve (GET), create (PUT), or remove (DELETE) a user. | None |
Parameters
| Name | Type | Description |
|---|---|---|
| cursor | string | Cursor to get the next page of results. Omit on initial call. |
| orderby | string | Specify any field described in the query parameter syntax. Optionally add asc or desc to control the sort order. |
| fields | string | Comma-separated list of fields to return for bulk API |
| query | string | The Remote Manager query language query condition used to filter results. See v1 API Query Language. |
| size | integer | Number of items to return. The maximum and default is 1000. |
| validate_only | boolean | If true, the API call only validates the password in the payload based on the accounts password complexity rules and does not perform the action. The default is false. |
Fields
address
(Optional) String that specifies the street address for the user.
city
(Optional) String that specifies the city for the user.
country
(Optional) String that specifies the country for the user.
(Required) Email address for the user.
enabled
(Required) Specifies whether the username is enabled or disabled. The default is enabled.
first_name
(Required) First name of the user.
job_title
(Optional) Job title of the user.
last_login
Returns the timestamp of the last login for the user.
last_name
(Required) Last name of the user.
password
(Required) Password of the user.
phone_number
(Optional) Phone number for the user.
postal_code
(Optional) Postal code for the user address.
registration_date
Returns the timestamp for the user registration.
security_policy
(Optional) Specifies a security policy for the user.
role
(Required) Specifies the role for the user. Roles include: Administrator, User, Read only users, Application, Read only application.
state
(Optional) State for the user address.
username
(Required) Username for the user.