Add Role

Adds a role or optional entitleable action to a user’s account.

Request Example

curl -X POST \
	https://acme.symphony.com/pod/v1/admin/user/346147139412345/roles/add \
  -H 'cache-control: no-cache' \
	-H 'content-type: application/json' \
	-H 'sessiontoken: SESSION_TOKEN' \
	-d '{"id":"COMPLIANCE_OFFICER"}'

🚧 Required Permissions
Calling this endpoint requires the User Provisioning role with ACCESS_USER_PROVISIONING_API privilege. See Bot Permissions for a list of roles and associated privileges.

Last updated 1 year ago

Was this helpful?

Add a role to a user

post

/v1/admin/user/{uid}/roles/add

Path parameters

uidinteger · int64required

User ID as a decimal integer

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

idstring

Example: xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v1/admin/user/{uid}/roles/add' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '{"id":"xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA"}'

200

400

401

403

500

{
  "format": "TEXT",
  "message": "Role added"
}

Success