{ "info": { "_postman_id": "b5b02ec3-a06c-4391-9b21-d538a91925b2", "name": "Admin Control API", "description": "API to manage policies and resources. A policy is a set of rules that apply to a specific area and a particular group, allowing an organization to ensure a basic level of compliance, security, and behavior. A resource refers to any asset, entity, or item that the policy aims to govern, regulate, or protect.", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Policies", "description": "A policy is a set of rules that apply to a specific area and a particular group, allowing an organization to ensure a basic level of compliance, security, and behavior. All policies have their own distinct set of rules and specifies the types of resources that can be associated with it.", "item": [ { "name": "Get list of policies", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies", "query": [ { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "Sets the starting point for the page of results to return." }, { "key": "type", "value": "{{type}}", "disabled": true, "description": "Sets the type for the page of policies to return." } ], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns comprehensive details on organizational policies, including both rules and resources.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } } }, "response": [] }, { "name": "Create a new policy", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a policy aligned with your organization's standards.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get single policy", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns information about a policy by policyId.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } } }, "response": [] }, { "name": "Update single policy", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Update a policy with a policyId.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete single policy", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a policy with a policyId\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `delete:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } } }, "response": [] }, { "name": "Validate a policy", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId/validate", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false } ] }, "method": "GET", "header": [], "description": "Validate a policy to view potential issues in your policy\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } } }, "response": [] } ] }, { "name": "Resources", "description": "A resource refers to any asset, entity, or item that the policy aims to govern, regulate, or protect.", "item": [ { "name": "Get list of resources associated with a policy", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId/resources", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } } }, "response": [] }, { "name": "Create a new policy resource", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId/resources", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Add a new resource to a policy\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete all policy resources", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId/resources", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove all resources from a policy.", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } } }, "response": [] }, { "name": "Update single policy resource", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId/resources/:resourceId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false }, { "key": "resourceId", "value": "{{resourceId}}", "description": "Unique Id associated with a resource.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Delete one resource from a policy\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete single policy resource", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/policies/:policyId/resources/:resourceId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false }, { "key": "resourceId", "value": "{{resourceId}}", "description": "Unique Id associated with a resource.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete one resource from a policy\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } } }, "response": [] } ] }, { "name": "Authentication Policies", "description": "Authentication policies are a set of rules that govern the authentication process for users. [Understand authentication policies](https://support.atlassian.com/security-and-access-policies/docs/understand-authentication-policies/)", "item": [ { "name": "Add users to a policy", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/auth-policy/:policyId/add-users", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "policyId", "value": "{{policyId}}", "description": "Unique Id associated with each policy.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "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](https://developer.atlassian.com/cloud/admin/auth-policy-cookbook/)\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get the status of a task", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/auth-policy/task/:taskId", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "taskId", "value": "{{taskId}}", "description": "Unique Id obtained after adding users to an authentication policy.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Verify that users are assigned to the intended policy and report errors, if any.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `write:policies:admin`\n", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } } }, "response": [] }, { "name": "Get policy information for managed users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/control/v1/orgs/:orgId/users/auth-policies/bulk-fetch", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get authentication policy information for a given list of managed users. This is a bulk action.", "auth": { "type": "bearer", "bearer": { "key": "token", "type": "string", "value": "{{BEARER_TOKEN}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "" } ] }