App Access Settings APIs
Returns a paginated list of domain configurations for your organization's app access settings. Each domain can be configured to control who can access apps in your organization.
Results are returned in alphabetical order by domain name. Use the cursor parameter
to paginate through results.
The special domain ANYONE represents users with any email address (no domain restriction).
string
Requiredstring
integer
Successful operation
A paginated list of domain configurations for app access settings.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/app-access-settings/domains' \
--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
{
"data": [
{
"domain": "ANYONE",
"enabled": true,
"numberOfProductsAppliesTo": 2
},
{
"domain": "example.com",
"enabled": true,
"numberOfProductsAppliesTo": 1
}
],
"links": {
"self": "https://api.atlassian.com/admin/v2/orgs/my-org-id/app-access-settings/domains",
"prev": null,
"next": "https://api.atlassian.com/admin/v2/orgs/my-org-id/app-access-settings/domains?cursor=ZXhhbXBsZS5jb20&limit=20"
}
}Registers a new approved-domain configuration for your organization, including the
initial per-product configuration. Returns 201 Created with the new configuration
and a Location header pointing at the newly created resource.
Use ANYONE as the domain to control access for users with any email address.
string
Requiredstring
Requiredboolean
Requiredarray<AppAccessSettingsProduct>
RequiredDomain configuration successfully created
string
Detailed app access settings configuration for a specific domain.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request POST \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/app-access-settings/domains' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"domain": "example.com",
"adminNotifications": false,
"products": [
{
"productId": "ari:cloud:jira::site/<CLOUD_ID>",
"adminApprovalRequired": false,
"role": "ari:cloud:identity::role/product/member"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
{
"domain": "example.com",
"enabled": true,
"adminNotifications": false,
"products": [
{
"productId": "ari:cloud:jira::site/<CLOUD_ID>",
"adminApprovalRequired": false,
"role": "ari:cloud:identity::role/product/member"
}
]
}Returns the app access settings configuration for a specific domain in your organization.
Use ANYONE as the domain value to retrieve settings for users with any email address
(no domain restriction).
string
Requiredstring
RequiredSuccessful operation
Detailed app access settings configuration for a specific domain.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/app-access-settings/domains/{domain}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"domain": "example.com",
"adminNotifications": "ON_REQUEST",
"products": [
{
"productId": "ari:cloud:jira::site/abcd-1234",
"adminApprovalRequired": false,
"role": "ari:cloud:identity::role/product/member"
}
]
}Replaces the full per-product configuration for a domain. Any product that was previously configured but is not in the request body will be removed.
For partial updates (e.g. add or change a single product without disturbing the
others), use POST /v2/orgs/{orgId}/app-access-settings/domains/{domain}/products.
string
Requiredstring
Requiredboolean
Requiredarray<AppAccessSettingsProduct>
RequiredDomain configuration successfully updated
Detailed app access settings configuration for a specific domain.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl --request PUT \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/app-access-settings/domains/{domain}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"adminNotifications": false,
"products": [
{
"productId": "ari:cloud:jira::site/<CLOUD_ID>",
"adminApprovalRequired": false,
"role": "ari:cloud:identity::role/product/member"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
{
"domain": "example.com",
"enabled": true,
"adminNotifications": false,
"products": [
{
"productId": "ari:cloud:jira::site/<CLOUD_ID>",
"adminApprovalRequired": false,
"role": "ari:cloud:identity::role/product/member"
}
]
}Adds or replaces a single product's access configuration on a domain. Other products configured on the domain are left untouched (this is a partial update).
Use this endpoint when you want to configure or change one product without re-sending the entire product list.
string
Requiredstring
Requiredstring
Requiredboolean
string
Product configuration successfully upserted
Detailed app access settings configuration for a specific domain.
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'https://api.atlassian.com/admin/v2/orgs/{orgId}/app-access-settings/domains/{domain}/products' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"productId": "ari:cloud:jira::site/<CLOUD_ID>",
"adminApprovalRequired": false,
"role": "ari:cloud:identity::role/product/member"
}'1
2
3
4
5
6
7
8
9
10
11
12
{
"domain": "example.com",
"enabled": true,
"adminNotifications": false,
"products": [
{
"productId": "ari:cloud:jira::site/<CLOUD_ID>",
"adminApprovalRequired": false,
"role": "ari:cloud:identity::role/product/member"
}
]
}Rate this page: