Atlassian Users API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 17 JSON Schema definitions.
Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.
This API exposes
37 operations
across 32 paths,
and defines 78 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 4 base URLs: https://api.atlassian.com, https://api.bitbucket.org/2.0, //your-domain.atlassian.net, https://your-domain.atlassian.net.
37 operations32 paths78 schemas3 DELETE25 GET8 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Atlassian Users API declares
7 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (API Key) (bearerAuth).
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 7 scopes.
It accepts HTTP basic authentication (basic).
An API key is passed in the header as Authorization (api_key).
It accepts HTTP basic authentication (basicAuth).
It supports OAuth 2.0 (oAuthDefinitions) using the authorizationCode flow, exposing 73 scopes.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes.
bearerAuth — Use an Atlassian API key as a Bearer token. Create API keys at https://admin.atlassian.com.
oauth2 — OAuth 2.0 authorization for Atlassian Cloud APIs.
basic — Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username a…
api_key — API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only availa…
basicAuth — You can access this resource via basic auth.
oAuthDefinitions — This API uses OAuth 2 with the authorizationCode grant flow.
OAuth2 — OAuth2 scopes for Jira
Paths & Operations 37
Across 32 paths, the API surfaces 37 operations — 3 DELETE, 25 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are Content (20 properties), Space (17 properties), User_2 (17 properties), BulkUserLookup (16 properties). Each schema is shown below with its type and property counts.
UserPage
object
A paginated list of users.
2 properties
InviteUsersRequest
object
Request body for inviting users to the organization.
4 properties
PaginationLinks
object
Links for cursor-based pagination.
3 properties
RoleAssignment
object
Represents a role assignment for a user.
2 properties
InviteUsersResponse
object
Response for user invitation requests.
1 property
RoleAssignmentRequest
object
Request body for assigning or revoking product roles.
1 property
ErrorResponse
object
Standard error response.
3 properties
User
object
Represents a user account in an Atlassian organization.
10 properties
OrgRoleAssignmentRequest
object
Request body for assigning or revoking organization-level roles.
1 property
error
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
2 properties1 required
account_links
object
Links related to an Account.
1 property
link
object
A link to a resource related to this object.
2 properties
object
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
1 property1 required
account
ContentLookAndFeel
object
4 properties
GenericAccountId
stringnull
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
ContentBody
object
7 properties2 required
HeaderLookAndFeel
object
5 properties5 required
ContentArray
object
5 properties3 required
SearchFieldLookAndFeel
objectnull
2 properties2 required
ButtonLookAndFeel
objectnull
2 properties2 required
GenericUserKey
stringnull
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
ScreenLookAndFeel
object
15 properties1 required
HorizontalHeaderLookAndFeel
object
5 properties2 required
Embeddable
object
Icon
objectnull
This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.
4 properties4 required
SpaceSettings
objectnull
4 properties2 required
ContentRestriction
object
5 properties3 required
AccountIdEmailRecord
object
2 properties2 required
ContentChildren
object
5 properties
TopNavigationLookAndFeel
object
3 properties1 required
Group
object
4 properties3 required
SuperBatchWebResources
object
4 properties
UsersUserKeys
objectnull
3 properties1 required
GenericUserName
stringnull
This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the [deprecation notice](/cloud/confluence/dep…
Label
object
4 properties4 required
Content
objectnull
Base object for all content types.
20 properties2 required
Space
objectnull
17 properties6 required
Theme
object
5 properties1 required
Container
objectnull
Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)
LookAndFeel
object
8 properties6 required
EmbeddedContent
object
3 properties
GroupArray
object
4 properties4 required
OperationCheckResult
object
An operation and the target entity that it applies to, e.g. create page.
2 properties2 required
BulkUserLookup
object
16 properties9 required
UserAnonymous
object
7 properties4 required
GroupArrayWithLinks
object
Same as GroupArray but with links property.
6 properties5 required
LabelArray
object
5 properties2 required
SpaceDescription
object
3 properties3 required
MenusLookAndFeel
object
2 properties2 required
User_2
objectnull
17 properties1 required
SpacePermission
object
This object represents a permission for given space. Permissions consist of at least one operation object with an accompanying subjects object. The following c…
5 properties3 required
ContentHistory
objectnull
11 properties1 required
GenericLinks
object
ContentMetadata
object
Metadata object for page, blogpost, comment content
4 properties
WebResourceDependencies
object
6 properties
AccountIdEmailRecordArray
array
UserDetails
object
2 properties
ContainerLookAndFeel
objectnull
12 properties6 required
BulkUserLookupArray
object
5 properties5 required
Version
objectnull
14 properties3 required
ContentChildType
object
Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.
4 properties
UserArray
object
6 properties1 required
NavigationLookAndFeel
objectnull
3 properties2 required
AvatarUrlsBean
object
4 properties
ColumnItem
object
Details of an issue navigator column item.
2 properties
UnrestrictedUserEmail
object
2 properties
UserColumnRequestBody
object
1 property
ListWrapperCallbackGroupName
object
SimpleListWrapperApplicationRole
object
5 properties
ListWrapperCallbackApplicationRole
object
NewUserDetails
object
The user details.
8 properties1 required
GroupName
object
Details about a group.
3 properties
PageBeanUser
object
A page of items.
7 properties
ApplicationRole
object
Details of an application role.
14 properties
User_3
object
A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: T…
14 properties
SimpleListWrapperGroupName
object
5 properties
UserMigrationBean
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Atlassian Users API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
