Skip to main content
POST
/
v2.0
/
users
/
{userId}
/
addroletouser
Adds a new org-wide role to an user.
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/users/{userId}/addroletouser \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "role": "admin"
}'
This response does not have an example.

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
userId
string
required

The Id of the User

Required string length: 24

Body

application/json
​
role
enum<string>
Available options:
admin,
apiKeys,
base_role,
basicSupportUser,
fullSupportUser,
liveAgentAdmin,
liveAgentAgent,
liveAgentSupervisor,
odata,
projectAssigner,
projectManager,
userManager,
userDetailsViewer,
voiceGatewayUser,
opsCenterUser

Response

User-role was added to the user.