Envoyer un courriel à un nouvel utilisateur

Envoyer un courriel à un nouvel utilisateur #

Envoie un lien par courriel d'activation à un utilisateur existant.

POST /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendActivationEmail

Document note
Cela se fera automatiquement si le sendNewUserEmail est activé sur le compte client.

Exemple #

Cette demande permettra d'envoyer un lien d'activation à cet utilisateur au sein du locataire client.

Hand Left warning
Les courriels d'activation ne peuvent être envoyés que par le locataire principal de l'utilisateur.

Demande #

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendActivationEmail> HTTP/1.1
Autorisation : Porteur {TOKEN}

Réponse #

HTTP/1.1 204 Aucun contenu
Date : Fri, 07 Feb 2020 13:40:24 GMT

Erreurs #

Non autorisé #

Lorsque le jeton n'est pas fourni, invalide ou expiré

HTTP/1.1 401 Non autorisé

Mauvaise demande #

Lorsque l'identifiant du locataire fourni n'est pas dans le bon format

HTTP/1.1 400 Mauvaise demande
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 149
{
	« error » : 400,
	« message » : « La valeur '<tenant id>' n'est pas valide.
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Lorsque ce locataire n'est pas le locataire principal de l'utilisateur

HTTP/1.1 400 Mauvaise demande
Date : Fri, 07 Feb 2020 13:33:16 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 162
{
	« error » : 400,
	« errorCode » : « TenantNotPrimary »,
	« message » : « Ce n'est pas le locataire principal de cet utilisateur. »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-07T13:33:16.0582281Z »
}

Non trouvé #

Lorsqu'il n'y a pas de clients qui ont un identifiant de locataire correspondant, ou d'utilisateurs au sein de ce locataire qui ont un identifiant d'utilisateur correspondant

HTTP/1.1 404 Introuvable
Date : Thu, 06 Feb 2020 12:46:58 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 95
{
	« error » : 404,
	« message » : « Introuvable »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:46:58.7669535Z »
}