組織とアクセス

組織・プロジェクト・アクセスと緊急停止

説明は公開 API の契約（OpenAPI）から生成しています。

エンドポイント

POST	/v1/platform/organizations
GET	/v1/platform/organization
GET	/v1/platform/members
POST	/v1/platform/members
DELETE	/v1/platform/members/{id}
PUT	/v1/platform/members/{id}/roles
PUT	/v1/platform/members/{id}/delegation
DELETE	/v1/platform/members/{id}/delegation
GET	/v1/platform/groups
PUT	/v1/platform/groups/{name}
GET	/v1/platform/projects
POST	/v1/platform/projects
GET	/v1/platform/service-accounts
POST	/v1/platform/service-accounts
POST	/v1/platform/service-accounts/{id}/keys
DELETE	/v1/platform/service-accounts/{id}/keys/{keyId}
GET	/v1/platform/engagements
POST	/v1/platform/engagements
POST	/v1/platform/engagements/{id}/narrow
POST	/v1/platform/engagements/{id}/revoke
POST	/v1/platform/suspension
DELETE	/v1/platform/suspension
GET	/v1/platform/network-policy
PUT	/v1/platform/network-policy
GET	/v1/platform/sso-connection
PUT	/v1/platform/sso-connection
DELETE	/v1/platform/sso-connection

createOrganization

POST/v1/platform/organizations

組織を作る。作った利用者が owner になる

パラメーター

名前	場所	型	必須	説明
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json — NameInput

名前	型	必須	説明
name	string	はい
display_name	string	はい

応答

• 201 — Organization: 組織
• default — Problem: RFC 9457 Problem Details

getOrganization

GET/v1/platform/organization

応答

• 200 — Organization: 組織
• default — Problem: RFC 9457 Problem Details

listMembers

GET/v1/platform/members

応答

• 200 — object: メンバー
• default — Problem: RFC 9457 Problem Details

inviteMember

POST/v1/platform/members

パラメーター

名前	場所	型	必須	説明
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json

名前	型	必須	説明
email	string	はい
roles	Role[]	はい
display_name	string

応答

• 201 — Member: 招待したメンバー
• default — Problem: RFC 9457 Problem Details

removeMember

DELETE/v1/platform/members/{id}

メンバーを組織から外す。その人のトークンは次の呼出しから拒否し、グループからも外す。owner を外せるのは owner だけで、最後の owner は外せない

パラメーター

名前	場所	型	必須	説明
id	path	string	はい

応答

• 200 — Member: 外したメンバー
• default — Problem: RFC 9457 Problem Details

setMemberRoles

PUT/v1/platform/members/{id}/roles

パラメーター

名前	場所	型	必須	説明
id	path	string	はい

リクエストの本文

application/json

名前	型	必須	説明
roles	Role[]	はい

応答

• 200 — Member: メンバー
• default — Problem: RFC 9457 Problem Details

setMemberDelegation

PUT/v1/platform/members/{id}/delegation

不在の期間（両端の日を含む）に、割り当ての候補をこのメンバーから代理のメンバーへ回す。本人か、メンバーを管理できる人が設定する

パラメーター

名前	場所	型	必須	説明
id	path	string	はい

リクエストの本文

application/json

名前	型	必須	説明
delegate_id	string	はい
starts_on	string	はい
ends_on	string	はい

応答

• 200 — Delegation: 代理
• default — Problem: RFC 9457 Problem Details

removeMemberDelegation

DELETE/v1/platform/members/{id}/delegation

パラメーター

名前	場所	型	必須	説明
id	path	string	はい

応答

• 204: 代理を外した
• default — Problem: RFC 9457 Problem Details

listGroups

GET/v1/platform/groups

応答

• 200 — object: グループ
• default — Problem: RFC 9457 Problem Details

putGroup

PUT/v1/platform/groups/{name}

パラメーター

名前	場所	型	必須	説明
name	path	string	はい

リクエストの本文

application/json

名前	型	必須	説明
display_name	string	はい
member_ids	string[]
emails	string[]

応答

• 200 — Group: グループ
• default — Problem: RFC 9457 Problem Details

listProjects

GET/v1/platform/projects

応答

• 200 — object: プロジェクト
• default — Problem: RFC 9457 Problem Details

createProject

POST/v1/platform/projects

パラメーター

名前	場所	型	必須	説明
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json — NameInput

名前	型	必須	説明
name	string	はい
display_name	string	はい

応答

• 201 — Project: プロジェクト
• default — Problem: RFC 9457 Problem Details

listServiceAccounts

GET/v1/platform/service-accounts

応答

• 200 — object: サービスアカウント
• default — Problem: RFC 9457 Problem Details

createServiceAccount

POST/v1/platform/service-accounts

パラメーター

名前	場所	型	必須	説明
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json

名前	型	必須	説明
name	string	はい
project	string	はい
environment	Environment	はい
scopes	string[]	はい

応答

• 201 — ServiceAccount: サービスアカウント
• default — Problem: RFC 9457 Problem Details

createApiKey

POST/v1/platform/service-accounts/{id}/keys

platform:keys.manage が必要。Idempotency-Key は要らない。応答を保存せず、呼ぶたびに権限を確かめて新しい鍵を発行する。 応答を受け取れなかった鍵は失効し、発行し直す

パラメーター

名前	場所	型	必須	説明
id	path	string	はい

リクエストの本文

application/json

名前	型	必須	説明
expires_at	string		この時刻から先は入口が拒否する。省くと期限を付けない。今より後の時刻にする

応答

• 201 — object: 発行した API キー
• default — Problem: RFC 9457 Problem Details

revokeApiKey

DELETE/v1/platform/service-accounts/{id}/keys/{keyId}

パラメーター

名前	場所	型	必須	説明
id	path	string	はい
keyId	path	string	はい

応答

• 200 — ApiKey: 失効した API キー
• default — Problem: RFC 9457 Problem Details

listEngagements

GET/v1/platform/engagements

platform:engagements.manage（顧客の管理者）が必要。委任の内容と、入った運営者の主体の一覧

応答

• 200 — object: 運営者の委任
• default — Problem: RFC 9457 Problem Details

createEngagement

POST/v1/platform/engagements

platform:engagements.manage（顧客の管理者）が必要。運営者の組織の主体が、決めたプロジェクトと環境に、決めた範囲で 入れるようにする。渡せるのは起案と実行のスコープだけで、人の承認の決定は渡せない。広げるときは新しい委任を作る

パラメーター

名前	場所	型	必須	説明
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json

名前	型	必須	説明
operator_organization	string	はい	運営者の組織の name か tenant_id
project	string	はい
environment	Environment	はい
operator_groups	string[]
operator_emails	string[]
scopes	string[]	はい
senders	string[]		運営者が使える送信の名義（SenderIdentity の名前）
valid_from	string
valid_until	string	はい

応答

• 201 — Engagement: 運営者の委任
• default — Problem: RFC 9457 Problem Details

narrowEngagement

POST/v1/platform/engagements/{id}/narrow

platform:engagements.manage（顧客の管理者）が必要。範囲を狭める。すぐ効き、入っている主体は入り直す。 いまの範囲を超える値は拒否する

パラメーター

名前	場所	型	必須	説明
id	path	string	はい
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json

名前	型	必須	説明
operator_groups	string[]
operator_emails	string[]
scopes	string[]
senders	string[]
valid_until	string

応答

• 200 — Engagement: 運営者の委任
• default — Problem: RFC 9457 Problem Details

revokeEngagement

POST/v1/platform/engagements/{id}/revoke

platform:engagements.manage（顧客の管理者）が必要。委任を止める。運営者のトークンは次の呼出しから拒否し、 その主体が始めた実行と、外へ出していない操作も止める

パラメーター

名前	場所	型	必須	説明
id	path	string	はい
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json

名前	型	必須	説明
reason	string	はい

応答

• 200 — Engagement: 運営者の委任
• default — Problem: RFC 9457 Problem Details

suspendOrganization

POST/v1/platform/suspension

緊急停止。すべての API と実行を止める

パラメーター

名前	場所	型	必須	説明
Idempotency-Key	header	string		副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる

リクエストの本文

application/json

名前	型	必須	説明
reason	string	はい

応答

• 200 — Organization: 組織
• default — Problem: RFC 9457 Problem Details

resumeOrganization

DELETE/v1/platform/suspension

緊急停止を解く（owner だけ）

応答

• 200 — Organization: 組織
• default — Problem: RFC 9457 Problem Details

getNetworkPolicy

GET/v1/platform/network-policy

接続元の制限。組織の API を呼べるネットワークの一覧と、この要求の接続元

応答

• 200 — NetworkPolicy: 接続元の制限
• default — Problem: RFC 9457 Problem Details

putNetworkPolicy

PUT/v1/platform/network-policy

ネットワークの一覧を置き換える。登録したネットワークから変えるときは、いまの接続元を一覧に残す

リクエストの本文

application/json

名前	型	必須	説明
networks	NetworkInput[]	はい

応答

• 200 — NetworkPolicy: 接続元の制限
• default — Problem: RFC 9457 Problem Details

getSsoConnection

GET/v1/platform/sso-connection

組織の IdP の接続。登録していなければ connection は null

応答

• 200 — SsoConnectionState: IdP の接続
• default — Problem: RFC 9457 Problem Details

putSsoConnection

PUT/v1/platform/sso-connection

登録すると、登録したドメインの社員はその IdP でログインし、組織へはその IdP のセッションでしか入れなくなる。IdP に登録する戻り先は <入口>/api/auth/sso/callback/<provider_id>

リクエストの本文

application/json — SsoConnectionInput

名前	型	必須	説明
issuer	string	はい	IdP の発行元（https の URL）。discovery の文書（/.well-known/openid-configuration）を読める必要がある
client_id	string	はい
client_secret	string	はい	保存するだけで、応答には返さない
domains	string[]	はい	この IdP でログインできるメールアドレスのドメイン。ほかの組織が登録したドメインと、だれでも作れるメールのドメインは登録できない

応答

• 200 — SsoConnectionState: IdP の接続
• default — Problem: RFC 9457 Problem Details

deleteSsoConnection

DELETE/v1/platform/sso-connection

IdP の接続を外す。外した後は、メンバーはメールのワンタイムコードでログインする

応答

• 204: 外した
• default — Problem: RFC 9457 Problem Details