Member Object - Stytch Docs

{
  "organization_id": "<string>",
  "member_id": "<string>",
  "email_address": "<string>",
  "status": "<string>",
  "name": "<string>",
  "sso_registrations": [
    {
      "connection_id": "<string>",
      "external_id": "<string>",
      "registration_id": "<string>",
      "sso_attributes": {}
    }
  ],
  "is_breakglass": true,
  "member_password_id": "<string>",
  "oauth_registrations": [
    {
      "provider_type": "<string>",
      "provider_subject": "<string>",
      "member_oauth_registration_id": "<string>",
      "profile_picture_url": "<string>",
      "locale": "<string>"
    }
  ],
  "email_address_verified": true,
  "mfa_phone_number_verified": true,
  "is_admin": true,
  "totp_registration_id": "<string>",
  "retired_email_addresses": [
    {
      "email_id": "<string>",
      "email_address": "<string>"
    }
  ],
  "is_locked": true,
  "mfa_enrolled": true,
  "mfa_phone_number": "<string>",
  "default_mfa_method": "<string>",
  "roles": [
    {
      "role_id": "<string>",
      "sources": [
        {
          "type": "<string>",
          "details": {}
        }
      ]
    }
  ],
  "trusted_metadata": {},
  "untrusted_metadata": {},
  "created_at": "<string>",
  "updated_at": "<string>",
  "scim_registration": {
    "connection_id": "<string>",
    "registration_id": "<string>",
    "external_id": "<string>",
    "scim_attributes": {
      "user_name": "<string>",
      "id": "<string>",
      "external_id": "<string>",
      "active": true,
      "groups": [
        {
          "value": "<string>",
          "display": "<string>"
        }
      ],
      "display_name": "<string>",
      "nick_name": "<string>",
      "profile_url": "<string>",
      "user_type": "<string>",
      "title": "<string>",
      "preferred_language": "<string>",
      "locale": "<string>",
      "timezone": "<string>",
      "emails": [
        {
          "value": "<string>",
          "type": "<string>",
          "primary": true
        }
      ],
      "phone_numbers": [
        {
          "value": "<string>",
          "type": "<string>",
          "primary": true
        }
      ],
      "addresses": [
        {
          "formatted": "<string>",
          "street_address": "<string>",
          "locality": "<string>",
          "region": "<string>",
          "postal_code": "<string>",
          "country": "<string>",
          "type": "<string>",
          "primary": true
        }
      ],
      "ims": [
        {
          "value": "<string>",
          "type": "<string>",
          "primary": true
        }
      ],
      "photos": [
        {
          "value": "<string>",
          "type": "<string>",
          "primary": true
        }
      ],
      "entitlements": [
        {
          "value": "<string>",
          "type": "<string>",
          "primary": true
        }
      ],
      "roles": [
        {
          "value": "<string>",
          "type": "<string>",
          "primary": true
        }
      ],
      "x509certificates": [
        {
          "value": "<string>",
          "type": "<string>",
          "primary": true
        }
      ],
      "name": {
        "formatted": "<string>",
        "family_name": "<string>",
        "given_name": "<string>",
        "middle_name": "<string>",
        "honorific_prefix": "<string>",
        "honorific_suffix": "<string>"
      },
      "enterprise_extension": {
        "employee_number": "<string>",
        "cost_center": "<string>",
        "division": "<string>",
        "department": "<string>",
        "organization": "<string>",
        "manager": {
          "value": "<string>",
          "ref": "<string>",
          "display_name": "<string>"
        }
      }
    }
  },
  "external_id": "<string>",
  "lock_created_at": "<string>",
  "lock_expires_at": "<string>"
}

organization_id

string

required

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

string

required

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.

email_address

string

required

The email address of the Member.

status

string

required

The status of the Member. The possible values are: pending, invited, active, or deleted.

name

string

required

The name of the Member.

sso_registrations

object[]

required

An array of registered SAML Connection or OIDC Connection objects the Member has authenticated with.

Show child attributes

is_breakglass

boolean

required

Identifies the Member as a break glass user - someone who has permissions to authenticate into an Organization by bypassing the Organization's settings. A break glass account is typically used for emergency purposes to gain access outside of normal authentication procedures. Refer to the Organization object and its auth_methods and allowed_auth_methods fields for more details.

member_password_id

string

required

Globally unique UUID that identifies a Member's password.

oauth_registrations

object[]

required

A list of OAuth registrations for this member.

Show child attributes

email_address_verified

boolean

required

Whether or not the Member's email address is verified.

mfa_phone_number_verified

boolean

required

Whether or not the Member's phone number is verified.

is_admin

boolean

required

Whether or not the Member has the stytch_admin Role. This Role is automatically granted to Members who create an Organization through the discovery flow. See the RBAC guide for more details on this Role.

totp_registration_id

string

required

Globally unique UUID that identifies a TOTP instance.

retired_email_addresses

object[]

required

A list of retired email addresses for this member. A previously active email address can be marked as retired in one of two ways:

It's replaced with a new primary email address during an explicit Member update.
A new email address is surfaced by an OAuth, SAML or OIDC provider. In this case the new email address becomes the Member's primary email address and the old primary email address is retired.

A retired email address cannot be used by other Members in the same Organization. However, unlinking retired email addresses allows them to be subsequently re-used by other Organization Members. Retired email addresses can be unlinked using the Unlink Retired Email endpoint.

Show child attributes

is_locked

boolean

required

Whether the Member is temporarily locked due to too many failed authentication attempts. See the User Locking Guide for more information.

mfa_enrolled

boolean

required

Sets whether the Member is enrolled in MFA. If true, the Member must complete an MFA step whenever they wish to log in to their Organization. If false, the Member only needs to complete an MFA step if the Organization's MFA policy is set to REQUIRED_FOR_ALL.

mfa_phone_number

string

required

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).

default_mfa_method

string

required

The Member's default MFA method. This value is used to determine which secondary MFA method to use in the case of multiple methods registered for a Member. The current possible values are sms_otp and totp.

roles

object[]

required

Explicit or implicit Roles assigned to this Member, along with details about the role assignment source. See the RBAC guide for more information about role assignment.

Show child attributes

trusted_metadata

object

An arbitrary JSON object for storing application-specific data or identity-provider-specific data.

untrusted_metadata

object

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.

created_at

string

The timestamp of the Member's creation. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. 2021-12-29T12:33:09Z.

updated_at

string

The timestamp of when the Member was last updated. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. 2021-12-29T12:33:09Z.

scim_registration

object

A scim member registration, referencing a SCIM Connection object in use for the Member creation.

Show child attributes

external_id

string

The ID of the member given by the identity provider.

lock_created_at

string

When the member lock was created, if there is one. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. 2021-12-29T12:33:09Z.

lock_expires_at

string

When the member lock expires, if there is one. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. 2021-12-29T12:33:09Z.

⌘I