Eine Domain gewähren und entziehen
Eine ganze Domain auf einmal: jede Adresse darauf, auch später hinzugefügte.
Führt jeden der 2 Aufrufe in Ihrem Workspace aus.
POST /members/{userId}/domains
Eine ganze Domain auf einmal: jede Adresse darauf, auch später hinzugefügte.
Eine Domain gewähren
Benötigt members:write. POST /members/{userId}/domains mit { domainId, access }; access ist standardmäßig member. Gibt das gesamte Mitglied in seinem nunmehrigen Zustand zurück, mit dem Grant in 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" } ] }Ein Upsert, wie ein Adress-Grant: Erneutes Posten mit einem anderen access ändert den Grant, statt einen zweiten hinzuzufügen.
Ein Domain-Grant erreicht jede Adresse der Domain, auch Adressen, die nach ihm hinzugefügt werden, und ist damit der Grant für jemanden, der sich um eine ganze Domain kümmert. Einzeln gewährte Adressen bleiben daneben, wie sie sind.
Die Person muss bereits im Workspace sein, laden Sie sie also zuerst mit POST /members ein. Der Inhaber wird mit member_is_owner abgelehnt, weil er jede Domain erreicht, und ein Workspace, dessen Tarif keinen Teamzugang enthält, wird mit 403 plan_required abgelehnt.
Ein auf bestimmte Adressen oder Domains beschränkter Schlüssel oder eine so beschränkte App wird mit 422 capability_unsupported abgelehnt, und eine App, die für ein Mitglied handelt, kann nur eine Domain vergeben, die dieses Mitglied erreicht.
Ein OAuth-Zugriffstoken braucht für diesen Aufruf einen Bestätigungscode. Solange die App in den letzten 60 Minuten keinen bestätigt hat, antwortet der Aufruf mit 403 step_up_required und ändert nichts. Ein API-Schlüssel wird nie gefragt. Die Seite Authentifizierung zeigt, wie Sie einen Code anfordern und bestätigen.
Eine Domain entziehen
Benötigt members:write. DELETE /members/{userId}/domains/{domainId}. Gibt das Mitglied zurück, abzüglich dieser Domain.
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": [] }Einzeln gewährte Adressen der Domain bleiben gewährt, und die Person behält ihre Rolle.
Eine Domain, die nicht zu diesem Workspace gehört, wird mit 422 member_not_found abgelehnt statt stillschweigend ignoriert.
Ein OAuth-Zugriffstoken braucht für diesen Aufruf einen Bestätigungscode. Solange die App in den letzten 60 Minuten keinen bestätigt hat, antwortet der Aufruf mit 403 step_up_required und ändert nichts. Ein API-Schlüssel wird nie gefragt. Die Seite Authentifizierung zeigt, wie Sie einen Code anfordern und bestätigen.