POST
/
hubs
/
{hub_id}
/
users

Path Parameters

hub_id
string
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.

primaryConnection.name
string
required

Name is the name of the Connection.

primaryConnection.credentials
object
required

ConnectionCredentialsCreate defines the Action and Trigger credentials for the owning Connector.

This supports defining multiple credentials for each type, which are applied to the request in the order they are defined. This is to enable Connectors which require both a user session token and an API key to be provided in the request.

This object can either define a reference to an existing Credential via the InferredReference object, or it can define a new Credential via the CredentialCreate object.

primaryConnection.variables
object[]
required
displayName
string

DisplayName is a human-readable name for the user

Response

201 - application/json
id
string
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
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.

primaryConnection.id
string
required

ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all) public-facing APIs will use the name in combination with the Connector's id instead.

primaryConnection.name
string
required

Name is the name of the Connection. This must be unique within the owning Connector.

primaryConnection.credentials
object
required

ConnectionCredentials defines the Action and Trigger credentials for the owning Connector. If multiple credentials are defined for each type, they are applied to the request in the order they are defined. This is to enable Connectors which require both a user session token and an API key to be provided in the request.

primaryConnection.variables
object[]
required
primaryConnection.createdAt
string
required

CreatedAt is the time the Connection was created.

primaryConnection.updatedAt
string
required

UpdatedAt is the time the Connection was last updated.

createdAt
string
required

CreatedAt is the time the user was created.

updatedAt
string
required

UpdatedAt is the time the user was last updated.

List End UsersRetrieve an End User