Stytch · Schema

api_b2b_totp_v1_MigrateRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
organization_id string 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 organi
member_id string Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set
secret string The TOTP secret key shared between the authenticator app and the server used to generate TOTP codes.
recovery_codes array An existing set of recovery codes to be imported into Stytch to be used to authenticate in place of the secondary MFA method.
View JSON Schema on GitHub

JSON Schema

stytch-api-b2b-totp-v1-migraterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_totp_v1_MigrateRequest",
  "title": "api_b2b_totp_v1_MigrateRequest",
  "type": "object",
  "properties": {
    "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."
    },
    "member_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member."
    },
    "secret": {
      "type": "string",
      "description": "The TOTP secret key shared between the authenticator app and the server used to generate TOTP codes."
    },
    "recovery_codes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An existing set of recovery codes to be imported into Stytch to be used to authenticate in place of the secondary MFA method."
    }
  },
  "description": "Request type",
  "required": [
    "organization_id",
    "member_id",
    "secret",
    "recovery_codes"
  ]
}