The Organizations REST API REST API

Orgs

Get organizations

GET /admin/v1/orgs

Returns a list of your organizations (based on your API key).

Request

Query parameters

cursor

string

Sets the starting point for the page of results to return.

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

400

401

429

500

Successful operation

Content type	Value
application/json	OrgPage

Get an organization by ID

GET /admin/v1/orgs/{orgId}

Returns information about a single organization by ID

Request

Path parameters

orgId Required

string

ID of the organization to return

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

401

404

429

500

Successful operation

Content type	Value
application/json	Org

Get users in an organization

GET /admin/v1/orgs/{orgId}/users

Returns a list of users in an organization.

Request

Path parameters

orgId Required

string

ID of the organization to query

Query parameters

cursor

string

Sets the starting point for the page of results to return.

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/users' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

400

401

404

429

500

Successful operation

Content type	Value
application/json	UserPage

Get domains in an organization

GET /admin/v1/orgs/{orgId}/domains

Returns a list of domains in an organization one page at a time.

Request

Path parameters

orgId Required

string

ID of the organization to query

Query parameters

cursor

string

Sets the starting point for the page of results to return.

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/domains' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

400

401

403

429

500

Successful operation

Content type	Value
application/json	DomainPage

Get domain by ID

GET /admin/v1/orgs/{orgId}/domains/{domainId}

Returns information about a single verified domain by ID.

Request

Path parameters

orgId Required

string

ID of the organization the domain belongs to

domainId Required

string

ID of the domain to return

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/domains/{domainId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

400

401

403

404

429

500

Successful operation

Content type	Value
application/json	Domain

Get an audit log of events

GET /admin/v1/orgs/{orgId}/events

Returns an audit log of events from an organization one page at a time.

Request

Path parameters

orgId Required

string

ID of the org

Query parameters

cursor

string

Sets the starting point for the page of results to return

string

Single query term for searching events.

from

string

The earliest date and time of the event represented as a UNIX epoch time.

string

The latest date and time of the event represented as a UNIX epoch time.

action

string

A query filter that returns events of a specific action type.

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/events' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

400

401

429

500

Successful operation

Content type	Value
application/json	EventPage

Get an event by ID

GET /admin/v1/orgs/{orgId}/events/{eventId}

Returns information about a single event by ID.

Request

Path parameters

orgId Required

string

ID of the organization to query

eventId Required

string

ID of the event to return

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/events/{eventId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

401

404

429

500

Successful operation

Content type	Value
application/json	Event

Get list of event actions

GET /admin/v1/orgs/{orgId}/event-actions

Returns information localized event actions

Request

Path parameters

orgId Required

string

ID of the organization to query

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/event-actions' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

401

404

429

500

Successful operation

Content type	Value
application/json	EventActions

Get list of policies

GET /admin/v1/orgs/{orgId}/policies

Returns information about org policies

Request

Path parameters

orgId Required

string

ID of the organization to query

Query parameters

cursor

string

Sets the starting point for the page of results to return.

type

string

Sets the type for the page of policies to return.

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

401

429

500

Successful operation

Content type	Value
application/json	PolicyPage

Create a policy

POST /admin/v1/orgs/{orgId}/policies

Create a policy for an org

Request

Path parameters

orgId Required

string

ID of the organization to create policy for

Body parameters

data

PolicyCreateModel

Example

cURL

Node.js

Java

Python

PHP

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": {}
        }
      ]
    }
  }
}'

Responses

202

400

401

429

500

Successful operation

Content type	Value
application/json	Policy

Get a policy by ID

GET /admin/v1/orgs/{orgId}/policies/{policyId}

Returns information about a single policy by ID

Request

Path parameters

orgId Required

string

ID of the organization to return

policyId Required

string

ID of the policy to query

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

401

404

429

500

Successful operation

Content type	Value
application/json	Policy

Update a policy

PUT /admin/v1/orgs/{orgId}/policies/{policyId}

Update a policy for an org

Request

Path parameters

orgId Required

string

ID of the organization to update policy for

policyId Required

string

ID of the policy to update

Body parameters

data

PolicyUpdateModel

Example

cURL

Node.js

Java

Python

PHP

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": {}
        }
      ]
    }
  }
}'

Responses

202

400

401

404

429

500

Successful operation

Content type	Value
application/json	Policy

Delete a policy

DELETE /admin/v1/orgs/{orgId}/policies/{policyId}

Delete a policy for an org

Request

Path parameters

orgId Required

string

ID of the organization to create policy for

policyId Required

string

ID of the policy to delete

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

202

400

401

404

429

500

Successful operation

A schema has not been defined for this response code.

Add Resource to Policy

POST /admin/v1/orgs/{orgId}/policies/{policyId}/resources

Adds a resource to an existing Policy

Request

Path parameters

orgId Required

string

ID of the organization to return

policyId Required

string

ID of the policy to query

Body parameters

id Required

string

meta

Example

cURL

Node.js

Java

Python

PHP

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

Responses

202

401

404

429

500

Successful operation

Content type	Value
application/json	Policy

Update Policy Resource

PUT /admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}

Update an existing Policy Resource

Request

Path parameters

orgId Required

string

ID of the organization to return

policyId Required

string

ID of the policy to query

resourceId Required

string

Resource ID

Body parameters

meta

Example

cURL

Node.js

Java

Python

PHP

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

Responses

202

401

404

429

500

Successful operation

Content type	Value
application/json	Policy

Delete Policy Resource

DELETE /admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}

Delete an existing Policy Resource

Request

Path parameters

orgId Required

string

ID of the organization to return

policyId Required

string

ID of the policy to query

resourceId Required

string

Resource ID

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

204

401

404

429

500

Successful operation

Content type	Value
application/json	Policy

Validate Policy

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

Request

Path parameters

orgId Required

string

Organization ID

policyId Required

string

Policy ID

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}/validate' \
  --header 'Authorization: Bearer <access_token>'

Responses

202

400

401

429

500

Accepted CDEN policy validation request

A schema has not been defined for this response code.