Conceder e revogar um domínio
Um domínio inteiro de uma vez: todos os endereços nele, incluindo os que forem adicionados depois.
Executa qualquer uma das 2 chamadas no seu espaço de trabalho.
POST /members/{userId}/domains
Um domínio inteiro de uma vez: todos os endereços nele, incluindo os que forem adicionados depois.
Conceder um domínio
Requer members:write. POST /members/{userId}/domains com { domainId, access }; access assume member por omissão. Devolve o membro inteiro tal como fica, com a concessão em 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" } ] }Um upsert, como uma concessão de endereço: voltar a fazer POST com um access diferente altera a concessão em vez de acrescentar uma segunda.
Uma concessão de domínio alcança todos os endereços do domínio, incluindo os que forem adicionados depois dela, por isso é a concessão para quem cuida de um domínio inteiro. Os endereços concedidos um a um ficam como estão ao lado dela.
A pessoa tem de estar já no espaço de trabalho, por isso convide-a primeiro com POST /members. O proprietário é recusado com member_is_owner, porque alcança todos os domínios, e um espaço de trabalho cujo plano não inclui acesso de equipa é recusado com 403 plan_required.
Uma chave ou uma app limitada a determinados endereços ou domínios é recusada com 422 capability_unsupported, e uma app que age por um membro só pode dar um domínio que esse membro alcance.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.
Revogar um domínio
Requer members:write. DELETE /members/{userId}/domains/{domainId}. Devolve o membro, menos esse domínio.
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": [] }Os endereços do domínio que foram concedidos um a um continuam concedidos, e a pessoa mantém a sua função.
Um domínio que não pertence a este espaço de trabalho é recusado com 422 member_not_found em vez de ignorado em silêncio.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.