Modify a role
put
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/roles/{roleId}
The API modifies granted roles, granted privileges and grantees of an existing role.
Request
Path Parameters
-
roleId(required): string
Id of a Role.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Input for replacing a Role
Show Source
-
grantees: array
grantees
List of Users whom the role has been granted
-
name(required): string
Read Only:
true
Name of the RoleExample:CLOUD_ADMIN_ROLE
-
privilegeGrants: array
privilegeGrants
List of Privileges given to the Role
-
roleGrants: array
roleGrants
List of Roles granted to the Role
Match All
Show Source
-
object
RoleCommonDetails
It represents some information of a Role
Nested Schema : grantees
Type:
array
List of Users whom the role has been granted
Show Source
-
Array of:
object GranteeSummary
It represents User or Role to whom a Role is granted
Nested Schema : privilegeGrants
Type:
array
List of Privileges given to the Role
Show Source
-
Array of:
object PrivilegeGrantDetails
Privilege Grant details for createing/modifying a User or a Role
Nested Schema : roleGrants
Type:
array
List of Roles granted to the Role
Show Source
-
Array of:
object RoleGrantSummary
Info about Role granted to a User or to an another Role
Nested Schema : RoleCommonDetails
Type:
object
It represents some information of a Role
Show Source
-
description: string
Description about the RoleExample:
Role has privileges to perform Enterprise Manager administrative operations
-
isWithAdmin: boolean
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
-
id: string
Read Only:
true
Unique identifier for a Grantee (User or Role)Example:B0F9D83F6E313B03E0537013790ACA39
-
isWithAdmin: boolean
If a Grantee is a User, this flag says whether the Private Role has been granted as WITH_ADMINExample:
true
-
links: object
links
Read Only:
true
The Grantee related links -
name: string
Name of a GranteeExample:
TEST_SUPER_ADMIN
-
type: array
type
Type of Grantee
Nested Schema : links
Type:
object
Read Only:
true
The Grantee related links
Show Source
-
self: object
Link
Represents a link(could be self, previous or next)
Nested Schema : type
Type:
array
Type of Grantee
Show Source
-
Array of:
string
Allowed Values:
[ "User", "Role" ]
This is the representation of types of Grantees.
Example:
User
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
Nested Schema : PrivilegeGrantDetails
Type:
object
Privilege Grant details for createing/modifying a User or a Role
Show Source
-
name: string
Name of a PrivilegeExample:
VIEW_TARGET
-
secureResources: array
secureResources
List of SecureResources on which the Privilege is applicable
Nested Schema : secureResources
Type:
array
List of SecureResources on which the Privilege is applicable
Show Source
-
Array of:
object SecureResourceDetails
It represents Secure Resource details for creating/modifying a User or a Role.
Nested Schema : SecureResourceDetails
Type:
object
It represents Secure Resource details for creating/modifying a User or a Role.
Show Source
-
id: string
Id of the ResourceExample:
DE5CD14CE9D0C0EBEFFFDDEBAA83DA33
-
propagationPolicy: array
propagationPolicy
Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.
Nested Schema : propagationPolicy
Type:
array
Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.
Show Source
-
Array of:
string
Allowed Values:
[ "ALL", "SELF", "MEMBERS" ]
This gives type where a privilege is applicable to which part of composite resource. - ALL means the privilege is given for composite resource and its members. - SELF means the privilege is given only for composite resource. - MEMBERS means the privilege is given only for members of composite resource.
Example:
MEMBERS
Nested Schema : RoleGrantSummary
Type:
object
Info about Role granted to a User or to an another Role
Show Source
-
description: string
Read Only:
true
Description about the RoleExample:This Role is an Test Role
-
id: string
Read Only:
true
Unique identifier for a Role GrantExample:B0F9D83F6E313B03E0537013790ACA39
-
isPrivate: boolean
Read Only:
true
Flag says whether grant Role is a private role or not.Example:true
-
isWithAdmin: boolean
Read Only:
true
Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private roleExample:true
-
links: object
links
Read Only:
true
The Role related links -
name: string
Name of a RoleExample:
EM_ALL_ADMINISTRATOR
-
owner: string
Read Only:
true
Owner / Creator of the RoleExample:SYSMAN
-
type: string
Read Only:
true
Type of Role like EM Role, Oracle Defined Role, External RoleExample:Oracle Defined Role
Nested Schema : links
Type:
object
Read Only:
true
The Role related links
Show Source
-
roleLink: object
Link
Represents a link(could be self, previous or next)
Response
Supported Media Types
- application/json
200 Response
Role modified successfully
Root Schema : Role
Type:
object
It represents a Role
Show Source
-
grantees: array
grantees
List of Users whom the role has been granted
-
privilegeGrants: array
privilegeGrants
List of Privileges given to the Role
-
roleGrants: array
roleGrants
List of Roles granted to the Role
Match All
Show Source
-
object
allOf
RoleDetails
It represents a Role
Nested Schema : grantees
Type:
array
List of Users whom the role has been granted
Show Source
-
Array of:
object GranteeSummary
It represents User or Role to whom a Role is granted
Nested Schema : privilegeGrants
Type:
array
List of Privileges given to the Role
Show Source
-
Array of:
object PrivilegeGrantSummary
Privilege Grant to a User or to a Role
Nested Schema : roleGrants
Type:
array
List of Roles granted to the Role
Show Source
-
Array of:
object RoleGrantSummary
Info about Role granted to a User or to an another Role
Nested Schema : RoleDetails
Type:
object
It represents a Role
Show Source
-
id: string
Read Only:
true
Unique identifier for a RoleExample:B0F9D83F6E313B03E0537013790ACA39
-
isPrivate: boolean
Role is a private role or notExample:
false
-
links: object
links
Read Only:
true
the Role related links -
name: string
Name of a RoleExample:
EM_ALL_ADMINISTRATOR
-
owner: string
Read Only:
true
User who owns the RoleExample:SYSMAN
-
type: array
type
Type of Role
Match All
Show Source
-
object
RoleCommonDetails
It represents some information of a Role
Nested Schema : RoleCommonDetails
Type:
object
It represents some information of a Role
Show Source
-
description: string
Description about the RoleExample:
Role has privileges to perform Enterprise Manager administrative operations
-
isWithAdmin: boolean
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
-
id: string
Read Only:
true
Unique identifier for a Grantee (User or Role)Example:B0F9D83F6E313B03E0537013790ACA39
-
isWithAdmin: boolean
If a Grantee is a User, this flag says whether the Private Role has been granted as WITH_ADMINExample:
true
-
links: object
links
Read Only:
true
The Grantee related links -
name: string
Name of a GranteeExample:
TEST_SUPER_ADMIN
-
type: array
type
Type of Grantee
Nested Schema : links
Type:
object
Read Only:
true
The Grantee related links
Show Source
-
self: object
Link
Represents a link(could be self, previous or next)
Nested Schema : type
Type:
array
Type of Grantee
Show Source
-
Array of:
string
Allowed Values:
[ "User", "Role" ]
This is the representation of types of Grantees.
Example:
User
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
Nested Schema : PrivilegeGrantSummary
Type:
object
Privilege Grant to a User or to a Role
Show Source
-
description: string
Read Only:
true
Description about the PrivilegeExample:Ability to view Jobs
-
displayName: string
Read Only:
true
Display name of the PrivilegeExample:View Report
-
links: object
links
links related to the privilege grant
-
name: string
Name of a PrivilegeExample:
VIEW_TARGET
-
scope: array
scope
Read Only:
true
Scope of the Privilege -
secureResourceType: string
Read Only:
true
SecureResource Type of the PrivilegeExample:JOB
Nested Schema : links
Type:
object
links related to the privilege grant
Show Source
-
privilege: object
Link
Represents a link(could be self, previous or next)
-
secureResources: object
Link
Represents a link(could be self, previous or next)
Nested Schema : scope
Type:
array
Read Only:
true
Scope of the Privilege
Show Source
-
Array of:
string
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
-
description: string
Read Only:
true
Description about the RoleExample:This Role is an Test Role
-
id: string
Read Only:
true
Unique identifier for a Role GrantExample:B0F9D83F6E313B03E0537013790ACA39
-
isPrivate: boolean
Read Only:
true
Flag says whether grant Role is a private role or not.Example:true
-
isWithAdmin: boolean
Read Only:
true
Flag says whether Private Role is granted as WITH_ADMIN, This is shown if the Role is a private roleExample:true
-
links: object
links
Read Only:
true
The Role related links -
name: string
Name of a RoleExample:
EM_ALL_ADMINISTRATOR
-
owner: string
Read Only:
true
Owner / Creator of the RoleExample:SYSMAN
-
type: string
Read Only:
true
Type of Role like EM Role, Oracle Defined Role, External RoleExample:Oracle Defined Role
Nested Schema : links
Type:
object
Read Only:
true
The Role related links
Show Source
-
roleLink: object
Link
Represents a link(could be self, previous or next)
400 Response
Bad Request
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
Unauthorized
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
403 Response
Forbidden
Root Schema : MissingPrivErrorResponse
Type:
object
Response sent back as an Error in case required privileges are missing
Show Source
-
missingPrivileges: array
missingPrivileges
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
Match All
Show Source
-
object
ErrorResponse
Error response
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
-
Array of:
object MissingPrivilegeSummary
It represents a Privilege which is missing on a Resource to view or manage it.
Nested Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
Nested Schema : MissingPrivilegeSummary
Type:
object
It represents a Privilege which is missing on a Resource to view or manage it.
Show Source
-
displayName: string
Display Name of PrivilegeExample:
Manage
-
name: string
Name of PrivilegeExample:
MANAGE_JOB
404 Response
Not Found
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
Default Response
Unexpected Error
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string