Orgs
Users
Domains
Events
Policies
Directory

Rate this page:

Policies

Policies APIs

Get list of policies

GET /admin/v1/orgs/{orgId}/policies

Returns information about org policies

Request

Path parameters
orgId Required

string

ID of the organization to query

Query parameters
cursor

string

Sets the starting point for the page of results to return.

type

string

Sets the type for the page of policies to return.

Example

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

Responses

Successful operation

Content typeValue
application/json

PolicyPage

Create a policy

POST /admin/v1/orgs/{orgId}/policies

Create a policy for an org

Request

Path parameters
orgId Required

string

ID of the organization to create policy for

Body parameters

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
curl --request POST \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "type": "policy",
    "attributes": {
      "type": "ip-allowlist",
      "name": "<string>",
      "status": "enabled",
      "rule": {},
      "resources": [
        {
          "id": "<string>",
          "meta": {},
          "links": {}
        }
      ]
    }
  }
}'

Responses

Successful operation

Content typeValue
application/json

Policy

Get a policy by ID

GET /admin/v1/orgs/{orgId}/policies/{policyId}

Returns information about a single policy by ID

Request

Path parameters
orgId Required

string

ID of the organization to return

policyId Required

string

ID of the policy to query

Example

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

Responses

Successful operation

Content typeValue
application/json

Policy

Update a policy

PUT /admin/v1/orgs/{orgId}/policies/{policyId}

Update a policy for an org

Request

Path parameters
orgId Required

string

ID of the organization to update policy for

policyId Required

string

ID of the policy to update

Body parameters

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
curl --request PUT \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {
    "id": "<string>",
    "type": "policy",
    "attributes": {
      "type": "ip-allowlist",
      "name": "<string>",
      "status": "enabled",
      "rule": {},
      "resources": [
        {
          "id": "<string>",
          "meta": {},
          "links": {}
        }
      ]
    }
  }
}'

Responses

Successful operation

Content typeValue
application/json

Policy

Delete a policy

DELETE /admin/v1/orgs/{orgId}/policies/{policyId}

Delete a policy for an org

Request

Path parameters
orgId Required

string

ID of the organization to create policy for

policyId Required

string

ID of the policy to delete

Example

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

Responses

Successful operation

A schema has not been defined for this response code.

Add Resource to Policy

POST /admin/v1/orgs/{orgId}/policies/{policyId}/resources

Adds a resource to an existing Policy

Request

Path parameters
orgId Required

string

ID of the organization to return

policyId Required

string

ID of the policy to query

Body parameters
id Required

string

meta

Meta

links

Links

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request POST \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}/resources' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "meta": {
    "scheduledDate": "<string>",
    "migrationStartDateTime": "<string>",
    "migrationEndDataTime": "<string>",
    "atlassianAccountId": "<string>"
  },
  "links": {
    "ticket": "<string>"
  }
}'

Responses

Successful operation

Content typeValue
application/json

Policy

Update Policy Resource

PUT /admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}

Update an existing Policy Resource

Request

Path parameters
orgId Required

string

ID of the organization to return

policyId Required

string

ID of the policy to query

resourceId Required

string

Resource ID

Body parameters
meta

Meta

links

Links

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request PUT \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "meta": {
    "scheduledDate": "<string>",
    "migrationStartDateTime": "<string>",
    "migrationEndDataTime": "<string>",
    "atlassianAccountId": "<string>"
  },
  "links": {
    "ticket": "<string>"
  }
}'

Responses

Successful operation

Content typeValue
application/json

Policy

Delete Policy Resource

DELETE /admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}

Delete an existing Policy Resource

Request

Path parameters
orgId Required

string

ID of the organization to return

policyId Required

string

ID of the policy to query

resourceId Required

string

Resource ID

Example

1
2
3
4
curl --request DELETE \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Successful operation

Content typeValue
application/json

Policy

Validate Policy

GET /admin/v1/orgs/{orgId}/policies/{policyId}/validate

Validate a policy based on specific requirements. For example, Trigger CDEN validation by pushing a task into the SQS dns-validation queue

Request

Path parameters
orgId Required

string

Organization ID

policyId Required

string

Policy ID

Example

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

Responses

Accepted CDEN policy validation request

A schema has not been defined for this response code.

Rate this page: