Atlassian · Schema

Avatar

Details of an avatar.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
fileName string The file name of the avatar icon. Returned for system avatars.
id string The ID of the avatar.
isDeletable boolean Whether the avatar can be deleted.
isSelected boolean Whether the avatar is used in Jira. For example, shown as a project's avatar.
isSystemAvatar boolean Whether the avatar is a system avatar.
owner string The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for
urls object The list of avatar icon URLs.
View JSON Schema on GitHub

JSON Schema

atlassian-avatar-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Avatar",
  "title": "Avatar",
  "additionalProperties": true,
  "description": "Details of an avatar.",
  "properties": {
    "fileName": {
      "description": "The file name of the avatar icon. Returned for system avatars.",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the avatar.",
      "type": "string"
    },
    "isDeletable": {
      "description": "Whether the avatar can be deleted.",
      "readOnly": true,
      "type": "boolean"
    },
    "isSelected": {
      "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.",
      "readOnly": true,
      "type": "boolean"
    },
    "isSystemAvatar": {
      "description": "Whether the avatar is a system avatar.",
      "readOnly": true,
      "type": "boolean"
    },
    "owner": {
      "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.",
      "readOnly": true,
      "type": "string"
    },
    "urls": {
      "additionalProperties": {
        "format": "uri",
        "readOnly": true,
        "type": "string"
      },
      "description": "The list of avatar icon URLs.",
      "readOnly": true,
      "type": "object"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}