権限のリスト
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/privileges
このAPIは、デフォルトでは名前順(昇順)で権限のリストを返します。
リクエスト
問合せパラメータ
- limit: integer
最小値:
1
最大値:2000
リストのページ分割用。ページ当たりの最大結果数、またはページ分割される"List"コールで返すアイテムの最大数。このAPIでは、limitとして指定した数より多を返すことはありませんが、その数が必ずしも返されるというわけではありません。デフォルト値:20
- name: string
フィルタ処理する権限の正確な名前例:
MANAGE_JOB
- nameContains: string
権限のフィルタ処理に使用される権限名の一部例:
MANAGE_JOB
- page: string
ページのシステム生成ページ・トークン。
- secureResourceType: string
権限のSecureResourceタイプ指定可能な値:
[ "ALL", "SYSTEM", "<TARGETやJOBなどのSecureResourceType>" ]
例:JOB
- sort: string
方向付きの結果セットの順序。許容されるソート・フィールドは名前です。指定可能な方向はDESCとASCです例:
name:DESC
この操作にはリクエスト本文はありません。
先頭に戻るレスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
権限のリストが正常に返されました
ルート・スキーマ: PrivilegeCollection
型:
object
これは権限のリストを表すものです。
ソースの表示
-
count(必須): integer
権限の数例:
20
-
items(必須): array items
権限リスト
-
links(必須): links
結果セットのナビゲーション・リンク
ネストされたスキーマ: links
型:
object
結果セットのナビゲーション・リンク
ソースの表示
-
next: object Link
リンクを表します(self、previous、nextのいずれか)
-
previous: object Link
リンクを表します(self、previous、nextのいずれか)
-
self: object Link
リンクを表します(self、previous、nextのいずれか)
ネストされたスキーマ: PrivilegeSummary
型:
object
権限を表します
ソースの表示
-
applicableTypes: array applicableTypes
権限が適用されるSecureResourceタイプ。
-
description: string
権限の説明例:
Ability to perform various operations except edit and delete on job
-
displayName: string
権限の表示名例:
Manage
-
includedPrivileges: array includedPrivileges
この権限にすでに含まれている権限
-
isDefault: boolean
SecureResourceが選択された場合のスーパー管理者以外に対するデフォルト権限例:
true
-
isDefaultToSuperUser: boolean
SecureResourceが選択された場合のスーパー管理者に対するデフォルト権限例:
false
-
isGrantedToSuperUser: boolean
権限がスーパーユーザーに付与されるかどうか例:
false
-
name: string
権限の名前例:
MANAGE_JOB
-
privilegeRequiredToGrant: string
この権限を付与するために必要な権限例:
GRANT_VIEW_JOB
-
scope: string
権限のスコープ例:
Resource
-
secureResourceType: string
権限のSecureResourceタイプ例:
JOB
-
secureResourceTypeDescription: string
SecureResourceタイプの説明例:
Security class defines the access model behaviour for job
-
secureResourceTypeDisplayName: string
SecureResourceタイプの表示名例:
Job System
ネストされたスキーマ: applicableTypes
型:
array
権限が適用されるSecureResourceタイプ。
ソースの表示
- 配列: string
例:
oracle_database
ネストされたスキーマ: Link
型:
object
リンクを表します(self、previous、nextのいずれか)
ソースの表示
-
href: string
リンクのためのURL例:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
401レスポンス
認証に失敗しました
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
403レスポンス
許可されていません
ルート・スキーマ: MissingPrivErrorResponse
型:
object
必要な権限がない場合にエラーとして返送されるレスポンス
ソースの表示
-
missingPrivileges: array missingPrivileges
エラーが発生したために欠落している権限。これにより、権限オブジェクトには権限の内部名および表示名のみが含まれます
すべてに一致
ソースの表示
- object ErrorResponse
エラー・レスポンス
ネストされたスキーマ: missingPrivileges
型:
array
エラーが発生したために欠落している権限。これにより、権限オブジェクトには権限の内部名および表示名のみが含まれます
ソースの表示
- 配列: object MissingPrivilegeSummary
これは、リソースの表示または管理のための権限がないことを表します。
ネストされたスキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
ネストされたスキーマ: MissingPrivilegeSummary
型:
object
これは、リソースの表示または管理のための権限がないことを表します。
ソースの表示
-
displayName: string
権限の表示名例:
Manage
-
name: string
権限の名前例:
MANAGE_JOB
500レスポンス
内部サーバー・エラー
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
503レスポンス
サービスを使用できません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
デフォルト・レスポンス
予期しないエラー
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列