Skip to main content
POST
/
api
/
v1
/
registered-users
Create Registered User
curl --request POST \
  --url https://ah-api.merge.dev/api/v1/registered-users \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "origin_user_id": "user1234",
  "origin_user_name": "Yash",
  "shared_credential_group": {
    "origin_company_id": "merge-1234",
    "origin_company_name": "Merge",
    "custom_groupings": {}
  },
  "user_type": "HUMAN"
}'
{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "origin_user_id": "user1234",
  "origin_user_name": "Yash",
  "shared_credential_group": {
    "origin_company_id": "merge-1234",
    "origin_company_name": "Merge",
    "custom_groupings": {}
  },
  "user_type": "HUMAN"
}

Authorizations

​
Authorization
string
header
required

Production Access Key (Bearer)

Body

​
origin_user_id
string
required

Unique identifier for Registered User

Example:

"user1234"

​
origin_user_name
string
required

The human readable name of Registered User

Example:

"Yash"

​
shared_credential_group
object
required

Object used to identify which the groupings a Registered User is part of and can share credentials across.

​
user_type

ENUM of HUMAN or SYSTEM

  • HUMAN - HUMAN
  • SYSTEM - SYSTEM
Available options:
HUMAN,
SYSTEM
Example:

"HUMAN"

Response

201 - application/json
​
id
string
required
Example:

"0958cbc6-6040-430a-848e-aafacbadf4ae"

​
origin_user_id
string
required

Unique identifier for Registered User

Example:

"user1234"

​
origin_user_name
string
required

The human readable name of Registered User

Example:

"Yash"

​
shared_credential_group
object
required

Object used to identify which the groupings a Registered User is part of and can share credentials across.

​
user_type

ENUM of HUMAN or SYSTEM

  • HUMAN - HUMAN
  • SYSTEM - SYSTEM
Available options:
HUMAN,
SYSTEM
Example:

"HUMAN"