Permission Groups V1

Permission group operations

List all 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.

SecuritybasicAuth or bearerAuth
Request
query Parameters
include_actions
boolean

If false, only ids will be returned, otherwise the nested resource will be returned.

include_resource_groups
boolean

If false, only ids will be returned, otherwise the nested resource will be returned.

page[number]
number <double>

Current page based on pagination settings.

page[size]
number <double>

Number of results to return per page based on pagination settings.

Responses
200

Successful response

Response Schema: application/json
Array of objects (Permission Group)
object (Metadata)
401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

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.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

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.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

422

Invalid parameters supplied in request. See HTTP response body for details.

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

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.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

get/auth/permission_groups
Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create a permission group
Creates a new permission group object.


SecuritybasicAuth or bearerAuth 
Request 
Request Body schema: application/json
required
description
required
string
Human readable identifier.


 
actions
required
Array of strings
 
resource_groups
required
Array of strings
 
Responses 
200
Successful response


Response Schema: application/json
object (Permission Group) 
 
id
string
uuid.


 
description
string
Human readable identifier.


 
actions
Array of strings
 
resource_groups
Array of strings
 
record_type
string
Record type.


 
created_at
string
Timestamp of resource creation.


 
updated_at
string
Timestamp of last resource update.


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
422
Invalid parameters supplied in request. See HTTP response body for details.


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
post/auth/permission_groups
Request samples 
application/json
{
  • "description": "Text Jenny",
  • "actions": [
    • "string"
    ],
  • "resource_groups": [
    • "string"
    ]
}
Response samples 
application/json
{
  • "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"
    }
}
Retrieve a permission group
Retrieves the details of an existing permission group.


SecuritybasicAuth or bearerAuth 
Request 
path Parameters
id
required
string
The id of the Permission Group


 
query Parameters
include_actions
boolean
If true, only ids will be returned, otherwise the nested resource will be returned.


 
include_resource_groups
boolean
If true, only ids will be returned, otherwise the nested resource will be returned.


 
Responses 
200
Successful response


Response Schema: application/json
object (Permission Group) 
 
id
string
uuid.


 
description
string
Human readable identifier.


 
actions
Array of strings
 
resource_groups
Array of strings
 
record_type
string
Record type.


 
created_at
string
Timestamp of resource creation.


 
updated_at
string
Timestamp of last resource update.


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
404
Resource not found


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
422
Invalid parameters supplied in request. See HTTP response body for details.


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
get/auth/permission_groups/{id}
Request samples 
Response samples 
application/json
{
  • "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"
    }
}
Update a permission group
Updates the specified permission group with the parameters passed. Any parameters not included in the request will be left unchanged.


SecuritybasicAuth or bearerAuth 
Request 
path Parameters
id
required
string
The id of the Permission Group


 
Request Body schema: application/json
required
description
required
string
Human readable identifier.


 
actions
required
Array of strings
 
resource_groups
required
Array of strings
 
Responses 
200
Successful response


Response Schema: application/json
object (Permission Group) 
 
id
string
uuid.


 
description
string
Human readable identifier.


 
actions
Array of strings
 
resource_groups
Array of strings
 
record_type
string
Record type.


 
created_at
string
Timestamp of resource creation.


 
updated_at
string
Timestamp of last resource update.


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
404
Resource not found


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
422
Invalid parameters supplied in request. See HTTP response body for details.


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
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.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
patch/auth/permission_groups/{id}
Request samples 
application/json
{
  • "description": "Text Jenny",
  • "actions": [
    • "string"
    ],
  • "resource_groups": [
    • "string"
    ]
}
Response samples 
application/json
{
  • "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"
    }
}