Get user role pairings

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

Query Parameters

• query object

  Allows for pagination and sorting using the deepObject notation.

  
  

  resource?query[limit]=50&query[offset]=0&query[order]=label

  
  

  Parameter	Description	Default
  limit	Limits the number of results returned	100
  offset	Returns the results starting at the value provided	0
  order	Allows you to determine the order in which the data is returned (not available on profile attributes)	id

  Example: query[limit]=100&query[offset]=50&query[order]=created_at
• user_id uuid

  The ID of a user for filtering

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
• role_id uuid

  The ID of a role for filtering

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
• metadata boolean

  Returns batching metadata in the response

  Example: true

Responses

• 200
• 400
• 500

---

Expected response to a valid request

application/json

• Schema
• Example (from schema)

---

Schema

• user_roles object[]

  id uuid

  the id

  uid string

  Possible values: >= 32 characters and <= 32 characters

  the uid

  user_id uuid

  the user id

  role_id uuid

  the role id

• _metadata object

  limit int32

  The limit

  offset int32

  The offset

  total int32

  The total

  next string

  The link to the next page of data

  previous string

  The link to the previous page of data

{
  "user_roles": [
    {
      "id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "user_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "role_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"
    }
  ],
  "_metadata": {
    "limit": 50,
    "offset": 100,
    "total": 10000,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

Bad Request - unable to complete.

application/json

• Schema
• Example (from schema)

---

Schema

oneOf
• MOD1
• MOD2
---
error
error
errors

{
  "error": "Invalid JSON syntax. Please check your syntax and try again."
}

Internal Server Error - returned on unhandled exceptions.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

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

Loading...