UserCreate

Properties required when creating a new user.

AuthenticationAuthorizationIdentityMicrosoftMicrosoft EntraOAuthOpenID ConnectSAMLSCIMSingle Sign-OnZero Trust

Properties

Name Type Description
accountEnabled boolean True if the account should be enabled.
displayName string The name to display in the address book.
mailNickname string The mail alias for the user.
userPrincipalName string The user principal name ([email protected]).
passwordProfile object
givenName string
surname string
jobTitle string
department string
usageLocation string
city string
country string
mobilePhone string
businessPhones array
View JSON Schema on GitHub

JSON Schema

microsoft-azure-active-directory-usercreate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserCreate",
  "title": "UserCreate",
  "type": "object",
  "description": "Properties required when creating a new user.",
  "required": [
    "accountEnabled",
    "displayName",
    "mailNickname",
    "userPrincipalName",
    "passwordProfile"
  ],
  "properties": {
    "accountEnabled": {
      "type": "boolean",
      "description": "True if the account should be enabled.",
      "example": true
    },
    "displayName": {
      "type": "string",
      "description": "The name to display in the address book.",
      "example": "example_value"
    },
    "mailNickname": {
      "type": "string",
      "description": "The mail alias for the user.",
      "example": "example_value"
    },
    "userPrincipalName": {
      "type": "string",
      "description": "The user principal name ([email protected]).",
      "example": "example_value"
    },
    "passwordProfile": {
      "$ref": "#/components/schemas/PasswordProfile"
    },
    "givenName": {
      "type": "string",
      "example": "example_value"
    },
    "surname": {
      "type": "string",
      "example": "example_value"
    },
    "jobTitle": {
      "type": "string",
      "example": "example_value"
    },
    "department": {
      "type": "string",
      "example": "example_value"
    },
    "usageLocation": {
      "type": "string",
      "example": "example_value"
    },
    "city": {
      "type": "string",
      "example": "example_value"
    },
    "country": {
      "type": "string",
      "example": "example_value"
    },
    "mobilePhone": {
      "type": "string",
      "example": "example_value"
    },
    "businessPhones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": []
    }
  }
}