すべてのロールを取得
リクエスト
GET <REST API URL>/roles?fields=string&$skip=int&$top=int&query=string&orderBy=stringパラメーター | 説明 |
|---|---|
fields | オプション。各ロールのフィールドの指定されたサブセットのみを返します。フィールド構文を使用してサブセットを定義します。 |
$skip | オプション。最初のロールを返す前にスキップするロールの数を設定できます。 |
$top | オプション。返すロールの最大数を設定できます。 |
query | オプション。検索クエリを指定して、返された結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。ロールについては、次のフィールドとタプルがサポートされています。 has : permission — いくつかの権限を持つロール id : value — 指定された ID のロール key : roleKey — 指定されたキーを持つロール name : roleName — 名のロール permission : permission — 与えられた許可を含むロール permission (key : permissionKey , service : service） — 指定された権限を含むロール permission (service : service） — サービスから少なくとも 1 つの権限を持つロール has : permission — いくつかの権限を持つデフォルトのロール id : value — 指定された ID のサービスのデフォルトのロール key : value — 指定されたキーを持つデフォルトのロール name : value — 指定された名前のデフォルトのロール permission : permission — 指定された権限を含むデフォルトのロール |
orderBy | オプション。指定されたフィールドでソートされたロールのリストを返します。詳細については、ソート構文を参照してください。ロールは、次のフィールドによる順序付けをサポートします: key、name、key、name |
レスポンス
レスポンスコード | 意味 |
|---|---|
200 OK | リクエストが成功しました。 |
400 不正な要求 | リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。 |
403 禁止します | 要求元は、要求されたリソースにアクセスできません。 |
404 お探しのページが見つかりませんでした | 要求されたリソースが見つかりませんでした。 |
500 内部サーバーエラー | サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。 |
レスポンスボディ
{
"skip": int,
"top": int,
"total": int,
"roles": [role, ...]
}
