younifyd
Menu

Create Invite V2

Invite user

POST/v2/invites

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Create Invite V2 action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{createInviteV2.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

namestring

Name of the user.

emailstring (email)required

Email address of the user.

isAdminboolean

Indicates whether the user is an `admin`.

rolesarray<integer (int64)>

A list of the IDs of the roles assigned to the user.

aclstring

Indicates the access level of the user.

json
{
  "email": "john.doe@example.com",
  "name": "John Doe",
  "isAdmin": false,
  "roles": [
    13
  ],
  "acl": "string"
}

Response

Returns 201 with an object. Read it in later steps with {{createInviteV2.response.data.<field>}}.

idinteger (int64)

The internal ID of this entity.

createdstring (date-time)

The time this entity was created.

modifiedstring (date-time)

The time this entity was last modified.

emailstring (email)

The email address associated with the user profile.

accountIdinteger (int64)

The ID of the account that owns this entity.

namestring

Name of the user.

statestring

State of the user.

One ofinvitedactivedeactivated

inviteTokenstring

Invitation token of the user. **Note**: If the user has already accepted their invitation, this is `null`.

isAdminboolean

Indicates whether the user is an `admin`.

policyobject

Access level of the user.

rolesarray<integer (int64)>

A list of the IDs of the roles assigned to the user.

authMethodstring

Authentication method for this user.

applicationNotificationSubscriptionsobject

Application notifications that the user is subscribed to.

lastSignedInstring (date-time)

Timestamp when the user last signed in to Talon.One.

lastAccessedstring (date-time)

Timestamp of the user's last activity after signing in to Talon.One.

latestFeedTimestampstring (date-time)

Timestamp when the user was notified for feed.

additionalAttributesobject

Additional user attributes, created and used by external identity providers.

json
{
  "id": 6,
  "created": {},
  "modified": {},
  "email": "john.doe@example.com",
  "accountId": 3886,
  "name": "John Doe",
  "state": "invited",
  "inviteToken": "Gy9b8w1irmQtEPo5RmbMmSPheL5h4",
  "policy": {
    "Role": 127
  },
  "isAdmin": false,
  "roles": [
    71
  ],
  "authMethod": "basic_auth"
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.