When users need to log in using an email and password, they have to set up their password first. We support this flow through a registration token, which needs to be created through the Activation Token endpoint.
Part of Web API v3 for user management. You need a token with the v3:activation_token:read or v3:activation_token:write scope, see Authenticating with the Web API v3.
Before you start
Before you can create an activation token, the user must be created using the user API endpoints. See Managing users via the API.
You can have the TinQwise learning platform send invitation emails with tokens to users directly, or you can choose to retrieve the tokens using this API and distribute them yourself.
đ§ Be careful
If you are using SSO, such as SAML2 or OpenID, to log users in on the TinQwise learning platform, you should not use User Activation Tokens.
đ Good to know
User Activation Tokens can only be created and retrieved for users who are pending (who have never logged in) and who are not suspended (blocked from logging in).
Retrieving user activation tokens
Use the GET /api/v3/public/user_activation_tokens/ endpoint to retrieve a list of tokens for pending users.
Field | Description |
| The uuid of the user. |
| The date at which the token was created. |
| The date at which the token expires. An expired token can not be used. You must first delete an expired token before you can create a new one for a user. |
| Shows whether the TinQwise learning platform has sent an email to this user with the activation link. |
| The url that the customer should follow to activate their account. |
Creating user activation tokens
POST a user UUID (user_uuid) and whether an email should be sent (send_email) to /api/v3/public/user_activation_tokens/ to create an activation token.
Setting the send_email field to true will send the standard registration email for the platform.
This email can be edited under Control > Settings > Terminology by the platform admins.
Modifying user activation tokens
Tokens can not be modified, only created and deleted.
Deleting user activation tokens
Send a DELETE to /api/v3/public/user_activation_tokens/{user_uuid}/ to delete a token.
Resending an activation token
If you want to send a new registration email, you have to create a new activation token:
The user should be unsuspended by setting
is_suspendedtofalse.Delete any existing token or tokens for this user.
Create a new token for this user, and make sure to set
send_emailtotrue.
âď¸ Tip
It is also possible to resend invites manually by using the Control website, see User invitations.