List all permission groups
GET/auth/permission_groups
Returns a list of your permission groups. Results are paginated to improve retrieval peformance. The meta data indicates how many total records exist.
Request
Query Parameters
If false, only ids will be returned, otherwise the nested resource will be returned.
If false, only ids will be returned, otherwise the nested resource will be returned.
Current page based on pagination settings.
Number of results to return per page based on pagination settings.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
uuid.
Human readable identifier.
Record type.
Timestamp of resource creation.
Timestamp of last resource update.
meta
object
Total number of pages based on pagination settings
Total number of results
Current Page based on pagination settings (included when defaults are used.)
Number of results to return per page based on pagination settings (included when defaults are used.)
{
"data": [
{
"id": "1490ecab-d4a1-4f22-abe7-60f5500a060f",
"description": "Text Jenny",
"actions": [
"string"
],
"resource_groups": [
"string"
],
"record_type": "permission_group",
"created_at": "2018-02-08T18:49:22.998023Z",
"updated_at": "2018-02-08T18:49:22.998023Z"
}
],
"meta": {
"total_pages": 13,
"total_results": 13,
"page_number": 3,
"page_size": 1
}
}
401: Authentication error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
an application-specific error code, expressed as a stringified integer.
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
JSON pointer to the field which is causing the error.
{
"errors": [
{
"code": "10001",
"title": "error title",
"detail": "additional detail about the error",
"pointer": "/pointer/to/field"
}
]
}
403: Authorization error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
an application-specific error code, expressed as a stringified integer.
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
JSON pointer to the field which is causing the error.
{
"errors": [
{
"code": "10001",
"title": "error title",
"detail": "additional detail about the error",
"pointer": "/pointer/to/field"
}
]
}
422: Invalid parameters supplied in request. See HTTP response body for details.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
an application-specific error code, expressed as a stringified integer.
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
JSON pointer to the field which is causing the error.
{
"errors": [
{
"code": "10001",
"title": "error title",
"detail": "additional detail about the error",
"pointer": "/pointer/to/field"
}
]
}