Get roles

This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results.

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
• 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

• roles object[]

  id uuid

  the id

  uid string

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

  the uid

  name string

  The name

  groups string[]

  the groups

• _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

{
  "roles": [
    {
      "id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "uid": "sponsors_role",
      "name": "Sponsors",
      "groups": [
        "ad_group_name"
      ]
    }
  ],
  "_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...