• Policies
  • Resources
Cloud
Control REST API / Reference / REST API

Policies

Postman Collection
OpenAPI

A policy is a set of rules that apply to a specific area and a particular group, allowing an organization to ensure a basic level of compliance, security, and behavior. All policies have their own distinct set of rules and specifies the types of resources that can be associated with it.

GET

Get list of policies

Returns comprehensive details on organizational policies, including both rules and resources.

Request

Path parameters

orgId

string

Required

Query parameters

cursor

string

type

Models.PolicyType

Responses

The request has succeeded.

application/json

Models.PolicyPage
GET/admin/control/v1/orgs/{orgId}/policies
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "data": [ {} ], "meta": { "next": "<string>", "page_size": 25 }, "links": { "self": "<string>", "prev": "<string>", "next": "<string>" } }
POST

Create a new policy

Create a policy aligned with your organization's standards.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

data

oneOf [object, object, object]

Required

Responses

The request has been accepted for processing, but processing has not yet completed.

application/json

Models.PolicyResponse
POST/admin/control/v1/orgs/{orgId}/policies
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "data": {} }'
202Response
1 2 3 { "data": {} }
GET

Get single policy

Returns information about a policy by policyId.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

The request has succeeded.

application/json

Models.PolicyResponse
GET/admin/control/v1/orgs/{orgId}/policies/{policyId}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 { "data": {} }
PUT

Update single policy

Update a policy with a policyId.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Request bodyapplication/json

data

oneOf [object, object, object]

Required

Responses

The request has been accepted for processing, but processing has not yet completed.

application/json

Models.PolicyResponse
PUT/admin/control/v1/orgs/{orgId}/policies/{policyId}
1 2 3 4 5 6 7 8 curl --request PUT \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "data": {} }'
202Response
1 2 3 { "data": {} }
DEL

Delete single policy

Delete a policy with a policyId

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

The request has been accepted for processing, but processing has not yet completed.

DEL/admin/control/v1/orgs/{orgId}/policies/{policyId}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}' \ --header 'Authorization: Bearer <access_token>'
GET

Validate a policy

Validate a policy to view potential issues in your policy

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

The request has been accepted for processing, but processing has not yet completed.

GET/admin/control/v1/orgs/{orgId}/policies/{policyId}/validate
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}/validate' \ --header 'Authorization: Bearer <access_token>'

Rate this page: