...
Get the user by id or email or username where status is active, if not provided get it from the access token.
if not found return error
if found continue with the following steps:
check if already invited to this tenant
if yes return an error
if no, generate pin if code is set to yes
if failed to generate pin return an error
invite the user by updating its allowedTenants
send an email to the user with the generated pin
...
Name | Source | Mandatory | Type | Special Format | Description |
---|---|---|---|---|---|
user | Body | YESNOW | Object | Includes ONE of id, username, or email | User object, if not set username will be fetch from access token |
Name | Mandatory | type | Description | ||
id | YES | string | User Id | ||
username | YES | string | Username | ||
YES | User email | ||||
tenant | Body | YES | Object | Includes tenant id, and code | Tenant object |
Name | Mandatory | type | Description | ||
id | YES | string | tenant id | ||
code | YES | string | tenant code | ||
groups | Body | NO | Array | Array of strings | Groups array |
pin | Body | NO | Object | Includes code and allowed parameters | Pin object |
Name | Mandatory | type | Description | ||
code | YES | Boolean | Set to true to create random code | ||
allowed | YES | Boolean | Set to true if this user is allowed to start pin login |
...