TAtalon
Accounts and users

Invite user

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Create a new user in the account and send an invitation to their email address.

[!note] The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the Resend invitation email endpoint.

post/v2/invites

Request

Request body

namestring

Name of the user.

emailstring email required

Email address of the user.

isAdminboolean

Indicates whether the user is an admin.

rolesinteger[]

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

aclstring

Indicates the access level of the user.

Example request

{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "roles": [
    13
  ]
}

Response

Created

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

modifiedstring date-time required

The time this entity was last modified.

emailstring email required

The email address associated with the user profile.

accountIdinteger required

The ID of the account that owns this entity.

namestring required

Name of the user.

state'invited' | 'active' | 'deactivated' required

State of the user.

inviteTokenstring required

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 required

Access level of the user.

rolesinteger[]

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.

Example response

{
  "id": 6,
  "created": "2020-06-10T09:05:27.993483Z",
  "modified": "2021-09-12T10:12:42Z",
  "email": "john.doe@example.com",
  "accountId": 3886,
  "name": "John Doe",
  "state": "invited",
  "inviteToken": "Gy9b8w1irmQtEPo5RmbMmSPheL5h4",
  "policy": {
    "Role": 127,
    "Applications": null
  },
  "roles": [
    71
  ],
  "authMethod": "basic_auth",
  "applicationNotificationSubscriptions": {},
  "lastSignedIn": "2021-09-12T10:12:42Z",
  "lastAccessed": "2021-09-12T10:14:42Z",
  "latestFeedTimestamp": "2020-06-01T00:00:00Z",
  "additionalAttributes": {}
}

Changes

No recorded changes to this operation across all 2 revisions of this API.