Add Role

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

Add a role to a user

post

Path parameters

uidinteger · int64Required

User ID as a decimal integer

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

idstringOptionalExample: xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

HTTPcURLJavaScriptPython

POST /pod/v1/admin/user/{uid}/roles/add HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "id": "xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA"
}

{
  "format": "TEXT",
  "message": "Success"
}

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.