getRoles

Purpose

Returns a list in XML or JSON format of all the roles in the tenant with the following details:

Name
Integration code
Description
ID
Original ID

Does not include the Super Admin role in the response.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getRoles

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

Full administrative privileges.

Response

A list of all roles in the tenant in XML or JSON format.

Example

Output example in JSON format:

[
  {
    "name": "Portal Guest",
    "code": null,
    "description": "System role used to assign permissions to non-authenticated portal users.",
    "id": "99",
    "originalId": "99"
  },
  {
    "name": "Library Employee",
    "code": null,
    "description": null,
    "id": "67956084",
    "originalId": "67956084"
  },
  {
    "name": "Administrator",
    "code": null,
    "description": "System Administrator has unrestricted access to all applications.",
    "id": "90",
    "originalId": "90"
  },
  {
    "name": "Portal User",
    "code": null,
    "description": "System role used to assign permissions to authenticated portal users.",
    "id": "93",
    "originalId": "93"
  },
  {
    "name": "No Access",
    "code": null,
    "description": "",
    "id": "94",
    "originalId": "94"
  }
]