Rate this page:
GET /users/{account_id}/manage
Returns the set of permissions you have for managing the specified Atlassian account
string
The user account to manage
[a-zA-Z0-9_|:-]{1,128}
Array<string>
Valid values: profile
, profile.write
, profile.read
, email.set
, lifecycle.enablement
, apiToken.read
, apiToken.delete
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/users/{account_id}/manage' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'
You have permission to manage at least some aspect of the specified user account. Restrictions around the privileges specified are returned.
Content type | Value |
---|---|
application/json |
GET /users/{account_id}/manage/profile
Returns information about a single Atlassian account by ID
string
The ID of the user
[a-zA-Z0-9_|:-]{1,128}
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/users/{account_id}/manage/profile' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'
You have permission to manage the user. The profile data is returned.
Content type | Value |
---|---|
application/json |
PATCH /users/{account_id}/manage/profile
Updates fields in a user account. The profile.write
privilege details which fields you can change.
string
The ID of the user to update
[a-zA-Z0-9_|:-]{1,128}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
curl --request PATCH \
--url 'https://api.atlassian.com/users/{account_id}/manage/profile' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Lila User",
"nickname": "marshmallow",
"zoneinfo": "America/Los_Angeles",
"locale": "en-US",
"extended_profile": {
"job_title": "Lead Investigator",
"organization": "Amalgamated Investigations",
"department": "Investigations",
"location": "Lompoc, CA"
}
}'
You have permission to manage the user. The profile is updated.
Content type | Value |
---|---|
application/json |
PUT /users/{account_id}/manage/email
Sets the specified user's email address. Before using this endpoint, you must verify the target domain as the new email address will be considered verified.
The permission to make use of this resource is exposed by the email.set
privilege.
This call invalidates all active sessions.
string
The ID of the user
[a-zA-Z0-9_|:-]{1,128}
string
The email address of the user.
Constraints
partMaxLength
: The maximum length of the user part and of any
subdomain is 255 characters.validCharacters
: Control and null characters are not allowed1 2 3 4 5 6 7
curl --request PUT \
--url 'https://api.atlassian.com/users/{account_id}/manage/email' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "vmars@marsinvestigations.com"
}'
Everything went fine, nothing to return.
GET /users/{accountId}/manage/api-tokens
Gets the API tokens owned by the specified user.
string
The ID of the user
[a-zA-Z0-9_|:-]{1,128}
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/users/{accountId}/manage/api-tokens' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<anything> |
DELETE /users/{accountId}/manage/api-tokens/{tokenId}
Deletes a specifid API token by ID.
string
The ID of the user
[a-zA-Z0-9_|:-]{1,128}
string
The ID of the API token
1 2 3
curl --request DELETE \
--url 'https://api.atlassian.com/users/{accountId}/manage/api-tokens/{tokenId}' \
--header 'Authorization: Bearer <access_token>'
The API token was deleted
POST /users/{account_id}/manage/lifecycle/disable
Disables the specified user account. The permission to make use of this resource is exposed by the lifecycle.enablement
privilege.
You can optionally set a message associated with the block that will be shown to the user on attempted authentication. If none is supplied, a default message will be used.
string
The ID of the user
[a-zA-Z0-9_|:-]{1,128}
string
1 2 3 4 5 6 7
curl --request POST \
--url 'https://api.atlassian.com/users/{account_id}/manage/lifecycle/disable' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"message": "On 6-month suspension"
}'
Everything went fine, nothing to return.
POST /users/{account_id}/manage/lifecycle/enable
Enables the specified user account. The permission to make use of this resource is exposed by the lifecycle.enablement
privilege.
You can optionally set a message associated with the block that will be shown to the user on attempted authentication. If none is supplied, a default message will be used.
string
The unique identifier of the user to enable.
[a-zA-Z0-9_|:-]{1,128}
1 2 3
curl --request POST \
--url 'https://api.atlassian.com/users/{account_id}/manage/lifecycle/enable' \
--header 'Authorization: Bearer <access_token>'
Everything went fine, nothing to return.
Rate this page: