Atlassian · Schema

BulkUserLookup

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
type	string
username	object
userKey	object
accountId	object
accountType	string	The account type of the user, may return empty string if unavailable.
email	string	The email address of the user. Depending on the user's privacy setting, this may return an empty string.
publicName	string	The public name or nickname of the user. Will always contain a value.
profilePicture	object
displayName	string	The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.
timeZone	string	This displays user time zone. Depending on the user's privacy setting, this may return null.
isExternalCollaborator	boolean	Whether the user is an external collaborator user
operations	array
details	object
personalSpace	object
_expandable	object
_links	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BulkUserLookup",
  "title": "BulkUserLookup",
  "required": [
    "_expandable",
    "_links",
    "accountId",
    "accountType",
    "displayName",
    "email",
    "profilePicture",
    "publicName",
    "type"
  ],
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "known",
        "unknown",
        "anonymous",
        "user"
      ]
    },
    "username": {
      "$ref": "#/components/schemas/GenericUserName"
    },
    "userKey": {
      "$ref": "#/components/schemas/GenericUserKey"
    },
    "accountId": {
      "$ref": "#/components/schemas/GenericAccountId"
    },
    "accountType": {
      "type": "string",
      "description": "The account type of the user, may return empty string if unavailable."
    },
    "email": {
      "type": "string",
      "description": "The email address of the user. Depending on the user's privacy setting, this may return an empty string."
    },
    "publicName": {
      "type": "string",
      "description": "The public name or nickname of the user. Will always contain a value."
    },
    "profilePicture": {
      "$ref": "#/components/schemas/Icon"
    },
    "displayName": {
      "type": "string",
      "description": "The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName."
    },
    "timeZone": {
      "nullable": true,
      "type": "string",
      "description": "This displays user time zone. Depending on the user's privacy setting, this may return null."
    },
    "isExternalCollaborator": {
      "type": "boolean",
      "description": "Whether the user is an external collaborator user"
    },
    "operations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OperationCheckResult"
      }
    },
    "details": {
      "$ref": "#/components/schemas/UserDetails"
    },
    "personalSpace": {
      "$ref": "#/components/schemas/Space"
    },
    "_expandable": {
      "type": "object",
      "properties": {
        "operations": {
          "type": "string"
        },
        "details": {
          "type": "string"
        },
        "personalSpace": {
          "type": "string"
        }
      }
    },
    "_links": {
      "$ref": "#/components/schemas/GenericLinks"
    }
  }
}