Migrate
Migrates a password from your existing system to Stytch for a specific Member.
bcrypt, scrypt, argon2, MD-5, SHA-1, SHA-512, and PBKDF2. This endpoint has a rate limit of 100 requests per second.
If you are using cross-organization passwords (allowing an end user to share the same password across all of their ), call this method separately for each organization_id associated with the given email_address to ensure the password is set across all of their Organizations.Authorizations
Body
Request type
Required additional parameters for PBKDF2 hash keys. Note that we use the SHA-256 by default, please contact support@stytch.com if you use another hashing function.
An arbitrary JSON object of application-specific data. These fields can be edited directly by the frontend SDK, and should not be used to store critical information. See the Metadata resource for complete field behavior details.
Roles to explicitly assign to this Member. Will completely replace any existing explicitly assigned roles. See the RBAC guide for more information about role assignment.
If a Role is removed from a Member, and the Member is also implicitly assigned this Role from an SSO connection
or an SSO group, we will by default revoke any existing sessions for the Member that contain any SSO
authentication factors with the affected connection ID. You can preserve these sessions by passing in the
preserve_existing_sessions parameter with a value of true.
Whether to preserve existing sessions when explicit Roles that are revoked are also implicitly assigned
by SSO connection or SSO group. Defaults to false - that is, existing Member Sessions that contain SSO
authentication factors with the affected SSO connection IDs will be revoked.
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.
Response
Successful response