Get details of a role

get

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

The API returns details like role type, whether private role or not, granted roles, granted privileges, grantees of a role.

Request

Path Parameters
Query Parameters
  • Name of sub-resource to expand.
    • Allowed Values: [ "roleGrants", "privilegeGrants", "grantees" ]
    Example:
    roleGrants,grantees

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Role details returned successfully
Body ()
Root Schema : Role
Type: object
It represents a Role
Show Source
Match All
It represents a Role
Show Source
Nested Schema : grantees
Type: array
List of Users whom the role has been granted
Show Source
Nested Schema : privilegeGrants
Type: array
List of Privileges given to the Role
Show Source
Nested Schema : roleGrants
Type: array
List of Roles granted to the Role
Show Source
Nested Schema : RoleDetails
Type: object
It represents a Role
Show Source
Match All
It represents a Role
Show Source
Nested Schema : RoleCommonDetails
Type: object
It represents some information of a Role
Show Source
  • Description about the Role
    Example: Role has privileges to perform Enterprise Manager administrative operations
  • Private Role has WITH_ADMIN or not. This attribute exists only for Private Roles.
    Example: true
Nested Schema : GranteeSummary
Type: object
It represents User or Role to whom a Role is granted
Show Source
Nested Schema : type
Type: array
Type of Grantee
Show Source
  • Allowed Values: [ "User", "Role" ]
    This is the representation of types of Grantees.
Example:
User
Nested Schema : PrivilegeGrantSummary
Type: object
Privilege Grant to a User or to a Role
Show Source
Nested Schema : scope
Type: array
Read Only: true
Scope of the Privilege
Show Source
  • Allowed Values: [ "INSTANCE", "CLASS", "SYSTEM", "SET" ]
    This is the representation of scopes of privileges.
Example:
INSTANCE
Nested Schema : RoleGrantSummary
Type: object
Info about Role granted to a User or to an another Role
Show Source
  • Read Only: true
    Description about the Role
    Example: This Role is an Test Role
  • Read Only: true
    Unique identifier for a Role Grant
    Example: B0F9D83F6E313B03E0537013790ACA39
  • Read Only: true
    Flag says whether grant Role is a private role or not.
    Example: true
  • Read Only: true
    Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private role
    Example: true
  • links
  • Name of a Role
    Example: EM_ALL_ADMINISTRATOR
  • Read Only: true
    Owner / Creator of the Role
    Example: SYSMAN
  • Read Only: true
    Type of Role like EM Role, Oracle Defined Role, External Role
    Example: Oracle Defined Role

401 Response

Unauthorized
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

403 Response

Forbidden
Body ()
Root Schema : MissingPrivErrorResponse
Type: object
Response sent back as an Error in case required privileges are missing
Show Source
Match All
Response sent back as an Error in case required privileges are missing
Show Source
Nested Schema : missingPrivileges
Type: array
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
Show Source
Nested Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source
Nested Schema : MissingPrivilegeSummary
Type: object
It represents a Privilege which is missing on a Resource to view or manage it.
Show Source

404 Response

Not Found
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

503 Response

Service Unavailable
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source

Default Response

Unexpected Error
Body ()
Root Schema : ErrorResponse
Type: object
Response sent back in the case of an error.
Show Source
Back to Top