Oracle Enterprise ManagerのREST API

指定の検索詳細に対するロールのリスト

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/roles/actions/search

このAPIは、リクエスト本文で指定された検索詳細に対するロールのリストを返します。デフォルトでは名前順(昇順)の結果を返します。検索は、システム権限またはセキュア・リソースIDを持つオブジェクト権限によって権限基準を指定することで実行できます。

リクエスト

問合せパラメータ

limit: integer

最小値: 1

最大値: 2000

リストのページ分割用。ページ当たりの最大結果数、またはページ分割される"List"コールで返すアイテムの最大数。このAPIでは、limitとして指定した数より多を返すことはありませんが、その数が必ずしも返されるというわけではありません。

デフォルト値: 20
page: string

ページのシステム生成ページ・トークン。
sort: string
方向付きの結果セットの順序。許容されるソート・フィールドは名前です。指定可能な方向はDESCとASCです
例:
```
name:DESC
```

サポートされているメディア・タイプ

application/json

ルート・スキーマ: schema

型: object

ロールの検索条件を指定するオブジェクト

ソースの表示

privilegeCriteria: object RoleSearchPrivilegeCriteria

権限およびセキュア・リソースIDに基づいてロール検索基準を指定するためのオブジェクト

{
    "type":"object",
    "properties":{
        "privilegeCriteria":{
            "$ref":"#/components/schemas/RoleSearchPrivilegeCriteria"
        }
    },
    "description":"Object for providing searching conditions for Roles"
}

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

型: object

権限およびセキュア・リソースIDに基づいてロール検索基準を指定するためのオブジェクト

ソースの表示

privilegeName: string

権限名

例: EDITT_JOB
secureResourceId: string

セキュア・リソースのID

例: 7A9DC0E23DFE8DFDE050590AC0EC2AD8

{
    "type":"object",
    "properties":{
        "privilegeName":{
            "type":"string",
            "description":"Name of a Privilege",
            "example":"EDITT_JOB"
        },
        "secureResourceId":{
            "type":"string",
            "description":"Id of a Secure Resource",
            "example":"7A9DC0E23DFE8DFDE050590AC0EC2AD8"
        }
    },
    "description":"Object for providing Role search criteria based on a Privilege and a Secure Resource Id"
}

例

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

検索に対するロールのリストが正常に返されました

ルート・スキーマ: RoleCollection

型: object

これはロールのリストを表すものです。

ソースの表示

count(必須): integer

このページ内のロールの数

例: 20
items(必須): array items

ロールのリスト
links(必須): object links

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

{
    "required":[
        "count",
        "items",
        "links"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of Roles in this page",
            "example":"20"
        },
        "links":{
            "type":"object",
            "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 list of roles",
            "items":{
                "$ref":"#/components/schemas/RoleSummary"
            }
        }
    },
    "description":"This is the representation of list of Roles."
}

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

型: array

ロールのリスト

ソースの表示

配列: object RoleSummary

ロールを表します

{
    "type":"array",
    "description":"The list of roles",
    "items":{
        "$ref":"#/components/schemas/RoleSummary"
    }
}

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

型: object

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

ソースの表示

next: object Link

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

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

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

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

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

型: object

ロールを表します

すべてに一致

ソースの表示

object allOf RoleDetails

ロールを表します

{
    "type":"object",
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleDetails"
        }
    ]
}

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

型: object

ロールを表します

ソースの表示

id: string

読取り専用: true

ロールの一意識別子

例: B0F9D83F6E313B03E0537013790ACA39
isPrivate: boolean

ロールがプライベート・ロールかどうか

例: false
links: object links

読取り専用: true

ロールの関連リンク
name: string

ロール名

例: EM_ALL_ADMINISTRATOR
owner: string

読取り専用: true

ロールを所有するユーザー

例: SYSMAN
type: array type

ロールのタイプ

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"array",
            "description":"Type of Role",
            "example":"EM Role",
            "items":{
                "$ref":"#/components/schemas/RoleType"
            }
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Role is a private role or not",
            "example":false
        },
        "owner":{
            "type":"string",
            "description":"User who owns the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "roleGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "privilegeGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "grantees":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the Role related links",
            "readOnly":true
        }
    },
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleCommonDetails"
        }
    ]
}

すべてに一致

ソースの表示

object RoleCommonDetails

ロールの一部の情報を表します

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"array",
            "description":"Type of Role",
            "example":"EM Role",
            "items":{
                "$ref":"#/components/schemas/RoleType"
            }
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Role is a private role or not",
            "example":false
        },
        "owner":{
            "type":"string",
            "description":"User who owns the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "roleGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "privilegeGrants":{
                    "$ref":"#/components/schemas/Link"
                },
                "grantees":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"the Role related links",
            "readOnly":true
        }
    },
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleCommonDetails"
        }
    ]
}

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

型: object

ロールの一部の情報を表します

ソースの表示

description: string

ロールについての説明

例: Role has privileges to perform Enterprise Manager administrative operations
isWithAdmin: boolean

プライベート・ロールにWITH_ADMINがあるかどうか。この属性はプライベート・ロールにのみ存在します。

例: true

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description about the Role",
            "example":"Role has privileges to perform Enterprise Manager administrative operations"
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"Private Role has WITH_ADMIN or not. This attribute exists only for Private Roles.",
            "example":true
        }
    },
    "description":"It represents some information of a Role"
}

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

400レスポンス

不正なリクエスト

ルート・スキーマ: 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"
        }
    }
}

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"
        }
    }
}

先頭に戻る