IBM Support

IIAS WebConsole API

Education


Abstract

IIAS WebConsole APIs are not public and only a subset of the /dbapi/v3/users APIs are supported.

Content

Following are examples of supported APIs:

(1) Returns the list of users - GET /dbapi/v3/users
Administrators can retrieve the list of all users in the system. Regular users will receive a list containing only their own user profile.
    curl -u "<userid>:<password>" -k -X GET https://<hostNameOrIP>:11089/dbapi/v3/users

(2) Creates a new user. **ADMIN ONLY** - POST /dbapi/v3/users
Creates a new user. This operation is only available to system administrators.
    curl -u "<userid>:<password>" -k -X POST --header "Content-Type: application/json" -d '{"id":"testuserxx1","name":"TEST USER XX-1", "role":"bluadmin", "email":"testxx1@cn.ibm.com", "password":"CommonUser@1234"}' https://<hostNameOrIP>:11089/dbapi/v3/users
    curl -u "<userid>:<password>" -k -X POST --header "Content-Type: application/json" -d '{"id":"testuserxx2","name":"TEST USER XX-2", "role":"bluuser", "email":"testxx2@cn.ibm.com", "password":"CommonUser@1234"}' https://<hostNameOrIP>:11089/dbapi/v3/users

(3) Get a specific user by ID - GET /dbapi/v3/users/{id}
Get a specific user by ID. System administrators may retrieve user information for any user. Regular users may only retrieve themselves.
    curl -u "<userid>:<password>" -k -X GET https://<hostName>:11089/dbapi/v3/users/testuserxx1

(4) Updates an existing user - PUT /dbapi/v3/users/{id}
Updates an existing user. System administrators may update user information for any user. Regular users may only update themselves.
    curl -u "<userid>:<password>" -k -X PUT --header "Content-Type: application/json" -d '{"id":"testuserxx","name":"TEST USER XX", "role":"bluadmin", "email":"testxx1@cn.ibm.com", "old_password":"CommonUser@1234", "new_password":"CommonUser@5678"}' https://<hostNameOrIP>:11089/dbapi/v3/users/testuserxx1

(5) Deletes an existing user **ADMIN ONLY** - DELETE /dbapi/v3/users/{id}
Deletes an existing user. Only administratos can delete users.
    curl -u "<userid>:<password>" -k -X DELETE https://<hostNameOrIP>:11089/dbapi/v3/users/testuserxx1

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSHRBY","label":"IBM Integrated Analytics System"},"Component":"WebConsole API","Platform":[{"code":"PF004","label":"Appliance"}],"Version":"1.0.10.1, 1.0.11.1, 1.0.12, 1.0.13, 1.0.14, 1.0.15, 1.0.16, 1.0.17, 1.0.18","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
17 October 2019

UID

ibm11072666