List Roles

Returns a list of all roles available in the company (pod).

🚧 Required Permissions
Calling this endpoint requires the ACCESS_ADMIN_API privilege. See Bot Permissions for a list of roles and associated privileges.

Last updated 1 year ago

Was this helpful?

Get a list of all roles available in the company (pod)

get

/v1/admin/system/roles/list

Header parameters

sessionTokenstringrequired

Session authentication token.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'yourpodURL.symphony.com/pod/v1/admin/system/roles/list' \
  --header 'sessionToken: text'

200

400

401

403

500

[
  {
    "id": "CONTENT_MANAGEMENT",
    "name": "Content Management",
    "userTypes": [
      "SYSTEM",
      "NORMAL"
    ],
    "optionalActions": [
      "MONITOR_ROOMS"
    ]
  },
  {
    "id": "COMPLIANCE_OFFICER",
    "name": "Compliance Officer",
    "userTypes": [
      "NORMAL"
    ],
    "optionalActions": [
      "BAN_AND_UNBAN_ROOM_MEMBER",
      "LOCK_AND_UNLOCK_ROOM",
      "MONITOR_ROOMS",
      "MONITOR_WALL_POSTS"
    ]
  }
]

Success