Available in version 10.1 Fix Pack 1

Delete a user from the database

Description

URL

scheme://domain:port/platform/ws/users/{userName}

Description

Permanently removes the specified user from the database. To get a list of users that are listed in the database and are allowed to log in and use IBM Spectrum LSF Application Center, use the API /platform/ws/users (GET).

Users that are removed from the database no longer have access to IBM Spectrum LSF Application Center.

The logged on user must have view_configure permission on the setting resource to use this API.

Ensure ALLOW_UNKNOWN_USER=N and ENABLE_USER_GROUP=N in the configuration file pmc.conf so that only users listed in the database are given access and deleted users and user groups are not automatically updated from LSF.

HTTP-Method

DELETE

Parameters

None

Request

Request-Method

DELETE

Request-URI

/platform/ws/users/{userName}

Request-Header

Name

Value

Accept

application/xml or application/json

Message-body

empty

Response

Response-Code

  • 200 Success: Request was successful.
  • 204 Success: Request was successful and user deleted from the database.
  • 403 Forbidden: The user that is logged on does not have view_configure permission on the setting resource.
  • 404 Not found: The specified user was not found in the database.
  • 500 Internal Server Error: Exception occurred.

Response-Header

Name

Value

Content-Type

application/xml or application/json

Message-body

 Success Message If successful, returns null.
Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/rbac/error.xsd.

<error>
  <message>
     %s
  </message>
</error>

Example: Delete user testUser from the database

# Request
Delete /platform/ws/users/testUser HTTP/1.1
Host: www.example.org
Request-Header: "Accept: application/xml", "Content-Type: application/xml";

# Response
204 Deleted

Related APIs

To add a user to the database, use the API /platform/ws/users (POST).

To get a list of users that are in the database, use the API /platform/ws/users (GET).

End of change