Cloud

Organizations REST API / Reference / REST API

Policies

Policies APIs

Operations

GET/v1/orgs/{orgId}/policies POST/v1/orgs/{orgId}/policies GET/v1/orgs/{orgId}/policies/{policyId}PUT/v1/orgs/{orgId}/policies/{policyId}DEL/v1/orgs/{orgId}/policies/{policyId}POST/v1/orgs/{orgId}/policies/{policyId}/resources PUT/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}DEL/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}GET/v1/orgs/{orgId}/policies/{policyId}/validate

GET

Get list of policies

Returns information about org policies

Request

Path parameters

orgId

string

Required

Query parameters

cursor

string

type

string

Responses

Successful operation

application/json

PolicyPage

GET/v1/orgs/{orgId}/policies

curl

Node.js

Java

Python

PHP

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

200Response

{
  "data": [
    {
      "id": "<string>",
      "type": "policy",
      "attributes": {
        "type": "ip-allowlist",
        "name": "<string>",
        "status": "enabled",
        "rule": {},
        "resources": [
          {
            "id": "<string>",
            "applicationStatus": "applying",
            "meta": {},
            "links": {}
          }
        ]
      }
    }
  ],
  "meta": {
    "next": "<string>",
    "page_size": 25
  },
  "links": {
    "self": "<string>",
    "prev": "<string>",
    "next": "<string>"
  }
}

POST

Create a policy

Create a policy for an org

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

data

PolicyCreateModel

Responses

Successful operation

application/json

Policy

POST/v1/orgs/{orgId}/policies

curl

Node.js

Java

Python

PHP

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": {}
        }
      ]
    }
  }
}'

202Response

{
  "data": {
    "id": "<string>",
    "type": "policy",
    "attributes": {
      "type": "ip-allowlist",
      "name": "<string>",
      "status": "enabled",
      "rule": {},
      "resources": [
        {
          "id": "<string>",
          "applicationStatus": "applying",
          "meta": {},
          "links": {}
        }
      ]
    }
  }
}

GET

Get a policy by ID

Returns information about a single policy by ID

Request

Path parameters

orgId

string

Required

policyId

string

Required

Responses

Successful operation

application/json

Policy

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

curl

Node.js

Java

Python

PHP

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

200Response

{
  "data": {
    "id": "<string>",
    "type": "policy",
    "attributes": {
      "type": "ip-allowlist",
      "name": "<string>",
      "status": "enabled",
      "rule": {},
      "resources": [
        {
          "id": "<string>",
          "applicationStatus": "applying",
          "meta": {},
          "links": {}
        }
      ]
    }
  }
}

PUT

Update a policy

Update a policy for an org

Request

Path parameters

orgId

string

Required

policyId

string

Required

Request bodyapplication/json

data

PolicyUpdateModel

Responses

Successful operation

application/json

Policy

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

curl

Node.js

Java

Python

PHP

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": {}
        }
      ]
    }
  }
}'

202Response

{
  "data": {
    "id": "<string>",
    "type": "policy",
    "attributes": {
      "type": "ip-allowlist",
      "name": "<string>",
      "status": "enabled",
      "rule": {},
      "resources": [
        {
          "id": "<string>",
          "applicationStatus": "applying",
          "meta": {},
          "links": {}
        }
      ]
    }
  }
}

DEL

Delete a policy

Delete a policy for an org

Request

Path parameters

orgId

string

Required

policyId

string

Required

Responses

Successful operation

DEL/v1/orgs/{orgId}/policies/{policyId}

curl

Node.js

Java

Python

PHP

1
2
3

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

POST

Add Resource to Policy

Adds a resource to an existing Policy

Request

Path parameters

orgId

string

Required

policyId

string

Required

Request bodyapplication/json

string

Required

meta

Responses

Successful operation

application/json

Policy

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

curl

Node.js

Java

Python

PHP

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>"
  }
}'

202Response

{
  "data": {
    "id": "<string>",
    "type": "policy",
    "attributes": {
      "type": "ip-allowlist",
      "name": "<string>",
      "status": "enabled",
      "rule": {},
      "resources": [
        {
          "id": "<string>",
          "applicationStatus": "applying",
          "meta": {},
          "links": {}
        }
      ]
    }
  }
}

PUT

Update Policy Resource

Update an existing Policy Resource

Request

Path parameters

orgId

string

Required

policyId

string

Required

resourceId

string

Required

Request bodyapplication/json

meta

Responses

Successful operation

application/json

Policy

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

curl

Node.js

Java

Python

PHP

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>"
  }
}'

202Response

{
  "data": {
    "id": "<string>",
    "type": "policy",
    "attributes": {
      "type": "ip-allowlist",
      "name": "<string>",
      "status": "enabled",
      "rule": {},
      "resources": [
        {
          "id": "<string>",
          "applicationStatus": "applying",
          "meta": {},
          "links": {}
        }
      ]
    }
  }
}

DEL

Delete Policy Resource

Delete an existing Policy Resource

Request

Path parameters

orgId

string

Required

policyId

string

Required

resourceId

string

Required

Responses

Successful operation

application/json

Policy

DEL/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}

curl

Node.js

Java

Python

PHP

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'

204Response

{
  "data": {
    "id": "<string>",
    "type": "policy",
    "attributes": {
      "type": "ip-allowlist",
      "name": "<string>",
      "status": "enabled",
      "rule": {},
      "resources": [
        {
          "id": "<string>",
          "applicationStatus": "applying",
          "meta": {},
          "links": {}
        }
      ]
    }
  }
}

GET

Validate Policy

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

string

Required

policyId

string

Required

Responses

Accepted CDEN policy validation request

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

curl

Node.js

Java

Python

PHP

1
2
3

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