単一ロールの取得
パスで指定された単一のロール情報を返却する
📬 リクエスト
Section titled “📬 リクエスト”GET {resource_api_url}/roles/{name}
リクエストヘッダ
Section titled “リクエストヘッダ”| キー | 値 |
|---|---|
| Authorization | Bearer {アクセストークン} |
パスパラメータ
Section titled “パスパラメータ”| パラメータ | 形式 | 必須 | 説明 | 値の例 |
|---|---|---|---|---|
| name | 文字列 | YES | 検索対象のロール名 | sales_department |
クエリパラメータ
Section titled “クエリパラメータ”なし
✨ 成功レスポンス
Section titled “✨ 成功レスポンス”ステータスコード
Section titled “ステータスコード”200 : OK
レスポンスヘッダ
Section titled “レスポンスヘッダ”| キー | 値 |
|---|---|
| Content-Type | application/json |
レスポンスボディ
Section titled “レスポンスボディ”| フィールド | 形式 | 必須 | 説明 | 値の例 |
|---|---|---|---|---|
| name | 文字列 | YES | ロール名 | sales_department |
| display_name | 文字列 | YES | ロールの表示名 | 営業本部 |
| parent_name | 文字列 | NO | 親ロール名 | null |
レスポンスボディのサンプル
Section titled “レスポンスボディのサンプル”💬 具体的な要求事項
Section titled “💬 具体的な要求事項”- 検索対象のロールが存在しない場合は、「
404: Not Found」エラーを返却してください - システム内でロールの情報を階層構造で保持する場合、「parent_name」には対象ロールの1階層上のロール名を設定してください
📚 参考資料
Section titled “📚 参考資料”なし