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

Authentication Policies

Postman Collection
OpenAPI
POST

Add users to a policy

Add users to an authentication policy to address the security of different user sets. Understand how to add users to a policy and check the status

Scopes

OAuth 2.0 scopes required: write:policies:admin

Request

Path parameters

orgId

string

Required
policyId

string

Required

Request bodyapplication/json

users

array<string>

Required

Responses

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

application/json

Models.AsyncResponseModel
POST/admin/control/v1/orgs/{orgId}/auth-policy/{policyId}/add-users
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/auth-policy/{policyId}/add-users' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "users": [ "<string>" ] }'
202Response
1 2 3 4 { "taskId": "<string>", "taskLink": "<string>" }
GET

Get the status of a task

Verify that users are assigned to the intended policy and report errors, if any.

Scopes

OAuth 2.0 scopes required: write:policies:admin

Request

Path parameters

orgId

string

Required
taskId

string

Required

Responses

The request has succeeded.

application/json

Models.AddUsersToPolicyTaskStatus
GET/admin/control/v1/orgs/{orgId}/auth-policy/task/{taskId}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/auth-policy/task/{taskId}' \ --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 { "inProgressCount": 2154, "successCount": 2154, "failureCount": 2154, "failureReasons": [ { "emails": [ "<string>" ], "details": { "status": 2154, "title": "<string>", "detail": "<string>" } } ] }
POST

Get policy information for managed users

Get authentication policy information for a given list of managed users. This is a bulk action.

Request

Path parameters

orgId

string

Required

Request bodyapplication/json

accountIds

array<string>

Required

Responses

The request has succeeded.

application/json

array<Models.UserPolicyInfo>

POST/admin/control/v1/orgs/{orgId}/users/auth-policies/bulk-fetch
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/users/auth-policies/bulk-fetch' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "accountIds": [ "<string>" ] }'
200Response
1 2 3 4 5 6 7 8 9 10 11 [ { "email": "<string>", "name": "<string>", "accountId": "<string>", "authPolicyInfo": { "policyId": "<string>", "dateAdded": 1623868831000 } } ]

Rate this page: