Utilisateur du correctif

Utilisateur du correctif #

Met à jour un ensemble spécifique de propriétés d'un utilisateur. Cela utilise le bouton JSON Format du correctif pour tout changement.

PATCH /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}

Hand Left warning
Lorsque vous appliquez des correctifs aux rôles d'un utilisateur, soyez prudent si vous utilisez l'opération REPLACER.
Avec l'opération de remplacement, les rôles actuels de l'utilisateur seront remplacés par les valeurs fournies dans la demande de correctif.
Tout rôle non fourni dans la demande de correctif sera supprimé de l'utilisateur (à l'exception de la commande PBX rôle d'utilisateur qui est synchronisé à partir du PBX).

Exemple 1 #

Cette demande mettra à jour le nom d'affichage de l'utilisateur.

Demande # 

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : garder en vie
[ {
	« op » : « remplacer »,
	« chemin » : « /nomd'affichage »,
	« value » : « Mon nouveau nom »
}][{
	"op": "replace",
	"path": "/displayName",
	"value": "My New Name"
}]

Réponse # 

HTTP/1.1 200 OK
Type de contenu : application/json; charset=utf-8
Longueur du contenu : xx
Request-Context : appId=cid-v1 :d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	« status » : « succès »,
	« timestamp » : « 2019-11-29T15:16:54.2586208Z »
}

Exemple 2 #

Cette demande AJOUTERA le rôle customer.user.supervisorl1 à l'utilisateur, en conservant les rôles existants intacts.

Demande # 

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{TENANT_ID}/users/{USER_ID}> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : garder en vie
[ {
	« op » : « ajouter »,
	« path » : « /roles/-« ,
	« value » : « customer.user.supervisorl1 »
}][{
	"op": "add",
	"path": "/roles/-",
	"value": "customer.user.supervisorl1"
}]

Réponse # 

HTTP/1.1 200 OK
Type de contenu : application/json; charset=utf-8
Longueur du contenu : xx
Request-Context : appId=cid-v1 :d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	« status » : « succès »,
	« timestamp » : « 2019-11-29T15:16:54.2586208Z »
}

Exemple 3 #

Cette demande remplacera TOUS les rôles attribués à l'utilisateur par les deux fournis.

Demande # 

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{TENANT_ID}/users/{USER_ID}> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : garder en vie
\[{
	« op » : « remplacer »,
	« path » : « /roles »,
	« valeur » : [" user.admin », « customer.user"]["user.admin", "customer.user"]
}]

Réponse # 

HTTP/1.1 200 OK
Type de contenu : application/json; charset=utf-8
Longueur du contenu : xx
Request-Context : appId=cid-v1 :d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	« status » : « succès »,
	« timestamp » : « 2019-11-29T15:16:54.2586208Z »
}

Erreurs #

Non autorisé #

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

HTTP/1.1 401 Non autorisé

Mauvaise demande (1) #

Lorsque le nom de locataire ou d'utilisateur 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 '\< locataire/utilisateur id>' n'est pas valide.",
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Mauvaise demande (2) #

Lorsque le dernier utilisateur avec les rôles « user.admin » et « customer.user » dans ce client tente de faire supprimer ce rôle.

Hand Left warning
Il doit toujours y avoir un utilisateur dans un client client avec les rôles « user.admin » et « customer.user ». 
HTTP/1.1 400 Mauvaise demande
Date : Thu, 06 Feb 2020 13:12:06 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 132
{
	« error » : 400,
	« message » : « Il doit y avoir au moins un administrateur d'utilisateurs. »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T13:12:06.9741515Z »
}

Mauvaise demande (3) #

Lorsque vous tentez de corriger une propriété non valide. 

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 » : « L'emplacement cible spécifié par le segment de chemin '<invalid property>' n'a pas été trouvé.",
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Conflit #

Si l'adresse e-mail de ce nouvel utilisateur quitte déjà pour un autre utilisateur dans ce locataire client 

HTTP/1.1 409 Conflit
Date : Thu, 06 Feb 2020 13:05:39 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 178
{
	« error » : 409,
	« errorCode » : « Conflit d'e-mails »,
	« message » : « Un utilisateur avec l'adresse courriel [[email protected]](mailto:[email protected]) existe déjà.
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T13:05:39.5486342Z »
}

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 »
}

Paiement requis #

Si cette demande peut entraîner des frais supplémentaires, voir Charges. 

HTTP/1.1 402 Paiement requis
Date : Thu, 06 Feb 2020 13:01:00 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 274
{
	« données » : {
		« id » : « {USER_ID} »,
		« displayName » : « Nouvel utilisateur »,
		« email » : « [[email protected]](mailto:[email protected])",
		« primaryTenant » : « {CUSTOMER_TENANT_ID} »,
		« roles » : [" admin.user », « customer.user », « customer.user.supervisorl1 », « customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
	},
	« error » : 402,
	« message » : « des frais supplémentaires s'appliquent »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T13:01:01.1302340Z »
}