Stytch · Schema

api_user_v1_UpdateRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
name	object	The name of the user. Each field in the name object is optional.
attributes	object	Provided attributes to help with fraud detection. These values are pulled and passed into Stytch endpoints by your application.
trusted_metadata	object	The `trusted_metadata` field contains an arbitrary JSON object of application-specific data. See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
untrusted_metadata	object	The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critica
external_id	string	An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `\|` characters with a maximum length of 128 characters.
roles	array	Roles to explicitly assign to this User. See the [RBAC guide](https://stytch.com/docs/guides/rbac/role-assignment) for more information about role assignment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_user_v1_UpdateRequest",
  "title": "api_user_v1_UpdateRequest",
  "type": "object",
  "properties": {
    "name": {
      "$ref": "#/components/schemas/api_user_v1_Name",
      "description": "The name of the user. Each field in the name object is optional."
    },
    "attributes": {
      "$ref": "#/components/schemas/api_attribute_v1_Attributes",
      "description": "Provided attributes to help with fraud detection. These values are pulled and passed into Stytch endpoints by your application."
    },
    "trusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "The `trusted_metadata` field contains an arbitrary JSON object of application-specific data. See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details."
    },
    "untrusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details."
    },
    "external_id": {
      "type": "string",
      "description": "An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters."
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Roles to explicitly assign to this User.\n   See the [RBAC guide](https://stytch.com/docs/guides/rbac/role-assignment) for more information about role assignment."
    }
  },
  "description": "Request type"
}