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).

Request

Path parameters

orgId

string

Required

Query parameters

cursor

string

limit

integer

Responses

Successful operation

application/json

AppAccessSettingsDomainsPage

A paginated list of domain configurations for app access settings.

GET/v2/orgs/{orgId}/app-access-settings/domains

curl

Node.js

Java

Python

PHP

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'

200Response

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

GET

Get app access settings for a domainExperimental

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).

Request

Path parameters

orgId

string

Required

domain

string

Required

Responses

Successful operation

application/json

AppAccessSettingsDomainDetail

Detailed app access settings configuration for a specific domain.

GET/v2/orgs/{orgId}/app-access-settings/domains/{domain}

curl

Node.js

Java

Python

PHP

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'

200Response

{
  "domain": "example.com",
  "enabled": true,
  "adminNotifications": false,
  "products": [
    {
      "productId": "ari:cloud:jira::app/all",
      "accessMode": "DIRECT_ACCESS",
      "defaultRole": "ari:cloud:jira::role/software/member"
    }
  ]
}