Access Control - Policy Groups

get Access Control Policy Groups

Retrieves a list of policy groups.

SecurityApiKeyAuth
Responses
200

OK

get/access_control/policy_groups
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create an Access Control Policy Group
Creates a policy group.


SecurityApiKeyAuth 
Request 
Request Body schema: application/json
name
required
string
Policy Group's name


 
Responses 
200
OK


post/access_control/policy_groups
Request samples 
application/json
{
  • "name": "some_policy_group"
}
Response samples 
application/json
{
  • "id": 10,
  • "account_id": 123,
  • "name": "some_policy_group",
  • "taggable_name": "some_policy_group",
  • "description": "some_policy_group_description",
  • "policy_count": 1,
  • "created_at": "2012-01-01T12:00:00Z",
  • "updated_at": "2012-01-01T12:00:00Z"
}
Get an Access Control Policy Group
Retrieves information about the specified policy group.


SecurityApiKeyAuth 
Request 
path Parameters
required
AccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)
 
 Example:  67 or some_policy_group
Responses 
200
OK


get/access_control/policy_groups/{policy_group_id_or_taggable_name}
Request samples 
Response samples 
application/json
{
  • "id": 10,
  • "account_id": 123,
  • "name": "some_policy_group",
  • "taggable_name": "some_policy_group",
  • "description": "some_policy_group_description",
  • "policy_count": 1,
  • "created_at": "2012-01-01T12:00:00Z",
  • "updated_at": "2012-01-01T12:00:00Z"
}
Update an Access Control Policy Group
Updates information related to a policy group.


SecurityApiKeyAuth 
Request 
path Parameters
required
AccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)
 
 Example:  67 or some_policy_group
Request Body schema: application/json
name
required
string
Policy Group's name


 
description
string or null
Policy Group's description


 
Responses 
200
OK


patch/access_control/policy_groups/{policy_group_id_or_taggable_name}
Request samples 
application/json
{
  • "name": "some_policy_group",
  • "description": "some_policy_group_description"
}
Response samples 
application/json
{
  • "id": 10,
  • "account_id": 123,
  • "name": "some_policy_group",
  • "taggable_name": "some_policy_group",
  • "description": "some_policy_group_description",
  • "policy_count": 1,
  • "created_at": "2012-01-01T12:00:00Z",
  • "updated_at": "2012-01-01T12:00:00Z"
}
Delete an Access Control Policy Group
Deletes a policy group.


SecurityApiKeyAuth 
Request 
path Parameters
required
AccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)
 
 Example:  67 or some_policy_group
Responses 
200
OK


delete/access_control/policy_groups/{policy_group_id_or_taggable_name}
Request samples 
Get an Access Control Policy Group's Policies
Retrieves the list of the specified policy group's policies.


SecurityApiKeyAuth 
Request 
path Parameters
required
AccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)
 
 Example:  67 or some_policy_group
Responses 
200
OK


get/access_control/policy_groups/{policy_group_id_or_taggable_name}/policies
Request samples 
Response samples 
application/json
{
  • "policy_ids": [
    ]
}
Update an Access Control Policy Group's Policies
Updates the policies attached to a policy group.


SecurityApiKeyAuth 
Request 
path Parameters
required
AccessControlPolicyGroupId (integer) or AccessControlPolicyGroupTaggableName (string)
 
 Example:  67 or some_policy_group
Request Body schema: application/json
policy_ids
required
Array of integers (AccessControlPolicyId) 
Policy Group's Policies


 
Responses 
200
OK


patch/access_control/policy_groups/{policy_group_id_or_taggable_name}/policies
Request samples 
application/json
{
  • "policy_ids": [
    ]
}
Response samples 
application/json
{
  • "policy_ids": [
    ]
}