ロール取得
ロール情報の取得を行います。
基本仕様
- エンドポイント : /roles/{role_id}
- メソッド : GET
なおエンドポイントの{role_id}は省略可能です。省略した場合ロール一覧が取得できます。
リクエストヘッダー
APIキーなどの共通の設定は「Cracker API概要」を参照してください。
パスパラメータ
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| role_id | 文字列 | 特定のロール情報を取得する場合、ロールIDを指定します。 |
クエリパラメータ
なし
リクエストボディ
なし
レスポンスボディ
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| role_id | 文字列 | ロールID |
| role_name | 文字列 | ロール名 |
| authority | 文字列 | ex)A000000000000000000000000000000 |
authority詳細は「データベース構成と規則」を参照
レスポンスボディサンプル
{
"role_id": "0f1eeff3-6217-4b56-1bc1-9012d82a7da1",
"role_name": "クラス展示",
"authority": "A000000000000000000000000000000"
}