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. All APIs marked as deprecated will be temporarily disabled while we make updates to them.
Returns comprehensive details on organizational policies, including both rules and resources.
OAuth 2.0 scopes required: read:policies:admin
string
Requiredstring
Models.PolicyType
The request has succeeded.
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'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"data": [
{}
],
"meta": {
"next": "<string>",
"page_size": 25
},
"links": {
"self": "<string>",
"prev": "<string>",
"next": "<string>",
"page_size": "<string>"
}
}Create a policy aligned with your organization's standards.
OAuth 2.0 scopes required: write:policies:admin
string
RequiredoneOf [object, object, object]
RequiredThe request has been accepted for processing, but processing has not yet completed.
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": {}
}'1
2
3
{
"data": {}
}Returns information about a policy by policyId.
OAuth 2.0 scopes required: read:policies:admin
string
Requiredstring
RequiredThe request has succeeded.
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'1
2
3
{
"data": {}
}Update a policy with a policyId.
OAuth 2.0 scopes required: write:policies:admin
string
Requiredstring
RequiredoneOf [object, object, Models.DataSecurityPolicy]
RequiredThe request has been accepted for processing, but processing has not yet completed.
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": {}
}'1
2
3
{
"data": {}
}Delete a policy with a policyId
OAuth 2.0 scopes required: delete:policies:admin
string
Requiredstring
RequiredThe request has been accepted for processing, but processing has not yet completed.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}' \
--header 'Authorization: Bearer <access_token>'Returns comprehensive details on organizational policies, including both rules and status.
OAuth 2.0 scopes required: read:policies:admin
string
Requiredstring
Models.PolicyType
The request has succeeded.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/control/v2/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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
"data": [
{
"id": "<string>",
"type": "policy",
"attributes": {
"type": "data-security",
"rule": {
"export": {
"blockPageExport": true
},
"appAccess": {
"blockAll": true,
"blockedApps": [
"ari:cloud:ecosystem::app/6cbe3d88-199b-485e-9f58-cec9e642a0da"
],
"allowedApps": [
"ari:cloud:ecosystem::app/6cbe3d88-199b-485e-9f58-cec9e642a0da"
]
},
"publicLinks": {
"block": true
},
"anonymousAccess": {
"block": true
}
},
"metadata": {
"lastUpdatedBy": "<string>",
"createdBy": "<string>",
"hasHadCoverage": true,
"systemTag": "<string>",
"policyCoverageLevel": "UNASSIGNED",
"description": "<string>"
}
}
}
],
"meta": {
"next": "<string>",
"page_size": 25
},
"links": {
"self": "<string>",
"prev": "<string>",
"next": "<string>",
"page_size": "<string>"
}
}Create a policy aligned with your organization's standards.
OAuth 2.0 scopes required: write:policies:admin
string
Requiredobject
RequiredThe request has been accepted for processing, but processing has not yet completed.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/admin/control/v2/orgs/{orgId}/policies' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"data": {}
}'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
32
33
34
35
36
37
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "data-security",
"rule": {
"export": {
"blockPageExport": true
},
"appAccess": {
"blockAll": true,
"blockedApps": [
"ari:cloud:ecosystem::app/6cbe3d88-199b-485e-9f58-cec9e642a0da"
],
"allowedApps": [
"ari:cloud:ecosystem::app/6cbe3d88-199b-485e-9f58-cec9e642a0da"
]
},
"publicLinks": {
"block": true
},
"anonymousAccess": {
"block": true
}
},
"metadata": {
"lastUpdatedBy": "<string>",
"createdBy": "<string>",
"hasHadCoverage": true,
"systemTag": "<string>",
"policyCoverageLevel": "UNASSIGNED",
"description": "<string>"
}
}
}
}Returns information about a policy by policyId.
OAuth 2.0 scopes required: read:policies:admin
string
Requiredstring
RequiredThe request has succeeded.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/control/v2/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
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "data-security",
"rule": {
"export": {
"blockPageExport": true
},
"appAccess": {
"blockAll": true,
"blockedApps": [
"ari:cloud:ecosystem::app/6cbe3d88-199b-485e-9f58-cec9e642a0da"
],
"allowedApps": [
"ari:cloud:ecosystem::app/6cbe3d88-199b-485e-9f58-cec9e642a0da"
]
},
"publicLinks": {
"block": true
},
"anonymousAccess": {
"block": true
}
},
"metadata": {
"lastUpdatedBy": "<string>",
"createdBy": "<string>",
"hasHadCoverage": true,
"systemTag": "<string>",
"policyCoverageLevel": "UNASSIGNED",
"description": "<string>"
}
}
}
}Update a policy with a policyId.
OAuth 2.0 scopes required: write:policies:admin
string
Requiredstring
RequiredoneOf [object, object, Models.DataSecurityPolicy]
RequiredThe request has been accepted for processing, but processing has not yet completed.
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'https://api.atlassian.com/admin/control/v2/orgs/{orgId}/policies/{policyId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"data": {}
}'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
32
33
34
35
36
37
{
"data": {
"id": "<string>",
"type": "policy",
"attributes": {
"type": "data-security",
"rule": {
"export": {
"blockPageExport": true
},
"appAccess": {
"blockAll": true,
"blockedApps": [
"ari:cloud:ecosystem::app/6cbe3d88-199b-485e-9f58-cec9e642a0da"
],
"allowedApps": [
"ari:cloud:ecosystem::app/6cbe3d88-199b-485e-9f58-cec9e642a0da"
]
},
"publicLinks": {
"block": true
},
"anonymousAccess": {
"block": true
}
},
"metadata": {
"lastUpdatedBy": "<string>",
"createdBy": "<string>",
"hasHadCoverage": true,
"systemTag": "<string>",
"policyCoverageLevel": "UNASSIGNED",
"description": "<string>"
}
}
}
}Validate a policy to view potential issues in your policy
OAuth 2.0 scopes required: read:policies:admin
string
Requiredstring
RequiredThe request has been accepted for processing, but processing has not yet completed.
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: