Delete a user
delete
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/users/{userId}
The API submits a request to delete an existing user and the user deletion happens asynchronously. When a user is deleted, any jobs created by the user are stopped and deleted. Also, any blackouts created by the user are deleted. However, the user can not be deleted if there any blackouts created by the user that are active at the time the call to delete the user is issued. This situation is considered an invalid state from which to delete a user. First, any and all of these active blackouts must be stopped, and a failed delete user call must be reissued.
Request
Path Parameters
-
userId(required): string
Id of a User.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Information for User deletion
Show Source
-
delegateUserName: string
Name of User to assign the secure objects owned by User who is getting deleted. If delegateUserName is not specified then the secure objects owned by the user getting deleted, will be deleted.Example:
USER_B
-
forceDelete: boolean
Flag to force the deletion of User though User has active logged-in sessions. Default value is false.Example:
true
Response
Supported Media Types
- application/json
202 Response
A request to delete the user was accepted
Headers
-
Location:
URL to get the status of Delete User action.
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
409 Response
User is currently having active sessions
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