• Policies
  • Resources
  • Authentication Policies
Cloud
Control REST API / Reference / REST API

Resources

Postman Collection
OpenAPI
GET

Get list of resources associated with a policy

Scopes

OAuth 2.0 scopes required: read:policies:admin

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

The request has succeeded.

application/json

Models.PolicyResourcePage
GET/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 { "data": [ { "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" }, "id": "<string>", "applicationStatus": "validating" } ], "meta": { "next": "<string>", "page_size": 25 }, "links": { "self": "<string>", "prev": "<string>", "next": "<string>" } }
POST

Create a new policy resource

Add a new resource to a policy

Scopes

OAuth 2.0 scopes required: write:policies:admin

Request

Path parameters

orgId

string

Required
policyId

string

Required

Request bodyapplication/json

meta

Models.PolicyResourceMeta

links

Models.PolicyResourceLinks

id

string

Required

Responses

The request has been accepted for processing, but processing has not yet completed.

application/json

Models.PolicyResource
POST/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 curl --request POST \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" }, "id": "<string>" }'
202Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" }, "id": "<string>", "applicationStatus": "validating" }
DEL

Delete all policy resources

Remove all resources from a policy.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

No content

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

Update single policy resource

Delete one resource from a policy

Scopes

OAuth 2.0 scopes required: write:policies:admin

Request

Path parameters

orgId

string

Required
policyId

string

Required
resourceId

string

Required

Request bodyapplication/json

meta

Models.PolicyResourceMeta

links

Models.PolicyResourceLinks

Responses

The request has been accepted for processing, but processing has not yet completed.

application/json

Models.PolicyResource
PUT/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 curl --request PUT \ --url 'https://api.atlassian.com/admin/control/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>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" } }'
202Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" }, "id": "<string>", "applicationStatus": "validating" }
DEL

Delete single policy resource

Delete one resource from a policy

Scopes

OAuth 2.0 scopes required: write:policies:admin

Request

Path parameters

orgId

string

Required
policyId

string

Required
resourceId

string

Required

Responses

No content

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

Rate this page: