Get roles

GET 
/roles

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

Request

Query Parameters

query object

Allows for pagination and sorting.

metadata boolean

Returns batching metadata in the response

Responses

200

Expected response to a valid request

application/json

Schema

Schema

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

Example (from schema)

{
  "roles": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "uid": "sponsors_role",
      "name": "Sponsors",
      "groups": [
        "ad_group_name"
      ]
    }
  ],
  "_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...