Let's the client-side know that credentials are required.
The reason
defines which parameters are used. The client passed the credentials with an
invoke_authenticate call.
The REQUIRED is used for the first credentials prompt, when the client can return credentials as stored from the previous success login.
The REJECTED is used when the previously used credentials had been rejected by the server. That usually means that the user should be asked to provide/correct the credentials.
The SSL_FAILED is used when a secured connection failed due to some server-side certificate issues.
The ERROR is used when the server returned an error. It is not possible to connect to it at the moment usually.
If an error occurs, the function sets error
and returns false
.
this |
an Source |
reason |
an SourceCredentialsReason, why the credentials are required |
certificate_pem |
PEM-encoded secure connection certificate, or an empty string |
certificate_errors |
a bit-or of TlsCertificateFlags for secure connection certificate |
op_error |
a Error with a description of the previous credentials error, or |
cancellable |
optional Cancellable object, or |
|