Lusid.Sdk.Extensions.ApiConfiguration Class Reference

Configuration for the ClientCredentialsFlowTokenProvider, usually sourced from a "secrets.json" file More...

Public Member Functions
bool	HasMissingConfig ()
	Checks if any of the required configuration values are missing More...
List< string >	GetMissingConfig ()
	Returns a list of the missing required configuration values More...

Properties
string	TokenUrl [get, set]
	Url for the token provider More...
string	Username [get, set]
	Username More...
string	Password [get, set]
	Password More...
string	ClientId [get, set]
	OAuth2 Client ID More...
string	ClientSecret [get, set]
	OAuth2 Client Secret More...
string	BaseUrl [get, set]
	Api Url More...
string	SnakeCaseBaseUrl [get, set]
	Snake Case Api Url More...
string	LowerCaseBaseUrl [get, set]
	Lower Case Api Url More...
string	ApplicationName [get, set]
	Client Application name More...
string	PersonalAccessToken [get, set]
	Configurable via FBN_ACCESS_TOKEN env variable - get the value from LUSID web 'Your Profile'->'Personal access tokens'. Takes precedence over other authentication factors if set. More...
string	AccessTokenOldName [get, set]
	Exists for backwards compatibility - please use PersonalAccessToken instead (field name 'accessToken' in config) More...
int?	TimeoutMs [get, set]
	The client timeout in milliseconds. If left unset the default timeout will be used More...
int?	RateLimitRetries [get, set]
	The number of retries when being rate limited. If left unset the default number of rate limit retries will be used More...

Detailed Description

Configuration for the ClientCredentialsFlowTokenProvider, usually sourced from a "secrets.json" file

Member Function Documentation

GetMissingConfig()

List<string> Lusid.Sdk.Extensions.ApiConfiguration.GetMissingConfig ( )

inline

Returns a list of the missing required configuration values

Returns

List of missing configuration values or empty list if all configuration values are present

HasMissingConfig()

bool Lusid.Sdk.Extensions.ApiConfiguration.HasMissingConfig ( )

inline

Checks if any of the required configuration values are missing

Returns

true if there is any configuration details missing, call GetMissingConfig to obtain details of the missing configuration details

Property Documentation

AccessTokenOldName

string Lusid.Sdk.Extensions.ApiConfiguration.AccessTokenOldName

getset

Exists for backwards compatibility - please use PersonalAccessToken instead (field name 'accessToken' in config)

ApplicationName

string Lusid.Sdk.Extensions.ApiConfiguration.ApplicationName

getset

Client Application name

BaseUrl

string Lusid.Sdk.Extensions.ApiConfiguration.BaseUrl

getset

Api Url

ClientId

string Lusid.Sdk.Extensions.ApiConfiguration.ClientId

getset

OAuth2 Client ID

ClientSecret

string Lusid.Sdk.Extensions.ApiConfiguration.ClientSecret

getset

OAuth2 Client Secret

LowerCaseBaseUrl

string Lusid.Sdk.Extensions.ApiConfiguration.LowerCaseBaseUrl

getset

Lower Case Api Url

Password

string Lusid.Sdk.Extensions.ApiConfiguration.Password

getset

Password

PersonalAccessToken

string Lusid.Sdk.Extensions.ApiConfiguration.PersonalAccessToken

getset

Configurable via FBN_ACCESS_TOKEN env variable - get the value from LUSID web 'Your Profile'->'Personal access tokens'. Takes precedence over other authentication factors if set.

RateLimitRetries

int? Lusid.Sdk.Extensions.ApiConfiguration.RateLimitRetries

getset

The number of retries when being rate limited. If left unset the default number of rate limit retries will be used

SnakeCaseBaseUrl

string Lusid.Sdk.Extensions.ApiConfiguration.SnakeCaseBaseUrl

getset

Snake Case Api Url

TimeoutMs

int? Lusid.Sdk.Extensions.ApiConfiguration.TimeoutMs

getset

The client timeout in milliseconds. If left unset the default timeout will be used

TokenUrl

string Lusid.Sdk.Extensions.ApiConfiguration.TokenUrl

getset

Url for the token provider

Username

string Lusid.Sdk.Extensions.ApiConfiguration.Username

getset

Username

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Extensions/ApiConfiguration.cs