Conceder y revocar un dominio
Un dominio completo de una vez: todas sus direcciones, incluidas las que se añadan después.
Ejecuta cualquiera de las 2 llamadas en tu espacio de trabajo.
POST /members/{userId}/domains
Un dominio completo de una vez: todas sus direcciones, incluidas las que se añadan después.
Conceder un dominio
Requiere members:write. POST /members/{userId}/domains con { domainId, access }; access es member de forma predeterminada. Devuelve el miembro completo tal como queda, con la concesión en 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, como una concesión de dirección: volver a hacer POST con un access distinto cambia la concesión en lugar de añadir una segunda.
Una concesión de dominio llega a todas las direcciones del dominio, incluidas las que se añadan después de ella, así que es la concesión para alguien que se ocupa de un dominio completo. Las direcciones concedidas una a una se quedan como están junto a ella.
La persona tiene que estar ya en el espacio de trabajo, así que invítala primero con POST /members. Al propietario se le rechaza con member_is_owner, porque llega a todos los dominios, y un espacio de trabajo cuyo plan no incluye acceso de equipo se rechaza con 403 plan_required.
Una clave o una app limitada a direcciones o dominios concretos se rechaza con 422 capability_unsupported, y una app que actúa por un miembro solo puede dar un dominio al que llega ese miembro.
Un token de acceso OAuth necesita un código de verificación para esta llamada. Hasta que la app haya verificado uno en los últimos 60 minutos, la llamada responde 403 step_up_required y no cambia nada. A una clave de API nunca se le pide. La página Autenticación muestra cómo pedir un código y verificarlo.
Revocar un dominio
Requiere members:write. DELETE /members/{userId}/domains/{domainId}. Devuelve el miembro, menos ese dominio.
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": [] }Las direcciones del dominio que se concedieron una a una siguen concedidas, y la persona conserva su rol.
Un dominio que no pertenece a este espacio de trabajo se rechaza con 422 member_not_found en lugar de ignorarse en silencio.
Un token de acceso OAuth necesita un código de verificación para esta llamada. Hasta que la app haya verificado uno en los últimos 60 minutos, la llamada responde 403 step_up_required y no cambia nada. A una clave de API nunca se le pide. La página Autenticación muestra cómo pedir un código y verificarlo.