Atlassian · Schema

NewUserDetails

The user details.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
applicationKeys array Deprecated, do not use.
displayName string This property is no longer available. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up
emailAddress string The email address for the user.
key string This property is no longer available. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
name string This property is no longer available. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
password string This property is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an
products array Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. If left empty, the user will get default product access. To create a user w
self string The URL of the user.
View JSON Schema on GitHub

JSON Schema

atlassian-newuserdetails-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NewUserDetails",
  "title": "NewUserDetails",
  "additionalProperties": true,
  "description": "The user details.",
  "properties": {
    "applicationKeys": {
      "description": "Deprecated, do not use.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "displayName": {
      "description": "This property is no longer available. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.",
      "type": "string"
    },
    "emailAddress": {
      "description": "The email address for the user.",
      "type": "string"
    },
    "key": {
      "description": "This property is no longer available. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "type": "string"
    },
    "name": {
      "description": "This property is no longer available. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "type": "string"
    },
    "password": {
      "description": "This property is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.",
      "type": "string"
    },
    "products": {
      "description": "Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. If left empty, the user will get default product access. To create a user without product access, set this field to be an empty array.",
      "items": {
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    },
    "self": {
      "description": "The URL of the user.",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "emailAddress"
  ],
  "type": "object"
}