ドメインの付与と取り消し
一度にドメイン全体を扱います。後から追加されるものも含め、そのドメインのすべてのアドレスが対象です。
2件の呼び出しをワークスペースに対して実行します。
POST /members/{userId}/domains
一度にドメイン全体を扱います。後から追加されるものも含め、そのドメインのすべてのアドレスが対象です。
ドメインを付与する
members:write が必要です。POST /members/{userId}/domains に { domainId, access } を送ります。access の既定値は member です。更新後のメンバー全体を返し、付与は 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" } ] }アドレスの付与と同じく upsert です。別の access で再度 POST すると、2 つ目の付与を追加するのではなく、既存の付与が変更されます。
ドメインの付与は、付与の後に追加されたアドレスも含め、そのドメインのすべてのアドレスに届きます。そのため、ドメイン全体を担当する人にはこの付与が向いています。1 つずつ付与されたアドレスは、ドメインの付与とは別にそのまま残ります。
その人はすでにワークスペースにいる必要があるので、先に POST /members で招待してください。オーナーはすべてのドメインに届くため member_is_owner で拒否され、プランにチームメンバーが含まれないワークスペースは 403 plan_required で拒否されます。
特定のアドレスやドメインに限定されたキーやアプリは 422 capability_unsupported で拒否されます。また、メンバーの代わりに動くアプリが付与できるのは、そのメンバーが届くドメインだけです。
OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。
ドメインを取り消す
members:write が必要です。DELETE /members/{userId}/domains/{domainId}。そのドメインを除いたメンバーを返します。
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": [] }そのドメインのアドレスのうち 1 つずつ付与されたものは付与されたまま残り、その人のロールもそのままです。
このワークスペースにないドメインは、黙って無視されるのではなく 422 member_not_found で拒否されます。
OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。