api_b2b_password_v1_MigrateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_password_v1_MigrateRequest",
  "title": "api_b2b_password_v1_MigrateRequest",
  "type": "object",
  "properties": {
    "email_address": {
      "type": "string",
      "description": "The email address of the Member."
    },
    "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_b2b_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."
    },
    "organization_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience."
    },
    "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**."
    },
    "pbkdf_2_config": {
      "$ref": "#/components/schemas/api_password_v1_PBKDF2Config",
      "description": "Required additional parameters for PBKDF2 hash keys. Note that we use the SHA-256 by default, please contact [[email protected]](mailto:[email protected]) if you use another hashing function."
    },
    "name": {
      "type": "string",
      "description": "The name of the Member. Each field in the name object is optional."
    },
    "trusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "An arbitrary JSON object for storing application-specific data or identity-provider-specific data."
    },
    "untrusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "An arbitrary JSON object of application-specific data. These fields can be edited directly by the\n  frontend SDK, and should not be used to store critical information. See the [Metadata resource](https://stytch.com/docs/b2b/api/metadata)\n  for complete field behavior details."
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Roles to explicitly assign to this Member.\n Will completely replace any existing explicitly assigned roles. See the\n [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment.\n\n   If a Role is removed from a Member, and the Member is also implicitly assigned this Role from an SSO connection\n   or an SSO group, we will by default revoke any existing sessions for the Member that contain any SSO\n   authentication factors with the affected connection ID. You can preserve these sessions by passing in the\n   `preserve_existing_sessions` parameter with a value of `true`."
    },
    "preserve_existing_sessions": {
      "type": "boolean",
      "description": "Whether to preserve existing sessions when explicit Roles that are revoked are also implicitly assigned\n  by SSO connection or SSO group. Defaults to `false` - that is, existing Member Sessions that contain SSO\n  authentication factors with the affected SSO connection IDs will be revoked."
    },
    "mfa_phone_number": {
      "type": "string",
      "description": "The Member's phone number. A Member may only have one phone number. 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 member is created, this will set an identifier that can be used in most API calls where a `member_id` is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project. Note that if a member already exists, this field will be ignored."
    }
  },
  "description": "Request type",
  "required": [
    "email_address",
    "hash",
    "hash_type",
    "organization_id"
  ]
}