List Roles

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

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

get

Header parameters

sessionTokenanyrequired

Session authentication token.

Responses

application/json

object[]optional

Role detailed.

Example: [{"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"]}]

application/json

application/json

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /pod/v1/admin/system/roles/list HTTP/1.1
Host: yourpodURL.symphony.com
Accept: */*

[
  {
    "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"
    ]
  }
]

🚧 Required Permissions

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