Organizations REST API Developer

Organizations REST API Developer

Rate this page:

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

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

Responses

Successful operation

Content typeValue
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

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

Responses

Successful operation

Content typeValue
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

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

Responses

Successful operation

Content typeValue
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

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

Responses

Successful operation

Content typeValue
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

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

Responses

Successful operation

Content typeValue
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

q

string

Single query term for searching events.

from

string

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

to

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

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

Responses

Successful operation

Content typeValue
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

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

Responses

Successful operation

Content typeValue
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

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

Responses

Successful operation

Content typeValue
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

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'

Responses

Successful operation

Content typeValue
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

Example

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

Responses

Successful operation

Content typeValue
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

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'

Responses

Successful operation

Content typeValue
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

Example

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

Responses

Successful operation

Content typeValue
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

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

Responses

Successful operation

A schema has not been defined for this response code.

Rate this page: