Skip to navigation

Update Registered User

Updates fields on a Registered User by ID

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

registered_user_idstringRequiredformat: "uuid"
Agent Handler ID of the Registered User

Request

This endpoint expects an object.
origin_user_idstringOptional
Unique identifier for Registered User
origin_user_namestringOptional
The human readable name of Registered User
shared_credential_groupobjectOptional
Object used to identify which the groupings a Registered User is part of and can share credentials across.
user_typeenumOptionalDefaults to HUMAN

ENUM of HUMAN or SYSTEM

Allowed values:
origin_user_emailstring or nullOptionalformat: "email"<=254 characters

Email address of the Registered User. Optional. Must be unique among Registered Users in the same company (shared_credential_group); a duplicate returns 400. Users without a company are not checked. Send null in an update to clear it.

Response

idstringRead-only
origin_user_idstringRead-only
Unique identifier for Registered User
origin_user_namestring
The human readable name of Registered User
shared_credential_groupobject or null
Object used to identify which the groupings a Registered User is part of and can share credentials across.
user_typestring

ENUM of HUMAN or SYSTEM

authenticated_connectorslist of stringsRead-only
List of connector slugs that the user has authenticated with
is_testboolean
Whether this is a test user or production user
origin_user_emailstring or nullformat: "email"
Email address of the Registered User, or null if none was provided