環境ロールを作成

POST /v1/roles · 権限 roles:write

環境のロールカタログにロールを作成します。レスポンスには ETag が含まれ、書き込みは role.created として監査されます。Idempotency-Key は任意です。

リクエスト

フィールド 型 必須 説明
key string はい 小文字、数字、_、- のみ。1〜64 文字。スコープ内で一意で、変更できません。
name string はい 表示名。最大 128 文字。
description string いいえ 最大 1024 文字。
is_privileged boolean いいえ 特権ロールとして指定します。セルフサービスでは、組織の管理者ロール（org_admin_role_id）を持つメンバーのみが割り当てられます。外部グループをこのロールにマッピングするには roles:write と承認が必要です。
assignable_in_self_service boolean いいえ 既定値は true。特権ロールの場合も同様です。

レスポンス

ロールとともに 201 Created。

{
  "id": "rol_01j9xr7s1t2w6x8y0z2a4b6c8e",
  "organization_id": null,
  "key": "support",
  "name": "Support",
  "description": "",
  "is_privileged": false,
  "assignable_in_self_service": true,
  "permission_ids": [],
  "created_at": "2026-10-12T09:31:00.123456Z",
  "updated_at": "2026-10-12T09:31:00.123456Z",
  "version": 1
}

エラー

HTTP code 発生条件
409 role_key_conflict 同じスコープに、この key のロールが既にあります。
409 role_limit_reached 環境ロール 1,000 件、または組織あたり 50 件の上限に達しています。
422 validation_failed フィールドが欠落しているか、無効です。
401 unauthenticated 資格情報がない、無効、または失効しています。
403 insufficient_permissions 資格情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間を待ってから再試行してください。
503 service_unavailable 依存先が一時的に利用できません。Retry-After の期間を待ってから再試行してください。

例

curl -i -X POST "https://api.eu.keenauth.com/v1/roles" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"support","name":"Support"}'