Agent HandlerRegistered Users

Create Registered User

Creates a Registered User with the given values. Idempotent on origin_user_id: if one already exists in your organization with that origin_user_id, it is returned unchanged with a 200 instead of a duplicate being created. Use PATCH /registered-users/{id} to change an existing Registered User.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Request

This endpoint expects an object.
origin_user_idstringRequired
Unique identifier for Registered User
origin_user_namestringRequired
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

Response

A Registered User with this origin_user_id already existed and was returned unchanged.

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