Modify User Groups

Adds a list of group references that the user with the given id belongs to. This endpoint allows for the group membership info to be pre-populated before a user logs in for the first time.

Request

URI

PUT

https://{api_host}/cloudapi/1.0.0/users/{userUrn}/groups

COPY

Path Parameters

string

userUrn

Required

userUrn

Request Body

EntityReferences of type(s) application/json

Optional

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "name": "string",
            "id": "string"
        }
    ]
}

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns EntityReferences of type(s) application/json;version=40.0

This response body class contains all of the following: InlineEntityReferences0 , InlineEntityReferences1

"EntityReferences Object"

Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object],[object Object]

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"values":["object"]}' https://{api_host}/cloudapi/1.0.0/users/{userUrn}/groups

Availability

Added in 40.0

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Vendor Extension

User Operations