ATatlassian
Service Account
preview

Update a service account

Changed on

Updates a service account's display name and/or description within the specified organization.

Scopes

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

patch/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

atlassianIdstring required

The Atlassian account ID of the service account to update.

displayNamestring

The updated display name for the service account.

descriptionstring

The updated description for the service account.

Response

Returned if the service account is successfully updated.

atlassianIdstring required

The Atlassian account ID of the service account.

idstring required

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

emailstring

The email address of the service account.

displayNamestring required

The display name of the service account.

picturestring nullable

The URL of the service account's avatar image.

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.

createdByIdstring nullable

The account ID of the user who created the service account.

descriptionstring nullable

The description of the service account.

Example response

{
  "updatedAt": 1764642980899
}

Changes