user-group

user-group
user-group

Represents a user group

JSON Example
{
    "id": "string",
    "authSourceId": "string",
    "name": "string",
    "description": "string",
    "displayName": "string",
    "userIds": [
        "string"
    ],
    "roleNames": [
        "string"
    ],
    "role-permissions": [
        {
            "roleName": "string",
            "scopeId": "string",
            "traversal-spec-instances": [
                {
                    "adapterKind": "string",
                    "resourceKind": "string",
                    "name": "string",
                    "resourceSelection": [
                        {
                            "type": "string",
                            "resourceId": [
                                "string"
                            ]
                        }
                    ],
                    "selectAllResources": false,
                    "includedAdapterKinds": [
                        "string"
                    ]
                }
            ],
            "allowAllObjects": false,
            "links": [
                {
                    "href": "string",
                    "rel": "string",
                    "name": "string",
                    "description": "string"
                }
            ]
        }
    ],
    "externalId": "string",
    "links": [
        {
            "href": "string",
            "rel": "string",
            "name": "string",
            "description": "string"
        }
    ]
}
string As uuid As uuid
id
Optional

The identifier of this group.(unique)

Note: Required when updating or deleting the user group.

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
name
Required

The name of this group.

string
description
Optional

A description about this group.

string
displayName
Optional

The displayName of this group.

array of string
userIds
Optional

The list of users who are members of this group.

array of string
roleNames
Optional

(Deprecated) List of role names assigned to the user group. May be null.

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.

string
externalId
Optional

External ID of vIDB user group. This field is only used in vIDB user group import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.

array of link
links
Optional

links

Property Of
Parameter To
Returned By