IAM users (/iamusers/)
URL: https://[server_name]/api/v1/iamusers/
This end-point represents IAM user resource.
Supported fields
Field | Display name | Type | Required | Other restrictions |
---|---|---|---|---|
username | username | String | Yes | Unique within its IAM account. |
account |
account |
Interger/String |
Yes |
Must be IAM account ID. |
is_admin |
is_admin |
Boolean |
No |
true or false |
localuser |
localuser |
Interger/String |
Yes |
Must be local user id and must be null if ldapuser is set. |
ldapuser |
ldapuser |
Interger/String |
Yes |
Must be remote LDAP user id and must be null if localuser is set. |
Allowed methods
HTTP method | Resource URI | Action |
---|---|---|
GET | /api/v1/iamusers/ | Get all IAM users. |
GET | /api/v1/iamusers/[id]/ | Get a specific IAM user with ID. |
POST |
/api/v1/iamusers/ |
Create a new IAM user. |
PATCH |
/api/v1/iamusers/[id]/ |
Update specific fields for a specific IAM user with ID. |
DELETE |
/api/v1/iamusers/[id]/ |
Delete an IAM user. |
Allowed filters
Field | Lookup expressions | Values |
---|---|---|
id |
exact, in
|
|
username |
exact
|
|
account |
|
Account ID |
localuser |
|
Local user ID |
ldapuser |
|
LDAP user ID |