External IDs for members and organizations

When a member or organization is created in Stytch, they will be assigned a unique identifier that looks like a UUID. For your convenience, you may choose to additionally assign an "external ID" to a member which can then be used in any place where the Stytch member_id is expected. You can also assign an "organization external ID" to an organization which can then be used any place where the Stytch organization_id is expected.

An External IDs is a string consisting of alphanumeric, ., _, or - characters with a maximum length of 128 characters. Member external IDs must be unique across members in a given organization, but may be reused across different organizations in the same project. Organization external IDs must be unique across all organizations in the same project

When calling the Create Member you may pass in an optional external_id parameter. When calling the Create Organization you may pass in an optional organization_external_id parameter.

You may also set an external ID during a call to the Migrate Password endpoint, but only if the member does not yet exist and is created. If the member already exists, you must use the Update Member endpoint to assign or reassign the external_id.

If a member has already been created, you may assign it an external_id later with the Update Member endpoint. Similar to creation, pass in an external_id parameter and it will then be assigned to that member. Again, remember that external IDs must be unique within a given organization, but may be reused across different organizations in the same project.

Organizations can similarly be assigned an organization_external_id later with the Update Organization endpoint.

If you wish to change a member's external ID you may use the same Update Member endpoints listed above.

If you wish to change an organization's external ID you may use the Update Organization endpoint.

After this point, you will no longer be able to refer to that entity by its old external_id.

In any endpoint that expects a member_id, you may instead choose to pass in your custom-defined external_id. For clarity, all responses from Stytch will continue to use the Stytch-defined member_id, though external_id will exist as a subfield within the Member object.

In any endpoint that expects an organization_id, you may instead choose to pass in your custom-defined organization_external_id. Similarly, all responses from Stytch will continue to use the Stytch-defined organization_id, though organization_external_id will exist as a subfield within the Organization object.

const stytch = require('stytch');

const client = new stytch.B2BClient({
  project_id: 'PROJECT_ID',
  secret: 'SECRET',
});

const params = {
  organization_id: "example-organization-external-id",
  member_id: "example-member-external-id",
};

client.organizations.members.get(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });