Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

back

CTE UserSpace Administration

API Response Codes

search

Please Note:

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 CodeMessagesCorrective Actions
400 Bad RequestClient is marked for deletion. Cannot modify CTE ClientSpecify a client that is not marked for deletion. The clients marked for deletion cannot be modified.
401 UnauthorisedUnauthorised: Bearer token malformed: Token is expired by 50sRefresh the authentication token. The current token has expired.
404 Not FoundResource not foundSpecify a valid client ID. A client with the specified ID does not exit.
422 Unprocessable EntityClient has MANUAL password_creation_method. Cannot generate automatic passwordChange the password creation method to MANUAL, and then reset the password.

Client Groups APIs

post /v1/transparent-encryption/clientgroups

Creates a client group.

Response CodeMessagesCorrective Actions
400 Bad RequestInvalid 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 UnauthorizedUnauthorized: Bearer token malformed: Token is expired by 50sRefresh the authentication token. The current token has expired.
404 Not FoundClientGroup Profile set Failed: Failed to get CTE profile for ProfileID: <profile-id>. Err: record not foundSpecify a valid profile ID.
409 ConflictCould not create clientgroup as it already existsSpecify a different name for the group. A client group with the specified name already exists.
422 Unprocessable EntityValidation errors:\ncluster_type: cluster_type is a required fieldSpecify the cluster type.
422 Unprocessable EntityValidation 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 CodeMessagesCorrective Actions
400 Bad RequestClient <client-name> is marked for deletion. Cannot add client to clientgroup. Rejecting complete requestSpecify a client that is not marked for deletion. The clients marked for deletion cannot be added to a client group.
401 UnauthorizedUnauthorized: Bearer token malformed: Token is expired by 50sRefresh the authentication token. The current token has expired.
409 ConflictFailed to create Client-ClientGroup Association. Error:could not create clientgroupclientassn as it already existsEnsure 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 EntityFailed to get CTE ClientGroup: record not foundSpecify a valid client group ID.
422 Unprocessable EntityFailed to get CTE Client: record not foundSpecify a valid client_id list.
422 Unprocessable EntityValidation errors:\nclient_list: client_list must contain at least 1 itemSpecify at least one client ID in the client_id list.