移動先

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

ロールの詳細の取得

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/roles/{roleId}

このAPIは、ロール・タイプ、プライベート・ロールかどうか、付与されたロール、付与された権限、ロールの権限受領者などの詳細を返します。

リクエスト

パス・パラメータ

• roleId(必須): string
  ロールのID

問合せパラメータ

• expand: array[string]
  展開するサブリソースの名前。

  • 指定可能な値: [ "roleGrants", "privilegeGrants", "grantees" ]

  [
      "roleGrants",
      "privilegeGrants",
      "grantees"
  ]

  例:

  roleGrants,grantees

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

ロールの詳細が正常に返されました

本文()

ルート・スキーマ: Role

型: object

ロールを表します

ソースの表示

• grantees: array grantees
  ロールが付与されているユーザーのリスト
• privilegeGrants: array privilegeGrants
  ロールに付与された権限のリスト
• roleGrants: array roleGrants
  ロールに付与されたロールのリスト

{
    "type":"object",
    "properties":{
        "roleGrants":{
            "type":"array",
            "description":"List of Roles granted to the Role",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges given to the Role",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantSummary"
            }
        },
        "grantees":{
            "type":"array",
            "description":"List of Users whom the role has been granted",
            "items":{
                "$ref":"#/components/schemas/GranteeSummary"
            }
        }
    },
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleDetails"
        }
    ]
}

すべてに一致

ソースの表示

• object allOf RoleDetails
  ロールを表します

{
    "type":"object",
    "properties":{
        "roleGrants":{
            "type":"array",
            "description":"List of Roles granted to the Role",
            "items":{
                "$ref":"#/components/schemas/RoleGrantSummary"
            }
        },
        "privilegeGrants":{
            "type":"array",
            "description":"List of Privileges given to the Role",
            "items":{
                "$ref":"#/components/schemas/PrivilegeGrantSummary"
            }
        },
        "grantees":{
            "type":"array",
            "description":"List of Users whom the role has been granted",
            "items":{
                "$ref":"#/components/schemas/GranteeSummary"
            }
        }
    },
    "description":"It represents a Role",
    "allOf":[
        {
            "$ref":"#/components/schemas/RoleDetails"
        }
    ]
}

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

型: array

ロールが付与されているユーザーのリスト

ソースの表示

• 配列: object GranteeSummary
  ロールが付与されているユーザーまたはロールを表します

{
    "type":"array",
    "description":"List of Users whom the role has been granted",
    "items":{
        "$ref":"#/components/schemas/GranteeSummary"
    }
}

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

型: array

ロールに付与された権限のリスト

ソースの表示

• 配列: object PrivilegeGrantSummary
  ユーザーまたはロールへの権限付与

{
    "type":"array",
    "description":"List of Privileges given to the Role",
    "items":{
        "$ref":"#/components/schemas/PrivilegeGrantSummary"
    }
}

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

型: array

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

ソースの表示

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

{
    "type":"array",
    "description":"List of Roles granted to the Role",
    "items":{
        "$ref":"#/components/schemas/RoleGrantSummary"
    }
}

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

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

型: object

ロールが付与されているユーザーまたはロールを表します

ソースの表示

• id: string
  読取り専用: true

  権限受領者(ユーザーまたはロール)の一意識別子

  例: B0F9D83F6E313B03E0537013790ACA39
• isWithAdmin: boolean
  権限受領者がユーザーの場合、このフラグはプライベート・ロールがWITH_ADMINとして付与されているかどうかを示します

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

  権限受領者の関連リンク
• name: string
  権限受領者の名前

  例: TEST_SUPER_ADMIN
• type: array type
  権限受領者のタイプ

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Grantee (User or Role)",
            "readOnly":true,
            "example":"B0F9D83F6E313B03E0537013790ACA39"
        },
        "name":{
            "type":"string",
            "description":"Name of a Grantee",
            "example":"TEST_SUPER_ADMIN"
        },
        "type":{
            "type":"array",
            "description":"Type of Grantee",
            "example":"User",
            "items":{
                "$ref":"#/components/schemas/GranteeTypes"
            }
        },
        "isWithAdmin":{
            "type":"boolean",
            "description":"If a Grantee is a User, this flag says whether the Private Role has been granted as WITH_ADMIN",
            "example":true
        },
        "links":{
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"The Grantee related links",
            "readOnly":true
        }
    },
    "description":"It represents User or Role to whom a Role is granted"
}

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

型: object

読取り専用: true

権限受領者の関連リンク

ソースの表示

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

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

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

型: array

権限受領者のタイプ

ソースの表示

• 配列: string
  指定可能な値: [ "User", "Role" ]

  これは権限受領者のタイプを表すものです。

{
    "type":"array",
    "description":"Type of Grantee",
    "example":"User",
    "items":{
        "$ref":"#/components/schemas/GranteeTypes"
    }
}

例:

User

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

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

型: object

ユーザーまたはロールへの権限付与

ソースの表示

• description: string
  読取り専用: true

  権限についての説明

  例: Ability to view Jobs
• displayName: string
  読取り専用: true

  権限の表示名

  例: View Report
• links: object links
  権限付与に関連するリンク
• name: string
  権限名

  例: VIEW_TARGET
• scope: array scope
  読取り専用: true

  権限のスコープ
• secureResourceType: string
  読取り専用: true

  権限のSecureResourceタイプ

  例: JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of a Privilege",
            "example":"VIEW_TARGET"
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the Privilege",
            "readOnly":true,
            "example":"View Report"
        },
        "description":{
            "type":"string",
            "description":"Description about the Privilege",
            "readOnly":true,
            "example":"Ability to view Jobs"
        },
        "secureResourceType":{
            "type":"string",
            "description":"SecureResource Type of the Privilege",
            "readOnly":true,
            "example":"JOB"
        },
        "scope":{
            "type":"array",
            "description":"Scope of the Privilege",
            "readOnly":true,
            "example":"INSTANCE",
            "items":{
                "$ref":"#/components/schemas/PrivilegeScopes"
            }
        },
        "links":{
            "type":"object",
            "properties":{
                "privilege":{
                    "$ref":"#/components/schemas/Link"
                },
                "secureResources":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"links related to the privilege grant"
        }
    },
    "description":"Privilege Grant to a User or to a Role"
}

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

型: object

権限付与に関連するリンク

ソースの表示

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

{
    "type":"object",
    "properties":{
        "privilege":{
            "$ref":"#/components/schemas/Link"
        },
        "secureResources":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"links related to the privilege grant"
}

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

型: array

読取り専用: true

権限のスコープ

ソースの表示

• 配列: string
  指定可能な値: [ "INSTANCE", "CLASS", "SYSTEM", "SET" ]

  これは権限のスコープを表すものです。

{
    "type":"array",
    "description":"Scope of the Privilege",
    "readOnly":true,
    "example":"INSTANCE",
    "items":{
        "$ref":"#/components/schemas/PrivilegeScopes"
    }
}

例:

INSTANCE

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

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

先頭に戻る