User Roles

Get a list of user roles

Retrieve the user roles in the organization, optionally filtered by user or member. role is the stored role value: a system role name or, for custom roles, the custom role name. locations lists the locations a role is restricted to (empty means all locations). Some restricted users can still read data in all locations through a secondary viewer role, which this endpoint does not expose.

Required scopes: flex.user.userRoles.read

get/api/v2/organizations/{orgSlug}/user-roles

Request

Base URL
https://app.officernd.com
URL
https://app.officernd.com/api/v2/organizations/{orgSlug}/user-roles
Auth
OAuth 2
Authorization code: https://identity.officernd.com/auth/authorize
Client credentials
Token URL: https://identity.officernd.com/auth/token scopes: flex.user.userRoles.read

Path parameters

orgSlugstring required

organization slug

Query parameters

userstring

Filter by user id. Supports single id (e.g. user=xxx) or multiple (e.g. user[$in]=id1,id2).

memberstring

Filter by member id. Supports single id (e.g. member=xxx) or multiple (e.g. member[$in]=id1,id2).

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "603dfbc260f4054084125d35",
      "user": "603dfbc260f4054084125d33",
      "member": "603dfbc260f4054084125d30",
      "role": "admin",
      "locations": [
        "603dfbc260f4054084125d36"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.