B2B Saas Authentication

/

API reference

/

Members

/

Member object

Member object


Fields


organization_idstring

member_idstring

email_addressstring

email_address_verifiedboolean

statusstring

mfa_enrolledboolean

mfa_phone_numberstring

mfa_phone_number_verifiedboolean

default_mfa_methodstring

retired_email_addressesarray[object]

namestring

trusted_metadataobject

untrusted_metadataobject

sso_registrationsarray[objects]

oauth_registrationsarray[object]

scim_registrationobject

member_password_idstring

totp_registration_idstring

is_breakglassboolean

rolesarray[objects]

is_adminboolean

created_atstring

updated_atstring

OBJECT

{
  "member": {
    "email_address": "sandbox@stytch.com",
    "email_address_verified": true,
    "member_password_id": "member-password-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
    "member_id": "member-test-32fc5024-9c09-4da3-bd2e-c9ce4da9375f",
    "name": "Test Member",
    "organization_id": "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
    "status": "active",
    "is_breakglass": false,
    "is_admin": false,
    "mfa_enrolled": true,
    "mfa_phone_number": "+12025550162",
    "mfa_phone_number_verified": true,
    "default_mfa_method": "totp",
    "retired_email_addresses": [{
      "email_id": "email-test-81bf03a8-86e1-4d95-bd44-bb3495224953",
      "email_address": "sandbox@stytch.com"
    }],
    "totp_registration_id": "member-totp-test-41920359-8bbb-4fe8-8fa3-aaa83f35f02c",
    "trusted_metadata": {
      "role": "admin",
      "teams": ["tech", "support"]
    },
    "untrusted_metadata": {
      "job_title": "Business Analyst",
      "preferred_locales": ["en", "es"]
    },
    "oauth_registrations": [{
      "member_oauth_registration_id": "oauth-user-test-de86770c-911d-463f-80e7-f1b089cead14",
      "provider_subject": "10769150350006150715113082367",
      "provider_type": "Google",
      "profile_picture_url": "example.com",
      "locale": "en"
    }],
    "roles": [
      {
        "role_id": "reader",
        "sources": [
          {        
            "type": "email_assignment",
            "details": { "email_domain": "example.com" }
          }
        ]
      },
      {
        "role_id": "contributor",
        "sources": [
          {
            "type": "sso_connection_group",
            "details": { "connection_id": "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9", "group": "admins" }
          }
        ]
      },
      {
              "role_id": "reviewer",
              "sources": [
                    {
                        "type": "scim_connection_group",
                        "details": {
                            "connection_id": "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
                            "group_id": "scim-group-test-5c44cc6a-8af7-48d6-8da7-ea821342f5a6"
                        }
                    }
                }
              ]
            },
      {
        "role_id": "editor",
        "sources": [
          {
            "type": "direct_assignment",
            "details": {}
          },
          {
            "type": "sso_connection",
            "details": { "connection_id": "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9" }
          }
        ]
      },
      {
        "role_id": "stytch_member",
        "sources": [
          {
            "type": "direct_assignment",
            "details": {}
          }
        ]
      }
    ],
    "sso_registrations": [{
      "connection_id": "saml-connection-test-51861cbc-d3b9-428b-9761-227f5fb12be9",
      "external_id": "sandbox@stytch.com",
      "registration_id": "saml-member-registration-test-9a6d293d-d8b3-42e8-abb4-220cc2060e93",
      "sso_attributes": {
        "email": ["sandbox@stytch.com"],
        "first_name": ["Test"],
        "last_name": ["Member"]
      }
    }],
    "scim_registration": [{
      "connection_id": "scim-connection-test-cdd5415a-c470-42be-8369-5c90cf7762dc",
      "external_id": "00u8am9px8Ye2R0T55d2'
      "registration_id": "scim-registration-test-ase5425a-jh52-14jk-9324-era3swqw",
      "scim_attributes": {
            "active": true,
            "externalId": "00u8am9px8Ye2R0T55d2",
            "id": "member-test-32fc5024-9c09-4da3-bd2e-c9ce4da9375f",
            "userName": "${exampleEmail}"
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User",
                "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
            ],
            ...
      }
    }],
    "created_at": "2023-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}