Add Account To User Groups

Adds specific groups to the account (user or service account)

Request

URI

POST

https://{api_host}/api/v2/account/{id}/addUserGroups

COPY

Path Parameters

string

Required

Request Body

addAccountToUserGroupsBody of type(s) application/json

Optional

[
    {}
]

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

successful operation

Returns UserModel of type(s) application/json

{
    "identifier": "string",
    "customer": "string",
    "ssoId": "string",
    "lastSuccessfulLogin": 0,
    "groups": [
        "string"
    ],
    "userGroups": [
        {
            "id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
            "name": "string",
            "customer": "string",
            "users": [
                "string"
            ],
            "userCount": 0,
            "properties": {
                "nameEditable": false,
                "usersEditable": false,
                "rolesEditable": false
            },
            "description": "string",
            "roles": [
                "RoleDTO Object"
            ]
        }
    ],
    "roles": [
        {
            "sampleLinkedGroups": [
                "UserGroup Object"
            ],
            "linkedGroupsCount": 0,
            "sampleLinkedAccounts": [
                "string"
            ],
            "linkedAccountsCount": 0,
            "restrictedPermissions": [
                "string"
            ],
            "properties": {
                "nameEditable": false,
                "usersRemovable": false,
                "usersAddable": false,
                "permsEditable": false,
                "deletable": false
            },
            "permissions": [
                "string"
            ],
            "name": "string",
            "id": "string",
            "description": "string",
            "createdEpochMillis": 0,
            "lastUpdatedMs": 0,
            "lastUpdatedAccountId": "string",
            "customer": "string"
        }
    ]
}

string

identifier

Required

The unique identifier of this user, which must be their valid email address

string

customer

Required

The id of the customer to which this user belongs

string

ssoId

Optional

ssoId