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

sessionTokenstringRequired

Session authentication token.

Responses

200

Success

application/json

Role detailed.

idstringOptionalExample: CONTENT_MANAGEMENT

namestringOptionalExample: Content Management

userTypesstring[]OptionalExample: ["NORMAL","SYSTEM"]

optionalActionsstring[]OptionalExample: ["MONITOR_ROOMS","MONITOR_WALL_POSTS"]

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

get

/v1/admin/system/roles/list

HTTPcURLJavaScriptPython

GET /pod/v1/admin/system/roles/list HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
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.