.Net SDK
Tokenio.TokenClient Class Reference
Inheritance diagram for Tokenio.TokenClient:

Classes

class  Builder
 

Public Member Functions

Task< TokenMember > ResolveAlias (Alias alias)
 Resolve an alias to a TokenMember object, containing member ID and the alias with the correct type. More...
 
TokenMember ResolveAliasBlocking (Alias alias)
 Resolve an alias to a TokenMember object, containing member ID and the alias with the correct type. More...
 
Task< Boolean > AliasExists (Alias alias)
 Checks if a given alias already exists. More...
 
bool AliasExistsBlocking (Alias alias)
 Checks if a given alias already exists. More...
 
Task< string > GetMemberId (Alias alias)
 Looks up member id for a given alias. More...
 
string GetMemberIdBlocking (Alias alias)
 Looks up member id for a given alias. More...
 
Task< MemberCreateMember (Alias alias=null, CreateMemberType createMemberType=CreateMemberType.Personal)
 Creates a new Token member with a set of auto-generated keys, an alias, and member type. More...
 
Member CreateMemberBlocking (Alias alias=null, CreateMemberType createMemberType=CreateMemberType.Personal)
 Creates a new Token member with a set of auto-generated keys, an alias, and member type. More...
 
Task< MemberCreateBusinessMember (Alias alias)
 Creates a new business-use Token member with a set of auto-generated keys and alias. More...
 
Member CreateBusinessMemberBlocking (Alias alias)
 Creates a new business-use Token member with a set of auto-generated keys and alias. More...
 
Task< MemberGetMember (string memberId)
 Return a Member set up to use some Token member's keys (assuming we have them). More...
 
Member GetMemberBlocking (string memberId)
 Return a Member set up to use some Token member's keys (assuming we have them). More...
 
Task< TokenRequestRetrieveTokenRequest (string requestId)
 Returns a token request for a specified token request id. More...
 
TokenRequest RetrieveTokenRequestBlocking (string requestId)
 Returns a token request for a specified token request id. More...
 
Task< string > BeginRecovery (Alias alias)
 Begins account recovery. More...
 
string BeginRecoveryBlocking (Alias alias)
 Begins account recovery. More...
 
Task< Authorization > CreateRecoveryAuthorization (string memberId, Key privilegedKey)
 Create a recovery authorization for some agent to sign. More...
 
Authorization CreateRecoveryAuthorizationBlocking (string memberId, Key privilegedKey)
 Create a recovery authorization for some agent to sign. More...
 
Task< MemberRecoveryOperation > GetRecoveryAuthorization (string verificationId, string code, Key key)
 Gets recovery authorization from Token. More...
 
MemberRecoveryOperation GetRecoveryAuthorizationBlocking (string verificationId, string code, Key key)
 Gets recovery authorization from Token. More...
 
Task< MemberCompleteRecovery (string memberId, IList< MemberRecoveryOperation > recoveryOperations, Key privilegedKey, ICryptoEngine cryptoEngine)
 Completes account recovery. More...
 
Member CompleteRecoveryBlocking (string memberId, IList< MemberRecoveryOperation > recoveryOperations, Key privilegedKey, ICryptoEngine cryptoEngine)
 Completes account recovery. More...
 
Task< MemberCompleteRecoveryWithDefaultRule (string memberId, string verificationId, string code)
 Completes account recovery if the default recovery rule was set. More...
 
Member CompleteRecoveryWithDefaultRuleBlocking (string memberId, string verificationId, string code)
 Completes account recovery if the default recovery rule was set. More...
 
Task< PagedBanksGetBanks ()
 Returns the first 200 available banks for linking. More...
 
Task< PagedBanksGetBanks (IList< string > ids)
 Returns banks from a given list of bank IDs (case-insensitive). More...
 
Task< PagedBanksGetBanks (string search)
 Return banks whose 'name' or 'identifier' contains the given search string (case-insensitive). More...
 
Task< PagedBanksGetBanks (int page, int perPage)
 Returns banks with specified paging information. More...
 
Task< PagedBanksGetBanks (string country, int page, int perPage)
 Return banks whose 'country' matches the given country code (case-insensitive). More...
 
Task< PagedBanksGetBanks (IList< string > ids, string search, string country, int? page, int? perPage, string sort)
 Return banks that satisfy given filtering requirements. More...
 
PagedBanks GetBanksBlocking ()
 Returns the first 200 available banks for linking. More...
 
PagedBanks GetBanksBlocking (IList< string > ids)
 Returns banks from a given list of bank IDs (case-insensitive). More...
 
PagedBanks GetBanksBlocking (string search)
 Return banks whose 'name' or 'identifier' contains the given search string (case-insensitive). More...
 
PagedBanks GetBanksBlocking (int page, int perPage)
 Returns banks with specified paging information. More...
 
PagedBanks GetBanksBlocking (string country, int page, int perPage)
 Return banks whose 'country' matches the given country code (case-insensitive). More...
 
PagedBanks GetBanksBlocking (IList< string > ids, string search, string country, int? page, int? perPage, string sort)
 Return banks that satisfy given filtering requirements. More...
 
Task< string > GenerateTokenRequestUrl (string requestId, string state="", string csrfToken="")
 Generates a Token request URL from a request ID, an original state and a CSRF token. More...
 
string GenerateTokenRequestUrlBlocking (string requestId, string state="", string csrfToken="")
 Generates a Token request URL from a request ID, an original state and a CSRF token. More...
 
Task< TokenRequestCallbackParseTokenRequestCallbackUrl (string callbackUrl, string csrfToken="")
 Parse the token request callback URL to extract the state and the token ID. Verify that the state contains the CSRF token hash and that the signature on the state and CSRF token is valid. More...
 
TokenRequestCallback ParseTokenRequestCallbackUrlBlocking (string callbackUrl, string csrfToken="")
 Parse the token request callback URL to extract the state and the token ID. Verify that the state contains the CSRF token hash and that the signature on the state and CSRF token is valid. More...
 
Task< IList< string > > GetCountries (string provider)
 Returns a list of countries with Token-enabled banks. More...
 
IList< string > GetCountriesBlocking (string provider)
 Returns a list of countries with Token-enabled banks. More...
 
Task< TokenRequestResultGetTokenRequestResult (string tokenRequestId)
 Get the token request result based on a token's tokenRequestId. More...
 
TokenRequestResult GetTokenRequestResultBlocking (string tokenRequestId)
 Get the token request result based on a token's tokenRequestId. More...
 
void Dispose ()
 

Static Public Member Functions

static Builder NewBuilder ()
 Creates a new Builder instance that is used to configure and More...
 
static TokenClient Create (TokenCluster cluster, string developerKey)
 Creates a new instance of TokenIO that's configured to use the specified environment. More...
 

Member Function Documentation

◆ AliasExists()

Task<Boolean> Tokenio.TokenClient.AliasExists ( Alias  alias)
inline

Checks if a given alias already exists.

Parameters
aliasthe alias to check
Returns
true if alias exists, false otherwise

◆ AliasExistsBlocking()

bool Tokenio.TokenClient.AliasExistsBlocking ( Alias  alias)
inline

Checks if a given alias already exists.

Parameters
aliasthe alias to check
Returns
true if alias exists, false otherwise

◆ BeginRecovery()

Task<string> Tokenio.TokenClient.BeginRecovery ( Alias  alias)
inline

Begins account recovery.

Parameters
aliasthe used to recover
Returns
the verification id

◆ BeginRecoveryBlocking()

string Tokenio.TokenClient.BeginRecoveryBlocking ( Alias  alias)
inline

Begins account recovery.

Parameters
aliasthe used to recover
Returns
the verification id

◆ CompleteRecovery()

Task<Member> Tokenio.TokenClient.CompleteRecovery ( string  memberId,
IList< MemberRecoveryOperation >  recoveryOperations,
Key  privilegedKey,
ICryptoEngine  cryptoEngine 
)
inline

Completes account recovery.

Parameters
memberIdthe member id
recoveryOperationsthe member recovery operations
privilegedKeythe privileged public key in the member recovery operations
cryptoEnginethe new crypto engine
Returns
the new member

◆ CompleteRecoveryBlocking()

Member Tokenio.TokenClient.CompleteRecoveryBlocking ( string  memberId,
IList< MemberRecoveryOperation >  recoveryOperations,
Key  privilegedKey,
ICryptoEngine  cryptoEngine 
)
inline

Completes account recovery.

Parameters
memberIdthe member id
recoveryOperationsthe member recovery operations
privilegedKeythe privileged public key in the member recovery operations
cryptoEnginethe new crypto engine
Returns
the new member

◆ CompleteRecoveryWithDefaultRule()

Task<Member> Tokenio.TokenClient.CompleteRecoveryWithDefaultRule ( string  memberId,
string  verificationId,
string  code 
)
inline

Completes account recovery if the default recovery rule was set.

Parameters
memberIdthe member id
verificationIdthe verification id
codethe code
Returns
the new member

◆ CompleteRecoveryWithDefaultRuleBlocking()

Member Tokenio.TokenClient.CompleteRecoveryWithDefaultRuleBlocking ( string  memberId,
string  verificationId,
string  code 
)
inline

Completes account recovery if the default recovery rule was set.

Parameters
memberIdthe member id
verificationIdthe verification id
codethe code
Returns
the new member

◆ Create()

static TokenClient Tokenio.TokenClient.Create ( TokenCluster  cluster,
string  developerKey 
)
inlinestatic

Creates a new instance of TokenIO that's configured to use the specified environment.

Parameters
clusterthe token cluster to connect to
developerKeythe developer key
Returns
an instance of TokenIO

◆ CreateBusinessMember()

Task<Member> Tokenio.TokenClient.CreateBusinessMember ( Alias  alias)
inline

Creates a new business-use Token member with a set of auto-generated keys and alias.

Parameters
aliasthe alias to be associated with member
Returns
the created member

◆ CreateBusinessMemberBlocking()

Member Tokenio.TokenClient.CreateBusinessMemberBlocking ( Alias  alias)
inline

Creates a new business-use Token member with a set of auto-generated keys and alias.

Parameters
aliasthe alias to be associated with member
Returns
the created member

◆ CreateMember()

Task<Member> Tokenio.TokenClient.CreateMember ( Alias  alias = null,
CreateMemberType  createMemberType = CreateMemberType.Personal 
)
inline

Creates a new Token member with a set of auto-generated keys, an alias, and member type.

Parameters
aliasnullable member alias to use, must be unique. If null, then no alias will be created with the member
createMemberTypethe type of member to register
Returns
the created member

◆ CreateMemberBlocking()

Member Tokenio.TokenClient.CreateMemberBlocking ( Alias  alias = null,
CreateMemberType  createMemberType = CreateMemberType.Personal 
)
inline

Creates a new Token member with a set of auto-generated keys, an alias, and member type.

Parameters
aliasnullable member alias to use, must be unique. If null, then no alias will be created with the member
createMemberTypethe type of member to register
Returns
the created member

◆ CreateRecoveryAuthorization()

Task<Authorization> Tokenio.TokenClient.CreateRecoveryAuthorization ( string  memberId,
Key  privilegedKey 
)
inline

Create a recovery authorization for some agent to sign.

Parameters
memberIdthe ID of the member we claim to be.
privilegedKeythe new privileged key we want to use.
Returns
the authorization

◆ CreateRecoveryAuthorizationBlocking()

Authorization Tokenio.TokenClient.CreateRecoveryAuthorizationBlocking ( string  memberId,
Key  privilegedKey 
)
inline

Create a recovery authorization for some agent to sign.

Parameters
memberIdthe ID of the member we claim to be.
privilegedKeythe new privileged key we want to use.
Returns
the authorization

◆ GenerateTokenRequestUrl()

Task<string> Tokenio.TokenClient.GenerateTokenRequestUrl ( string  requestId,
string  state = "",
string  csrfToken = "" 
)
inline

Generates a Token request URL from a request ID, an original state and a CSRF token.

Parameters
requestIdthe request id
statethe state
csrfTokenthe csrf token
Returns
the token request url

◆ GenerateTokenRequestUrlBlocking()

string Tokenio.TokenClient.GenerateTokenRequestUrlBlocking ( string  requestId,
string  state = "",
string  csrfToken = "" 
)
inline

Generates a Token request URL from a request ID, an original state and a CSRF token.

Parameters
requestIdthe request id
statethe state
csrfTokenthe csrf token
Returns
the token request url

◆ GetBanks() [1/6]

Task<PagedBanks> Tokenio.TokenClient.GetBanks ( )
inline

Returns the first 200 available banks for linking.

Returns
banks with paging information

◆ GetBanks() [2/6]

Task<PagedBanks> Tokenio.TokenClient.GetBanks ( IList< string >  ids)
inline

Returns banks from a given list of bank IDs (case-insensitive).

Parameters
idsthe bank IDs
Returns
banks with paging information

◆ GetBanks() [3/6]

Task<PagedBanks> Tokenio.TokenClient.GetBanks ( string  search)
inline

Return banks whose 'name' or 'identifier' contains the given search string (case-insensitive).

Parameters
searchthe keyword to search for
Returns
banks with paging information

◆ GetBanks() [4/6]

Task<PagedBanks> Tokenio.TokenClient.GetBanks ( int  page,
int  perPage 
)
inline

Returns banks with specified paging information.

Parameters
pagethe result page to retrieve
perPagemax number of records per page, can be at most 200
Returns
banks with paging information

◆ GetBanks() [5/6]

Task<PagedBanks> Tokenio.TokenClient.GetBanks ( string  country,
int  page,
int  perPage 
)
inline

Return banks whose 'country' matches the given country code (case-insensitive).

Parameters
countrythe ISO 3166-1 alpha-2 country code
pagethe result page to retrieve
perPagemax number of records per page, can be at most 200
Returns
banks with paging information

◆ GetBanks() [6/6]

Task<PagedBanks> Tokenio.TokenClient.GetBanks ( IList< string >  ids,
string  search,
string  country,
int?  page,
int?  perPage,
string  sort 
)
inline

Return banks that satisfy given filtering requirements.

Parameters
idsthe bank IDs to fetch
searchthe keyword to search the fields 'name' and 'identifier' for
countryISO 3166-1 alpha-2 country code of the banks
pagethe result page to retrieve
perPagemax number of records per page, can be at most 200
sortthe key to sort the results, one of: name, provider and country
Returns
banks with paging information

All fields are optional. Set to null if absent. The default value for page is 1; the default value for perPage is 200. Values set out of range will be treated as default value.

◆ GetBanksBlocking() [1/6]

PagedBanks Tokenio.TokenClient.GetBanksBlocking ( )
inline

Returns the first 200 available banks for linking.

Returns
banks with paging information

◆ GetBanksBlocking() [2/6]

PagedBanks Tokenio.TokenClient.GetBanksBlocking ( IList< string >  ids)
inline

Returns banks from a given list of bank IDs (case-insensitive).

Parameters
idsthe bank IDs
Returns
banks with paging information

◆ GetBanksBlocking() [3/6]

PagedBanks Tokenio.TokenClient.GetBanksBlocking ( string  search)
inline

Return banks whose 'name' or 'identifier' contains the given search string (case-insensitive).

Parameters
searchthe keyword to search for
Returns
banks with paging information

◆ GetBanksBlocking() [4/6]

PagedBanks Tokenio.TokenClient.GetBanksBlocking ( int  page,
int  perPage 
)
inline

Returns banks with specified paging information.

Parameters
pagethe result page to retrieve
perPagemax number of records per page, can be at most 200
Returns
banks with paging information

◆ GetBanksBlocking() [5/6]

PagedBanks Tokenio.TokenClient.GetBanksBlocking ( string  country,
int  page,
int  perPage 
)
inline

Return banks whose 'country' matches the given country code (case-insensitive).

Parameters
countrythe ISO 3166-1 alpha-2 country code
pagethe result page to retrieve
perPagemax number of records per page, can be at most 200
Returns
banks with paging information

◆ GetBanksBlocking() [6/6]

PagedBanks Tokenio.TokenClient.GetBanksBlocking ( IList< string >  ids,
string  search,
string  country,
int?  page,
int?  perPage,
string  sort 
)
inline

Return banks that satisfy given filtering requirements.

Parameters
idsthe bank IDs to fetch
searchthe keyword to search the fields 'name' and 'identifier' for
countryISO 3166-1 alpha-2 country code of the banks
pagethe result page to retrieve
perPagemax number of records per page, can be at most 200
sortthe key to sort the results, one of: name, provider and country
Returns
banks with paging information

All fields are optional. Set to null if absent. The default value for page is 1; the default value for perPage is 200. Values set out of range will be treated as default value.

◆ GetCountries()

Task<IList<string> > Tokenio.TokenClient.GetCountries ( string  provider)
inline

Returns a list of countries with Token-enabled banks.

Parameters
providerIf specified, return banks whose 'provider' matches the given provider
Returns
a list of country codes

◆ GetCountriesBlocking()

IList<string> Tokenio.TokenClient.GetCountriesBlocking ( string  provider)
inline

Returns a list of countries with Token-enabled banks.

Parameters
providerIf specified, return banks whose 'provider' matches the given provider
Returns
a list of country codes

◆ GetMember()

Task<Member> Tokenio.TokenClient.GetMember ( string  memberId)
inline

Return a Member set up to use some Token member's keys (assuming we have them).

Parameters
memberIdthe member ID
Returns
the member

◆ GetMemberBlocking()

Member Tokenio.TokenClient.GetMemberBlocking ( string  memberId)
inline

Return a Member set up to use some Token member's keys (assuming we have them).

Parameters
memberIdthe member ID
Returns
the member

◆ GetMemberId()

Task<string> Tokenio.TokenClient.GetMemberId ( Alias  alias)
inline

Looks up member id for a given alias.

Parameters
aliasthe alias to check
Returns
member id if alias already exists, null otherwise

◆ GetMemberIdBlocking()

string Tokenio.TokenClient.GetMemberIdBlocking ( Alias  alias)
inline

Looks up member id for a given alias.

Parameters
aliasthe alias to check
Returns
member id if alias already exists, null otherwise

◆ GetRecoveryAuthorization()

Task<MemberRecoveryOperation> Tokenio.TokenClient.GetRecoveryAuthorization ( string  verificationId,
string  code,
Key  key 
)
inline

Gets recovery authorization from Token.

Parameters
verificationIdthe verification id
codethe verification code
keythe privileged key
Returns
the member recovery operation

◆ GetRecoveryAuthorizationBlocking()

MemberRecoveryOperation Tokenio.TokenClient.GetRecoveryAuthorizationBlocking ( string  verificationId,
string  code,
Key  key 
)
inline

Gets recovery authorization from Token.

Parameters
verificationIdthe verification id
codethe verification code
keythe privileged key
Returns
the member recovery operation

◆ GetTokenRequestResult()

Task<TokenRequestResult> Tokenio.TokenClient.GetTokenRequestResult ( string  tokenRequestId)
inline

Get the token request result based on a token's tokenRequestId.

Parameters
tokenRequestIdthe token request id
Returns
the token request result

◆ GetTokenRequestResultBlocking()

TokenRequestResult Tokenio.TokenClient.GetTokenRequestResultBlocking ( string  tokenRequestId)
inline

Get the token request result based on a token's tokenRequestId.

Parameters
tokenRequestIdthe token request id
Returns
the token request result

◆ NewBuilder()

static Builder Tokenio.TokenClient.NewBuilder ( )
inlinestatic

Creates a new Builder instance that is used to configure and

Returns
the builder

◆ ParseTokenRequestCallbackUrl()

Task<TokenRequestCallback> Tokenio.TokenClient.ParseTokenRequestCallbackUrl ( string  callbackUrl,
string  csrfToken = "" 
)
inline

Parse the token request callback URL to extract the state and the token ID. Verify that the state contains the CSRF token hash and that the signature on the state and CSRF token is valid.

Parameters
callbackUrlthe token request callback url
csrfTokenthe csrf token
Returns
an instance of TokenRequestCallback

◆ ParseTokenRequestCallbackUrlBlocking()

TokenRequestCallback Tokenio.TokenClient.ParseTokenRequestCallbackUrlBlocking ( string  callbackUrl,
string  csrfToken = "" 
)
inline

Parse the token request callback URL to extract the state and the token ID. Verify that the state contains the CSRF token hash and that the signature on the state and CSRF token is valid.

Parameters
callbackUrlthe token request callback url
csrfTokenthe csrf token
Returns
an instance of TokenRequestCallback

◆ ResolveAlias()

Task<TokenMember> Tokenio.TokenClient.ResolveAlias ( Alias  alias)
inline

Resolve an alias to a TokenMember object, containing member ID and the alias with the correct type.

Parameters
aliasalias to resolve
Returns
TokenMember

◆ ResolveAliasBlocking()

TokenMember Tokenio.TokenClient.ResolveAliasBlocking ( Alias  alias)
inline

Resolve an alias to a TokenMember object, containing member ID and the alias with the correct type.

Parameters
aliasalias to resolve
Returns
TokenMember

◆ RetrieveTokenRequest()

Task<TokenRequest> Tokenio.TokenClient.RetrieveTokenRequest ( string  requestId)
inline

Returns a token request for a specified token request id.

Parameters
requestIdthe request id
Returns
the token request

◆ RetrieveTokenRequestBlocking()

TokenRequest Tokenio.TokenClient.RetrieveTokenRequestBlocking ( string  requestId)
inline

Returns a token request for a specified token request id.

Parameters
requestIdthe request id
Returns
the token request

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