문서로 건너뛰기
API

도메인 권한 부여와 회수

도메인 전체를 한 번에: 나중에 추가되는 주소까지 포함해 그 도메인의 모든 주소.

POST/members/{userId}/domains

2개 호출을 워크스페이스에 실제로 실행합니다.

POST /members/{userId}/domains

도메인 전체를 한 번에: 나중에 추가되는 주소까지 포함해 그 도메인의 모든 주소.

도메인 권한 부여

members:write가 필요합니다. POST /members/{userId}/domains에 { domainId, access }를 보냅니다. access의 기본값은 member입니다. 현재 상태의 멤버 전체를 반환하며, 권한 부여는 domains에 담겨 있습니다.

curl
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하면 두 번째 부여를 추가하지 않고 기존 부여를 바꿉니다.

도메인 권한 부여는 부여한 뒤에 추가된 주소까지 포함해 그 도메인의 모든 주소에 닿습니다. 그래서 도메인 전체를 맡은 사람에게 알맞은 부여입니다. 하나씩 부여한 주소는 도메인 부여와 별개로 그대로 남습니다.

그 사람은 이미 워크스페이스에 있어야 하므로, 먼저 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
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": []  }

그 도메인에서 하나씩 부여한 주소는 부여된 채로 남고, 그 사람의 역할도 그대로입니다.

이 워크스페이스에 없는 도메인은 조용히 무시되지 않고 422 member_not_found로 거부됩니다.

OAuth 액세스 토큰으로 이 호출을 하려면 인증 코드가 필요합니다. 앱이 최근 60분 안에 코드를 인증하기 전까지 호출은 403 step_up_required로 응답하고 아무것도 바꾸지 않습니다. API 키는 요구받지 않습니다. 코드를 요청하고 인증하는 방법은 인증 페이지에 있습니다.

레퍼런스