List org role members

Gets a list of members assigned to a platform role in the authenticated org.

Required permission

Organisation > Admin > Roles > Read

Path parameters

roleId
string required
ID of the org role

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
min
1
max
100
page
integer
The page number to access.
min
1
cursor
string
The cursor returned from the previous page of results, used to request the next page.
min length
24
max length
24
type
string
Filter members by how they were added, directly or implicitly via directory group membership.
one of
explicit, implicit
userIds
(multiple options: anyOf)
Filter members by user ID. Specify the parameter multiple times to filter by multiple user IDs.

[array] required

string required
pattern
^[A-Za-z0-9-]+$

string required

pattern

^[A-Za-z0-9-]+$

Response body

{object}
Response object.

data
{object} required
Result data.

members
[array] required
An array of members in the org role.

{object}
An org role member object.

id
string required
ID (username) of the org member. For users who are not finalized this ID may change on finalisation.
pattern
^[A-Za-z0-9-]+$
name
string
Display name from the member profile.
emails
[array]
Email addresses of the member.

{object}
Email addresses of the member.

address
string
verified
boolean

joinedAt
string
The time the member joined the org.
lastLoginTime
string
The time the member last logged in.
finalized
boolean required
Whether the account has been fully set up by the user.
type
string required
How the member was added to the role. `explicit` means manually added; `implicit` means provisioned via Directory Sync.
one of
explicit, implicit

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

GET /v1/org-roles/{roleId}/members

Example response

200 OK

A list of members in the org role.

JSON

{
  "data": {
    "members": [
      {
        "id": "john-doe",
        "name": "John Doe",
        "emails": [
          {
            "address": "john@example.com",
            "verified": true
          }
        ],
        "joinedAt": "2021-01-20T11:19:53.175Z",
        "lastLoginTime": "2021-01-20T11:19:53.175Z",
        "type": "explicit"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}