Rate this page:
GET /admin/v1/orgs
Returns a list of your organizations (based on your API key).
NONE
string
Sets the starting point for the page of results to return.
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}
Returns information about a single organization by ID
NONE
string
ID of the organization to return
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'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/users
Returns a list of users in an organization.
NONE
string
ID of the organization to query
string
Sets the starting point for the page of results to return.
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'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/domains
Returns a list of domains in an organization one page at a time.
NONE
string
ID of the organization to query
string
Sets the starting point for the page of results to return.
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'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/domains/{domainId}
Returns information about a single verified domain by ID.
NONE
string
ID of the organization the domain belongs to
string
ID of the domain to return
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'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/events
Returns an audit log of events from an organization one page at a time.
NONE
string
ID of the org
string
Sets the starting point for the page of results to return
string
Single query term for searching events.
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.
string
A query filter that returns events of a specific action type.
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'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/events/{eventId}
Returns information about a single event by ID.
NONE
string
ID of the organization to query
string
ID of the event to return
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'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/event-actions
Returns information localized event actions
NONE
string
ID of the organization to query
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'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/policies
Returns information about org policies
NONE
string
ID of the organization to query
string
Sets the starting point for the page of results to return.
string
Sets the type for the page of policies to return.
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'
Successful operation
Content type | Value |
---|---|
application/json |
POST /admin/v1/orgs/{orgId}/policies
Create a policy for an org
NONE
string
ID of the organization to create policy for
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'
Successful operation
Content type | Value |
---|---|
application/json |
GET /admin/v1/orgs/{orgId}/policies/{policyId}
Returns information about a single policy by ID
NONE
string
ID of the organization to return
string
ID of the policy to query
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'
Successful operation
Content type | Value |
---|---|
application/json |
PUT /admin/v1/orgs/{orgId}/policies/{policyId}
Update a policy for an org
NONE
string
ID of the organization to update policy for
string
ID of the policy to update
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'
Successful operation
Content type | Value |
---|---|
application/json |
DELETE /admin/v1/orgs/{orgId}/policies/{policyId}
Delete a policy for an org
NONE
string
ID of the organization to create policy for
string
ID of the policy to delete
1 2 3
curl --request DELETE \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}' \
--header 'Authorization: Bearer <access_token>'
Successful operation
A schema has not been defined for this response code.
POST /admin/v1/orgs/{orgId}/policies/{policyId}/resources
Adds a resource to an existing Policy
NONE
string
ID of the organization to return
string
ID of the policy to query
1 2 3 4
curl --request POST \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}/resources' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'
Successful operation
Content type | Value |
---|---|
application/json |
PUT /admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}
Update an existing Policy Resource
NONE
string
ID of the organization to return
string
ID of the policy to query
string
Resource ID
1 2 3 4
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'
Successful operation
Content type | Value |
---|---|
application/json |
DELETE /admin/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}
Delete an existing Policy Resource
NONE
string
ID of the organization to return
string
ID of the policy to query
string
Resource ID
1 2 3 4
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'
Successful operation
Content type | Value |
---|---|
application/json |
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
NONE
string
Organization ID
string
Policy ID
1 2 3
curl --request GET \
--url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/policies/{policyId}/validate' \
--header 'Authorization: Bearer <access_token>'
Accepted CDEN policy validation request
A schema has not been defined for this response code.
Rate this page: