IBM Cloud Pak for Data Platform API

Introduction

The IBM® Cloud Pak for Data Platform API connects to your Cloud Pak for Data platform to manage your user account. Administrators can also manage the users who have access to the platform, manage roles, and monitor the status of the platform.

Authentication

To authenticate to the API, you pass an access token in an Authorization header. The token is associated with a user name. To generate an access token, call the Get authorization token method.

Generating an access token. The response includes a token property.

Replace {cpd_cluster_host} and {port} with the details for the service instance. Replace {username} and {password} with your IBM Cloud Pak for Data credentials.

curl -k -X POST -d "{\"username\":\"{username}\",\"password\":\"{password}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/authorize"

curl -k -X POST -d "{\"username\":\"{username}\",\"password\":\"{password}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/authorize"

Authenticating to the API. Replace {token} with your details.

curl -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/v1/{method}"

curl -H "Authorization: Bearer {token}" "https://{cpd_cluster_host}{:port}/v1/{method}"

Service endpoint

The service endpoint is based on your IBM Cloud Pak deployment URL.

https://{cpd_cluster_host}{:port}/icp4d-api/v1/{method}

For example, if your instance is deployed at https://www.example.com:31843, you can access the APIs at https://www.example.com:31843/icp4d-api/v1/{method}.

Example

curl -H "Authorization: Bearer {token}" -X {request_method} "https://{cpd_cluster_host}{:port}/icp4d-api/v1/{method}"

curl -H "Authorization: Bearer {token}" -X {request_method} "https://{cpd_cluster_host}{:port}/icp4d-api/v1/{method}"

Disabling SSL verification

All Cloud Pak for Data services use Secure Sockets Layer (SSL) (or Transport Layer Security (TLS)) for secure connections between the client and server. The connection is verified against the local certificate store to ensure authentication, integrity, and confidentiality.

If you use a self-signed certificate, you need to disable SSL verification to make a successful connection.

Enabling SSL verification is highly recommended. Disabling SSL jeopardizes the security of the connection and data. Disable SSL only if absolutely necessary, and take steps to enable SSL as soon as possible.

To disable SSL verification for a curl request, use the --insecure (-k) option with the request.

Example that disables SSL verification

curl -k -X {request_method} -H "Authorization: Bearer {token}" "{url}/v1/{method}"

curl -k -X {request_method} -H "Authorization: Bearer {token}" "{url}/v1/{method}"

Error handling

IBM Cloud Pak for Data uses standard HTTP response codes to indicate whether a method completed successfully. HTTP response codes in the 2xx range indicate success. A response in the 4xx range is some sort of failure, and a response in the 5xx range usually indicates an internal system error that cannot be resolved by the user. Response codes are listed with the method.

ErrorResponse

Name	Description
messageCode string	An identifier of the response.
statusCode integer	The HTTP response code.
exception string	An explanation of the problem.
message string	An explanation of the `messageCode`.

IBM Cloud Pak for Data docs

Watson Data API: Manage data-related assets and the people who need to use these assets.
Watson Machine Leaning API: Build and train analytical models and neural networks.
Watson OpenScale API: Measure the outcomes of your AI models.
Watson APIs for Cloud Pak for Data
- Watson Assistant API: v2 | v1
- Watson Discovery API v1
- Watson API Kit
  - Natural Language Understanding API
  - IBM Watson Speech to Text API
  - IBM Watson Text to Speech API

Get authorization token

Generate a bearer token from your Cloud Pak for Data credentials.

POST /v1/authorize

/v1/authorize

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetAuthorizationToken(getAuthorizationTokenOptions *GetAuthorizationTokenOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetAuthorizationToken(getAuthorizationTokenOptions *GetAuthorizationTokenOptions) (*core.DetailedResponse, error)

ServiceCall<LoginResponse> getAuthorizationToken(GetAuthorizationTokenOptions getAuthorizationTokenOptions)ServiceCall<LoginResponse> getAuthorizationToken(GetAuthorizationTokenOptions getAuthorizationTokenOptions)

getAuthorizationToken(params, [callback()])

getAuthorizationToken(params, [callback()])

get_authorization_token(self, password, username, **kwargs)

get_authorization_token(self, password, username, **kwargs)

Request

Instantiate the GetAuthorizationTokenOptions struct and set the fields to provide parameter values for the GetAuthorizationToken method.

Use the GetAuthorizationTokenOptions.Builder to create a GetAuthorizationTokenOptions object that contains the parameter values for the getAuthorizationToken method.

Request Body

loginCredentials

GetAuthorizationTokenOptions

The GetAuthorizationToken options.

GetAuthorizationTokenOptions

The getAuthorizationToken options.

parameters

password
string
IBM Cloud Pak for Data password.
username
string
IBM Cloud Pak for Data user name.

parameters

password
str
IBM Cloud Pak for Data password.
username
str
IBM Cloud Pak for Data user name.

```
curl -k -X POST -H "cache-control: no-cache" -d "{\"username\":\"{username}\",\"password\":\"{password}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/authorize"
```

Response

Response Body

loginResponse

LoginResponse

Status Code

200
Success
400
Bad Request
401
Unauthorized
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }
{ "messageCode": "200", "message": "Success", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }

Get all users

Returns all users in the cluster.

GET /v1/users

/v1/users

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetAllUsers(getAllUsersOptions *GetAllUsersOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetAllUsers(getAllUsersOptions *GetAllUsersOptions) (*core.DetailedResponse, error)

ServiceCall<GetAllUsersResponse> getAllUsers()ServiceCall<GetAllUsersResponse> getAllUsers()

getAllUsers(params, [callback()])

getAllUsers(params, [callback()])

get_all_users(self, **kwargs)

get_all_users(self, **kwargs)

Request

Custom Headers

Authorization
string
The bearer token associated with a user name.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

```
curl -k -X GET -H "Authorization: Bearer {token}" -H "cache-control: no-cache" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/users"
```

Response

Response Body

getAllUsersResponse

GetAllUsersResponse

Status Code

200
Success
401
Unauthorized
500
Internal error

Example responses

Status 200

{
  "messageCode": "200",
  "message": "Success",
  "UsersInfo": [
    {
      "approval_status": "approved",
      "authenticator": "default",
      "created_timestamp": "2018-10-08T21:53:14.855Z",
      "current_account_status": "enabled",
      "displayName": "admin",
      "email": "admin@example.com",
      "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
      "permissions": [
        "string"
      ],
      "role": "admin",
      "uid": "1001",
      "user_roles": [
        "string"
      ],
      "username": "Admin"
    }
  ]
}{
  "messageCode": "200",
  "message": "Success",
  "UsersInfo": [
    {
      "approval_status": "approved",
      "authenticator": "default",
      "created_timestamp": "2018-10-08T21:53:14.855Z",
      "current_account_status": "enabled",
      "displayName": "admin",
      "email": "admin@example.com",
      "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
      "permissions": [
        "string"
      ],
      "role": "admin",
      "uid": "1001",
      "user_roles": [
        "string"
      ],
      "username": "Admin"
    }
  ]
}

Success example

{
  "messageCode": "200",
  "message": "Success",
  "UsersInfo": [
    {
      "approval_status": "approved",
      "authenticator": "default",
      "created_timestamp": "2018-10-08T21:53:14.855Z",
      "current_account_status": "enabled",
      "displayName": "admin",
      "email": "admin@example.com",
      "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
      "permissions": [
        "string"
      ],
      "role": "admin",
      "uid": "1001",
      "user_roles": [
        "string"
      ],
      "username": "Admin"
    }
  ]
}{
  "messageCode": "200",
  "message": "Success",
  "UsersInfo": [
    {
      "approval_status": "approved",
      "authenticator": "default",
      "created_timestamp": "2018-10-08T21:53:14.855Z",
      "current_account_status": "enabled",
      "displayName": "admin",
      "email": "admin@example.com",
      "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
      "permissions": [
        "string"
      ],
      "role": "admin",
      "uid": "1001",
      "user_roles": [
        "string"
      ],
      "username": "Admin"
    }
  ]
}

Create user

Create a user account for the cluster.

POST /v1/users

/v1/users

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) CreateUser(createUserOptions *CreateUserOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) CreateUser(createUserOptions *CreateUserOptions) (*core.DetailedResponse, error)

ServiceCall<CreateUserSuccessResponse> createUser(CreateUserOptions createUserOptions)ServiceCall<CreateUserSuccessResponse> createUser(CreateUserOptions createUserOptions)

createUser(params, [callback()])

createUser(params, [callback()])

create_user(self, display_name, email, user_name, user_roles, **kwargs)

create_user(self, display_name, email, user_name, user_roles, **kwargs)

Request

Instantiate the CreateUserOptions struct and set the fields to provide parameter values for the CreateUser method.

Use the CreateUserOptions.Builder to create a CreateUserOptions object that contains the parameter values for the createUser method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Request Body

createUserParamsBody

The new user.

Example:

{
  "displayName": "Admin",
  "email": "user@example.com",
  "user_name": "admin",
  "user_roles": [
    "string"
  ]
}{
  "displayName": "Admin",
  "email": "user@example.com",
  "user_name": "admin",
  "user_roles": [
    "string"
  ]
}

CreateUserOptions

The CreateUser options.

CreateUserOptions

The createUser options.

parameters

display_name
string
The name that is displayed for this user.
email
string
The user's email address.
user_name
string
The user name.
user_roles
string[]
The roles assigned to the user.

parameters

display_name
str
The name that is displayed for this user.
email
str
The user's email address.
user_name
str
The user name.
user_roles
list[str]
The roles assigned to the user.

```
curl -k -X POST -H "Authorization: Bearer {token}" -H "cache-control: no-cache" -d "{\"user_name\":\"{username}\",\"displayName\":\"{display_name}\",\"user_roles\":\"{user_roles}\",\"email\":\"{email}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/users"
```

Response

Response Body

createUserSuccessResponse

CreateUserSuccessResponse

Status Code

200
Success
401
Unauthorized
500
Internal error

Example responses

Status 200

{
  "messageCode": "200",
  "message": "Success",
  "UserInfo": {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": "2018-10-08T21:53:14.855Z",
    "current_account_status": "enabled",
    "displayName": "admin",
    "email": "admin@example.com",
    "first_failed_attempt_timestamp": "2018-10-08T21:53:14.855Z",
    "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
    "permissions": [
      "string"
    ],
    "recent_number_of_failed_attempts": 0,
    "release_lock_at_timestamp": "2018-10-08T21:53:14.855Z",
    "role": "admin",
    "uid": "1001",
    "user_roles": [
      "string"
    ],
    "username": "Admin"
  }
}{
  "messageCode": "200",
  "message": "Success",
  "UserInfo": {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": "2018-10-08T21:53:14.855Z",
    "current_account_status": "enabled",
    "displayName": "admin",
    "email": "admin@example.com",
    "first_failed_attempt_timestamp": "2018-10-08T21:53:14.855Z",
    "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
    "permissions": [
      "string"
    ],
    "recent_number_of_failed_attempts": 0,
    "release_lock_at_timestamp": "2018-10-08T21:53:14.855Z",
    "role": "admin",
    "uid": "1001",
    "user_roles": [
      "string"
    ],
    "username": "Admin"
  }
}

Success example

{
  "messageCode": "200",
  "message": "Success",
  "UserInfo": {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": "2018-10-08T21:53:14.855Z",
    "current_account_status": "enabled",
    "displayName": "admin",
    "email": "admin@example.com",
    "first_failed_attempt_timestamp": "2018-10-08T21:53:14.855Z",
    "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
    "permissions": [
      "string"
    ],
    "recent_number_of_failed_attempts": 0,
    "release_lock_at_timestamp": "2018-10-08T21:53:14.855Z",
    "role": "admin",
    "uid": "1001",
    "user_roles": [
      "string"
    ],
    "username": "Admin"
  }
}{
  "messageCode": "200",
  "message": "Success",
  "UserInfo": {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": "2018-10-08T21:53:14.855Z",
    "current_account_status": "enabled",
    "displayName": "admin",
    "email": "admin@example.com",
    "first_failed_attempt_timestamp": "2018-10-08T21:53:14.855Z",
    "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
    "permissions": [
      "string"
    ],
    "recent_number_of_failed_attempts": 0,
    "release_lock_at_timestamp": "2018-10-08T21:53:14.855Z",
    "role": "admin",
    "uid": "1001",
    "user_roles": [
      "string"
    ],
    "username": "Admin"
  }
}

Get user information

Get details about one user.

GET /v1/users/{user_name}

/v1/users/{user_name}

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetUser(getUserOptions *GetUserOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetUser(getUserOptions *GetUserOptions) (*core.DetailedResponse, error)

ServiceCall<GetUserResponse> getUser(GetUserOptions getUserOptions)ServiceCall<GetUserResponse> getUser(GetUserOptions getUserOptions)

getUser(params, [callback()])

getUser(params, [callback()])

get_user(self, user_name, **kwargs)

get_user(self, user_name, **kwargs)

Request

Instantiate the GetUserOptions struct and set the fields to provide parameter values for the GetUser method.

Use the GetUserOptions.Builder to create a GetUserOptions object that contains the parameter values for the getUser method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Path Parameters

user_name
string
The user name.

GetUserOptions

The GetUser options.

GetUserOptions

The getUser options.

parameters

user_name
string
The user name.

parameters

user_name
str
The user name.

```
curl -k -X GET -H "Authorization: Bearer {token}" -H "cache-control: no-cache" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/users/{user_name}"
```

Response

Response Body

getUserResponse

GetUserResponse

Status Code

200
Success
401
Unauthorized
404
Not Found
500
Internal error

Example responses

Status 200

{
  "messageCode": "200",
  "message": "Success",
  "UserInfo": {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": "2018-10-08T21:53:14.855Z",
    "current_account_status": "enabled",
    "displayName": "admin",
    "email": "admin@example.com",
    "first_failed_attempt_timestamp": "2018-10-08T21:53:14.855Z",
    "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
    "permissions": [
      "string"
    ],
    "recent_number_of_failed_attempts": 0,
    "release_lock_at_timestamp": "2018-10-08T21:53:14.855Z",
    "role": "admin",
    "uid": "1001",
    "user_roles": [
      "string"
    ],
    "username": "Admin"
  }
}{
  "messageCode": "200",
  "message": "Success",
  "UserInfo": {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": "2018-10-08T21:53:14.855Z",
    "current_account_status": "enabled",
    "displayName": "admin",
    "email": "admin@example.com",
    "first_failed_attempt_timestamp": "2018-10-08T21:53:14.855Z",
    "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
    "permissions": [
      "string"
    ],
    "recent_number_of_failed_attempts": 0,
    "release_lock_at_timestamp": "2018-10-08T21:53:14.855Z",
    "role": "admin",
    "uid": "1001",
    "user_roles": [
      "string"
    ],
    "username": "Admin"
  }
}

Success example

{
  "messageCode": "200",
  "message": "Success",
  "UserInfo": {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": "2018-10-08T21:53:14.855Z",
    "current_account_status": "enabled",
    "displayName": "admin",
    "email": "admin@example.com",
    "first_failed_attempt_timestamp": "2018-10-08T21:53:14.855Z",
    "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
    "permissions": [
      "string"
    ],
    "recent_number_of_failed_attempts": 0,
    "release_lock_at_timestamp": "2018-10-08T21:53:14.855Z",
    "role": "admin",
    "uid": "1001",
    "user_roles": [
      "string"
    ],
    "username": "Admin"
  }
}{
  "messageCode": "200",
  "message": "Success",
  "UserInfo": {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": "2018-10-08T21:53:14.855Z",
    "current_account_status": "enabled",
    "displayName": "admin",
    "email": "admin@example.com",
    "first_failed_attempt_timestamp": "2018-10-08T21:53:14.855Z",
    "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
    "permissions": [
      "string"
    ],
    "recent_number_of_failed_attempts": 0,
    "release_lock_at_timestamp": "2018-10-08T21:53:14.855Z",
    "role": "admin",
    "uid": "1001",
    "user_roles": [
      "string"
    ],
    "username": "Admin"
  }
}

Update user details

Update information about a user account.

PUT /v1/users/{user_name}

/v1/users/{user_name}

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) UpdateUser(updateUserOptions *UpdateUserOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) UpdateUser(updateUserOptions *UpdateUserOptions) (*core.DetailedResponse, error)

ServiceCall<SuccessResponse> updateUser(UpdateUserOptions updateUserOptions)ServiceCall<SuccessResponse> updateUser(UpdateUserOptions updateUserOptions)

updateUser(params, [callback()])

updateUser(params, [callback()])

update_user(self, user_name, approval_status=None, display_name=None, email=None, user_roles=None, **kwargs)update_user(self, user_name, approval_status=None, display_name=None, email=None, user_roles=None, **kwargs)

Request

Instantiate the UpdateUserOptions struct and set the fields to provide parameter values for the UpdateUser method.

Use the UpdateUserOptions.Builder to create a UpdateUserOptions object that contains the parameter values for the updateUser method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Path Parameters

user_name
string
The user name.

Request Body

updateUserParamsBody

The updated user information.

UpdateUserOptions

The UpdateUser options.

UpdateUserOptions

The updateUser options.

parameters

user_name
string
The user name.
approval_status
string
The status of the user's access to the web client.

Allowable values: [pending,approved]
display_name
string
The name that is displayed for this user.
email
string
The user's email address.
user_roles
string[]
The roles assigned to the user.

parameters

user_name
str
The user name.
approval_status
str
The status of the user's access to the web client.

Allowable values: [pending,approved]
display_name
str
The name that is displayed for this user.
email
str
The user's email address.
user_roles
list[str]
The roles assigned to the user.

```
curl -k -X PUT -H "Authorization: Bearer {token}" -H "cache-control: no-cache" -d "{\"user_name\":\"{username}\", \"displayName\":\"{display_name}\", \"user_roles\":\"{user_roles}\", \"email\":\"{email}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/users/{user_name}"
```

Response

Response Body

successResponse

SuccessResponse

Status Code

200
Success
401
Unauthorized
404
Not found.
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success" }
{ "messageCode": "200", "message": "Success" }

Delete user

Delete a user from the cluster.

DELETE /v1/users/{user_name}

/v1/users/{user_name}

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) DeleteUser(deleteUserOptions *DeleteUserOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) DeleteUser(deleteUserOptions *DeleteUserOptions) (*core.DetailedResponse, error)

ServiceCall<SuccessResponse> deleteUser(DeleteUserOptions deleteUserOptions)ServiceCall<SuccessResponse> deleteUser(DeleteUserOptions deleteUserOptions)

deleteUser(params, [callback()])

deleteUser(params, [callback()])

delete_user(self, user_name, **kwargs)

delete_user(self, user_name, **kwargs)

Request

Instantiate the DeleteUserOptions struct and set the fields to provide parameter values for the DeleteUser method.

Use the DeleteUserOptions.Builder to create a DeleteUserOptions object that contains the parameter values for the deleteUser method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Path Parameters

user_name
string
The user name.

DeleteUserOptions

The DeleteUser options.

DeleteUserOptions

The deleteUser options.

parameters

user_name
string
The user name.

parameters

user_name
str
The user name.

```
curl -k -X DELETE -H "Authorization: Bearer {token}" -H "cache-control: no-cache" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/users/{user_name}"
```

Response

Response Body

successResponse

SuccessResponse

Status Code

200
Success
401
Unauthorized
404
Not Found
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success" }
{ "messageCode": "200", "message": "Success" }

List all roles

Returns the user roles in the cluster.

GET /v1/roles

/v1/roles

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetAllRoles(getAllRolesOptions *GetAllRolesOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetAllRoles(getAllRolesOptions *GetAllRolesOptions) (*core.DetailedResponse, error)

ServiceCall<GetAllRolesResponse> getAllRoles()ServiceCall<GetAllRolesResponse> getAllRoles()

getAllRoles(params, [callback()])

getAllRoles(params, [callback()])

get_all_roles(self, **kwargs)

get_all_roles(self, **kwargs)

Request

Custom Headers

Authorization
string
The bearer token associated with a user name.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

```
curl -k -X GET -H "Authorization: Bearer {token}" -H "cache-control: no-cache" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/roles"
```

Response

Response Body

getAllRolesResponse

GetAllRolesResponse

Status Code

200
Success
401
Unauthorized
500
Internal error

Example responses

Status 200

{
  "messageCode": "200",
  "message": "Success",
  "Roles": {
    "ID": "Administrator",
    "description": "Administrator role",
    "permissions": [
      "string"
    ],
    "role_name": "Administrator"
  }
}{
  "messageCode": "200",
  "message": "Success",
  "Roles": {
    "ID": "Administrator",
    "description": "Administrator role",
    "permissions": [
      "string"
    ],
    "role_name": "Administrator"
  }
}

Success example

{
  "messageCode": "200",
  "message": "Success",
  "Roles": {
    "ID": "Administrator",
    "description": "Administrator role",
    "permissions": [
      "string"
    ],
    "role_name": "Administrator"
  }
}{
  "messageCode": "200",
  "message": "Success",
  "Roles": {
    "ID": "Administrator",
    "description": "Administrator role",
    "permissions": [
      "string"
    ],
    "role_name": "Administrator"
  }
}

Create role

If the provided roles do not meet your needs, you can create other roles.

POST /v1/roles

/v1/roles

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) CreateRole(createRoleOptions *CreateRoleOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) CreateRole(createRoleOptions *CreateRoleOptions) (*core.DetailedResponse, error)

ServiceCall<SuccessResponse> createRole(CreateRoleOptions createRoleOptions)ServiceCall<SuccessResponse> createRole(CreateRoleOptions createRoleOptions)

createRole(params, [callback()])

createRole(params, [callback()])

create_role(self, permissions, role_name, description=None, **kwargs)

create_role(self, permissions, role_name, description=None, **kwargs)

Request

Instantiate the CreateRoleOptions struct and set the fields to provide parameter values for the CreateRole method.

Use the CreateRoleOptions.Builder to create a CreateRoleOptions object that contains the parameter values for the createRole method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Request Body

createRoleParamsBody

Information for creating a role

Example:

CreateRoleOptions

The CreateRole options.

CreateRoleOptions

The createRole options.

parameters

permissions
string[]
The permissions associated with the role.
role_name
string
Name for the role.
description
string
Description of the role.

parameters

permissions
list[str]
The permissions associated with the role.
role_name
str
Name for the role.
description
str
Description of the role.

```
curl -k -X POST -H "Authorization: Bearer {token}" -H "cache-control: no-cache" -d "{\"role_name\":\"{name}\",\"description\":\"{description}\",\"permissions\":\"{permissions}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/roles"
```

Response

Response Body

successResponse

SuccessResponse

Status Code

200
Success
401
Unauthorized
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success" }
{ "messageCode": "200", "message": "Success" }

List all permissions

Returns all permissions in the cluster.

GET /v1/roles/permissions

/v1/roles/permissions

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetAllPermissions(getAllPermissionsOptions *GetAllPermissionsOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetAllPermissions(getAllPermissionsOptions *GetAllPermissionsOptions) (*core.DetailedResponse, error)

ServiceCall<GetPermissionsResponse> getAllPermissions()ServiceCall<GetPermissionsResponse> getAllPermissions()

getAllPermissions(params, [callback()])

getAllPermissions(params, [callback()])

get_all_permissions(self, **kwargs)

get_all_permissions(self, **kwargs)

Request

Custom Headers

Authorization
string
The bearer token associated with a user name.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

```
curl -k -X GET -H "Authorization: Bearer {token}" -H "cache-control: no-cache" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/roles/permissions"
```

Response

Response Body

getPermissionsResponse

GetPermissionsResponse

Status Code

200
Success
401
Unauthorized
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success", "Permissions": [] }
{ "messageCode": "200", "message": "Success", "Permissions": [] }

Get role information

Get details about one role.

GET /v1/roles/{role_name}

/v1/roles/{role_name}

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetRole(getRoleOptions *GetRoleOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetRole(getRoleOptions *GetRoleOptions) (*core.DetailedResponse, error)

ServiceCall<GetRoleResponse> getRole(GetRoleOptions getRoleOptions)ServiceCall<GetRoleResponse> getRole(GetRoleOptions getRoleOptions)

getRole(params, [callback()])

getRole(params, [callback()])

get_role(self, role_name, **kwargs)

get_role(self, role_name, **kwargs)

Request

Instantiate the GetRoleOptions struct and set the fields to provide parameter values for the GetRole method.

Use the GetRoleOptions.Builder to create a GetRoleOptions object that contains the parameter values for the getRole method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Path Parameters

role_name
string
The name of the role.

GetRoleOptions

The GetRole options.

GetRoleOptions

The getRole options.

parameters

role_name
string
The name of the role.

parameters

role_name
str
The name of the role.

```
curl -k -X GET -H "Authorization: Bearer {token}" -H "cache-control: no-cache" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/roles/{role_name}"
```

Response

Response Body

getRoleResponse

GetRoleResponse

Status Code

200
Success
401
Unauthorized
404
Not Found
500
Internal error

Example responses

Status 200

{
  "messageCode": "200",
  "message": "Success",
  "RoleInfo": {
    "ID": "Administrator",
    "description": "Administrator role",
    "permissions": [
      "string"
    ],
    "role_name": "Administrator"
  }
}{
  "messageCode": "200",
  "message": "Success",
  "RoleInfo": {
    "ID": "Administrator",
    "description": "Administrator role",
    "permissions": [
      "string"
    ],
    "role_name": "Administrator"
  }
}

Success example

{
  "messageCode": "200",
  "message": "Success",
  "RoleInfo": {
    "ID": "Administrator",
    "description": "Administrator role",
    "permissions": [
      "string"
    ],
    "role_name": "Administrator"
  }
}{
  "messageCode": "200",
  "message": "Success",
  "RoleInfo": {
    "ID": "Administrator",
    "description": "Administrator role",
    "permissions": [
      "string"
    ],
    "role_name": "Administrator"
  }
}

Update role

Update the name, description, and permissions associated with a role.

PUT /v1/roles/{role_name}

/v1/roles/{role_name}

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) UpdateRole(updateRoleOptions *UpdateRoleOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) UpdateRole(updateRoleOptions *UpdateRoleOptions) (*core.DetailedResponse, error)

ServiceCall<SuccessResponse> updateRole(UpdateRoleOptions updateRoleOptions)ServiceCall<SuccessResponse> updateRole(UpdateRoleOptions updateRoleOptions)

updateRole(params, [callback()])

updateRole(params, [callback()])

update_role(self, role_name, permissions, description=None, **kwargs)

update_role(self, role_name, permissions, description=None, **kwargs)

Request

Instantiate the UpdateRoleOptions struct and set the fields to provide parameter values for the UpdateRole method.

Use the UpdateRoleOptions.Builder to create a UpdateRoleOptions object that contains the parameter values for the updateRole method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Path Parameters

role_name
string
The name of the role.

Request Body

updateRoleParamsBody

The updated role information.

UpdateRoleOptions

The UpdateRole options.

UpdateRoleOptions

The updateRole options.

parameters

role_name
string
The name of the role.
permissions
string[]
The permissions associated with the role.
description
string
The description of the role.

parameters

role_name
str
The name of the role.
permissions
list[str]
The permissions associated with the role.
description
str
The description of the role.

```
curl -k -X PUT -H "Authorization: Bearer {token}" -H "cache-control: no-cache" -d "{\"description\":\"{role_description}\",\"permissions\":\"{permissions}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/roles/{role_name}"
```

Response

Response Body

successResponse

SuccessResponse

Status Code

200
Success
401
Unauthorized
404
Not Found
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success" }
{ "messageCode": "200", "message": "Success" }

Delete role

Delete a role from the cluster.

DELETE /v1/roles/{role_name}

/v1/roles/{role_name}

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) DeleteRole(deleteRoleOptions *DeleteRoleOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) DeleteRole(deleteRoleOptions *DeleteRoleOptions) (*core.DetailedResponse, error)

ServiceCall<SuccessResponse> deleteRole(DeleteRoleOptions deleteRoleOptions)ServiceCall<SuccessResponse> deleteRole(DeleteRoleOptions deleteRoleOptions)

deleteRole(params, [callback()])

deleteRole(params, [callback()])

delete_role(self, role_name, **kwargs)

delete_role(self, role_name, **kwargs)

Request

Instantiate the DeleteRoleOptions struct and set the fields to provide parameter values for the DeleteRole method.

Use the DeleteRoleOptions.Builder to create a DeleteRoleOptions object that contains the parameter values for the deleteRole method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Path Parameters

role_name
string
The name of the role.

DeleteRoleOptions

The DeleteRole options.

DeleteRoleOptions

The deleteRole options.

parameters

role_name
string
The name of the role.

parameters

role_name
str
The name of the role.

```
curl -k -X DELETE -H "Authorization: Bearer {token}" -H "cache-control: no-cache" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/roles/{role_name}"
```

Response

Response Body

successResponse

SuccessResponse

Status Code

200
Success
401
Unauthorized
404
Not Found
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success" }
{ "messageCode": "200", "message": "Success" }

Change my password

Change the logged in user's password.

POST /v1/changepassword

/v1/changepassword

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) ChangePassword(changePasswordOptions *ChangePasswordOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) ChangePassword(changePasswordOptions *ChangePasswordOptions) (*core.DetailedResponse, error)

ServiceCall<SuccessResponse> changePassword(ChangePasswordOptions changePasswordOptions)ServiceCall<SuccessResponse> changePassword(ChangePasswordOptions changePasswordOptions)

changePassword(params, [callback()])

changePassword(params, [callback()])

change_password(self, password, **kwargs)

change_password(self, password, **kwargs)

Request

Instantiate the ChangePasswordOptions struct and set the fields to provide parameter values for the ChangePassword method.

Use the ChangePasswordOptions.Builder to create a ChangePasswordOptions object that contains the parameter values for the changePassword method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Form Parameters

password
string
New password.

ChangePasswordOptions

The ChangePassword options.

ChangePasswordOptions

The changePassword options.

parameters

password
string
New password.

parameters

password
str
New password.

```
curl -k -X POST -H "Authorization: Bearer {token}" -H "cache-control: no-cache" -d "{\"password\":\"{password}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/changepassword"
```

Response

Response Body

successResponse

SuccessResponse

Status Code

200
Success
401
Unauthorized
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success" }
{ "messageCode": "200", "message": "Success" }

Get my account information

Get details about the logged in user.

GET /v1/me

/v1/me

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetMe(getMeOptions *GetMeOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetMe(getMeOptions *GetMeOptions) (*core.DetailedResponse, error)

ServiceCall<GetMeResponse> getMe()ServiceCall<GetMeResponse> getMe()

getMe(params, [callback()])

getMe(params, [callback()])

get_me(self, **kwargs)

get_me(self, **kwargs)

Request

Custom Headers

Authorization
string
The bearer token associated with a user name.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

```
curl -k -X GET -H "Authorization: Bearer {token}" -H "cache-control: no-cache" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/me"
```

Response

Response Body

getMeResponse

GetMeResponse

Status Code

200
Success
401
Unauthorized
500
Internal error

Example responses

Status 200

{
  "messageCode": "200",
  "message": "Success",
  "UsersInfo": [
    {
      "approval_status": "approved",
      "authenticator": "default",
      "created_timestamp": "2018-10-08T21:53:14.855Z",
      "current_account_status": "enabled",
      "displayName": "admin",
      "email": "admin@example.com",
      "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
      "permissions": [
        "string"
      ],
      "role": "admin",
      "uid": "1001",
      "user_roles": [
        "string"
      ],
      "username": "Admin"
    }
  ]
}{
  "messageCode": "200",
  "message": "Success",
  "UsersInfo": [
    {
      "approval_status": "approved",
      "authenticator": "default",
      "created_timestamp": "2018-10-08T21:53:14.855Z",
      "current_account_status": "enabled",
      "displayName": "admin",
      "email": "admin@example.com",
      "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
      "permissions": [
        "string"
      ],
      "role": "admin",
      "uid": "1001",
      "user_roles": [
        "string"
      ],
      "username": "Admin"
    }
  ]
}

Success example

{
  "messageCode": "200",
  "message": "Success",
  "UsersInfo": [
    {
      "approval_status": "approved",
      "authenticator": "default",
      "created_timestamp": "2018-10-08T21:53:14.855Z",
      "current_account_status": "enabled",
      "displayName": "admin",
      "email": "admin@example.com",
      "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
      "permissions": [
        "string"
      ],
      "role": "admin",
      "uid": "1001",
      "user_roles": [
        "string"
      ],
      "username": "Admin"
    }
  ]
}{
  "messageCode": "200",
  "message": "Success",
  "UsersInfo": [
    {
      "approval_status": "approved",
      "authenticator": "default",
      "created_timestamp": "2018-10-08T21:53:14.855Z",
      "current_account_status": "enabled",
      "displayName": "admin",
      "email": "admin@example.com",
      "last_modified_timestamp": "2018-10-08T21:53:14.855Z",
      "permissions": [
        "string"
      ],
      "role": "admin",
      "uid": "1001",
      "user_roles": [
        "string"
      ],
      "username": "Admin"
    }
  ]
}

Update my information

Update the display name or email address for the logged in user.

PUT /v1/me

/v1/me

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) UpdateMe(updateMeOptions *UpdateMeOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) UpdateMe(updateMeOptions *UpdateMeOptions) (*core.DetailedResponse, error)

ServiceCall<SuccessResponse> updateMe(UpdateMeOptions updateMeOptions)ServiceCall<SuccessResponse> updateMe(UpdateMeOptions updateMeOptions)

updateMe(params, [callback()])

updateMe(params, [callback()])

update_me(self, display_name=None, email=None, **kwargs)

update_me(self, display_name=None, email=None, **kwargs)

Request

Instantiate the UpdateMeOptions struct and set the fields to provide parameter values for the UpdateMe method.

Use the UpdateMeOptions.Builder to create a UpdateMeOptions object that contains the parameter values for the updateMe method.

Custom Headers

Authorization
string
The bearer token associated with a user name.

Request Body

updateMeParamsBody

The updated user information.

UpdateMeOptions

The UpdateMe options.

UpdateMeOptions

The updateMe options.

parameters

display_name
string
The name that is displayed for this user.
email
string
The user's email address.

parameters

display_name
str
The name that is displayed for this user.
email
str
The user's email address.

```
curl -k -X PUT -H "Authorization: Bearer {token}" -H "cache-control: no-cache" -d "{\"displayName\":\"{display_name \",\"email\":\"{email}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/me"
```

Response

Response Body

successResponse

SuccessResponse

Status Code

200
Success
401
Unauthorized
500
Internal error

Example responses

{ "messageCode": "200", "message": "Success" }
{ "messageCode": "200", "message": "Success" }

Check server status

Indicates whether your Cloud Pak for Data API server is running.

GET /v1/monitor

/v1/monitor

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetMonitor(getMonitorOptions *GetMonitorOptions) (*core.DetailedResponse, error)

(ibmCloudPakForDataPlatformApi *IbmCloudPakForDataPlatformApiV1) GetMonitor(getMonitorOptions *GetMonitorOptions) (*core.DetailedResponse, error)

ServiceCall<SuccessResponse> getMonitor()ServiceCall<SuccessResponse> getMonitor()

getMonitor(params, [callback()])

getMonitor(params, [callback()])

get_monitor(self, **kwargs)

get_monitor(self, **kwargs)

Request

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

```
curl -k -X GET -H "Authorization: Bearer {token}" -H "cache-control: no-cache" -d "{\"displayName\":\"{display_name \",\"email\":\"{email}\"}" "https://{cpd_cluster_host}{:port}/icp4d-api/v1/monitor"
```

Response

Response Body

successResponse

SuccessResponse

Status Code

200
Success
default
Error

Example responses

{ "messageCode": "200", "message": "Success" }
{ "messageCode": "200", "message": "Success" }

Introduction

Authentication

Service endpoint

Disabling SSL verification

Error handling

Related information

Related APIs

Methods

Get authorization token

Request Body

password

username

GetAuthorizationTokenOptions

Password

Username

GetAuthorizationTokenOptions

password

username

parameters

password

username

parameters

password

username

Response Body

messageCode

message

token

LoginResponse

MessageCode

Message

LoginResponse

messageCode

message

LoginResponse

message_code

message

LoginResponse

message_code

message

Status Code

200

400

401

500

Get all users

Custom Headers

Authorization

No Request Parameters

No Request Parameters

No Request Parameters

No Request Parameters

Response Body

messageCode

message

UsersInfo

GetAllUsersResponse

MessageCode

Message

GetAllUsersResponse

messageCode

message

GetAllUsersResponse

message_code

message

GetAllUsersResponse

message_code

message

Status Code

200

401

500

Create user

Custom Headers

Authorization

Request Body

displayName

email

user_name

user_roles