Creates a new credential parameters and fills it with values.
(optional) an object to be converted into key-value pairs to initialize these credentials.
Gets the application access id. The value can be stored in parameters "access_id" pr "client_id"
the application access id.
Gets the application secret key. The value can be stored in parameters "access_key", "client_key" or "secret_key".
the application secret key.
Get the user password. The value can be stored in parameters "password" or "pass".
the user password.
Gets the key to retrieve these credentials from [[CredentialStore]]. If this key is null, than all parameters are already present.
the store key to retrieve credentials.
Gets the user name. The value can be stored in parameters "username" or "user".
the user name.
Sets the application access id.
a new application access id.
Sets the application secret key.
a new application secret key.
Sets the user password.
a new user password.
Sets the key to retrieve these parameters from [[CredentialStore]].
a new key to retrieve credentials.
Sets the user name.
a new user name.
Checks if these credential parameters shall be retrieved from [[CredentialStore]]. The credential parameters are redirected to [[CredentialStore]] when store_key parameter is set.
true if credentials shall be retrieved from [[CredentialStore]]
Retrieves a single CredentialParams from configuration parameters from "credential" section. If "credentials" section is present instead, then is returns only the first credential element.
ConfigParams, containing a section named "credential(s)".
the generated CredentialParams object.
Creates a new CredentialParams object filled with key-value pairs serialized as a string.
a string with serialized key-value pairs as "key1=value1;key2=value2;..." Example: "Key1=123;Key2=ABC;Key3=2016-09-16T00:00:00.00Z"
a new CredentialParams object.
Creates a new CredentialParams object filled with provided key-value pairs called tuples. Tuples parameters contain a sequence of key1, value1, key2, value2, ... pairs.
the tuples to fill a new CredentialParams object.
a new CredentialParams object.
Retrieves all CredentialParams from configuration parameters from "credentials" section. If "credential" section is present instead, than it returns a list with only one CredentialParams.
a configuration parameters to retrieve credentials
a list of retrieved CredentialParams
Generated using TypeDoc
Contains credentials to authenticate against external services. They are used together with connection parameters, but usually stored in a separate store, protected from unauthorized access.
Configuration parameters
In addition to standard parameters CredentialParams may contain any number of custom parameters
ConfigParams
ConnectionParams
CredentialResolver
ICredentialStore
Example
let credential = CredentialParams.fromTuples( "user", "jdoe", "pass", "pass123", "pin", "321" ); let username = credential.getUsername(); // Result: "jdoe" let password = credential.getPassword(); // Result: "pass123" let pin = credential.getAsNullableString("pin"); // Result: 321