Returns details for the current user.
required: Permission to access Jira.
643 matches
100 actions
The Jira Cloud platform REST
100 actions
Other/The Jira Cloud platform REST
Returns details for the current user.
required: Permission to access Jira.
{
"type": "object",
"properties": {
"expand": {
"type": "string"
}
},
"additionalProperties": false
}{
"type": "object",
"description": "A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
"properties": {
"accountId": {
"type": "string",
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests."
},
"accountType": {
"type": "string",
"description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"enum": [
"atlassian",
"app",
"customer",
"unknown"
]
},
"active": {
"type": "boolean",
"description": "Whether the user is active."
},
"applicationRoles": {
"description": "The application roles the user is assigned to.",
"type": "object"
},
"avatarUrls": {
"description": "The avatars of the user.",
"type": "object"
},
"displayName": {
"type": "string",
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value."
},
"emailAddress": {
"type": "string",
"description": "The email address of the user. Depending on the user’s privacy setting, this may be returned as null."
},
"expand": {
"type": "string",
"description": "Expand options that include additional user details in the response."
},
"groups": {
"description": "The groups that the user belongs to.",
"type": "object"
},
"key": {
"type": "string",
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"locale": {
"type": "string",
"description": "The locale of the user. Depending on the user’s privacy setting, this may be returned as null."
},
"name": {
"type": "string",
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the user."
},
"timeZone": {
"type": "string",
"description": "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null."
}
},
"additionalProperties": false
}