POST /UsersGroups/{usersGroupId}/Users

Adds users to a users group.

post

Authorizations

API Key

X-API-KEYstringRequired

Public API key used to identify the client application. It should be included in all requests.

Path parameters

usersGroupIdstring · uuidRequired

The users group ID.

Header parameters

X-API-SECRETstringRequired

API Secret is used to verify the integrity of the request and authenticate the client. It should be included in all requests. This value must be kept confidential and should never be exposed in client-side code or public repositories.

Example: YOUR_API_SECRET

Body

application/jsontext/jsonapplication/*+json

Request model to add users to a users group

userIdsstring · uuid[]Required

List of the user ids being added to the users group.

triggeredByUserIdstring · uuidRequired

Identifier of the admin user that triggered the operation.

implicitlyApproveRequestsbooleanOptional

Flag that configures request creation behaviour. True = request are automatically approved. False = Normal requests are created.

Responses

201

Created

No content

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

500

Internal Server Error

post/api/v1/UsersGroups/{usersGroupId}/Users

HTTPcURLJavaScriptPython

POST /api/v1/UsersGroups/{usersGroupId}/Users HTTP/1.1
Host: open-api.getcakewalk.io
X-API-KEY: YOUR_API_KEY
X-API-SECRET: YOUR_API_SECRET
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "triggeredByUserId": "123e4567-e89b-12d3-a456-426614174000",
  "implicitlyApproveRequests": true
}

application/jsontext/jsonapplication/*+json

No content