Modify a user

put

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

The API modifies an existing user details like emails, department, location, contact, granted roles, granted privileges, etc.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Input for modifying an existing User
Show Source
Match All
Input for modifying an existing User
Show Source
Nested Schema : privilegeGrants
Type: array
List of Privileges to be given to the User
Show Source
Nested Schema : roleGrants
Type: array
List of Roles to be granted to the User
Show Source
Nested Schema : UserCommonDetails
Type: object
It represents some information of a User
Show Source
Nested Schema : PrivilegeGrantDetails
Type: object
Privilege Grant details for createing/modifying a User or a Role
Show Source
Nested Schema : secureResources
Type: array
List of SecureResources on which the Privilege is applicable
Show Source
Nested Schema : SecureResourceDetails
Type: object
It represents Secure Resource details for creating/modifying a User or a Role.
Show Source
Nested Schema : propagationPolicy
Type: array
Scope where the privilege is applicable to. This is applicable only for Secure Resource Type called TARGET.
Show Source
  • 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
  • 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
Nested Schema : authenticationType
Type: array
Authentication Type of the User
Show Source
  • Allowed Values: [ "Repository", "SSO", "Enterprise" ]
    This is the representation of Authentication type of User.
Example:
Repository
Back to Top

Response

Supported Media Types

200 Response

User details modifed successfully
Body ()
Root Schema : User
Type: object
This is the representation of a User.
Show Source
Match All
This is the representation of a User.
Show Source
Nested Schema : privilegeGrants
Type: array
List of Privileges to be given to the User
Show Source
Nested Schema : roleGrants
Type: array
List of Roles to be granted to the User
Show Source
Nested Schema : UserDetails
Type: object
This is the representation of a User.
Show Source
Match All
This is the representation of a User.
Show Source
Nested Schema : UserCommonDetails
Type: object
It represents some information of a User
Show Source
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
Nested Schema : authenticationType
Type: array
Authentication Type of the User
Show Source
  • Allowed Values: [ "Repository", "SSO", "Enterprise" ]
    This is the representation of Authentication type of User.
Example:
Repository

400 Response

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

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