Update
PUT v1/user_groups/id
Description
Modify information about a user group.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 409 500 503
Detail Codes
Request
| Parameter | Type | JSON Type | Description | Mandatory | Deprecated |
|---|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the user group. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | true | |
| description | NsDescription | string | Description of the user group. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | false | |
| role | NsUserRoles | string enum | Role of the user. Possible values: 'administrator', 'poweruser', 'operator', 'guest'. | false | |
| inactivity_timeout | NsSeconds | number | The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting. Unsigned 64-bit integer. Example: '1234'. | false | |
| disabled | NsBoolean | boolean | User is currently disabled. Possible values: 'true', 'false'. | false |
JSON Request
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the user group. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsUserGroupName | string | Name of the user group. String of up to 64 uppercase or lowercase characters excluding ampersand, less than, greater than and ^/\[]:;|=,+*?;. Example: 'admin-group-24'. | |
| description | NsDescription | string | Description of the user group. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| role_id | NsObjectID | string | Identifier for the user group's role. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| role | NsUserRoles | string enum | Role of the user. Possible values: 'administrator', 'poweruser', 'operator', 'guest'. | |
| inactivity_timeout | NsSeconds | number | The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting. Unsigned 64-bit integer. Example: '1234'. | |
| creation_time | NsTime | number | Time when this user was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this user was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| disabled | NsBoolean | boolean | User is currently disabled. Possible values: 'true', 'false'. | |
| external_id | NsString | string | External ID of the user group. In Active Directory, it is the group's SID (Security Identifier). Plain string. | |
| domain_id | NsObjectID | string | Identifier of the domain this user group belongs to. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| domain_name | NsObjectName | string | Role of the user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. |
JSON Response