Fetches latest roles summary for the realm.

GET

/realms/{realm_id}/roles

• Development server

Authorizations

• firebase

Parameters

Path Parameters

realm_id

required

string format: uuid

The id of the realm.

Responses

200

The realm roles summary.

object

roles

Array<object>

object

user_id

string format: uuid

username

required

Username.

string

role_string_id

required

String id of role.

string format: uuid

role_name

required

Name of role.

string

label

required

Label associated with role assignment

string

Examples

{
  "invites": [
    {
      "user_firebase_id": "a90b0809-2c57-4ff1-be7c-4b7ab1b7edcc",
      "username": "bobatan",
      "role_string_id": "3df1d417-c36a-43dd-aaba-9590316ffc32",
      "role_name": "The Owner",
      "label": "Look ma, a label"
    }
  ]
}

401

User was not found in request that requires authentication.

Generic response object

object

message

string

Examples

No authentication token given.

{
  "message": "No authenticated user found."
}

Expired authentication token given.

{
  "message": "Authentication token expired."
}

403

User does not have required permissions to complete this action.

Generic response object

object

message

string

404

The realm was not found.

Generic response object

object

message

string

500

There was an error fetching realm roles.