Atlassian · Schema

UserBean

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
accountId string The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
active boolean Whether the user is active.
avatarUrls object The avatars of the user.
displayName string The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
key string This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migrat
name string This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migrat
self string The URL of the user.
View JSON Schema on GitHub

JSON Schema

atlassian-userbean-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserBean",
  "title": "UserBean",
  "additionalProperties": false,
  "properties": {
    "accountId": {
      "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
      "maxLength": 128,
      "type": "string"
    },
    "active": {
      "description": "Whether the user is active.",
      "type": "boolean"
    },
    "avatarUrls": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserBeanAvatarUrls"
        }
      ],
      "description": "The avatars of the user."
    },
    "displayName": {
      "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.",
      "type": "string"
    },
    "key": {
      "description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.  \nThe key of the user.",
      "type": "string"
    },
    "name": {
      "description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.  \nThe username of the user.",
      "type": "string"
    },
    "self": {
      "description": "The URL of the user.",
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}