権限情報の一覧取得¶
GET /api/v1/permission/list
概要¶
対象ワークスペースでロール設定に使用できる権限カタログを読み取ります。
呼び出し前の準備と使用手順¶
カスタムロールを設定する場合は、isSupportCustomRole=true を指定して選択可能な権限項目を取得し、その後 subs 内の key を読み取ります。返されるのは権限カタログと適用範囲です。特定のロールに付与済みの権限を照会する場合は、そのロールの詳細を読み取ってください。
サイトドメイン一覧から、所属サイトの OpenAPI アドレスを選択します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI Key 認証情報。API Key レコードの UUID ではなく、完全なキー値を使用します。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理で、本インターフェースの権限を持つ Key を作成または取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| isSupportCustomRole | boolean | 省略した場合はフィルタリングしません。true の場合はカスタムロールをサポートする権限項目のみを返し、false の場合はサポートしない項目のみを返します。一致する項目がないグループは省略されます。 null を許可: False 例: true取得・入力方法: フォームの要件に応じて、カスタムロールに設定可能な権限のみを表示するかを選択します。 |
パラメータ補足説明¶
ワークスペースはリクエスト内の DF-API-KEY によって決定されます。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/permission/list" \
--data-urlencode "isSupportCustomRole=true"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<object> |
本ページの結果。レコードがない場合は空配列です。 |
| content[].key | string | 権限識別子。ロール詳細の permissions に現れる場合があります。 |
| content[].name | string | 権限の表示名。 |
| content[].desc | string | 権限の機能説明。 |
| content[].disabled | integer | 選択不可フラグ。カスタムロールでの選択をサポートする場合は 0、それ以外は 1 です。 |
| content[].forbidWorkspaceVersion | array<string> |
無効に設定されているワークスペースバージョン。 |
| content[].isSupportOwner | integer | オーナーに適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].isSupportWsAdmin | integer | 管理者に適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].isSupportGeneral | integer | 標準メンバーに適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].isSupportReadOnly | integer | 読み取り専用メンバーに適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].isSupportAgent | integer | 招待された代理 ID に適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].isSupportCustomRole | integer | カスタムロールでの選択をサポートするかどうか。1 はサポート、0 は非サポートです。 |
| content[].subPermission | array<string> または string |
依存するその他の権限識別子。依存関係がない場合は空文字列または空配列になります。 |
| content[].subs | array<object> |
このグループのうち、フィルタ条件を満たす権限項目。 |
| content[].declaration | object または null | ワークスペース宣言。空でない結果に共通する情報です。 |
| content[].subs[].key | string | 権限識別子。ロール詳細の permissions に現れる場合があります。 |
| content[].subs[].name | string | 権限の表示名。 |
| content[].subs[].desc | string | 権限の機能説明。 |
| content[].subs[].disabled | integer | 選択不可フラグ。カスタムロールでの選択をサポートする場合は 0、それ以外は 1 です。 |
| content[].subs[].forbidWorkspaceVersion | array<string> |
無効に設定されているワークスペースバージョン。 |
| content[].subs[].isSupportOwner | integer | オーナーに適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].subs[].isSupportWsAdmin | integer | 管理者に適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].subs[].isSupportGeneral | integer | 標準メンバーに適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].subs[].isSupportReadOnly | integer | 読み取り専用メンバーに適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].subs[].isSupportAgent | integer | 招待された代理 ID に適用されるかどうか。1 はサポート、0 は非サポートです。 |
| content[].subs[].isSupportCustomRole | integer | カスタムロールでの選択をサポートするかどうか。1 はサポート、0 は非サポートです。 |
| content[].subs[].subPermission | array<string> または string |
依存するその他の権限識別子。依存関係がない場合は空文字列または空配列になります。 |
{
"code": 200,
"content": [
{
"key": "workspace.*",
"name": "ワークスペース",
"desc": "",
"subPermission": "",
"disabled": 1,
"subs": [
{
"key": "workspace.memberManage",
"name": "メンバー管理",
"desc": "ワークスペースのメンバーを管理",
"subPermission": "",
"disabled": 0,
"isSupportCustomRole": 1
}
],
"isSupportCustomRole": 0,
"declaration": null
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータが渡された | メッセージに無効なパラメータが示されます。 | パラメータ表に記載されていないフィールドを削除します。 |
| 406 | ft.NotFoundWorkspace | API Key に対応するワークスペースが見つからない | ワークスペースが存在しません。 | Key が属するワークスペースが有効かどうかを確認します。 |