API Response Codes
This section lists the response codes returned by the CTE APIs. The section describes the response codes, corresponding messages, and possible corrective actions to be taken for them.
Clients API
patch /v1/transparent-encryption/clients/{id}/resetpassword
Resets a client's password.
| Response Code | Messages | Corrective Actions |
|---|---|---|
| 400 Bad Request | Client is marked for deletion. Cannot modify CTE Client | Specify a client that is not marked for deletion. The clients marked for deletion cannot be modified. |
| 401 Unauthorised | Unauthorised: Bearer token malformed: Token is expired by 50s | Refresh the authentication token. The current token has expired. |
| 404 Not Found | Resource not found | Specify a valid client ID. A client with the specified ID does not exit. |
| 422 Unprocessable Entity | Client has MANUAL password_creation_method. Cannot generate automatic password | Change the password creation method to MANUAL, and then reset the password. |
Client Groups APIs
post /v1/transparent-encryption/clientgroups
Creates a client group.
| Response Code | Messages | Corrective Actions |
|---|---|---|
| 400 Bad Request | Invalid name supplied. The name must consist of alpha-numeric characters; it must start with an alpha character; and the only non-alpha-numeric characters allowed are underscore (_) and dash (-). |
Specify a valid client group name. |
| 401 Unauthorized | Unauthorized: Bearer token malformed: Token is expired by 50s | Refresh the authentication token. The current token has expired. |
| 404 Not Found | ClientGroup Profile set Failed: Failed to get CTE profile for ProfileID: <profile-id>. Err: record not found |
Specify a valid profile ID. |
| 409 Conflict | Could not create clientgroup as it already exists | Specify a different name for the group. A client group with the specified name already exists. |
| 422 Unprocessable Entity | Validation errors:\ncluster_type: cluster_type is a required field | Specify the cluster type. |
| 422 Unprocessable Entity | Validation errors:\ncluster_type: Key: 'CreateClientGroupParams.cluster_type' Error:Field validation for 'cluster_type' failed on the 'eq=NON-CLUSTER|eq=HDFS' tag. |
Specify a valid cluster type, NON-CLUSTER or HDFS. The specified cluster type is invalid. |
post /v1/transparent-encryption/clientgroups/{id}/clients
Adds a client to a client group.
| Response Code | Messages | Corrective Actions |
|---|---|---|
| 400 Bad Request | Client <client-name> is marked for deletion. Cannot add client to clientgroup. Rejecting complete request |
Specify a client that is not marked for deletion. The clients marked for deletion cannot be added to a client group. |
| 401 Unauthorized | Unauthorized: Bearer token malformed: Token is expired by 50s | Refresh the authentication token. The current token has expired. |
| 409 Conflict | Failed to create Client-ClientGroup Association. Error:could not create clientgroupclientassn as it already exists | Ensure that the association of the specified client and the group does not exist. The specified client is already part of the client group. |
| 422 Unprocessable Entity | Failed to get CTE ClientGroup: record not found | Specify a valid client group ID. |
| 422 Unprocessable Entity | Failed to get CTE Client: record not found | Specify a valid client_id list. |
| 422 Unprocessable Entity | Validation errors:\nclient_list: client_list must contain at least 1 item | Specify at least one client ID in the client_id list. |