Accounts and users

Invite user from identity provider

[!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.

Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.

post/v1/users/invite

Request

Base URL
https://yourbaseurl.talon.one
Auth
- API key in header Authorization
- or API key in header Authorization
TypeScript
https://skmtc.dev/talon/apis/management-api/docs/v1/users/invite/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring

Name of the user.

userGroupsstring[]

List of user groups in the external identity provider.

If there are roles in Talon.One whose names match these user groups, those roles will be automatically assigned to the user upon invitation.

emailstring email required

Email address of the user.

Example request

{
  "name": "John Doe",
  "userGroups": [
    "Managers",
    "Customer support"
  ],
  "email": "john.doe@example.com"
}

Response

Invitation email sent

Changes

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