api_password_v1_MigrateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_password_v1_MigrateRequest",
  "title": "api_password_v1_MigrateRequest",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address of the end user."
    },
    "hash": {
      "type": "string",
      "description": "The password hash. For a Scrypt or PBKDF2 hash, the hash needs to be a base64 encoded string."
    },
    "hash_type": {
      "$ref": "#/components/schemas/api_password_v1_MigrateRequestHashType",
      "description": "The password hash used. Currently `bcrypt`, `scrypt`, `argon_2i`, `argon_2id`, `md_5`, `sha_1`, `sha_512`, and `pbkdf_2` are supported."
    },
    "md_5_config": {
      "$ref": "#/components/schemas/api_password_v1_MD5Config",
      "description": "Optional parameters for MD-5 hash types."
    },
    "argon_2_config": {
      "$ref": "#/components/schemas/api_password_v1_Argon2Config",
      "description": "Required parameters if the argon2 hex form, as opposed to the encoded form, is supplied."
    },
    "sha_1_config": {
      "$ref": "#/components/schemas/api_password_v1_SHA1Config",
      "description": "Optional parameters for SHA-1 hash types."
    },
    "sha_512_config": {
      "$ref": "#/components/schemas/api_password_v1_SHA512Config",
      "description": "Optional parameters for SHA-512 hash types."
    },
    "scrypt_config": {
      "$ref": "#/components/schemas/api_password_v1_ScryptConfig",
      "description": "Required parameters if the scrypt is not provided in a [PHC encoded form](https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md#phc-string-format)."
    },
    "pbkdf_2_config": {
      "$ref": "#/components/schemas/api_password_v1_PBKDF2Config",
      "description": "Required additional parameters for PBKDF2 hash keys."
    },
    "trusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "The `trusted_metadata` field contains an arbitrary JSON object of application-specific data. See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details."
    },
    "untrusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details."
    },
    "set_email_verified": {
      "type": "boolean",
      "description": "Whether to set the user's email as verified. This is a dangerous field, incorrect use may lead to users getting erroneously\n                deduplicated into one User object. This flag should only be set if you can attest that the user owns the email address in question.\n                "
    },
    "name": {
      "$ref": "#/components/schemas/api_user_v1_Name",
      "description": "The name of the user. Each field in the name object is optional."
    },
    "phone_number": {
      "type": "string",
      "description": "The phone number of the user. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX)."
    },
    "set_phone_number_verified": {
      "type": "boolean",
      "description": "Whether to set the user's phone number as verified. This is a dangerous field, this flag should only be set if you can attest that\n   the user owns the phone number in question."
    },
    "external_id": {
      "type": "string",
      "description": "If a new user is created, this will set an identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters."
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Roles to explicitly assign to this User.\n   See the [RBAC guide](https://stytch.com/docs/guides/rbac/role-assignment) for more information about role assignment."
    }
  },
  "description": "Request type",
  "required": [
    "email",
    "hash",
    "hash_type"
  ]
}