api_organization_v1_organizations_members_UpdateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_organization_v1_organizations_members_UpdateRequest",
  "title": "api_organization_v1_organizations_members_UpdateRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Member.\n\nIf this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.name` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.name` action on the `stytch.self` Resource."
    },
    "trusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "An arbitrary JSON object for storing application-specific data or identity-provider-specific data.\n          If a session header is passed into the request, this field may **not** be passed into the request. You cannot\n          update trusted metadata when acting as a Member."
    },
    "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.\n\nIf this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.untrusted-metadata` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.untrusted-metadata` action on the `stytch.self` Resource."
    },
    "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.\n\nIf this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.is-breakglass` action on the `stytch.member` Resource."
    },
    "mfa_phone_number": {
      "type": "string",
      "description": "Sets the Member's phone number. Throws an error if the Member already has a phone number. To change the Member's phone number, use the [Delete member phone number endpoint](https://stytch.com/docs/b2b/api/delete-member-mfa-phone-number) to delete the Member's existing phone number first.\n\nIf this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.mfa-phone` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.mfa-phone` action on the `stytch.self` Resource."
    },
    "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`.\n\nIf this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.mfa-enrolled` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.settings.mfa-enrolled` action on the `stytch.self` Resource."
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Roles to explicitly assign to this Member.\n Will completely replace any existing explicitly assigned roles. See the\n [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment.\n\n   If a Role is removed from a Member, and the Member is also implicitly assigned this Role from an SSO connection\n   or an SSO group, we will by default revoke any existing sessions for the Member that contain any SSO\n   authentication factors with the affected connection ID. You can preserve these sessions by passing in the\n   `preserve_existing_sessions` parameter with a value of `true`.\n\nIf this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.roles` action on the `stytch.member` Resource."
    },
    "preserve_existing_sessions": {
      "type": "boolean",
      "description": "Whether to preserve existing sessions when explicit Roles that are revoked are also implicitly assigned\n  by SSO connection or SSO group. Defaults to `false` - that is, existing Member Sessions that contain SSO\n  authentication factors with the affected SSO connection IDs will be revoked."
    },
    "default_mfa_method": {
      "type": "string",
      "description": "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`.\n\nIf this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.default-mfa-method` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.settings.default-mfa-method` action on the `stytch.self` Resource."
    },
    "email_address": {
      "type": "string",
      "description": "Updates the Member's `email_address`, if provided. This will clear any existing passwords and require re-verification of the new email address.\n        If a Member's email address is changed, other Members in the same Organization cannot use the old email address, although the Member may update back to their old email address.\n        A Member's email address can only be useable again by other Members if the Member is deleted.\n\nIf this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.email` action on the `stytch.member` Resource. Members cannot update their own email address."
    },
    "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."
    },
    "unlink_email": {
      "type": "boolean",
      "description": "If `unlink_email` is `true` and an `email_address` is provided, the Member's previous email will be deleted instead of retired. Defaults to `false`."
    }
  },
  "description": "Request type"
}