{"openapi":"3.0.0","info":{"title":"API for Atlassian Access","version":"1.0"},"security":[{"bearerAuth":[]}],"tags":[{"name":"Orgs","description":"Orgs APIs"},{"name":"Users","description":"Orgs Users APIs"},{"name":"Groups","description":"Orgs Groups APIs"},{"name":"Domains","description":"Domain APIs"},{"name":"Events","description":"Events APIs"},{"name":"Policies","description":"Policies APIs"},{"name":"Directory","description":"Org Directory APIs"},{"name":"Workspaces","description":"Org Workspaces APIs"}],"paths":{"/v1/orgs":{"get":{"tags":["Orgs"],"operationId":"getOrgs","summary":"Get organizations","description":"Returns a list of your organizations (based on your API key).","parameters":[{"name":"cursor","in":"query","description":"Sets the starting point for the page of results to return.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgPage"}}}},"400":{"$ref":"#/components/responses/Error.InvalidPageCursor"},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}":{"get":{"tags":["Orgs"],"operationId":"getOrgById","summary":"Get an organization by ID","description":"Returns information about a single organization by ID","parameters":[{"$ref":"#/components/parameters/orgIdParam"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"$ref":"#/components/responses/Error.OrgNotFound"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/users":{"get":{"tags":["Users"],"operationId":"getUsers","summary":"Get managed accounts in an organization","description":"Returns a list of managed accounts in an organization.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"cursor","in":"query","description":"Sets the starting point for the page of results to return.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPage"}}}},"400":{"$ref":"#/components/responses/Error.InvalidPageCursor"},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"$ref":"#/components/responses/Error.OrgNotFound"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/users/search":{"post":{"tags":["Users"],"operationId":"searchUsers","summary":"Search for users in an organization","description":"**The API is available for customers using the new user management experience only. [How the new user management experience works](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**\n\nReturns a list of users within an organization, offering search functionality through multiple parameters for more precise results.\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersSearchRequest"},"examples":{"limit_only":{"value":{"limit":20}}}}}},"responses":{"200":{"description":"Organization found. Response contains user search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersSearchPage"},"examples":{"users_search_response":{"value":{"data":[{"accountId":"123e4567-e89b-12d3-a456-426614174000","accountType":"atlassian","accountStatus":"active"}],"links":{"next":"MDNlZWRmNzMtMWYwMi00NGM5LWI4NjgtZGQ1NTIwMjIwYjhj","self":"MDI0MzkwOGEtMmYyOC00NzgzLWI5YTktMDUwZTExNzJjZDU4"}}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-24`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationError"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v2/orgs/{orgId}/directories/{directoryId}/users":{"get":{"tags":["Users"],"x-experimental":true,"operationId":"getDirectoryUsers","summary":"Get users in an organization","description":"Returns a page of users in an organization that match the supplied parameters.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"$ref":"#/components/parameters/directoryIdParam"},{"$ref":"#/components/parameters/cursorParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/accountIdsParam"},{"$ref":"#/components/parameters/directoryIdsParam"},{"$ref":"#/components/parameters/resourceIdsParam"},{"$ref":"#/components/parameters/groupIdsParam"},{"$ref":"#/components/parameters/claimStatusParam"},{"$ref":"#/components/parameters/statusParam"},{"$ref":"#/components/parameters/accountStatusParam"},{"$ref":"#/components/parameters/membershipStatusParam"},{"$ref":"#/components/parameters/roleIdsParam"},{"$ref":"#/components/parameters/searchTermParam"},{"$ref":"#/components/parameters/userSortByParam"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDirectoryUserPage"}}}},"400":{"description":"Returned if the request is not in correct format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Returned if the requestor is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"404":{"description":"Returned if the organization ID or directory ID is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Returned if the API rate limit is reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/v2/orgs/{orgId}/directories/{directoryId}/users/stats":{"get":{"tags":["Users"],"x-experimental":true,"operationId":"getUserStats","summary":"Get user stats","description":"Returns user stats for the organization.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"$ref":"#/components/parameters/directoryIdParam"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDirectoryUserStats"}}}},"401":{"description":"Returned if the requestor is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"404":{"description":"Returned if the organization ID or directory ID is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Returned if the API rate limit is reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/role-assignments":{"get":{"tags":["Users"],"x-experimental":true,"operationId":"getUserRoleAssignments","summary":"Get user role assignments","description":"Returns a page of role assignments for a user that match the supplied parameters.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"$ref":"#/components/parameters/directoryIdParam"},{"$ref":"#/components/parameters/accountIdParam"},{"$ref":"#/components/parameters/cursorParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/directoryIdsParam"},{"$ref":"#/components/parameters/resourceOwnersParam"},{"$ref":"#/components/parameters/resourceIdsParam"},{"$ref":"#/components/parameters/roleIdsParam"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDirectoryUserRoleAssignmentPage"}}}},"400":{"description":"Returned if the request is not in correct format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Returned if the requestor is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"404":{"description":"Returned if the organization ID or directory ID is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Returned if the API rate limit is reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/v2/orgs/{orgId}/directories":{"get":{"tags":["Directory"],"x-experimental":true,"operationId":"getDirectoriesForOrg","summary":"Get directories in an organization","description":"Returns a page of directories in an organization that match the supplied parameters.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"$ref":"#/components/parameters/accountIdDirectoriesParam"},{"$ref":"#/components/parameters/searchTermDirectoriesParam"},{"$ref":"#/components/parameters/cursorParam"},{"$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"Returns if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDirectoryUserDirectoryPage"}}}},"400":{"description":"Returned if the request is not validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Returned if the requestor is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Returned if the API rate limit is reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/v1/orgs/{orgId}/groups/search":{"post":{"tags":["Groups"],"operationId":"searchGroups","summary":"Search for groups within an organization","description":"**The API is available for customers using the new user management experience only. [How the new user management experience works](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**\n\nReturns a list of groups within an organization, offering search functionality through multiple parameters for more precise results.\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupsSearchRequest"},"examples":{"limit_only":{"value":{"limit":20}}}}}},"responses":{"200":{"description":"Organization found. Response contains group search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupsSearchPage"},"examples":{"groups_search_response":{"value":{"data":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"example","description":"example description"}],"links":{"next":"MDNlZWRmNzMtMWYwMi00NGM5LWI4NjgtZGQ1NTIwMjIwYjhj","self":"MDI0MzkwOGEtMmYyOC00NzgzLWI5YTktMDUwZTExNzJjZDU4"}}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-24`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationError"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/domains":{"get":{"tags":["Domains"],"operationId":"getDomains","summary":"Get domains in an organization","description":"Returns a list of domains in an organization one page at a time.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:domains:admin`\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"cursor","in":"query","description":"Sets the starting point for the page of results to return.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainPage"}}}},"400":{"$ref":"#/components/responses/Error.InvalidPageCursor"},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"403":{"$ref":"#/components/responses/Error.NoPerms"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/domains/{domainId}":{"get":{"tags":["Domains"],"operationId":"getDomainById","summary":"Get domain by ID","description":"Returns information about a single verified domain by ID.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** `read:domains:admin`\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"domainId","in":"path","description":"ID of the domain to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}}},"400":{"$ref":"#/components/responses/Error.InvalidDomainIdentifier"},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"403":{"$ref":"#/components/responses/Error.NoPerms"},"404":{"description":"Domain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error.DomainNotFound.Model"}}}},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v2/orgs/{orgId}/directories/{directoryId}/groups":{"get":{"tags":["Groups"],"x-experimental":true,"operationId":"getGroups","summary":"Get groups in an organization","description":"Returns a page of groups in an organization that match the supplied parameters.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"$ref":"#/components/parameters/directoryIdParam"},{"$ref":"#/components/parameters/cursorParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/directoryIdsParam"},{"$ref":"#/components/parameters/accountIdsParam"},{"$ref":"#/components/parameters/groupIdsParam"},{"$ref":"#/components/parameters/resourceOwnersParam"},{"$ref":"#/components/parameters/resourceIdsParam"},{"$ref":"#/components/parameters/searchTermGroupParam"},{"$ref":"#/components/parameters/groupCountsParam"},{"$ref":"#/components/parameters/groupSortByParam"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDirectoryGroupPage"}}}},"400":{"description":"Returned if the request is not in correct format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Returned if the requestor is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"404":{"description":"Returned if the organization ID or directory ID is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Returned if the API rate limit is reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/v2/orgs/{orgId}/directories/{directoryId}/groups/stats":{"get":{"tags":["Groups"],"x-experimental":true,"operationId":"getGroupsStats","summary":"Get group stats","description":"Returns group stats for the organization.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"$ref":"#/components/parameters/directoryIdParam"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDirectoryGroupStats"}}}},"401":{"description":"Returned if the requestor is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"404":{"description":"Returned if the organization ID or directory ID is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Returned if the API rate limit is reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}":{"get":{"tags":["Groups"],"x-experimental":true,"operationId":"getGroup","summary":"Get group details","description":"Returns the details of a group.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"$ref":"#/components/parameters/directoryIdParam"},{"$ref":"#/components/parameters/groupIdParam"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDirectoryGroupDetails"}}}},"401":{"description":"Returned if the requestor is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"404":{"description":"Returned if the organization ID or directory ID is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Returned if the API rate limit is reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/role-assignments":{"get":{"tags":["Groups"],"x-experimental":true,"operationId":"getGroupRoleAssignments","summary":"Get group role assignments","description":"Returns a page of role assignments for a group that match the supplied parameters.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"$ref":"#/components/parameters/directoryIdParam"},{"$ref":"#/components/parameters/groupIdParam"},{"$ref":"#/components/parameters/cursorParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/directoryIdsParam"},{"$ref":"#/components/parameters/resourceOwnersParam"},{"$ref":"#/components/parameters/resourceIdsParam"},{"$ref":"#/components/parameters/roleIdsParam"}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDirectoryGroupRoleAssignmentPage"}}}},"400":{"description":"Returned if the request is not in correct format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Returned if the requestor is not authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"403":{"description":"Returned if the user does not have correct permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"404":{"description":"Returned if the organization ID or directory ID is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Returned if the API rate limit is reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}}}}},"/v1/orgs/{orgId}/events":{"get":{"tags":["Events"],"operationId":"getEvents","summary":"Query audit log events","description":"Returns a filtered list of audit log events for an organization. Use this endpoint for more granular and detailed querying. \nIf you simply need to paginate through all events, consider using the [/events-stream](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-events/#api-v1-orgs-orgid-events-stream-get) endpoint.  \nThese rate limits for this endpoint be lowered effective end of May 2025 as follows:\n - *Rate limit per user*: *10* requests per minute\n - *Rate limit per API path*: *10* requests per minute\n\n Please migrate to the polling API to guarantee uninterrupted service for use cases involving a high request rate.\n\n#### Scopes\n**[OAuth 2.0 scopes](/cloud/admin/scopes/) required:** **`Not supported (use API Key without scopes)`**\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"cursor","in":"query","description":"Sets the starting point for the page of results to return","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Single query term for searching events.","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","description":"The earliest date and time of the event represented as a UNIX epoch time in milliseconds.","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","description":"The latest date and time of the event represented as a UNIX epoch time in milliseconds.","required":false,"schema":{"type":"string"}},{"name":"action","in":"query","description":"A query filter that returns events of a specific action type.","required":false,"schema":{"type":"string"}},{"name":"actor","in":"query","description":"A query filter that returns events by one or more specific actors.","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"ip","in":"query","description":"A query filter that returns events by one or more specific ip addresses.","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"product","in":"query","description":"A query filter that returns events by one or more specific products.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["bitbucket","confluence","guard_detect","jira","loom"]}},"style":"form","explode":false},{"name":"location","in":"query","description":"A query filter that returns events by one or more specific locations. Of format: [ { \"city\": \"<CityName>\", \"countryName\": \"<CountryName>\" }, ... ]","schema":{"type":"string","example":[{"city":"Austin","countryName":"United States"},{"city":"Sydney","countryName":"Australia"}]},"style":"form","explode":false},{"name":"limit","in":"query","description":"The maximum number of events to return per page.","required":false,"schema":{"type":"integer","format":"int32","default":30,"minimum":1,"maximum":500}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventPage"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.InvalidPageCursor.Model"},{"$ref":"#/components/schemas/Error.InvalidSearchTimeDate.Model"},{"$ref":"#/components/schemas/Error.InvalidQueryCount.Model"},{"$ref":"#/components/schemas/Error.InvalidRequestSyntax.Model"}]}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/events-stream":{"get":{"tags":["Events"],"operationId":"pollEvents","summary":"Poll audit log events","description":"Returns a paginated list of audit logs events for an organization. Use this endpoint if you want to retrieve events in a simple, paginated manner with time-based filtering.\nIf you need more advanced filtering, refer to the [/events](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-events/#api-v1-orgs-orgid-events-get) endpoint.\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"cursor","in":"query","description":"Sets the starting point for the page of results to return. Can be used when last page is reached to poll for new events. The sort order is maintained in the cursor across requests.\n","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","description":"The earliest date and time of the event represented as a UNIX epoch time in milliseconds.","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","description":"The latest date and time of the event represented as a UNIX epoch time in milliseconds.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of events to return per page.","required":false,"schema":{"type":"integer","format":"int32","default":200,"minimum":1,"maximum":500}},{"name":"sortOrder","in":"query","description":"The order used to sort events by processing time. Defaults to ascending.","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollingEventPage"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.InvalidPageCursor.Model"},{"$ref":"#/components/schemas/Error.InvalidSearchTimeDate.Model"},{"$ref":"#/components/schemas/Error.InvalidQueryCount.Model"},{"$ref":"#/components/schemas/Error.InvalidRequestSyntax.Model"}]}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/events/{eventId}":{"get":{"tags":["Events"],"operationId":"getEventById","summary":"Get an event by ID","description":"Returns information about a single event by ID.","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"eventId","in":"path","description":"ID of the event to return","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"description":"Event or Org Not Found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.EventNotFound.Model"},{"$ref":"#/components/schemas/Error.OrgNotFound.Model"}]}}}},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/event-actions":{"get":{"tags":["Events"],"operationId":"getEventActions","summary":"Get list of event actions","description":"Returns information localized event actions","parameters":[{"$ref":"#/components/parameters/orgIdParam"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventActions"}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"$ref":"#/components/responses/Error.OrgNotFound"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/policies":{"get":{"tags":["Policies"],"operationId":"getPolicies","summary":"Get list of policies","description":"Returns information about org policies","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"cursor","in":"query","description":"Sets the starting point for the page of results to return.","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Sets the type for the page of policies to return.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyPage"}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}},"post":{"tags":["Policies"],"operationId":"createPolicy","summary":"Create a policy","description":"Create a policy for an org","parameters":[{"$ref":"#/components/parameters/orgIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCreateInput"}}}},"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"400":{"$ref":"#/components/responses/Error.InvalidResource"},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/policies/{policyId}":{"get":{"tags":["Policies"],"operationId":"getPolicyById","summary":"Get a policy by ID","description":"Returns information about a single policy by ID","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"policyId","in":"path","description":"ID of the policy to query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"description":"Policy or organization not found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.PolicyNotFound.Model"},{"$ref":"#/components/schemas/Error.OrgNotFound.Model"}]}}}},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}},"put":{"tags":["Policies"],"operationId":"updatePolicy","summary":"Update a policy","description":"Update a policy for an org","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"policyId","in":"path","description":"ID of the policy to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdateInput"}}}},"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"400":{"$ref":"#/components/responses/Error.InvalidResource"},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"description":"Policy or organization not found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.PolicyNotFound.Model"},{"$ref":"#/components/schemas/Error.OrgNotFound.Model"}]}}}},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}},"delete":{"tags":["Policies"],"operationId":"deletePolicy","summary":"Delete a policy","description":"Delete a policy for an org","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"policyId","in":"path","description":"ID of the policy to delete","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation"},"400":{"$ref":"#/components/responses/Error.InvalidResource"},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"description":"Policy or organization not found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.PolicyNotFound.Model"},{"$ref":"#/components/schemas/Error.OrgNotFound.Model"}]}}}},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/policies/{policyId}/resources":{"post":{"tags":["Policies"],"operationId":"addResourceToPolicy","summary":"Add Resource to Policy","description":"Adds a resource to an existing Policy","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"policyId","in":"path","description":"ID of the policy to query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceInput"}}}},"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"description":"Policy or organization not found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.PolicyNotFound.Model"},{"$ref":"#/components/schemas/Error.OrgNotFound.Model"}]}}}},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}":{"put":{"tags":["Policies"],"operationId":"updatePolicyResource","summary":"Update Policy Resource","description":"Update an existing Policy Resource","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"policyId","in":"path","description":"ID of the policy to query","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","description":"Resource ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUpdateInput"}}}},"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"description":"Policy or organization not found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.PolicyNotFound.Model"},{"$ref":"#/components/schemas/Error.OrgNotFound.Model"},{"$ref":"#/components/schemas/Error.PolicyResourceNotFound.Model"}]}}}},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}},"delete":{"tags":["Policies"],"operationId":"deletePolicyResource","summary":"Delete Policy Resource","description":"Delete an existing Policy Resource","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"policyId","in":"path","description":"ID of the policy to query","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","description":"Resource ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}}},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"404":{"description":"Policy or organization not found","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Error.PolicyNotFound.Model"},{"$ref":"#/components/schemas/Error.OrgNotFound.Model"},{"$ref":"#/components/schemas/Error.PolicyResourceNotFound.Model"}]}}}},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/policies/{policyId}/validate":{"get":{"tags":["Policies","Validate"],"summary":"Validate Policy","description":"Validate a policy based on specific requirements. For example, Trigger CDEN validation by pushing a task into the SQS dns-validation queue","operationId":"validatePolicy","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"policyId","in":"path","description":"Policy ID","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted CDEN policy validation request"},"400":{"$ref":"#/components/responses/Error.CdenPolicyValidationFailed"},"401":{"$ref":"#/components/responses/Error.Unauthenticated"},"429":{"$ref":"#/components/responses/Error.RateLimited"},"500":{"$ref":"#/components/responses/Error.CdenPolicyValidationFailed"}}}},"/v1/orgs/{orgId}/directory/users/{accountId}/last-active-dates":{"get":{"tags":["Directory"],"summary":"User’s last active dates","description":"**Additional response parameters of the API (for e.g., `added_to_org`) are available only to customers using the new user management experience.** Learn more about the [new user management experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).\n\nSpecifications:\n- Return a user’s last active date for each product listed in Atlassian Administration.\n- Active is defined as viewing a product's page for a minimum of 2 seconds. \n- The data for the last activity may be delayed by up to 24 hours.\n- If the user has not accessed a product, the `product_access` response field will be empty. \n\nLearn the fastest way to call the API with a detailed [tutorial](https://developer.atlassian.com/cloud/admin/organization/user-last-active-dates/).\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"accountId","in":"path","required":true,"description":"Unique ID of the user's account.\nUse the [Jira User Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get) to get the accountId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Cursor to fetch the next page","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProductAccessActivityPage"}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-404-8`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/directory/users/{accountId}":{"delete":{"tags":["Directory"],"summary":"Remove user access","description":"**The API is available for customers using the new user management experience only.** Learn more about the [new user management experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).\n\nSpecifications:\n- Remove user access to products listed in Atlassian Administration.\n- Remove users from **Users** and **Groups** in **Directory**.\n- Make product licenses available for active users.\n\nThe users are not removed immediately; instead, they are placed in a queue for deletion. Please note that it may take some time for all users to be completely removed.\n\nUsers with emails whose domain is claimed can still be found in **Managed accounts** in **Directory**.\n\nLearn the fastest way to call the API with a detailed [tutorial](https://developer.atlassian.com/cloud/admin/organization/remove-user/). \n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"accountId","in":"path","required":true,"description":"Unique ID of the user's account that you are deleting.\nUse the [Jira User Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get) to get the accountId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).","schema":{"type":"string"}}],"responses":{"204":{"description":"User access removed from organization. Everything went fine, nothing to return. The users are not removed immediately; instead, they are placed in a queue for deletion. Please note that it may take some time for all users to be completely removed."},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/directory/users/{accountId}/suspend-access":{"post":{"tags":["Directory"],"summary":"Suspend user access","description":"**The API is available for customers using the new user management experience only.** Learn more about the [new user management experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).\n\nSpecifications:\n- Suspend user access to products listed in Atlassian Administration while keeping the account active. \n- Make product licenses available for active users.\n- Maintain respective users in **Groups** for easy restoration.\n\nUser access can be restored anytime via the [Restore access API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-users-accountid-restore-access-post)\n\nLearn the fastest way to call the API with a detailed [tutorial](https://developer.atlassian.com/cloud/admin/organization/suspend-user/).\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"accountId","in":"path","required":true,"description":"Unique ID of the user's account that you are suspending.\nUse the [Jira User Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get) to get the accountId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).","schema":{"type":"string"}}],"responses":{"200":{"description":"User was successfully suspended in the organization directory.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Access to organization 6665kc2j-4644-14k8-j32c-68cc0b1d15b8 was suspended for user 637194fa77acd224b33bfae3","description":"A description of the entities affected, and changes made as a result of calling this API."}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Not Found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-404-8`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/directory/users/{accountId}/restore-access":{"post":{"tags":["Directory"],"summary":"Restore user access","description":"**The API is available for customers using the new user management experience only.** Learn more about the [new user management experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).\n\nThis API will:\n- Restore access of an existing user to products listed in Atlassian Administration.\n- Retract the suspend user action.\n\nThis API will not:\n- Restore access to a user when they have access to a product which is breaching it's license limit.\\\nTo make these changes, you will need to [remove users](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-groups-groupid-memberships-accountid-delete) from the group or \n[suspend users](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-users-accountid-suspend-access-post) that are in the group first.\\\nYou can also [manage your subscription](https://support.atlassian.com/subscriptions-and-billing/resources/) for the breaching product to increase your license limits.\n- Restore access to any user when your organisation has too many products that are breaching their license limits.\n\nLearn the fastest way to call the API with a detailed [tutorial](https://developer.atlassian.com/cloud/admin/organization/restore-user/).\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"accountId","in":"path","required":true,"description":"Unique ID of the user's account that you are suspending.\nUse the [Jira User Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get) to get the accountId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).","schema":{"type":"string"}}],"responses":{"200":{"description":"User's access is successfully restored in the organization directory.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Access to organization 6665kc2j-4644-14k8-j32c-68cc0b1d15b8 was restored for user 637194fa77acd224b33bfae3","description":"A description of the entities affected, and changes made as a result of calling this API."}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n- `ADMIN-400-32`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-404-8`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"409":{"description":"Conflict\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-409-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/directory/groups":{"post":{"tags":["Directory"],"summary":"Create group","description":"**The API is available for customers using the new user management experience only. Learn more about the [new user management experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).**\n\nThis API will:\n- Create a group in the organization's directory.\n- Create a collection of users that you can use to easily manage permissions, content access, notification schemes, and roles.\n\n**The creation of new groups using existing group names is not permitted.**\n\nLearn the fastest way to call the API with a detailed [tutorial](https://developer.atlassian.com/cloud/admin/organization/create-group/#create-group).\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupInput"}}}},"responses":{"200":{"description":"Request to create group was successfully accepted and will be eventually created in the organization directory.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Group test-group was created","description":"A description of the entities affected, and changes made as a result of calling this API."},"groupId":{"type":"string","example":"f29c72a8-7681-4ed0-8a2c-83372bf67437","description":"The unique identifier of the group."}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n- `ADMIN-400-24`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n- `ADMIN-403-5`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Not Found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-404-8`\n- `ADMIN-404-10`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/directory/groups/{groupId}":{"delete":{"tags":["Directory"],"summary":"Delete group","description":"**The API is available for customers using the new user management experience only. Learn more about the [new user management experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).**\n\nThis API will:\n- Delete a group from the organization's directory.\n- Delete the permissions, content access, notification schemes, and roles granted to the users.\n\nThis API will not:\n- Delete groups that are synchronized through SCIM. To delete these groups, you will need to delete them within your external identity provider. Learn more about [configuring user provisioning with an identity provider](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/).\n- Delete a group if it’s marked as a [default group](https://support.atlassian.com/user-management/docs/default-groups-and-permissions).\n- Delete `site-admin` group and therefore revoke org-admin role from a user.\n- Delete a group if it contains users (unless forced).\n\nLearn the fastest way to call the API with a detailed [tutorial](https://developer.atlassian.com/cloud/admin/organization/delete-group/#delete-group).\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"groupId","in":"path","required":true,"description":"Unique ID that serves as reference to the group.\nUse the [Jira Group Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-groups-picker-get) to get the groupId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Make sure to select **pivot to column** when prompted. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).","schema":{"type":"string"}},{"name":"forceIfNotEmpty","in":"query","description":"Groups cannot be deleted if it contains users, unless `forceIfNotEmpty=true` is provided","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Group was successfully deleted from organization's directory.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Group 0980d761-fce5-4ea1-83e4-9cc8f5db92ae was removed","description":"A description of the entities affected, and changes made as a result of calling this API."}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n- `ADMIN-403-5`\n- `ADMIN-403-6`\n- `ADMIN-403-7`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Not Found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-404-8`\n- `ADMIN-404-10`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"409":{"description":"Conflict\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-409-5`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/directory/groups/{groupId}/memberships":{"post":{"tags":["Directory"],"summary":"Add user to group","description":"**The API is available for customers using the new user management experience only. Learn more about the [new user management experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).**\n\nThis API will:\n- Add user to a group.\n- Assign multiple permissions to user at once.\n- Easily manage permissions, content access, notification schemes, and roles.\n\nThis API will not:\n- Make modifications to group memberships that are synchronized through SCIM. To make changes to these memberships, you will need to modify them within your external identity provider. Learn more about [configuring user provisioning with an identity provider](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/).\n- Add a user to a group that gives access to a product which is breaching it's license limit.\\\nTo make these changes, you will need to [remove users](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-groups-groupid-memberships-accountid-delete) from the group or\n[suspend users](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-users-accountid-suspend-access-post) that are in the group first.\\\nYou can also [manage your subscription](https://support.atlassian.com/subscriptions-and-billing/resources/) for the breaching product to increase your license limits.\n- Add a user to any group when your organisation has too many products that are breaching their license limits.\n\nLearn the fastest way to call the API with a detailed [tutorial](https://developer.atlassian.com/cloud/admin/organization/add-user-to-group/).\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"groupId","in":"path","required":true,"description":"Unique ID that serves as reference to the group.\nUse the [Jira Group Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-groups-picker-get) to get the groupId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Make sure to select **pivot to column** when prompted. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGroupMembershipInput"}}}},"responses":{"200":{"description":"User was successfully added to the group in the organization directory.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"User 637194fa77acd224b33bfae3 was added to group 9233fb03-53cc-4463-9698-047aedbffb5c","description":"A description of the entities affected, and changes made as a result of calling this API."}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n- `ADMIN-400-24`\n- `ADMIN-400-32`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n- `ADMIN-403-5`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Not Found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-404-8`\n- `ADMIN-404-10`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"409":{"description":"Conflict\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-409-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/directory/groups/{groupId}/memberships/{accountId}":{"delete":{"tags":["Directory"],"summary":"Remove user from group","description":"**The API is available for customers using the new user management experience only. Learn more about the [new user management experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).**\n\nThis API will:\n- Remove user from a group.\n- Remove multiple permissions for user at once.\n- Easily manage permissions, content access, notification schemes, and roles.\n\nThis API will not:\n- Make modifications to group memberships that are synchronized through SCIM. To make changes to these memberships, you will need to modify them within your external identity provider. Learn more about [configuring user provisioning with an identity provider](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/).\n- Modify `site-admin` group and therefore revoke org-admin role from a user.\n\nLearn the fastest way to call the API with a detailed [tutorial](https://developer.atlassian.com/cloud/admin/organization/remove-user-to-group/).\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"groupId","in":"path","required":true,"description":"Unique ID that serves as reference to the group.\nUse the [Jira Group Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-groups-picker-get) to get the groupId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Make sure to select **pivot to column** when prompted. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).","schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"description":"Unique ID of the user's account that you are adding to the group.\nUse the [Jira User Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get) to get the accountId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).","schema":{"type":"string"}}],"responses":{"200":{"description":"User was successfully removed from the group in the organization directory.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"User 63ec0aa0c5061c632c0cddde was removed from group fca77b90-a2a9-4385-961b-1377b3dbeb0b","description":"A description of the entities affected, and changes made as a result of calling this API."}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-403-3`\n- `ADMIN-403-5`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Not Found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-404-8`\n- `ADMIN-404-10`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/users/invite":{"post":{"tags":["Directory"],"x-experimental":true,"summary":"Invite user to org","description":"\n**The API is presently accessible exclusively to customers who hold a paid subscription.** \n\n**The API is available for customers using the [new user management experience only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**. \n\n**This API is in limited availability and access. The development, release, and timing of any features or functionality described herein remain at the sole discretion of Atlassian and are subject to change. Please reach out to Atlassian support to get access to this API.**\n\nThis API will:\n- invite user to org and add them to the directory\n- assign a role for a given resource\n- send email if the sendNotification field is set true with optional custom message for the email\n\nThis API will not:\n- add users to group\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteApiRequest"}}}},"responses":{"202":{"description":"Invitation successfully sent","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":"619034:4eb0cd3f-3cb6-4561-8d6a-0546e66cab3d","description":"gives a unique ID of the user added"}}}}},"400":{"description":"Bad request\n\nExpected values for `ApiErrorResponse.ApiError.code`: (see type description for details)\n- `ADMIN-UAM-400-1`\n- `ADMIN-UAM-400-2`\n- `ADMIN-UAM-400-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"401":{"description":"Not authenticated\n\nExpected values for `ApiErrorResponse.ApiError.code`: (see type description for details)\n- `ADMIN-UAM-401-1`\n- `ADMIN-UAM-401-2`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"402":{"description":"Payment required - Access to the API is currently unavailable for your organization because you do not have a valid paid subscription.\n\nExpected values for `ApiErrorResponse.ApiError.code`: (see type description for details)\n- `ADMIN-UAM-402-1`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"403":{"description":"Unauthorized\n\nExpected values for `ApiErrorResponse.ApiError.code`: (see type description for details)\n- `ADMIN-UAM-403-1`\n- `ADMIN-UAM-403-2`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"Resource not found\n\nExpected values for `ApiErrorResponse.ApiError.code`: (see type description for details)\n- `ADMIN-UAM-404-1`\n- `ADMIN-UAM-404-2`\n- `ADMIN-UAM-404-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"409":{"description":"Conflict\n\nExpected values for `ApiErrorResponse.ApiError.code`: (see type description for details)\n- `ADMIN-UAM-409-1`\n- `ADMIN-UAM-409-2`\n- `ADMIN-UAM-409-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"500":{"description":"Internal error\n\nExpected values for `ApiErrorResponse.ApiError.code`: (see type description for details)\n- `ADMIN-UAM-500-1`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}}}},"/v1/orgs/{orgId}/directory/groups/{groupId}/roles/assign":{"post":{"tags":["Directory"],"x-experimental":true,"operationId":"assignRoleToGroup","summary":"Assign roles to a group","description":"**The API is available for customers using the [new user management experience only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**. \n\n**This API is in limited availability and access. The development, release, and timing of any features or functionality described herein remain at the sole discretion of Atlassian and are subject to change. Please reach out to Atlassian support to get access to this API.**\n\nAssign roles that grant product access to groups. Please note that this operation adheres to eventual consistency, and it might take up to 30 seconds for changes to take effect.\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"groupId","in":"path","description":"Unique ID that serves as reference to the group. Use the [Search for groups within an organization API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v1-orgs-orgid-groups-search-post) to get the groupId.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoleAssignmentInput"}}}},"responses":{"202":{"description":"Roles were successfully added to the group","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","example":"Group 12345 added Roles. ROLE `user` for RESOURCE `ari:cloud:identity::group/test-group-uuid1` and ROLE `user-access-admin` for RESOURCE `ari:cloud:identity::group/test-group-uuid2` is in progress. Changes may take up to 30 seconds to reflect.","description":"A description of the entities affected, and changes made as a result of calling this API."}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-400-1`\n- `ADMIN-UAM-400-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-403-1`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Not Found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-404-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"409":{"description":"Conflict\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-409-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v1/orgs/{orgId}/directory/groups/{groupId}/roles/revoke":{"post":{"tags":["Directory"],"x-experimental":true,"operationId":"revokeRoleToGroup","summary":"Revoke roles from a group","description":"**The API is available for customers using the [new user management experience only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**. \n\n**This API is in limited availability and access. The development, release, and timing of any features or functionality described herein remain at the sole discretion of Atlassian and are subject to change. Please reach out to Atlassian support to get access to this API.**\n\nRevoke roles that provide product access to groups. It's important to note that this operation follows eventual consistency principles and may require up to 30 seconds to take effect.\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"groupId","in":"path","description":"Unique ID that serves as reference to the group. Use the [Search for groups within an organization API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v1-orgs-orgid-groups-search-post) to get the groupId.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoleAssignmentInput"}}}},"responses":{"202":{"description":"Roles were successfully removed from the group","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","example":"Group 12345 revoked Roles. ROLE1 for RESOURCE1 and ROLE2 for RESOURCE2 is in progress. Changes may take up to 30 seconds to reflect.","description":"A description of the entities affected, and changes made as a result of calling this API."}}}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-400-1`\n- `ADMIN-UAM-400-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n  - `ADMIN-401-2`\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Forbidden\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-403-1`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Not Found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-404-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"$ref":"#/components/responses/Error.InternalError"}}}},"/v2/orgs/{orgId}/workspaces":{"post":{"tags":["Workspaces"],"summary":"Get list of workspaces","description":"A workspace refers to a specific instance of an Atlassian product that is accessed through a unique URL. Whenever a user initiates or adds a new product instance, it results in the creation of a distinct workspace.\n\nThis API will:\n- Return a paginated list of workspaces in a given org\n- Return more details about an organization's products (including product URL).\n","operationId":"queryWorkspacesV2","requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchWorkspacesRequestV2"},"examples":{"cursor_only":{"value":{"cursor":"c29tZS1iYXNlLTY0LWVuY29kZWQtY3Vyc29y"}},"search_workspaces_request":{"value":{"limit":20,"sort":[{"field":"attributes.type","order":"asc"}],"query":{"and":[{"field":{"name":"attributes.type","values":["confluence"]}},{"searchWorkspaces":"some-particular-workspace"},{"features":["some-feature"]},{"policies":["some-policy"]}]}}}}}}},"parameters":[{"$ref":"#/components/parameters/orgIdParam"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDataResponseV2"}}}},"400":{"description":"Bad request\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-400-4`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationError"}}}},"401":{"description":"Unauthorized\n\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationError"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationError"}}}}}}},"/v1/orgs/{orgId}/users/{userId}/roles/assign":{"post":{"tags":["Directory"],"x-experimental":true,"operationId":"assignRole","summary":"Grant user access","description":"**The API is available for customers using the [new user management experience only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**. \n\n**This API is in limited availability and access. The development, release, and timing of any features or functionality described herein remain at the sole discretion of Atlassian and are subject to change. Please reach out to Atlassian support to get access to this API.**\n\nThis API can be used to grant Platform Roles to a user.\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"userId","in":"path","description":"The UserId on which the action(Role Assign) needs to happen. Use the [Search for users within an organization API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-get) to get the userId.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleApiRequest"}}}},"responses":{"204":{"description":"Role Assigned Successfully."},"400":{"description":"Role Assign request is malformed or validation failed\n\nExpected values for `ApiError.code`: (see type description for details)\n- `ADMIN-UAM-400-1`\n- `ADMIN-UAM-400-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Not authenticated\n\nExpected values for `ApiError.code`: (see type description for details)\n  - `ADMIN-401-2`\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-403-1`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Resource not found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-404-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"409":{"description":"Product License Limit Exceeded\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-409-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"description":"Internal error\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}}}},"/v1/orgs/{orgId}/users/{userId}/roles/revoke":{"post":{"tags":["Directory"],"x-experimental":true,"operationId":"revokeRole","summary":"Revoke user access","description":"**The API is available for customers using the [new user management experience only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**. \n\n**This API is in limited availability and access. The development, release, and timing of any features or functionality described herein remain at the sole discretion of Atlassian and are subject to change. Please reach out to Atlassian support to get access to this API.**\n\nThis API can be used to revoke Platform Roles from a user.\n","parameters":[{"$ref":"#/components/parameters/orgIdParam"},{"name":"userId","in":"path","description":"The UserId on which the action(Role Revoke) needs to happen. Use the [Search for users within an organization API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-get) to get the userId.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleApiRequest"}}}},"responses":{"204":{"description":"Role Revoked Successfully."},"400":{"description":"Role Revoke request is malformed or validation failed\n\nExpected values for `ApiError.code`: (see type description for details)\n- `ADMIN-UAM-400-1`\n- `ADMIN-UAM-400-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"401":{"description":"Not authenticated\n\nExpected values for `ApiError.code`: (see type description for details)\n  - `ADMIN-401-2`\nExpected values for `ProxyError.code`: (see type description for details)\n  - `401`\n","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProxyError"},{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}]}}}},"403":{"description":"Unauthorized\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-403-1`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"404":{"description":"Resource not found\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-404-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"409":{"description":"Product License Limit Exceeded\n\nExpected values for `ApplicationError.code`: (see type description for details)\n- `ADMIN-UAM-409-3`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors.ApplicationErrors.Model"}}}},"429":{"description":"Too many API requests\n\nExpected values for `ProxyError.code`: (see type description for details)\n- `429`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"500":{"description":"Internal error\n\nExpected values for `ApiErrorResponse.ApiError.code`: (see type description for details)\n- `ADMIN-UAM-500-1`\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}}}}},"servers":[{"url":"https://api.atlassian.com/admin"}],"x-atlassian-narrative":{"documents":[{"title":"About","anchor":"About","body":"The Organizations REST API provides resources for managing an Atlassian organization. Use this API to:\n- Get a list of users in an organization and update their access to products\n- Create and update organization policies\n- Get lists of domains and events\n\nPermission: Organization admin\n\n[Discover additional admin features](https://developer.atlassian.com/cloud/admin/rest-apis/)"},{"title":"Authentication","anchor":"auth","body":"Authentication is implemented via an API key. Use the API Key as a Bearer access token to authenticate the script and manage your organization. The Organization ID is used as a unique identifier in the path parameter for the organization. Copy the Organization ID and API key and keep them in a safe place. We won’t show them to you again.\n\nTo make requests to the API with the client/tool of your choice, [Create an API key and get the organization ID](https://support.atlassian.com/organization-administration/docs/manage-an-organization-with-the-admin-apis/)."},{"title":"Rate limits","anchor":"rate limits","body":"A rate limit defines the maximum number of API calls an application or user can perform during a specific time frame. When this threshold is surpassed, or if CPU or total time constraints are exceeded, the application or user might encounter delays. Consequently, API requests initiated by the user or application will not succeed.\n\nIt is essential to note that all API requests are subjected to rate limits.\n\nWhen a client breach the rate limit thresholds, they get [HTTP 429 Too Many Requests](https://datatracker.ietf.org/doc/html/rfc6585#section-4) responses. The client has to wait for the rate limit counter to reset on the server before being able to make successful requests.\n\n**Rate limit response headers**\n\nThe following HTTP response headers are returned indicating the rate and threshold allowed for a client for each endpoint.\n- **X-RateLimit-Limit:** The number of allowed requests in the current period\n- **X-RateLimit-Remaining:** The number of remaining requests in the current period\n- **X-RateLimit-Reset:** Next period reset time (ISO 8601 - Date and time in UTC)\n\n**Rate limits of Last Active Dates API**\n- `GET '/v1/orgs/{orgId}/directory/users/{accountId}/last-active-dates`\n\n- *Rate limit per organization*: *200* requests per minute\n\n**Rate limits of Events API**\n\nRate limits for the following endpoints is specified below: \n\n- `GET /v1/orgs/{orgId}/events`\n- `GET /v1/orgs/{orgId}/events/{eventId}`\n- `GET /v1/orgs/{orgId}/event-actions`\n\n- *Rate limit per user*: *60* requests per minute\n- *Rate limit per API path*: *50* requests per minute\n\nThese rate limits will be lowered effective end of May 2025 as follows:\n\n- *Rate limit per user*: *10* requests per minute\n- *Rate limit per API path*: *10* requests per minute\n\nPlease migrate to the polling API to guarantee uninterrupted service for use cases involving a high request rate.\n\n**Rate limits of Polling API**\n\nRate limits for the following endpoints is specified below: \n\n- `GET /v1/orgs/{orgId}/events-stream`\n\n- *Rate limit per user*: *60* requests per minute\n- *Rate limit per API path*: *50* requests per minute"},{"title":"Version and URI","anchor":"uri","body":"\nThe URIs for resources have the following structure:\n\n```\nhttps://api.atlassian.com/admin/<version>/orgs/<resource-name>\n```"},{"title":"Pagination","anchor":"Pagination","body":"\nThe Organizations REST API uses pagination to conserve server resources and limit response size. If there are more results available after the current page, a link to the next page of results is included in the JSON. You can use the `cursor` parameter to set a specific starting point for the results."},{"title":"Experimental features","anchor":"Experimental features","body":"\nMethods marked as experimental may change without an earlier notice. We are looking for your feedback for these methods."},{"title":"Vocabulary","anchor":"Vocabulary","body":"\nThere are several concepts that are common ideas with a unique meaning in Atlassian Administration. Learn more about [terminology](https://developer.atlassian.com/cloud/admin/cloud-admin-vocabulary/) related to the cloud admin experience."}]},"components":{"responses":{"Error.InvalidDomainIdentifier":{"description":"Invalid domain identifier","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-400-2"]}}}]}}}}}}},"Error.InvalidPageCursor":{"description":"Invalid page cursor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error.InvalidPageCursor.Model"}}}},"Error.InvalidResource":{"description":"Resource is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error.InvalidResource.Model"}}}},"Error.DomainNotFound":{"description":"Domain not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error.DomainNotFound.Model"}}}},"Error.NoPerms":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error.NoPerms.Model"}}}},"Error.OrgNotFound":{"description":"Organization not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error.OrgNotFound.Model"}}}},"Error.Unauthenticated":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"Error.Unauthorized":{"description":"The consumer could not be authenticated.","content":{"application/json":{"schema":{"type":"object","required":["key"],"properties":{"key":{"type":"string","enum":["unauthorized","asapUnauthorizedIssuer"]}}}}}},"Error.RateLimited":{"description":"Too many API requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyError"}}}},"Error.InternalError":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error.InternalError.Model"}}}},"Error.CdenPolicyValidationFailed":{"description":"CDEN policy validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error.CdenPolicyValidationFailed.Model"}}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"OrgModel":{"type":"object","required":["id","type","attributes","relationships","links"],"properties":{"id":{"type":"string","description":"Unique identifier of the Org"},"type":{"type":"string","enum":["orgs"],"description":"Type name of this object"},"attributes":{"type":"object","description":"Attributes of this object","properties":{"name":{"type":"string","description":"Name of this Org"}}},"relationships":{"type":"object","description":"Relationships of this object","properties":{"domains":{"type":"object","description":"Link to the related Domains of the Org","properties":{"links":{"$ref":"#/components/schemas/LinkRelatedModel"}}},"users":{"type":"object","description":"Link to the related Users of the Org","properties":{"links":{"$ref":"#/components/schemas/LinkRelatedModel"}}}}},"links":{"$ref":"#/components/schemas/LinkSelfModel"}}},"Org":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrgModel"}}},"OrgPage":{"type":"object","properties":{"data":{"type":"array","description":"0 or more values of `Org` are returned","items":{"$ref":"#/components/schemas/OrgModel"}},"links":{"$ref":"#/components/schemas/LinkPageModel"}}},"Product":{"type":"object","required":["key","name"],"properties":{"key":{"type":"string","enum":["jira-software","jira-service-desk","jira-core","jira-ops","stride","hipchat","confluence","bitbucket","trello","opsgenie","statuspage"],"description":"Unique key of the Product"},"name":{"type":"string","description":"Name of the Product"},"url":{"type":"string","description":"URL of the Product"},"last_active":{"type":"string","format":"date-time","description":"Last active date for a product"}}},"UserProductLastActive":{"required":["id","key"],"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the Product instance"},"key":{"type":"string","enum":["jira-software","jira-service-desk","jira-core","jira-ops","stride","hipchat","confluence","bitbucket","trello","opsgenie","statuspage"],"description":"Unique key of the Product"},"last_active":{"type":"string","format":"date","description":"Last active date for a product"}}},"User":{"type":"object","required":["account_id","account_type","account_status","name","picture"],"discriminator":{"propertyName":"account_type"},"properties":{"account_id":{"type":"string","description":"Unique ID of the users account. The format is [a-zA-Z0-9_|-:]{1,128}"},"account_type":{"type":"string","description":"The type of account","enum":["atlassian","customer","app"]},"account_status":{"type":"string","description":"The lifecycle status of the account","enum":["active","inactive","closed"]},"name":{"type":"string","description":"The display name of the user. Should be used for contextual rendering of the authorship in content. If the user has restricted visibility of their name, their nickname will be displayed as a substitute value"},"picture":{"type":"string","description":"The absolute URI (RFC3986) to the avatar name of the user. Should be used for contextual rendering of the authorship in content. If the user has restricted visibility of their avatar, an alternative URI will be provided as a substitute value"},"email":{"type":"string","description":"The email address of the user. If the user has restricted visibility of the email address, the property will be absent"},"access_billable":{"type":"boolean","description":"Billable status of User in Atlassian Guard Standard"},"last_active":{"type":"string","format":"date-time","description":"Last active date for a user"},"product_access":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"description":"Products which the User is using"},"links":{"$ref":"#/components/schemas/LinkSelfModel"}}},"UserPage":{"type":"object","properties":{"data":{"type":"array","description":"0 or more values of Users are returned","items":{"$ref":"#/components/schemas/User"}},"meta":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of users in this Query"}}},"links":{"$ref":"#/components/schemas/LinkPageModel"}}},"UserProductAccessModel":{"type":"object","required":["product_access"],"properties":{"product_access":{"type":"array","items":{"$ref":"#/components/schemas/UserProductLastActive"},"description":"Products accessed by the user"},"added_to_org":{"type":"string","nullable":true,"format":"date","description":"Date the user was added to the organization in ISO 8601 format."}}},"UserProductAccessActivityPage":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserProductAccessModel"},"links":{"$ref":"#/components/schemas/CursorNextPageModel"}}},"UsersSearchRequest":{"type":"object","properties":{"accountIds":{"maxItems":100,"minItems":0,"uniqueItems":true,"type":"array","description":"Unique ID of the users account. The format is [a-zA-Z0-9_|-:]{1,128}","items":{"maxLength":100,"minLength":0,"type":"string","format":"uuid","description":"Unique ID of the users account. The format is [a-zA-Z0-9_|-:]{1,128}"}},"accountTypes":{"uniqueItems":true,"type":"array","description":"The type of account","items":{"type":"string","description":"The type of account","enum":["atlassian","customer","app"]}},"accountStatuses":{"uniqueItems":true,"type":"array","description":"The lifecycle status of the account","items":{"type":"string","description":"The lifecycle status of the account","enum":["ACTIVE","INACTIVE"]}},"namesOrNicknames":{"$ref":"#/components/schemas/NamesOrNicknames"},"emailUsernames":{"$ref":"#/components/schemas/EmailUsernames"},"emailDomains":{"$ref":"#/components/schemas/EmailDomains"},"isSuspended":{"type":"boolean","description":"Suspended users with no access. This is independent of the user account status"},"cursor":{"type":"string","description":"Starting point marker for page result retrieval"},"limit":{"maximum":10000,"minimum":1,"type":"integer","description":"The number of items to return. Default = max = 10000","format":"int32"},"expand":{"uniqueItems":true,"type":"array","description":"Indicates the user information fields to include in the response. If unspecified, the response defaults to including only the accountId, accountType, and accountStatus fields.\nThe data for the product last access may be delayed by up to 24 hours.","items":{"type":"string","description":"Indicates the user information fields to include in the response. If unspecified, the response defaults to including only the accountId, accountType, and accountStatus fields.","enum":["NAME","EMAIL","EMAIL_VERIFIED","PRODUCT_LAST_ACCESS","GROUPS"]}}}},"UsersSearchPage":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicUser"}},"links":{"$ref":"#/components/schemas/LinkPageModel"}}},"PublicUser":{"type":"object","properties":{"accountId":{"type":"string","description":"Unique ID of the users account. The format is [a-zA-Z0-9_|-:]{1,128}"},"name":{"type":"string","description":"The display name of the user. Should be used for contextual rendering of the authorship in content. If the user has restricted visibility of their name, their nickname is displayed as a substitute value"},"nickname":{"type":"string","description":"The nickname of the user. Should be used for mentions or other in content references to the user."},"accountType":{"type":"string","description":"The type of account","enum":["atlassian","customer","app"]},"accountStatus":{"type":"string","description":"The lifecycle status of the account","enum":["active","partial","inactive","closed"]},"email":{"type":"string","description":"The email address of the user. The email will be absent for any user with an account_type of `app`"},"emailVerified":{"type":"boolean","description":"The email verification status of the user."},"statusInUserbase":{"type":"boolean","description":"The status of the user in the userbase"}},"description":"The current page of search results"},"CreateGroupInput":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the group."},"description":{"type":"string","description":"The description of the group."}}},"PublicGroup":{"required":["id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"roleAssignments":{"type":"array","items":{"$ref":"#/components/schemas/RoleAssignment"}}}},"RoleAssignment":{"type":"object","properties":{"resourceId":{"type":"string"},"principalId":{"type":"string"},"roleId":{"type":"string"}}},"AddGroupMembershipInput":{"type":"object","required":["account_id"],"properties":{"account_id":{"type":"string","description":"Unique ID of the user's account that you are adding to the group.\nUse the [Jira User Search API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get) to get the accountId (if Jira is available for your Organization). **Jira APIs use a different [authentication method ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**\nIf you don’t have Jira, export a .csv of the user list. Learn how to [export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/)."}}},"GroupsSearchRequest":{"type":"object","properties":{"groupIds":{"maxItems":100,"minItems":0,"uniqueItems":true,"type":"array","description":"Unique ID that serves as reference to the group.","items":{"maxLength":100,"minLength":0,"type":"string","format":"uuid","description":"Unique ID that serves as reference to the group."}},"groupNames":{"$ref":"#/components/schemas/GroupNames"},"cursor":{"type":"string","description":"Cursor specifying the starting point for page result retrieval."},"limit":{"maximum":1000,"minimum":1,"type":"integer","description":"The number of items to return. Default = max = 1000","format":"int"},"expand":{"uniqueItems":true,"type":"array","description":"Indicates the user information fields to include in the response. If unspecified, the response defaults to id, name and description.","items":{"type":"string","description":"Indicates the user information fields to include in the response. If unspecified, the response defaults to id, name and description.","enum":["USERS","META","ROLE_ASSIGNMENTS","MANAGEMENT_ACCESS"]}}}},"GroupsSearchPage":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicGroup"}},"links":{"$ref":"#/components/schemas/LinkPageModel"}}},"NamesOrNicknames":{"type":"object","properties":{"eq":{"maxItems":100,"minItems":0,"uniqueItems":true,"type":"array","description":"Names or nicknames filter","items":{"maxLength":100,"minLength":0,"type":"string","description":"Names or nicknames filter"}},"contains":{"type":"string","description":"Partial name or nickname filter"}}},"EmailDomains":{"type":"object","properties":{"eq":{"maxItems":100,"minItems":0,"uniqueItems":true,"type":"array","description":"The list of email domains to filter by, eg: for `abc@hello.com`, emailDomain is `hello.com`. Sample query param `{\"emailDomains\":{\"eq\":[\"hello.com\"]}}` ","items":{"maxLength":100,"minLength":0,"type":"string","description":"The list of email domains to filter by"}},"contains":{"type":"string","description":"Partial email domain filter"}}},"EmailUsernames":{"type":"object","properties":{"eq":{"maxItems":100,"minItems":0,"uniqueItems":true,"type":"array","description":"The list of email usernames to filter by, eg: for `abc@hello.com`, emailUsername is `abc`. Sample query param `{\"emailUsernames\":{\"eq\":[\"abc\"]}}` ","items":{"maxLength":100,"minLength":0,"type":"string","description":"The list of email usernames to filter by"}},"contains":{"type":"string","description":"Partial email username filter"}}},"GroupNames":{"type":"object","properties":{"eq":{"maxItems":100,"minItems":0,"uniqueItems":true,"type":"array","description":"The list of group names to filter by","items":{"maxLength":100,"minLength":0,"type":"string","description":"The list of group names to filter by"}},"contains":{"type":"string","description":"Partial group name filter"}}},"GroupRoleAssignmentInput":{"required":["roleAssociations"],"type":"object","properties":{"roleAssociations":{"type":"array","items":{"$ref":"#/components/schemas/RoleAssociation"}}}},"DomainModel":{"type":"object","required":["id","type","attributes","links"],"properties":{"id":{"type":"string","description":"Unique identifier of the Domain"},"type":{"type":"string","description":"Type name of this object","enum":["domains"]},"attributes":{"type":"object","description":"Attributes of this object","properties":{"name":{"type":"string","description":"Domain Name"},"claim":{"type":"object","description":"Claim for the domain","properties":{"type":{"type":"string","enum":["http","dns"]},"status":{"type":"string","enum":["verified","deleted","unverified","superseded","missing_token"],"description":"Verification Status of the Domain Claim"}}}}},"links":{"$ref":"#/components/schemas/LinkSelfModel"}}},"Domain":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DomainModel"}}},"DomainPage":{"type":"object","properties":{"data":{"type":"array","description":"0 or more values of Domain are returned","items":{"$ref":"#/components/schemas/DomainModel"}},"links":{"$ref":"#/components/schemas/LinkPageModel"}}},"EventActorModel":{"type":"object","description":"The entity that performed the action","required":["id"],"properties":{"id":{"type":"string","description":"Id of the Actor"},"name":{"type":"string","description":"The display name of the Actor."},"email":{"type":"string","description":"The email of the Actor."},"auth":{"type":"object","description":"Authentication used by the actor","required":["authType"],"properties":{"authType":{"type":"string","description":"The type of authentication used by the actor","enum":["container-token","api-token","connect-token","auth-token-for-2LO","auth-token-for-3LO"]},"tokenId":{"type":"string","description":"The id of the authentication token"},"tokenLabel":{"type":"string","description":"The label/name of the authentication token"}}},"onBehalfOf":{"type":"object","description":"The user the actor is acting on behalf of","required":["id"],"properties":{"id":{"type":"string","description":"Id of the user the actor is acting on behalf of"},"name":{"type":"string","description":"The display name of the user the actor is acting on behalf of"},"email":{"type":"string","description":"The email of the user the actor is acting on behalf of"}}},"app":{"type":"object","description":"The app that triggered the action","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the app"},"type":{"type":"string","description":"Type of app"},"attributes":{"type":"object","description":"Attributes of this app","additionalProperties":{}}}},"links":{"$ref":"#/components/schemas/LinkSelfModel"}}},"EventLocationModel":{"type":"object","properties":{"ip":{"type":"string","description":"IP address"},"geo":{"type":"string","description":"Geo location of the IP address","deprecated":true},"countryName":{"type":"string","description":"Country location according to the IP address"},"regionName":{"type":"string","description":"Region location according to the IP address"},"city":{"type":"string","description":"City location according to the IP address"}}},"EventObjectModel":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier of the event object"},"type":{"type":"string","description":"Type name of this object"},"attributes":{"type":"object","description":"Attributes of this object","additionalProperties":{}},"links":{"anyOf":[{"$ref":"#/components/schemas/LinkSelfAltModel"},{"$ref":"#/components/schemas/LinkAltModel"}]}}},"EventModel":{"type":"object","required":["id","type","attributes","links"],"properties":{"id":{"type":"string","description":"Unique identifier of the Event"},"type":{"type":"string","description":"Type name of this object","enum":["events"]},"attributes":{"type":"object","description":"Attributes of this object","required":["time","action","actor","context"],"properties":{"time":{"type":"string","format":"date-time","description":"The date and time of the event","example":"2025-02-27T18:50:12.281Z"},"action":{"type":"string","description":"Kind of Event. Complete list see `event-actions` API."},"actor":{"$ref":"#/components/schemas/EventActorModel"},"context":{"type":"array","description":"Describes one or more entities that the action was performed against. This field describes the \"what\" of the event.","items":{"$ref":"#/components/schemas/EventObjectModel"}},"container":{"type":"array","description":"Describes the location where the action was performed. This field describes the \"where\" of the event.","items":{"$ref":"#/components/schemas/EventObjectModel"}},"location":{"$ref":"#/components/schemas/EventLocationModel"}}},"links":{"$ref":"#/components/schemas/LinkSelfModel"},"message":{"$ref":"#/components/schemas/EventMessageModel"}}},"PollingEventModel":{"type":"object","required":["id","type","attributes","links"],"properties":{"id":{"type":"string","description":"Unique identifier of the event"},"type":{"type":"string","description":"Type name of this object","enum":["events"]},"attributes":{"type":"object","description":"Attributes of this object","required":["time","processedAt","action","actor","context"],"properties":{"time":{"type":"string","format":"date-time","description":"The date and time of the event.","example":"2025-02-27T18:50:12.281Z"},"processedAt":{"type":"string","format":"date-time","description":"The date and time the event was processed.","example":"2025-02-27T18:50:12.281Z"},"action":{"type":"string","description":"The kind of event. Complete list see `event-actions` API."},"actor":{"$ref":"#/components/schemas/EventActorModel"},"context":{"type":"array","description":"Describes one or more entities that the action was performed against. This field describes the \"what\" of the event.","items":{"$ref":"#/components/schemas/EventObjectModel"}},"container":{"type":"array","description":"Describes the location where the action was performed. This field describes the \"where\" of the event.","items":{"$ref":"#/components/schemas/EventObjectModel"}},"location":{"$ref":"#/components/schemas/EventLocationModel"}}},"links":{"$ref":"#/components/schemas/LinkSelfModel"},"message":{"$ref":"#/components/schemas/EventMessageModel"}}},"EventActionModel":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Unique identifier of the event action object."},"type":{"type":"string","description":"Type name of this object."},"attributes":{"type":"object","description":"Attributes of this object.","required":["displayName","groupDisplayName"],"properties":{"displayName":{"type":"string","description":"Display name of the event action."},"groupDisplayName":{"type":"string","description":"Display name of the event action group."}}}}},"Event":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventModel"}}},"EventPage":{"type":"object","properties":{"data":{"type":"array","description":"0 or more values of Event are returned","items":{"$ref":"#/components/schemas/EventModel"}},"meta":{"type":"object","properties":{"next":{"type":"string","description":"Value for the next cursor"},"page_size":{"type":"integer","description":"Number of items in a page"}}},"links":{"$ref":"#/components/schemas/LinkPageModel"}}},"PollingEventPage":{"type":"object","properties":{"data":{"type":"array","description":"0 or more values of Event are returned","items":{"$ref":"#/components/schemas/PollingEventModel"}},"meta":{"type":"object","properties":{"next":{"type":"string","description":"Value for the next cursor."},"page_size":{"type":"integer","description":"Number of items on a page."}}},"links":{"$ref":"#/components/schemas/LinkPageModel"}}},"EventActions":{"type":"object","properties":{"data":{"type":"array","description":"0 or more values of event actions are returned.","items":{"$ref":"#/components/schemas/EventActionModel"}}}},"PolicyModel":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Unique identifier of the Policy"},"type":{"type":"string","enum":["policy"],"description":"Type of this object"},"attributes":{"type":"object","description":"Attributes of this object","required":["type"],"properties":{"type":{"type":"string","enum":["ip-allowlist","data-residency","data-security"],"description":"Type of this Policy"},"name":{"type":"string","description":"Name of this Policy"},"status":{"type":"string","enum":["enabled","disabled"],"description":"Status of this Policy"},"rule":{"type":"object","description":"Rule of the Policy","oneOf":[{"$ref":"#/components/schemas/AllowIfContainedRule"}]},"resources":{"type":"array","description":"list of resources Policy is associated with","items":{"$ref":"#/components/schemas/Resource"}}}}}},"PolicyCreateModel":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","enum":["policy"],"description":"Type of this object"},"attributes":{"type":"object","description":"Attributes of this object","required":["type"],"properties":{"type":{"type":"string","enum":["ip-allowlist","data-residency"],"description":"Type of this Policy"},"name":{"type":"string","description":"Name of this Policy"},"status":{"type":"string","enum":["enabled","disabled"],"description":"Status of this Policy"},"rule":{"type":"object","description":"Rule of the Policy","oneOf":[{"$ref":"#/components/schemas/AllowIfContainedRule"}]},"resources":{"type":"array","description":"list of resources Policy is associated with","items":{"$ref":"#/components/schemas/ResourceInput"}}}}}},"PolicyUpdateModel":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"Unique identifier of the Policy"},"type":{"type":"string","enum":["policy"],"description":"Type of this object"},"attributes":{"type":"object","description":"Attributes of this object","required":["type"],"properties":{"type":{"type":"string","enum":["ip-allowlist","data-residency"],"description":"Type of this Policy"},"name":{"type":"string","description":"Name of this Policy"},"status":{"type":"string","enum":["enabled","disabled"],"description":"Status of this Policy"},"rule":{"type":"object","description":"Rule of the Policy","oneOf":[{"$ref":"#/components/schemas/AllowIfContainedRule"}]},"resources":{"type":"array","description":"list of resources Policy is associated with","items":{"$ref":"#/components/schemas/ResourceInput"}}}}}},"Policy":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicyModel"}}},"PolicyCreateInput":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicyCreateModel"}}},"PolicyUpdateInput":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PolicyUpdateModel"}}},"PolicyPage":{"type":"object","properties":{"data":{"type":"array","description":"0 or more values of Policy are returned","items":{"$ref":"#/components/schemas/PolicyModel"}},"meta":{"type":"object","properties":{"next":{"type":"string","nullable":true,"description":"Value for the next cursor"},"page_size":{"type":"integer","description":"Number of items in a page"}}},"links":{"$ref":"#/components/schemas/LinkPageModel"}}},"ResourceInput":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"meta":{"$ref":"#/components/schemas/Meta"},"links":{"$ref":"#/components/schemas/Links"}}},"ResourceUpdateInput":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/Meta"},"links":{"$ref":"#/components/schemas/Links"}}},"PageDataResponseV2":{"type":"object","properties":{"data":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/WorkspaceModel"}},"links":{"$ref":"#/components/schemas/LinkPageModel"},"meta":{"$ref":"#/components/schemas/MetaV2"}}},"WorkspaceModel":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"attributes":{"type":"object","properties":{"name":{"type":"string"},"typeKey":{"type":"string"},"type":{"type":"string"},"owner":{"type":"string","nullable":true},"status":{"type":"string","enum":["online","offline","deprecated"]},"statusDetails":{"type":"array","items":{"type":"string"}},"icons":{"type":"object","additionalProperties":{}},"avatars":{"type":"object","additionalProperties":{}},"labels":{"type":"array","items":{"type":"string"}},"sandbox":{"$ref":"#/components/schemas/Sandbox"},"usage":{"type":"integer","nullable":true},"capacity":{"type":"integer","nullable":true},"createdAt":{"type":"string","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"hostUrl":{"type":"string","nullable":true},"realm":{"type":"string"},"regions":{"type":"array","items":{"type":"string"}}},"readOnly":true,"additionalProperties":{}},"links":{"$ref":"#/components/schemas/LinkSelfModel"},"relationships":{"type":"object","additionalProperties":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/PolicyModelV2"},{"$ref":"#/components/schemas/EntitlementModelV2"},{"$ref":"#/components/schemas/FeatureModelV2"}]}}}}},"MetaV2":{"type":"object","properties":{"pageSize":{"type":"integer"},"startIndex":{"type":"integer","nullable":true},"endIndex":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"SearchWorkspacesRequestV2":{"type":"object","description":"Workspaces request supporting enhanced Workspace searching.","properties":{"query":{"$ref":"#/components/schemas/QueryVariants"},"limit":{"type":"integer","description":"Specifies the maximum page size.","minimum":1,"maximum":1000,"default":20},"sort":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SortField"}},"cursor":{"type":"string","nullable":true,"description":"A base-64 encoded continuation token used for pagination. When a cursor is provided in the request body, no other properties may be present."}}},"SortField":{"type":"object","properties":{"field":{"type":"string"},"order":{"type":"string","enum":["asc","desc"]}}},"QueryVariants":{"description":"Possible operators/operand in the event query.","nullable":true,"anyOf":[{"$ref":"#/components/schemas/AndOperator"},{"$ref":"#/components/schemas/NorOperator"},{"$ref":"#/components/schemas/FieldOperand"},{"$ref":"#/components/schemas/SearchWorkspacesOperand"},{"$ref":"#/components/schemas/FeatureFilter"},{"$ref":"#/components/schemas/PolicyFilter"}]},"AndOperator":{"type":"object","nullable":true,"additionalProperties":false,"description":"Returns workspaces matching all of the nested query variants. Absence of nested variants makes this operator no-op.\n","properties":{"and":{"description":"Returns workspaces matching all of the nested query variants. Absence of nested variants makes this operator no-op.","type":"array","items":{"$ref":"#/components/schemas/QueryVariants"}}}},"NorOperator":{"type":"object","nullable":true,"description":"Returns workspaces excluding those that match any of the nested query variants. Absence of nested variants makes this operator no-op.\n","additionalProperties":false,"properties":{"nor":{"description":"Returns workspaces excluding those that match any of the nested query variants. Absence of nested variants makes this operator no-op","type":"array","items":{"$ref":"#/components/schemas/QueryVariants"}}}},"FieldOperand":{"type":"object","nullable":true,"description":"Returns workspaces where a specified event field has one of the specified values. Absent of values makes this operator no-op.\n","additionalProperties":false,"properties":{"field":{"description":"Returns workspaces where a specified event field has one of the specified values.Absent of values makes this operator no-op.","type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}}},"SearchWorkspacesOperand":{"type":"object","nullable":true,"properties":{"searchWorkspaces":{"description":"Returns workspaces, which partially contain the specified text in workspace name or url.","type":"string"},"value":{"type":"string"}}},"FeatureFilter":{"type":"object","nullable":true,"properties":{"features":{"description":"Returns workspaces, which contains feature listed","type":"array","items":{"type":"string"}}}},"PolicyFilter":{"type":"object","nullable":true,"properties":{"policies":{"description":"Returns workspaces, which contains policy listed","type":"array","items":{"type":"string"}}}},"Sandbox":{"type":"object","nullable":true,"properties":{"type":{"type":"string","enum":["CHILD","NONE"]}}},"EntitlementModelV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"attributes":{"type":"object","properties":{"key":{"type":"string"},"planKey":{"nullable":true,"type":"string"},"plan":{"nullable":true,"type":"string"}}}}},"PolicyModelV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"attributes":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"object"}}}}}},"FeatureModelV2":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"type":{"type":"string","readOnly":true},"attributes":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"object"}}}}}},"Resource":{"type":"object","required":["id","applicationStatus"],"properties":{"id":{"type":"string"},"applicationStatus":{"type":"string","description":"Status of policy application on resource","enum":["applying","removing","applied","failed","scheduled"]},"meta":{"$ref":"#/components/schemas/Meta"},"links":{"$ref":"#/components/schemas/Links"}}},"Meta":{"type":"object","properties":{"scheduledDate":{"type":"string"},"migrationStartDateTime":{"type":"string"},"migrationEndDataTime":{"type":"string"},"atlassianAccountId":{"type":"string"}}},"Links":{"type":"object","properties":{"ticket":{"type":"string"}}},"AllowIfContainedRule":{"type":"object","description":"Applicable when policy type is `ip-allowlist` or `data-residency`","required":["in"],"properties":{"in":{"type":"array","items":{"type":"string"}}}},"EventMessageModel":{"type":"object","properties":{"content":{"type":"string","description":"Encrypted message of audit log activity"},"format":{"type":"string","description":"Format of the audit log message"}}},"LinkSelfModel":{"type":"object","required":["self"],"properties":{"self":{"type":"string","description":"URL to fetch this resource"}}},"LinkAltModel":{"type":"object","required":["alt"],"properties":{"alt":{"type":"string","description":"Alternate URL to fetch this resource"}}},"LinkRelatedModel":{"type":"object","required":["related"],"properties":{"related":{"type":"string","description":"URL to fetch this resource"}}},"LinkSelfAltModel":{"type":"object","description":"Links for a resources with self and alternate links","properties":{"self":{"type":"string","description":"URL to fetch this resource"},"alt":{"type":"string","description":"Alternate URL to fetch this resource"}}},"LinkPageModel":{"type":"object","description":"Links for a Paginated response","properties":{"self":{"type":"string","description":"URL to fetch this Page"},"prev":{"type":"string","description":"URL to fetch the Previous Page"},"next":{"type":"string","description":"URL to fetch the Next Page"}}},"InviteApiRequest":{"required":["email"],"type":"object","properties":{"email":{"type":"string","format":"email"},"permissionRule":{"$ref":"#/components/schemas/RoleAssociation"},"sendNotification":{"type":"boolean","default":false},"notificationText":{"type":"string"}}},"RoleAssociation":{"required":["resource","role"],"type":"object","properties":{"resource":{"type":"string","description":"Use the [Get Workspaces API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-v2-orgs-orgid-workspaces-post) to get an id.\nOnly the following resources are valid:\n- avp\n- beacon\n- bitbucket\n- compass\n- confluence\n- jira-admin\n- jira-core\n- jira-software\n- jira-servicedesk\n- jira-product-discovery\n- loom\n- mercury\n- opsgenie\n- platform\n- statuspage\n- townsquare\n- trello\n- unified-help\n","example":"ari:cloud:jira::site/70ef3a32-d0da-4e09-b35e-0109f91969c3"},"role":{"type":"string","enum":["atlassian/user","atlassian/admin","atlassian/guest","atlassian/customer","atlassian/contributor","atlassian/basic","atlassian/stakeholder"],"description":"Role to assign to a resource"}}},"CursorNextPageModel":{"type":"object","description":"Cursors for REST API pagination","properties":{"next":{"type":"string","description":"Cursor to fetch next page"}}},"ApplicationError":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for this particular occurrence of the error."},"status":{"type":"string","description":"The HTTP status code applicable to this error."},"code":{"type":"string","example":"ADMIN-XXX-X","description":"An application-specific error code:\n  - `ADMIN-400-1`  - Invalid page cursor\n  - `ADMIN-400-2`  - Invalid domain identifier\n  - `ADMIN-400-3`  - Invalid time date\n  - `ADMIN-400-4`  - Invalid resource\n  - `ADMIN-400-24` - Invalid request body\n  - `ADMIN-400-32` - Too many license breaches\n  - `ADMIN-403-3`  - Not allowed to manage the org\n  - `ADMIN-403-5`  - Not allowed to manage the group\n  - `ADMIN-403-6`  - Not allowed to delete group with default-role attribute\n  - `ADMIN-403-7`  - Not allowed to delete group which grants admin access to a product or org\n  - `ADMIN-404-1`  - Unknown resource\n  - `ADMIN-404-2`  - Organization not found\n  - `ADMIN-404-3`  - Domain not found\n  - `ADMIN-404-4`  - Event not found\n  - `ADMIN-404-5`  - Policy not found\n  - `ADMIN-404-8`  - User not found\n  - `ADMIN-404-10` - Group not found\n  - `ADMIN-405-1`  - Method not supported\n  - `ADMIN-409-3`  - License limit exceeded\n  - `ADMIN-409-5`  - Group not empty\n  - `ADMIN-429-1`  - Rate limit exceeded\n  - `ADMIN-500-1`  - Internal error\n"},"title":{"type":"string","description":"Human-readable summary of the error."},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the error, and a suggested action to resolve it."}}},"ProxyError":{"type":"object","properties":{"code":{"type":"number","description":"The HTTP status code applicable to this error."},"message":{"type":"string","description":"Human-readable explanation of the error."}}},"NoPermsError":{"type":"object","properties":{"timestamp":{"type":"string","description":"Timestamp of the request."},"path":{"type":"string","description":"Path of the request."},"status":{"type":"number","enum":[403],"description":"The HTTP status code applicable to this error."},"error":{"type":"string","description":"The HTTP status text applicable to this error."},"message":{"type":"string","description":"Human-readable explanation of the error."},"requestId":{"type":"string","description":"Id of the request."}}},"Errors.ApplicationErrors.Model":{"type":"object","title":"ApplicationErrors","description":"A list of application errors","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationError"}}}},"Error.InvalidPageCursor.Model":{"type":"object","description":"Invalid page cursor","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-400-1"]}}}]}}}},"Error.InvalidSearchTimeDate.Model":{"type":"object","description":"Invalid time date","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-400-3"]}}}]}}}},"Error.InvalidQueryCount.Model":{"type":"object","description":"The number of queries exceeded the limit","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-400-21"]}}}]}}}},"Error.InvalidRequestSyntax.Model":{"type":"object","description":"Request syntax is not valid","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-400-19"]}}}]}}}},"Error.InvalidResource.Model":{"type":"object","description":"Resource is not valid","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-400-4"]}}}]}}}},"Error.OrgNotFound.Model":{"type":"object","description":"Organization not found","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-404-2"]}}}]}}}},"Error.NoPerms.Model":{"$ref":"#/components/schemas/NoPermsError"},"Error.DomainNotFound.Model":{"type":"object","description":"Domain not found","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-404-3"]}}}]}}}},"Error.EventNotFound.Model":{"type":"object","description":"Event not found","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-404-4"]}}}]}}}},"Error.PolicyNotFound.Model":{"type":"object","description":"Policy not found","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-404-5"]}}}]}}}},"Error.PolicyResourceNotFound.Model":{"type":"object","description":"Policy Resource not found","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-404-6"]}}}]}}}},"Error.InternalError.Model":{"type":"object","description":"Internal error","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-500-1"]}}}]}}}},"Error.CdenPolicyValidationFailed.Model":{"type":"object","description":"CDEN policy validation failed","properties":{"errors":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ApplicationError"},{"type":"object","properties":{"code":{"type":"string","enum":["ADMIN-500-2"]}}}]}}}},"RoleApiRequest":{"required":["role"],"type":"object","properties":{"role":{"type":"string","enum":["atlassian/user","atlassian/user-access-admin","atlassian/admin","atlassian/guest","atlassian/contributor","atlassian/customer","atlassian/basic","atlassian/stakeholder","atlassian/site-admin","atlassian/org-admin"],"description":"Role to assign/revoke for a user"},"resource":{"type":"string","description":"Use the [Get Workspaces API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-v2-orgs-orgid-workspaces-post) to get an id.\nResource is required for all roles other than org-admin. Any resource passed for org-admin shall be ignored\n","example":"ari:cloud:platform::site/70ef3a32-d0da-4e09-b35e-0109f91969c3"}}},"ApiErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}}},"ApiError":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for this particular occurrence of the error."},"code":{"type":"string","description":"The code of the error. It can be one of the following values: - ADMIN-UAM-400-1: Bad Request - ADMIN-UAM-400-2: Inactive user - ADMIN-UAM-400-3: Invalid Role for Resource - ADMIN-UAM-400-4: Product not licensed - ADMIN-UAM-401-1: Unauthenticated - ADMIN-UAM-401-2: Unauthorized - ADMIN-UAM-402-1: Payment Required - ADMIN-UAM-403-1: Forbidden - ADMIN-UAM-403-2: Not allowed to manage the org - ADMIN-UAM-404-1: Unknown Resource - ADMIN-UAM-404-2: Organization not found - ADMIN-UAM-404-3: Group Not Found - ADMIN-UAM-405-1: Method Not Supported - ADMIN-UAM-409-1: Cannot create default group - ADMIN-UAM-409-2: Resource Conflicts - ADMIN-UAM-409-3: Product License Limit Exceeded - ADMIN-UAM-415-1: Unsupported Media Type - ADMIN-UAM-500-1: Internal Error\n"},"status":{"type":"string","description":"The HTTP status code applicable to this error."},"title":{"type":"string","description":"Human-readable summary of the error."},"detail":{"type":"string","nullable":true,"description":"Human-readable explanation specific to this occurrence of the error, and a suggested action to resolve it."}}},"MultiDirectoryUserPage":{"type":"object","properties":{"data":{"type":"array","description":"A page of users.","items":{"$ref":"#/components/schemas/MultiDirectoryUser"}},"links":{"$ref":"#/components/schemas/LinkPageCursor"}}},"MultiDirectoryUser":{"type":"object","properties":{"accountId":{"type":"string","description":"Unique ID of the user's account.","example":"12345678-1234-1234-1234-123456789012"},"accountType":{"$ref":"#/components/schemas/AccountType"},"status":{"$ref":"#/components/schemas/Status"},"accountStatus":{"$ref":"#/components/schemas/AccountStatus"},"membershipStatus":{"$ref":"#/components/schemas/MembershipStatus"},"addedToOrg":{"type":"string","description":"The ISO-8601 date and time the user was first added to the organization.","example":"2024-01-01T00:00:00.000Z"},"name":{"type":"string","description":"The full name of the user.","example":"John Doe"},"nickname":{"type":"string","description":"The nickname of the user.","example":"Jonny"},"email":{"type":"string","description":"The email address of the user.","example":"email@example.com"},"emailVerified":{"type":"boolean","description":"The email verification status of the user. If true, the user verified their email after  creating their account.","example":true},"claimStatus":{"$ref":"#/components/schemas/ClaimStatus"},"platformRoles":{"type":"array","description":"The admin role IDs of the user. The role IDs are used to determine the permissions of the user.","items":{"$ref":"#/components/schemas/PlatformRole"}},"picture":{"type":"string","description":"The URL of the user's profile picture.","example":"https://picture.example.com/picture.png"},"avatar":{"type":"string","description":"The URL of the user's public avatar.","example":"https://avatar.example.com/avatar.png"},"counts":{"$ref":"#/components/schemas/UserCounts"},"links":{"$ref":"#/components/schemas/LinkSelfCursor"}}},"MultiDirectoryUserStats":{"type":"object","properties":{"roles":{"type":"array","description":"User counts associated with different role IDs.","items":{"$ref":"#/components/schemas/RoleIdCounts"}},"accountStatus":{"type":"array","description":"User counts associated with different account statuses.","items":{"$ref":"#/components/schemas/AccountStatusCounts"},"example":[{"status":"active","count":5},{"status":"inactive","count":1},{"status":"closed","count":2}]}}},"MultiDirectoryUserRoleAssignmentPage":{"type":"object","properties":{"data":{"type":"array","description":"A page of user role assignments.","items":{"$ref":"#/components/schemas/MultiDirectoryUserRoleAssignment"}},"links":{"$ref":"#/components/schemas/LinkPageCursor"}}},"MultiDirectoryUserRoleAssignment":{"type":"object","properties":{"resourceId":{"$ref":"#/components/schemas/ResourceId"},"resourceOwner":{"$ref":"#/components/schemas/ResourceOwner"},"roles":{"type":"array","description":"The list of role IDs the user has for that resource ID.","items":{"$ref":"#/components/schemas/RoleIds"}}}},"MultiDirectoryUserDirectoryPage":{"type":"object","properties":{"data":{"type":"array","description":"A page of user directory information.","items":{"$ref":"#/components/schemas/MultiDirectoryUserDirectory"},"example":[{"directoryId":"12345678-1234-1234-1234-123456789012","name":"Primary Directory"},{"directoryId":"12345678-1234-1234-1234-123456789013","name":"Secondary Directory"}]},"links":{"$ref":"#/components/schemas/LinkPageCursor"}}},"MultiDirectoryUserDirectory":{"type":"object","properties":{"directoryId":{"type":"string","description":"Unique directory identifier.","example":"12345678-1234-1234-1234-123456789012"},"name":{"type":"string","description":"The name of the directory.","example":"Primary Directory"}}},"MultiDirectoryGroupPage":{"type":"object","properties":{"data":{"type":"array","description":"A page of groups.","items":{"$ref":"#/components/schemas/MultiDirectoryGroup"}},"links":{"$ref":"#/components/schemas/LinkPageCursor"}}},"MultiDirectoryGroup":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the group.","example":"12345678-1234-1234-1234-123456789012"},"name":{"type":"string","description":"The group name.","example":"jira-administrators"},"description":{"type":"string","description":"The group description.","example":"This group provides admin access to Jira."},"directoryId":{"type":"string","description":"The ID of the directory.","example":"12345678-1234-1234-1234-123456789012"},"managementAccess":{"$ref":"#/components/schemas/ManagementAccess"},"externalSynced":{"type":"boolean","description":"Indication if group was created via IdP Sync.","example":true},"counts":{"$ref":"#/components/schemas/GroupCounts"},"links":{"$ref":"#/components/schemas/LinkSelfCursor"}}},"MultiDirectoryGroupDetails":{"type":"object","properties":{"data":{"type":"object","description":"Group detail information.","properties":{"id":{"type":"string","description":"Unique ID of the group.","example":"12345678-1234-1234-1234-123456789012"},"name":{"type":"string","description":"The group name.","example":"jira-administrators"},"description":{"type":"string","description":"The group description.","example":"This group provides admin access to Jira."},"directoryId":{"type":"string","description":"The ID of the directory.","example":"12345678-1234-1234-1234-123456789012"},"managementAccess":{"$ref":"#/components/schemas/ManagementAccess"},"externalSynced":{"type":"boolean","description":"Indication if group was created via IdP Sync.","example":true},"counts":{"type":"GroupCounts","$ref":"#/components/schemas/GroupCounts"},"links":{"$ref":"#/components/schemas/LinkSelfCursor"}}}}},"MultiDirectoryGroupStats":{"type":"object","properties":{"types":{"type":"array","description":"Group counts associated with different group types.","items":{"$ref":"#/components/schemas/GroupTypeCounts"}},"totals":{"$ref":"#/components/schemas/GroupTotalCounts"}}},"MultiDirectoryGroupRoleAssignmentPage":{"type":"object","properties":{"data":{"type":"array","description":"A page of group role assignments.","items":{"$ref":"#/components/schemas/MultiDirectoryGroupRoleAssignment"}},"links":{"$ref":"#/components/schemas/LinkPageCursor"}}},"MultiDirectoryGroupRoleAssignment":{"type":"object","description":"The role assignment for the group.","properties":{"resourceId":{"$ref":"#/components/schemas/ResourceId"},"resourceOwner":{"$ref":"#/components/schemas/ResourceOwner"},"roles":{"type":"array","description":"Contains a list of roles the group has for that resource ID.","items":{"$ref":"#/components/schemas/RoleIds"},"example":["atlassian/user","atlassian/admin"]}}},"ResourceOwner":{"type":"string","description":"The resource owner of the product.","example":"jira-core"},"ResourceId":{"type":"string","description":"The resource ID from the role assignment relationship. The resource ID is in the Atlassian  Resource Identifier (ARI) format.","example":"ari:cloud:jira-core::site/1"},"RoleIds":{"type":"array","items":{"type":"string"},"description":"A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization.","example":["atlassian/org-admin","atlassian/site-admin"]},"ClaimStatus":{"type":"string","description":"The claim status for the user account.\n  - `managed` - Returns only managed accounts. For more on managed accounts: https://support.atlassian.com/user-management/docs/what-are-managed-accounts/.\n  - `unmanaged` - Returns only unmanaged accounts.","enum":["managed","unmanaged"],"example":"unmanaged"},"PlatformRole":{"type":"string","enum":["atlassian/org-admin","atlassian/site-admin","atlassian/user-access-admin"],"example":["atlassian/org-admin"]},"AccountType":{"type":"string","description":"The type of account.","enum":["atlassian"],"example":"atlassian"},"Status":{"type":"string","description":"The status for the user account. This status is a composite of `accountStatus` and `membershipStatus`.\n  - `active` - `accountStatus` is `active` and `membershipStatus` is `active`.\n  - `suspended` - `accountStatus` is `active` and `membershipStatus` is `suspended`.\n  - `not_invited` - `accountStatus` is `active` and `membershipStatus` is `no_membership`.\n  - `deactivated` - `accountStatus` is `inactive`.","enum":["active","suspended","not_invited","deactivated"],"example":"active"},"AccountStatus":{"type":"string","description":"The lifecycle status of the account.\n  - `active` - The account is active and can be used.\n  - `inactive` - The account is inactive and doesn't have access to any resources.\n  - `closed` - The account is closed and can't be used.","enum":["active","inactive","closed"],"example":"active"},"AccountStatusCounts":{"properties":{"status":{"$ref":"#/components/schemas/AccountStatus"},"count":{"type":"integer","description":"The number of accounts with the associated status."}}},"MembershipStatus":{"type":"string","description":"The membership status is the status of the user account in the organization.\n  - `active` - the account has an active membership for one or more directories within the organization.\n  - `suspended` - the account is suspended in all directories within the organization, to which the requestor has permission to access.\n  - `no_membership` - the account is in none of the organization’s directories.","enum":["active","suspended","no_membership"]},"GroupCounts":{"type":"object","description":"The number of objects associated with the group.","properties":{"users":{"type":"integer","description":"The number of users that belong to the group.","example":10},"resources":{"type":"integer","description":"The number of resources the group has roles assigned to, linked to the  directories the requestor can manage."}}},"RoleId":{"type":"string","description":"The list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within  the organization. The allowed roles are:\n   - `atlassian/user` - Can access the product, with no product admin permissions\n   - `atlassian/admin` - Can access the product, with product admin permissions\n   - `atlassian/guest` - Can only access one space you or space admins specify\n   - `atlassian/customer` - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable)\n   - `atlassian/user-access-admin` - No product access. Can administer users and groups for this product in Atlassian Administration\n   - `atlassian/contributor` - Can access the product to view, comment, and vote only (non-billable)\n   - `atlassian/basic` - Can access basic product features, with no product admin permissions (non-billable)\n   - `atlassian/stakeholder` - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans\n   - `atlassian/org-admin` - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration\n   - `atlassian/site-admin` - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering.","enum":["atlassian/user","atlassian/admin","atlassian/guest","atlassian/customer","atlassian/user-access-admin","atlassian/contributor","atlassian/basic","atlassian/stakeholder","atlassian/org-admin","atlassian/site-admin"]},"RoleIdCounts":{"type":"object","properties":{"roleId":{"type":"string","description":"The ID of the role.","example":"atlassian/org-admin"},"count":{"type":"integer","description":"The number of users with this role.","example":3}}},"UserCounts":{"type":"object","description":"The number of objects associated with the user.","properties":{"resources":{"type":"integer","description":"The number of resources the user has roles assigned to, linked to the directories the requestor can manage.","example":10}}},"GroupType":{"type":"string","description":"The group type.","enum":["GROUP"]},"GroupTypeCounts":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/GroupType"},"count":{"type":"integer","description":"The number of groups of this type in the organization.","example":10}}},"GroupTotalCounts":{"type":"object","description":"Total group counts across the organization.","properties":{"all":{"type":"integer","description":"The total number of groups in the organization.","example":10},"synced":{"type":"integer","description":"The total number of groups that are synced with an identity provider.","example":4}}},"ManagementAccess":{"type":"object","description":"Management access for the group. This is used to determine if the group can be deleted or modified.","properties":{"deletable":{"type":"boolean","description":"If true, the group can be deleted.","example":true},"modifiable":{"type":"boolean","description":"If true, the group can be modified."}}},"LinkSelfCursor":{"type":"object","description":"Links for a resource with a self cursor, for use in a cursor parameter.","properties":{"self":{"type":"string","description":"Cursor to fetch this resource.","example":"ECg53CukK1twBo0LK1u9nw"}}},"LinkPageCursor":{"type":"object","description":"Links for a paginated response, for use in a cursor parameter.","properties":{"self":{"type":"string","description":"Cursor to fetch this page.","example":"ObSbZxpM1f1fzia2_GnuJw"},"prev":{"type":"string","description":"Cursor to fetch the previous page.","example":"LIZFEbzCT2pCCkQhPIUgIQ"},"next":{"type":"string","description":"Cursor to fetch the next page.","example":"kloHX1ZQVasDAkx_P48NYQ"}}},"Errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","properties":{"id":{"type":"string","example":"<string>"},"status":{"type":"string","example":"<string>"},"code":{"type":"string","example":"<string>"},"title":{"type":"string","example":"<string>"},"detail":{"type":"string","example":"<string>"}}}},"parameters":{"orgIdParam":{"name":"orgId","in":"path","description":"Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.","required":true,"schema":{"type":"string"}},"accountIdParam":{"name":"accountId","in":"path","description":"Unique ID associated with a user account.","required":true,"schema":{"type":"string"}},"accountIdDirectoriesParam":{"name":"accountId","in":"query","description":"Filters the results to only the directories where the specified user is a member.","schema":{"type":"string"}},"groupIdParam":{"name":"groupId","in":"path","description":"Unique ID associated with a group.","required":true,"schema":{"type":"string"}},"directoryIdParam":{"name":"directoryId","in":"path","description":"Unique ID associated with a directory. The `-` character can be used to increase the operation scope  to all directories the requestor has permission to manage.","required":true,"schema":{"type":"string"}},"cursorParam":{"name":"cursor","in":"query","description":"Sets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.","schema":{"type":"string"},"example":"Qh8E1QpVV00ys/xI7pHI7Q.."},"limitParam":{"name":"limit","in":"query","description":"The desired number of results for the search request.","schema":{"type":"integer","default":20,"minimum":1,"maximum":100},"example":20},"groupTypesParam":{"name":"types","in":"query","schema":{"type":"array","items":{"type":"string","enum":["GROUP"]},"minItems":1,"maxItems":2}},"accountIdsParam":{"name":"accountIds","in":"query","description":"A list of user account IDs.","schema":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":10}},"directoryIdsParam":{"name":"directoryIds","in":"query","description":"A list of directory IDs. The requestor must have permissions to  administer resources linked to these directories.","schema":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":10}},"resourceOwnersParam":{"name":"resourceOwners","in":"query","description":"The list of resource owners to filter the results by. Used to identify resources using their owner to which the user has at least one role assigned to.","schema":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":10}},"resourceIdsParam":{"name":"resourceIds","in":"query","description":"A list of resource IDs. The resource IDs should be specified  using the Atlassian Resource Identifier (ARI) format. Example ARI: `ari:cloud:jira-core::site/1`","schema":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":10}},"groupIdsParam":{"name":"groupIds","in":"query","description":"A list of group IDs.","schema":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":10}},"claimStatusParam":{"name":"claimStatus","in":"query","description":"The claim status for the user account. By default, both `managed` and `unmanaged` accounts are returned.\n  - `managed` - Returns only managed accounts. For more on managed accounts: https://support.atlassian.com/user-management/docs/what-are-managed-accounts/\n  - `unmanaged` - Returns only unmanaged accounts.","schema":{"type":"string","enum":["managed","unmanaged"]}},"statusParam":{"name":"status","in":"query","description":"The status for the user account. This status is a composite of `accountStatus` and `membershipStatus`.\n  - `active` - `accountStatus` is `active` and `membershipStatus` is `active`.\n  - `suspended` - `accountStatus` is `active` and `membershipStatus` is `suspended`.\n  - `not_invited` - `accountStatus` is `active` and `membershipStatus` is `no_membership`.\n  - `deactivated` - `accountStatus` is `inactive`.","schema":{"type":"array","items":{"type":"string","enum":["active","suspended","not_invited","deactivated"]},"minItems":1,"maxItems":4}},"accountStatusParam":{"name":"accountStatus","in":"query","description":"The lifecycle status of the account.\n  - `active` - The account is active and can be used.\n  - `inactive` - The account is inactive and doesn't have access to any resources.\n  - `closed` - The account is closed and can't be used.","schema":{"type":"array","items":{"type":"string","enum":["active","inactive","closed"]},"minItems":1,"maxItems":3}},"membershipStatusParam":{"name":"membershipStatus","in":"query","description":"A list of membership statuses. The membership status is the status of the user account in the organization.\n  - `active` - the account has an active membership for one or more directories within the organization.\n  - `suspended` - the account is suspended in ALL directories within the organization, to which the requestor has permission to access.\n  - `no_membership` - the account is in NONE of the organization’s directories.","schema":{"type":"array","items":{"type":"string","enum":["active","suspended","no_membership"]},"minItems":1,"maxItems":3}},"roleIdsParam":{"name":"roleIds","in":"query","description":"A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within  the organization. The allowed roles are:\n   - `atlassian/user` - Can access the product, with no product admin permissions\n   - `atlassian/admin` - Can access the product, with product admin permissions\n   - `atlassian/guest` - Can only access one space you or space admins specify\n   - `atlassian/customer` - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable)\n   - `atlassian/user-access-admin` - No product access. Can administer users and groups for this product in Atlassian Administration\n   - `atlassian/contributor` - Can access the product to view, comment, and vote only (non-billable)\n   - `atlassian/basic` - Can access basic product features, with no product admin permissions (non-billable)\n   - `atlassian/stakeholder` - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans\n   - `atlassian/org-admin` - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration\n   - `atlassian/site-admin` - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering.","schema":{"type":"array","items":{"type":"string","enum":["atlassian/user","atlassian/admin","atlassian/guest","atlassian/customer","atlassian/user-access-admin","atlassian/contributor","atlassian/basic","atlassian/stakeholder","atlassian/org-admin","atlassian/site-admin"]},"minItems":1,"maxItems":10}},"searchTermParam":{"name":"searchTerm","in":"query","description":"A search term to search the `nickname` and `email` fields.","schema":{"type":"string"}},"searchTermDirectoriesParam":{"name":"searchTerm","in":"query","description":"A search term to search the `name` field.","schema":{"type":"string"}},"searchTermGroupParam":{"name":"searchTerm","in":"query","description":"A search term to search the `name` field.","schema":{"type":"string"}},"emailDomainsParam":{"name":"emailDomains","in":"query","description":"The email domain to filter the results. The email domain will be used to search against the  account email domain. For example, get all users with the `@atlassian.com` or `@example.com` email domain.","schema":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":10}},"userSortByParam":{"name":"sortBy","in":"query","description":"The field and direction to sort the results by. Currently, only a single field can be sorted by. If `null`, the default sorting will be used.","schema":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"object","required":["field","direction"],"properties":{"field":{"type":"string","description":"The name of the field to sort the results by.","default":"nick_name","enum":["nick_name","email"]},"direction":{"type":"string","description":"The direction to sort the results by.","default":"asc","enum":["asc","desc"]}}}}},"groupCountsParam":{"name":"counts","in":"query","description":"Whether to include counts of different objects associated with the group.","schema":{"type":"object","properties":{"includeResources":{"type":"boolean","description":"Whether to include the number of resources associated with the group."},"includeUsers":{"type":"boolean","description":"Whether to include the number of users associated with the group."}}}},"groupSortByParam":{"name":"sortBy","in":"query","description":"The field and direction to sort the results by. Currently, only a single field can be sorted by. If `null`, the default sorting will be used.","schema":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"object","required":["field","direction"],"properties":{"field":{"type":"string","description":"The name of the field to sort the results by.","default":"name","enum":["name","description"]},"direction":{"type":"string","description":"The direction to sort the results by.","default":"asc","enum":["asc","desc"]}}}}}}}}