List Roles

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

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

GETyourpodURL.symphony.com/pod/v1/admin/system/roles/list

Header parameters

Response

200400401403500

Success

Body

application/json

idstring

Example: "CONTENT_MANAGEMENT"

namestring

Example: "Content Management"

userTypesarray of string

optionalActionsarray of string

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/system/roles/list', {
    method: 'GET',
    headers: {
      "sessionToken": "text"
    },
});
const data = await response.json();

Response

200400401403500

[
  {
    "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.