Compléter une invitation d'utilisateur.

Habilitations requises : inviteUser (Invite user).

Cette API est un aperçu public et est activée pour un locataire qui inclut la prise en charge bêta des utilisateurs invités.

Créer l'utilisateur et l'ajouter à des groupes ou ajouter un utilisateur existant à des groupes en fonction de la charge utile qui est transmise. Si l'enregistrement de l'utilisateur est spécifié, l'utilisateur est créé et ajouté aux groupes. Si l'ID de l'utilisateur est spécifié, l'utilisateur est ajouté aux groupes. Si aucun des deux n'est spécifié, la transaction est terminée sans que l'utilisateur ne soit informé.

Cette API termine la transaction et génère l'événement d'audit. Si le flux n'est pas terminé et que le lien e-mail a expiré, la transaction est nettoyée automatiquement. En cas de succès, l'utilisateur final reçoit un courrier électronique lui indiquant qu'il a répondu avec succès à l'invitation.

Les notifications peuvent être marquées en indiquant themeId en tant que paramètre de requête. Le modèle d'image de marque se trouve à l'adresse " notifications/user_management/invite/invite_user_complete_email.xml "

Path Params
string
required

L'identifiant de la transaction pour l'invitation de l'utilisateur.

Query Params
string

L'identifiant du thème que vous souhaitez appliquer.

Body Params

Le corps de l'utilisateur invite à une opération complète.

string
required

La chaîne OTP du lien e-mail. Dans le lien du courriel, le paramètre de la requête factorTrnxId est l'OTP.

boolean

Notifier à l'utilisateur que l'invitation est terminée. Si l'attribut n'est pas spécifié, la notification par courrier électronique est envoyée.

string
required

Les données de l'utilisateur qui sont utilisées pour créer le compte ou l'ID de l'utilisateur pour mettre à jour un compte existant. Voir l'API POST /v2.0/Users pour la charge utile JSON qui est transmise à cette API pour la création d'un compte.

Responses

Language
URL
Response
Choose an example:
application/json