api_organization_v1_organizations_members_CreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_organization_v1_organizations_members_CreateRequest",
  "title": "api_organization_v1_organizations_members_CreateRequest",
  "type": "object",
  "properties": {
    "email_address": {
      "type": "string",
      "description": "The email address of the Member."
    },
    "name": {
      "type": "string",
      "description": "The name of the Member."
    },
    "trusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "An arbitrary JSON object for storing application-specific data or identity-provider-specific data."
    },
    "untrusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "An arbitrary JSON object of application-specific data. These fields can be edited directly by the\n  frontend SDK, and should not be used to store critical information. See the [Metadata resource](https://stytch.com/docs/b2b/api/metadata)\n  for complete field behavior details."
    },
    "create_member_as_pending": {
      "type": "boolean",
      "description": "Flag for whether or not to save a Member as `pending` or `active` in Stytch. It defaults to false. If true, new Members will be created with status `pending` in Stytch's backend. Their status will remain `pending` and they will continue to receive signup email templates for every Email Magic Link until that Member authenticates and becomes `active`. If false, new Members will be created with status `active`."
    },
    "is_breakglass": {
      "type": "boolean",
      "description": "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](https://stytch.com/docs/b2b/api/organization-object) and its `auth_methods` and `allowed_auth_methods` fields for more details."
    },
    "mfa_phone_number": {
      "type": "string",
      "description": "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)."
    },
    "mfa_enrolled": {
      "type": "boolean",
      "description": "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`."
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Roles to explicitly assign to this Member. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment)\n   for more information about role assignment."
    },
    "external_id": {
      "type": "string",
      "description": "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."
    }
  },
  "description": "Request type",
  "required": [
    "email_address"
  ]
}