Get user role pairings

GET 
/user_roles

This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters

Request

Query Parameters

query object

Allows for pagination and sorting.

user_id uuid

The ID of a user for filtering

role_id uuid

The ID of a role for filtering

metadata boolean

Returns batching metadata in the response

Responses

200

Expected response to a valid request

application/json

Schema

Schema

user_roles object[]
Array [
id uuid
uid string
Possible values: >= 32 characters and <= 32 characters
user_id uuid
role_id uuid
]
_metadata object
limit integer
offset integer
total integer
next string
previous string

Example (from schema)

{
  "user_roles": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "uid": "string",
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "_metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf
InvalidJson
error
ValidationErrors
error
errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "Sorry something went wrong"
}

Loading...