移動先

• リクエスト
• レスポンス

ユーザーに付与されたロールのリスト

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/users/{userId}/roleGrants

このAPIは、デフォルトでは名前順(昇順)でユーザーに付与されたロールのリストを返します。

リクエスト

パス・パラメータ

• userId(必須): string
  ユーザーのID。

問合せパラメータ

• limit: integer
  最小値: 1

  最大値: 2000

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

  デフォルト値: 20
• name: string
  フィルタ処理するロール付与の正確な名前

  例:

  EM_ALL_OPERATOR

• nameContains: string
  ロール付与のフィルタ処理に使用されるロール付与名の一部

  例:

  EM_ALL

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

  例:

  name:DESC

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

ユーザーのRoleGrantsが正常に返されました

本文()

ルート・スキーマ: RoleGrantCollection

型: object

これは、ユーザーまたは別のロールに付与されたロールのリストを表すものです。

ソースの表示

• count(必須): integer
  このページ内のロールの数

  例: 20
• items(必須): array items
  ロール付与
• links(必須): object links
  読取り専用: true

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

{
    "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",
            "readOnly":true
        },
        "items":{
            "type":"array",
            "description":"The role grants",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        }
    },
    "description":"This is the representation of List of Roles Grantsed to a User or to an another Role."
}

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

型: array

ロール付与

ソースの表示

• 配列: object RoleGrantSummary
  ユーザーまたは別のロールに付与されたロールに関する情報

{
    "type":"array",
    "description":"The role grants",
    "items":{
        "$ref":"#/components/schemas/RoleGrantSummary"
    }
}

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

型: object

読取り専用: true

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

ソースの表示

• 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",
    "readOnly":true
}

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

型: object

ユーザーまたは別のロールに付与されたロールに関する情報

ソースの表示

• description: string
  読取り専用: true

  ロールについての説明

  例: This Role is an Test Role
• id: string
  読取り専用: true

  ロール付与の一意識別子

  例: B0F9D83F6E313B03E0537013790ACA39
• isPrivate: boolean
  読取り専用: true

  ロールの付与がプライベート・ロールかどうかを示すフラグ。

  例: true
• isWithAdmin: boolean
  読取り専用: true

  プライベート・ロールがWITH_ADMINとして付与されているかどうかを示すフラグ。これは、ロールがプライベート・ロールの場合に表示されます

  例: true
• links: object links
  読取り専用: true

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

  例: EM_ALL_ADMINISTRATOR
• owner: string
  読取り専用: true

  ロールの所有者/作成者

  例: SYSMAN
• type: string
  読取り専用: true

  ロールのタイプ(EMロール、Oracle定義ロール、外部ロールなど)

  例: Oracle Defined Role

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Role Grant",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Role",
            "example":"EM_ALL_ADMINISTRATOR"
        },
        "type":{
            "type":"string",
            "description":"Type of Role like EM Role, Oracle Defined Role, External Role",
            "readOnly":true,
            "example":"Oracle Defined Role"
        },
        "description":{
            "type":"string",
            "description":"Description about the Role",
            "readOnly":true,
            "example":"This Role is an Test Role"
        },
        "isPrivate":{
            "type":"boolean",
            "description":"Flag says whether grant Role is a private role or not.",
            "readOnly":true,
            "example":true
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private role",
            "readOnly":true,
            "example":true
        },
        "owner":{
            "type":"string",
            "description":"Owner / Creator of the Role",
            "readOnly":true,
            "example":"SYSMAN"
        },
        "links":{
            "type":"object",
            "properties":{
                "roleLink":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The Role related links",
            "readOnly":true
        }
    },
    "description":"Info about Role granted to a User or to an another Role"
}

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

型: object

読取り専用: true

ロールの関連リンク

ソースの表示

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

{
    "type":"object",
    "properties":{
        "roleLink":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"The Role related links",
    "readOnly":true
}

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

404レスポンス

見つかりません

本文()

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

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

先頭に戻る