Skip to main content
POST
/
hubs
/
{hub_id}
/
users
Create an End User
curl --request POST \
  --url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "primaryConnection": {
    "name": "<string>",
    "credentials": {
      "action": [
        {
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "schemeType": "<string>",
            "validationMessages": [
              {
                "text": "<string>",
                "severity": "info",
                "detail": [
                  "<string>"
                ]
              }
            ]
          },
          "credential": {
            "name": "<string>",
            "type": "none",
            "data": {}
          }
        }
      ],
      "trigger": [
        {
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "schemeType": "<string>",
            "validationMessages": [
              {
                "text": "<string>",
                "severity": "info",
                "detail": [
                  "<string>"
                ]
              }
            ]
          },
          "credential": {
            "name": "<string>",
            "type": "none",
            "data": {}
          }
        }
      ]
    },
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "displayName": "<string>"
}
'
{
  "id": "<string>",
  "externalId": "<string>",
  "displayName": "<string>",
  "hubId": "<string>",
  "primaryConnection": {
    "id": "<string>",
    "name": "<string>",
    "credentials": {
      "action": [
        {
          "id": "<string>",
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "schemeType": "<string>",
            "validationMessages": [
              {
                "text": "<string>",
                "severity": "info",
                "detail": [
                  "<string>"
                ]
              }
            ]
          },
          "credential": {
            "id": "<string>",
            "organisationId": "<string>",
            "type": "none",
            "name": "<string>",
            "data": {},
            "usages": [
              {
                "connection": {
                  "id": "<string>",
                  "name": "<string>",
                  "connector": {
                    "id": "<string>",
                    "organisationId": "<string>",
                    "name": "<string>",
                    "protocol": "http",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "errors": [
              "<string>"
            ],
            "expiresAt": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "trigger": [
        {
          "id": "<string>",
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "schemeType": "<string>",
            "validationMessages": [
              {
                "text": "<string>",
                "severity": "info",
                "detail": [
                  "<string>"
                ]
              }
            ]
          },
          "credential": {
            "id": "<string>",
            "organisationId": "<string>",
            "type": "none",
            "name": "<string>",
            "data": {},
            "usages": [
              {
                "connection": {
                  "id": "<string>",
                  "name": "<string>",
                  "connector": {
                    "id": "<string>",
                    "organisationId": "<string>",
                    "name": "<string>",
                    "protocol": "http",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "errors": [
              "<string>"
            ],
            "expiresAt": "2023-11-07T05:31:56Z"
          }
        }
      ]
    },
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
hub_id
string<ulid>
required

Body

application/json

Request to create a new End User

​
externalId
string
required

ExternalID is the identifier of the user as identified in the Hub's primary connector/system.

​
primaryConnection
object
required

PrimaryConnection is the connection that the user will use to authenticate to the primary connector.

​
displayName
string

DisplayName is a human-readable name for the user

Response

Created

​
id
string<ulid>
required

ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.

​
externalId
string
required

ExternalID is the identifier for the user as determined by the organisation. This typically should be the same as the user's ID on the Primary Connector for the Hub. Regardless of the value, it must be unique within the Hub.

​
displayName
string
required

DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.

​
hubId
string<ulid>
required

The hub ID to which the user belongs to.

​
primaryConnection
object
required

PrimaryConnection is the connection that the user will use to authenticate to the primary connector.

​
createdAt
string<date-time>
required

CreatedAt is the time the user was created.

​
updatedAt
string<date-time>
required

UpdatedAt is the time the user was last updated.