取得¶
GET /api/v1/role/{role_uuid}/get
概要¶
現在のワークスペース内にある指定ロールの基本情報と権限識別子を取得します。
呼び出し前の準備と使用手順¶
先にロール一覧を呼び出して、ロール UUID を取得します。権限識別子を名前に表示する場合は、権限一覧からディレクトリを読み取れます。ロールが持つ権限と現在の API キーが持つ権限は、それぞれ異なる呼び出しによって決まります。
サイトドメイン表から、所属サイトの OpenAPI アドレスを選択します。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| role_uuid | string | Y | 対象ロールの UUID。 例: role_example取得または入力方法: ロール一覧レスポンスの content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI キーの認証情報。完全なキー値を使用し、API キーレコードの UUID は使用しません。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API キー管理で、この API の権限を持つキーを作成または取得します。 |
パラメータの補足¶
ワークスペースはリクエスト内の DF-API-KEY によって決まります。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/role/role_example/get"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | ロールレコード ID。 |
| content.uuid | string | ロール UUID。以降のロール詳細照会ではこのフィールドを使用します。 |
| content.name | string | ロール名。 |
| content.desc | string | ロールの説明。 |
| content.isSystem | integer | 1 はシステム組み込みロール、0 はその他のロールを示します。 |
| content.workspaceUUID | string | ロールが所属する、または適用されるワークスペース。システム組み込みロールの場合は空になることがあります。 |
| content.builtinRoleUUID | string | 管理バックエンドの組み込みロールテンプレート UUID。テンプレートがない場合は空です。 |
| content.isAllWorkspace | integer | 管理バックエンドの組み込みロールをすべてのワークスペースに適用するかどうか。0 はいいえ、1 ははいです。 |
| content.isManageBuiltinRole | boolean | 管理バックエンドで定義および適用された組み込みロールかどうか。 |
| content.creator | string | 作成者の識別子。 |
| content.updator | string | 最終更新者の識別子。 |
| content.createAt | integer | 作成日時。Unix 秒。 |
| content.updateAt | integer | 最終更新日時。Unix 秒。 |
| content.deleteAt | integer | 削除日時。Unix 秒。未削除の場合は -1。 |
| content.status | integer | ロールレコードのステータス。 |
| content.creatorInfo | object | 作成者情報。取得できない場合は {}。 |
| content.updatorInfo | object | 最終更新者情報。取得できない場合は {}。 |
| content.permissions | array<string> |
現在のロールの権限識別子の集合。 |
| content.declaration | object または null | ワークスペースの公開宣言データ。設定が空の場合は null になることがあります。 |
{
"code": 200,
"content": {
"id": 101,
"uuid": "role_example",
"name": "日志只读",
"desc": "查询应用日志",
"isSystem": 0,
"workspaceUUID": "wksp_example",
"builtinRoleUUID": "",
"isAllWorkspace": 0,
"isManageBuiltinRole": false,
"status": 0,
"creatorInfo": {},
"updatorInfo": {},
"permissions": [
"routine.defaultAccess"
],
"declaration": null
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundRole | 対応するロールが存在しない、削除済み、または現在のワークスペースで利用できない | 指定されたロールが見つからないか、ロールが削除されています。 | 現在のワークスペースのロール一覧を再取得し、実際に返された uuid を使用します。 |