Access Control - Policies

get Access Control Policies

Retrieves a list of policies.

SecurityApiKeyAuth
Request
query Parameters
column_permission_tag
string

Return only policies that refer to the specified tag

Responses
200

OK

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


SecurityApiKeyAuth 
Request 
Request Body schema: application/json
required
object
 
Responses 
200
OK


post/access_control/policies
Request samples 
application/json
{
  • "policy": {
    }
}
Response samples 
application/json
{
  • "id": 67,
  • "account_id": 123,
  • "name": "some_policy",
  • "description": "written about the policy",
  • "user_count": 3
}
Get an Access Control Policy
Retrieves information about the specified policy.


SecurityApiKeyAuth 
Request 
path Parameters
policy_id
required
integer (AccessControlPolicyId) 
 
 Example:  67
Responses 
200
OK


get/access_control/policies/{policy_id}
Request samples 
Response samples 
application/json
{
  • "id": 67,
  • "account_id": 123,
  • "name": "some_policy",
  • "description": "written about the policy",
  • "user_count": 3
}
Update an Access Control Policy
Updates information related to a policy.


SecurityApiKeyAuth 
Request 
path Parameters
policy_id
required
integer (AccessControlPolicyId) 
 
 Example:  67
Request Body schema: application/json
required
object
 
Responses 
200
OK


patch/access_control/policies/{policy_id}
Request samples 
application/json
{
  • "policy": {
    }
}
Response samples 
application/json
{
  • "id": 67,
  • "account_id": 123,
  • "name": "some_policy",
  • "description": "written about the policy",
  • "user_count": 3
}
Delete an Access Control Policy
Deletes a policy.


SecurityApiKeyAuth 
Request 
path Parameters
policy_id
required
integer (AccessControlPolicyId) 
 
 Example:  67
Responses 
200
OK


delete/access_control/policies/{policy_id}
Request samples 
Response samples 
application/json
{
  • "id": 67,
  • "account_id": 123,
  • "name": "some_policy",
  • "description": "written about the policy",
  • "user_count": 3
}
get User Policies
Retrieves a list of policies by user.


SecurityApiKeyAuth 
Request 
path Parameters
user_id
required
integer (UserId) 
 
 Example:  123
Responses 
200
OK


get/access_control/users/{user_id}/policies
Request samples 
Response samples 
application/json
[
  • {
    }
]
Update User Policies
Updates policies by user ID.


SecurityApiKeyAuth 
Request 
path Parameters
user_id
required
integer (UserId) 
 
 Example:  123
Request Body schema: application/json
policy_ids
required
Array of strings
 
Responses 
200
OK


patch/access_control/users/{user_id}/policies
Request samples 
application/json
{
  • "policy_ids": [
    ]
}
Response samples 
application/json
[
  • {
    }
]
Attach a policy to a user.
Attaches a policy to a user.


SecurityApiKeyAuth 
Request 
path Parameters
user_id
required
integer (UserId) 
 
 Example:  123
policy_id
required
integer (AccessControlPolicyId) 
 
 Example:  67
Responses 
200
OK


post/access_control/users/{user_id}/policies/{policy_id}
Request samples 
Response samples 
application/json
{
  • "id": 67,
  • "account_id": 123,
  • "name": "some_policy",
  • "description": "written about the policy",
  • "user_count": 3
}
Detach a Policy from a User
Detaches a policy from a user.


SecurityApiKeyAuth 
Request 
path Parameters
user_id
required
integer (UserId) 
 
 Example:  123
policy_id
required
integer (AccessControlPolicyId) 
 
 Example:  67
Responses 
200
OK


delete/access_control/users/{user_id}/policies/{policy_id}
Request samples 
Response samples 
application/json
{
  • "id": 67,
  • "account_id": 123,
  • "name": "some_policy",
  • "description": "written about the policy",
  • "user_count": 3
}
Attach
This operation attaches a policy to a user.


SecurityApiKeyAuth 
Request 
path Parameters
policy_id
required
integer (AccessControlPolicyId) 
 
 Example:  67
user_id
required
integer (UserId) 
 
 Example:  123
Responses 
200
OK


post/access_control/policies/{policy_id}/users/{user_id}
Request samples 
Response samples 
application/json
{
  • "id": 67,
  • "account_id": 123,
  • "name": "some_policy",
  • "description": "written about the policy",
  • "user_count": 3
}
Detach
Detaches a user from a policy.


SecurityApiKeyAuth 
Request 
path Parameters
policy_id
required
integer (AccessControlPolicyId) 
 
 Example:  67
user_id
required
integer (UserId) 
 
 Example:  123
Responses 
200
OK


delete/access_control/policies/{policy_id}/users/{user_id}
Request samples 
Response samples 
application/json
{
  • "id": 67,
  • "account_id": 123,
  • "name": "some_policy",
  • "description": "written about the policy",
  • "user_count": 3
}