user-group
user-group
Represents a user group
JSON Example
{
"authSourceId": "string",
"description": "string",
"displayName": "string",
"id": "string",
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"name": "string",
"role-permissions": [
{
"allowAllObjects": false,
"links": [
{
"description": "string",
"href": "string",
"name": "string",
"rel": "string"
}
],
"roleName": "string",
"traversal-spec-instances": [
{
"adapterKind": "string",
"includedAdapterKinds": [
"string"
],
"name": "string",
"resourceKind": "string",
"resourceSelection": [
{
"resourceId": [
"string"
],
"type": "string"
}
],
"selectAllResources": false
}
]
}
],
"roleNames": [
"string"
],
"userIds": [
"string"
]
}
string As uuid As uuid
authSourceId
Optional
The identifier of the auth source. If it is null, a local user group will be created.
string
description
Optional
A description about this group.
string
displayName
Optional
The displayName of this group.
string As uuid As uuid
id
Optional
The identifier of this group.(unique)
Note: Required when updating or deleting the user group.
string
name
Required
The name of this group.
array of role-permission
role-permissions
Optional
The list of role permissions assigned to this group. May be null. Replaces and takes precedence over roleNames
.
array of string
roleNames
Optional
(Deprecated) List of role names assigned to the user group. May be null.
array of string
userIds
Optional
The list of users who are members of this group.
Property Of