Oracle Enterprise ManagerのREST API

権限のリスト

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

結果セットのナビゲーション・リンク

{
    "required":[
        "count",
        "items",
        "links"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of privileges",
            "example":"20"
        },
        "links":{
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The result set navigation links"
        },
        "items":{
            "type":"array",
            "description":"The privilege list",
            "items":{
                "$ref":"#/components/schemas/PrivilegeSummary"
            }
        }
    },
    "description":"This is the representation of list of Privileges."
}

ネストされたスキーマ: items

型: array

権限リスト

ソースの表示

配列: object PrivilegeSummary

権限を表します

{
    "type":"array",
    "description":"The privilege list",
    "items":{
        "$ref":"#/components/schemas/PrivilegeSummary"
    }
}

ネストされたスキーマ: links

型: object

結果セットのナビゲーション・リンク

ソースの表示

next: object Link

リンクを表します(self、previous、nextのいずれか)
previous: object Link

リンクを表します(self、previous、nextのいずれか)
self: object Link

リンクを表します(self、previous、nextのいずれか)

{
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The result set navigation links"
}

ネストされたスキーマ: 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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        },
        "description":{
            "type":"string",
            "description":"Description of Privilege",
            "example":"Ability to perform various operations except edit and delete on job"
        },
        "secureResourceType":{
            "type":"string",
            "description":"SecureResource Type of Privilege",
            "example":"JOB"
        },
        "includedPrivileges":{
            "type":"array",
            "description":"Privileges which are already part of this privilege",
            "items":{
                "type":"string",
                "example":"VIEW_JOB"
            }
        },
        "secureResourceTypeDescription":{
            "type":"string",
            "description":"Description of SecureResource type",
            "example":"Security class defines the access model behaviour for job"
        },
        "isGrantedToSuperUser":{
            "type":"boolean",
            "description":"Privilege is granted to Super User or not",
            "example":false
        },
        "secureResourceTypeDisplayName":{
            "type":"string",
            "description":"Display Name of SecureResource Type",
            "example":"Job System"
        },
        "scope":{
            "type":"string",
            "description":"Scope of Privilege",
            "example":"Resource"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Default privilege when a SecureResource is picked up for a Non-Super Administrator",
            "example":true
        },
        "isDefaultToSuperUser":{
            "type":"boolean",
            "description":"Default privilege when a SecureResource is picked up for a Super Administrator",
            "example":false
        },
        "applicableTypes":{
            "type":"array",
            "description":"SecureResource Type for which the privilege is applicable.",
            "items":{
                "type":"string",
                "example":"oracle_database"
            }
        },
        "privilegeRequiredToGrant":{
            "type":"string",
            "description":"Privilege required to grant this privilege",
            "example":"GRANT_VIEW_JOB"
        }
    },
    "description":"It represents a Privilege"
}

ネストされたスキーマ: applicableTypes

型: array

権限が適用されるSecureResourceタイプ。

ソースの表示

配列: string

例: oracle_database

{
    "type":"array",
    "description":"SecureResource Type for which the privilege is applicable.",
    "items":{
        "type":"string",
        "example":"oracle_database"
    }
}

ネストされたスキーマ: includedPrivileges

型: array

この権限にすでに含まれている権限

ソースの表示

配列: string

例: VIEW_JOB

{
    "type":"array",
    "description":"Privileges which are already part of this privilege",
    "items":{
        "type":"string",
        "example":"VIEW_JOB"
    }
}

ネストされたスキーマ: Link

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

href: string

リンクのためのURL

例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

401レスポンス

認証に失敗しました

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403レスポンス

許可されていません

ルート・スキーマ: MissingPrivErrorResponse

型: object

必要な権限がない場合にエラーとして返送されるレスポンス

ソースの表示

missingPrivileges: array missingPrivileges

エラーが発生したために欠落している権限。これにより、権限オブジェクトには権限の内部名および表示名のみが含まれます

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

すべてに一致

ソースの表示

object ErrorResponse

エラー・レスポンス

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

ネストされたスキーマ: missingPrivileges

型: array

エラーが発生したために欠落している権限。これにより、権限オブジェクトには権限の内部名および表示名のみが含まれます

ソースの表示

配列: object MissingPrivilegeSummary

これは、リソースの表示または管理のための権限がないことを表します。

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

ネストされたスキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

ネストされたスキーマ: MissingPrivilegeSummary

型: object

これは、リソースの表示または管理のための権限がないことを表します。

ソースの表示

displayName: string

権限の表示名

例: Manage
name: string

権限の名前

例: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

500レスポンス

内部サーバー・エラー

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

サービスを使用できません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

デフォルト・レスポンス

予期しないエラー

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る