Accorder et révoquer un domaine
Un domaine entier d'un coup : toutes ses adresses, y compris celles ajoutées plus tard.
Exécute l'un des 2 appels sur votre espace de travail.
POST /members/{userId}/domains
Un domaine entier d'un coup : toutes ses adresses, y compris celles ajoutées plus tard.
Accorder un domaine
Nécessite members:write. POST /members/{userId}/domains avec { domainId, access } ; access vaut member par défaut. Renvoie le membre entier dans son état actuel, avec l'octroi dans domains.
curl -X POST "$OE/members/nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t/domains" -H "$AUTH" \ -H "Content-Type: application/json" \ -d '{ "domainId": "7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f", "access": "viewer" }'{ "object": "member", "userId": "nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t", "email": "[email protected]", "role": { "id": "role_2b81de079c1f0a4b7e05d386", "name": "Support", "builtin": null }, "addresses": [], "domains": [ { "domainId": "7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f", "domain": "acme.com", "access": "viewer" } ] }Un upsert, comme un octroi d'adresse : reposter avec un access différent modifie l'octroi plutôt que d'en ajouter un second.
Un octroi de domaine atteint toutes les adresses du domaine, y compris celles ajoutées après lui : c'est donc l'octroi qui convient à quelqu'un qui s'occupe d'un domaine entier. Les adresses accordées une par une restent telles quelles à côté de lui.
La personne doit déjà faire partie de l'espace de travail : invitez-la donc d'abord avec POST /members. Le propriétaire est refusé avec member_is_owner, parce qu'il atteint tous les domaines, et un espace de travail dont l'offre n'inclut pas l'accès d'équipe est refusé avec 403 plan_required.
Une clé ou une application limitée à certaines adresses ou certains domaines est refusée avec 422 capability_unsupported, et une application qui agit pour un membre ne peut donner qu'un domaine que ce membre atteint.
Un jeton d'accès OAuth a besoin d'un code de vérification pour cet appel. Tant que l'application n'en a pas vérifié un dans les 60 dernières minutes, l'appel répond 403 step_up_required et ne change rien. On ne le demande jamais à une clé API. La page Authentification montre comment demander un code et le vérifier.
Révoquer un domaine
Nécessite members:write. DELETE /members/{userId}/domains/{domainId}. Renvoie le membre, moins ce domaine.
curl -X DELETE \ "$OE/members/nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t/domains/7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f" \ -H "$AUTH"{ "object": "member", "userId": "nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t", "email": "[email protected]", "role": { "id": "role_2b81de079c1f0a4b7e05d386", "name": "Support", "builtin": null }, "addresses": [], "domains": [] }Les adresses du domaine accordées une par une restent accordées, et la personne garde son rôle.
Un domaine qui n'appartient pas à cet espace de travail est refusé avec 422 member_not_found plutôt qu'ignoré en silence.
Un jeton d'accès OAuth a besoin d'un code de vérification pour cet appel. Tant que l'application n'en a pas vérifié un dans les 60 dernières minutes, l'appel répond 403 step_up_required et ne change rien. On ne le demande jamais à une clé API. La page Authentification montre comment demander un code et le vérifier.