ATatlassian
Service Account
preview

Create a service account

Changed on

Creates a new service account for the specified organization. The service account is created with the given display name and optional description, then invited with the specified permission rules and optional additional group memberships.

Scopes

OAuth 2.0 scopes required: write:service-accounts:admin

post/orgs/{orgId}/service-accounts

Request

  • Base URL
    https://api.atlassian.com/admin/api-access/v1
  • URL
    https://api.atlassian.com/admin/api-access/v1/orgs/{orgId}/service-accounts
  • Auth
    none declared

Path parameters

orgIdstring required

Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.

Request body

displayNamestring required

The display name for the service account. Must be between 6 and 30 characters.

descriptionstring

An optional description for the service account.

Response

Returned if the service account is successfully created.

atlassianIdstring required

The Atlassian account ID of the created service account.

idstring required

The unique identifier of the created service account. Same value as atlassianId.

emailstring

The email address assigned to the created service account.

displayNamestring required

The display name of the created service account.

containerstring

The ARI of the organization the service account belongs to. e.g. ari:cloud:platform::org/{orgId}

updatedAtinteger

The timestamp (in milliseconds since epoch) when the service account was last updated.

statusstring required

The status of the service account.

Example response

{
  "updatedAt": 1763149545609
}

Changes