THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Table of Contents
...
Anchor Authentication Authentication
Authentication
| Authentication | |
| Authentication |
Description
This response type is returned when an error occurs with any command type.
Response
Pass client credentials to the server's security manager. Credentials are passed in as key, value pairs of strings and are interpreted by the security manager on the server. For a default Shiro security manager, the credentials might be as simple as
| Pre |
|---|
| {{"user", "bob"}, {"password", "bobspassword"}} |
Request
| AuthenticationRequestErrorResponse | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
| errorCodecredentials | Int | An Integer representing the error code for a specific error | Y |
| errorMessage | String | A description of the error. | N |
Possible Errors
...
| map<string,string> | A set of key, value properties defined by the server's security manager | Y |
Response
| AuthenticationResponse | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
| authenticated | boolean | Whether authenticated succeeded. | Y |
Expected behavior
If authentication is required, after the connection has completed handshaking, any request other than authentication will fail with an AUTHENTICATION_FAILED error.
- Once a connection is authenticated with user credentials, any operations that user doesn't have permission for will fail with AUTHORIZATION_FAILED.
- It's not possible to change the credentials associated with a connection. Changing credentials requires creating a new connection.
Errors
Error Code | Error Definition | Error Description | |||
|---|---|---|---|---|---|
| 13001103 | LOWUNSUPPORTED_AUTHENTICATION_MEMORY | Server does not have enough free memory to complete the operation | |||
| 1000 | UNCLASSIFIED_FAILURE | This error will be thrown as a last resort if an exception cannot be classified. This error will then have to be investigated and correctly classified | |||
| 1100 | ENCODING_ERROR | There was an error whilst encoding a data entry (key / value) | |||
MODE | The server's security manager is not compatible with protobuf authentication | ||||
| 1202 | ALREADY_AUTHENTICATED | The connection has already been authenticated | |||
| 1203 | AUTHENTICATION_NOT_SUPPORTED | The server doesn't support authentication | DECODING_ERROR | There was an error whilst decoding a data entry (key / value)