Policies APIs
Returns information about org policies
string
Requiredstring
string
Successful operation
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'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
"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>"
}
}Create a policy for an org
string
RequiredPolicyCreateModel
Successful operation
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": {}
}
]
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "ip-allowlist",
"name": "<string>",
"status": "enabled",
"rule": {},
"resources": [
{
"id": "<string>",
"applicationStatus": "applying",
"meta": {},
"links": {}
}
]
}
}
}Returns information about a single policy by ID
string
Requiredstring
RequiredSuccessful operation
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'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "ip-allowlist",
"name": "<string>",
"status": "enabled",
"rule": {},
"resources": [
{
"id": "<string>",
"applicationStatus": "applying",
"meta": {},
"links": {}
}
]
}
}
}Update a policy for an org
string
Requiredstring
RequiredPolicyUpdateModel
Successful operation
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": {}
}
]
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "ip-allowlist",
"name": "<string>",
"status": "enabled",
"rule": {},
"resources": [
{
"id": "<string>",
"applicationStatus": "applying",
"meta": {},
"links": {}
}
]
}
}
}Delete a policy for an org
string
Requiredstring
RequiredSuccessful operation
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}' \
--header 'Authorization: Bearer <access_token>'Adds a resource to an existing Policy
string
Requiredstring
Requiredstring
RequiredMeta
Links
Successful operation
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>"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "ip-allowlist",
"name": "<string>",
"status": "enabled",
"rule": {},
"resources": [
{
"id": "<string>",
"applicationStatus": "applying",
"meta": {},
"links": {}
}
]
}
}
}Update an existing Policy Resource
string
Requiredstring
Requiredstring
RequiredMeta
Links
Successful operation
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>"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "ip-allowlist",
"name": "<string>",
"status": "enabled",
"rule": {},
"resources": [
{
"id": "<string>",
"applicationStatus": "applying",
"meta": {},
"links": {}
}
]
}
}
}Delete an existing Policy Resource
string
Requiredstring
Requiredstring
RequiredSuccessful operation
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'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "ip-allowlist",
"name": "<string>",
"status": "enabled",
"rule": {},
"resources": [
{
"id": "<string>",
"applicationStatus": "applying",
"meta": {},
"links": {}
}
]
}
}
}Validate a policy based on specific requirements. For example, Trigger CDEN validation by pushing a task into the SQS dns-validation queue
string
Requiredstring
RequiredAccepted CDEN policy validation request
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}/validate' \
--header 'Authorization: Bearer <access_token>'Rate this page: