Rate this page:
Policies APIs
GET /admin/v1/orgs/{orgId}/policies
Returns information about org policies
string
ID of the organization to query
string
Sets the starting point for the page of results to return.
string
Sets the type for the page of policies to return.
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'
Successful operation
Content type | Value |
---|---|
application/json |
POST /admin/v1/orgs/{orgId}/policies
Create a policy for an org
string
ID of the organization to create policy for
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": {}
}
]
}
}
}'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/policies/{policyId}
Returns information about a single policy by ID
string
ID of the organization to return
string
ID of the policy to query
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'
Successful operation
Content type | Value |
---|---|
application/json |
PUT /admin/v1/orgs/{orgId}/policies/{policyId}
Update a policy for an org
string
ID of the organization to update policy for
string
ID of the policy to update
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": {}
}
]
}
}
}'
Successful operation
Content type | Value |
---|---|
application/json |
DELETE /admin/v1/orgs/{orgId}/policies/{policyId}
Delete a policy for an org
string
ID of the organization to create policy for
string
ID of the policy to delete
1 2 3
curl --request DELETE \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}' \
--header 'Authorization: Bearer <access_token>'
Successful operation
A schema has not been defined for this response code.
POST /admin/v1/orgs/{orgId}/policies/{policyId}/resources
Adds a resource to an existing Policy
string
ID of the organization to return
string
ID of the policy to query
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>"
}
}'
Successful operation
Content type | Value |
---|---|
application/json |
PUT /admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}
Update an existing Policy Resource
string
ID of the organization to return
string
ID of the policy to query
string
Resource ID
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>"
}
}'
Successful operation
Content type | Value |
---|---|
application/json |
DELETE /admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}
Delete an existing Policy Resource
string
ID of the organization to return
string
ID of the policy to query
string
Resource ID
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'
Successful operation
Content type | Value |
---|---|
application/json |
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
string
Organization ID
string
Policy ID
1 2 3
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}/validate' \
--header 'Authorization: Bearer <access_token>'
Accepted CDEN policy validation request
A schema has not been defined for this response code.
Rate this page: