Class DelegatedAuthClient

Hierarchy

DelegatedAuthClient

Index

Constructors

Properties

Methods

activateApplicationComplete activateApplicationInit activateCredentialComplete activateCredentialInit activatePersonalAccessTokenComplete activatePersonalAccessTokenInit activateServiceAccountComplete activateServiceAccountInit activateUserComplete activateUserInit archiveApplicationComplete archiveApplicationInit archivePersonalAccessTokenComplete archivePersonalAccessTokenInit archiveServiceAccountComplete archiveServiceAccountInit archiveUserComplete archiveUserInit createApplicationComplete createApplicationInit createCodeUserActionSignature createCodeUserActionSignatureChallenge createDelegatedUserLoginComplete createDelegatedUserLoginInit createDelegatedUserRecoveryComplete createDelegatedUserRecoveryInit createDelegatedUserRegistrationComplete createDelegatedUserRegistrationInit createPersonalAccessTokenComplete createPersonalAccessTokenInit createServiceAccountComplete createServiceAccountInit createUserActionSignature createUserActionSignatureChallenge createUserActionSignatureFromCode createUserComplete createUserCredentialChallenge createUserCredentialComplete createUserCredentialInit createUserInit createUserRecovery createUserRegistration deactivateApplicationComplete deactivateApplicationInit deactivateCredentialComplete deactivateCredentialInit deactivatePersonalAccessTokenComplete deactivatePersonalAccessTokenInit deactivateServiceAccountComplete deactivateServiceAccountInit deactivateUserComplete deactivateUserInit getApplication getPersonalAccessTokens getServiceAccount getUser listApplications listPersonalAccessTokens listServiceAccounts listUserCredentials listUsers restartDelegatedUserRegistrationComplete restartDelegatedUserRegistrationInit updateApplicationComplete updateApplicationInit updatePersonalAccessTokenComplete updatePersonalAccessTokenInit updateServiceAccountComplete updateServiceAccountInit updateUserComplete updateUserInit

Constructors

constructor

new DelegatedAuthClient(apiOptions): DelegatedAuthClient
Parameters
- apiOptions: DfnsDelegatedApiClientOptions
Returns DelegatedAuthClient
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:12

Properties

`Private` apiOptions

apiOptions: DfnsDelegatedApiClientOptions

Methods

activateApplicationComplete

activateApplicationComplete(request, signedChallenge): Promise<AppInfoWithPublicKey>
Parameters
- request: ActivateApplicationRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1333

activateApplicationInit

activateApplicationInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ActivateApplicationRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1312

activateCredentialComplete

activateCredentialComplete(request, signedChallenge): Promise<GenericSuccessMessage>
Parameters
- request: ActivateCredentialRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<GenericSuccessMessage>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:238

activateCredentialInit

activateCredentialInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ActivateCredentialRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:217

activatePersonalAccessTokenComplete

activatePersonalAccessTokenComplete(request, signedChallenge): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: ActivatePersonalAccessTokenRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:558

activatePersonalAccessTokenInit

activatePersonalAccessTokenInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ActivatePersonalAccessTokenRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:537

activateServiceAccountComplete

activateServiceAccountComplete(request, signedChallenge): Promise<UserAccessTokenInformation>
Parameters
- request: ActivateServiceAccountRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:816

activateServiceAccountInit

activateServiceAccountInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ActivateServiceAccountRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:792

activateUserComplete

activateUserComplete(request, signedChallenge): Promise<UserInfo>
Parameters
- request: ActivateUserRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1078

activateUserInit

activateUserInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ActivateUserRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1057

archiveApplicationComplete

archiveApplicationComplete(request, signedChallenge): Promise<AppInfoWithPublicKey>
Parameters
- request: ArchiveApplicationRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1288

archiveApplicationInit

archiveApplicationInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ArchiveApplicationRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1267

archivePersonalAccessTokenComplete

archivePersonalAccessTokenComplete(request, signedChallenge): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: ArchivePersonalAccessTokenRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:513

archivePersonalAccessTokenInit

archivePersonalAccessTokenInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ArchivePersonalAccessTokenRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:492

archiveServiceAccountComplete

archiveServiceAccountComplete(request, signedChallenge): Promise<UserAccessTokenInformation>
Parameters
- request: ArchiveServiceAccountRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:768

archiveServiceAccountInit

archiveServiceAccountInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ArchiveServiceAccountRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:747

archiveUserComplete

archiveUserComplete(request, signedChallenge): Promise<UserInfo>
Parameters
- request: ArchiveUserRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1033

archiveUserInit

archiveUserInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: ArchiveUserRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1012

createApplicationComplete

createApplicationComplete(request, signedChallenge): Promise<AppInfoWithPublicKey>
Parameters
- request: CreateApplicationRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1182

createApplicationInit

createApplicationInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: CreateApplicationRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1161

createCodeUserActionSignature

createCodeUserActionSignature(request): Promise<GenericSuccessMessage>
Parameters
- request: CreateCodeUserActionSignatureRequest
Returns Promise<GenericSuccessMessage>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:355

createCodeUserActionSignatureChallenge

createCodeUserActionSignatureChallenge(request): Promise<UserLoginChallenge>
Parameters
- request: CreateCodeUserActionSignatureChallengeRequest
Returns Promise<UserLoginChallenge>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:338

createDelegatedUserLoginComplete

createDelegatedUserLoginComplete(request, signedChallenge): Promise<UserLogin>
Parameters
- request: CreateDelegatedUserLoginRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserLogin>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:97

createDelegatedUserLoginInit

createDelegatedUserLoginInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: CreateDelegatedUserLoginRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:76

createDelegatedUserRecoveryComplete

createDelegatedUserRecoveryComplete(request, signedChallenge): Promise<UserRecoveryChallenge>
Parameters
- request: CreateDelegatedUserRecoveryRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserRecoveryChallenge>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1485

createDelegatedUserRecoveryInit

createDelegatedUserRecoveryInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: CreateDelegatedUserRecoveryRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1464

createDelegatedUserRegistrationComplete

createDelegatedUserRegistrationComplete(request, signedChallenge): Promise<UserRegistrationChallenge>
Parameters
- request: CreateDelegatedUserRegistrationRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserRegistrationChallenge>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:35

createDelegatedUserRegistrationInit

createDelegatedUserRegistrationInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: CreateDelegatedUserRegistrationRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:14

createPersonalAccessTokenComplete

createPersonalAccessTokenComplete(request, signedChallenge): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: CreatePersonalAccessTokenRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:407

createPersonalAccessTokenInit

createPersonalAccessTokenInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: CreatePersonalAccessTokenRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:386

createServiceAccountComplete

createServiceAccountComplete(request, signedChallenge): Promise<UserAccessTokenInformation>
Parameters
- request: CreateServiceAccountRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:662

createServiceAccountInit

createServiceAccountInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: CreateServiceAccountRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:641

createUserActionSignature

createUserActionSignature(request): Promise<UserActionSignature>
Parameters
- request: CreateUserActionSignatureRequest
Returns Promise<UserActionSignature>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:138

createUserActionSignatureChallenge

createUserActionSignatureChallenge(request): Promise<UserLoginChallenge>
Parameters
- request: CreateUserActionSignatureChallengeRequest
Returns Promise<UserLoginChallenge>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:121

createUserActionSignatureFromCode

createUserActionSignatureFromCode(request): Promise<UserActionSignature>
Parameters
- request: CreateUserActionSignatureFromCodeRequest
Returns Promise<UserActionSignature>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:321

createUserComplete

createUserComplete(request, signedChallenge): Promise<UserInfo>
Parameters
- request: CreateUserRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:929

createUserCredentialChallenge

createUserCredentialChallenge(request): Promise<UserCredentialChallenge>
Parameters
- request: CreateUserCredentialChallengeRequest
Returns Promise<UserCredentialChallenge>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:155

createUserCredentialComplete

createUserCredentialComplete(request, signedChallenge): Promise<CredentialInfo>
Parameters
- request: CreateUserCredentialRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<CredentialInfo>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:193

createUserCredentialInit

createUserCredentialInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: CreateUserCredentialRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:172

createUserInit

createUserInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: CreateUserRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:908

createUserRecovery

createUserRecovery(request): Promise<UserRegistration>
Parameters
- request: CreateUserRecoveryRequest
Returns Promise<UserRegistration>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1402

createUserRegistration

createUserRegistration(request): Promise<UserRegistration>
Parameters
- request: CreateUserRegistrationRequest
Returns Promise<UserRegistration>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:59

deactivateApplicationComplete

deactivateApplicationComplete(request, signedChallenge): Promise<AppInfoWithPublicKey>
Parameters
- request: DeactivateApplicationRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1378

deactivateApplicationInit

deactivateApplicationInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: DeactivateApplicationRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1357

deactivateCredentialComplete

deactivateCredentialComplete(request, signedChallenge): Promise<GenericSuccessMessage>
Parameters
- request: DeactivateCredentialRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<GenericSuccessMessage>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:283

deactivateCredentialInit

deactivateCredentialInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: DeactivateCredentialRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:262

deactivatePersonalAccessTokenComplete

deactivatePersonalAccessTokenComplete(request, signedChallenge): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: DeactivatePersonalAccessTokenRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:603

deactivatePersonalAccessTokenInit

deactivatePersonalAccessTokenInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: DeactivatePersonalAccessTokenRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:582

deactivateServiceAccountComplete

deactivateServiceAccountComplete(request, signedChallenge): Promise<UserAccessTokenInformation>
Parameters
- request: DeactivateServiceAccountRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:867

deactivateServiceAccountInit

deactivateServiceAccountInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: DeactivateServiceAccountRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:843

deactivateUserComplete

deactivateUserComplete(request, signedChallenge): Promise<UserInfo>
Parameters
- request: DeactivateUserRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1123

deactivateUserInit

deactivateUserInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: DeactivateUserRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1102

getApplication

getApplication(request): Promise<AppInfoWithPublicKey>
Parameters
- request: GetApplicationRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1206

getPersonalAccessTokens

getPersonalAccessTokens(request): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: GetPersonalAccessTokensRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:431

getServiceAccount

getServiceAccount(request): Promise<UserAccessTokenInformation>
Parameters
- request: GetServiceAccountRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:686

getUser

getUser(request): Promise<UserInfo>
Parameters
- request: GetUserRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:953

listApplications

listApplications(): Promise<ListApplicationsResponse>
Returns Promise<ListApplicationsResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1147

listPersonalAccessTokens

listPersonalAccessTokens(): Promise<ListPersonalAccessTokensResponse>
Returns Promise<ListPersonalAccessTokensResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:372

listServiceAccounts

listServiceAccounts(): Promise<ListServiceAccountsResponse>
Returns Promise<ListServiceAccountsResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:627

listUserCredentials

listUserCredentials(): Promise<ListUserCredentialsResponse>
Returns Promise<ListUserCredentialsResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:307

listUsers

listUsers(): Promise<ListUsersResponse>
Returns Promise<ListUsersResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:894

restartDelegatedUserRegistrationComplete

restartDelegatedUserRegistrationComplete(request, signedChallenge): Promise<UserRegistrationChallenge>
Parameters
- request: RestartDelegatedUserRegistrationRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserRegistrationChallenge>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1440

restartDelegatedUserRegistrationInit

restartDelegatedUserRegistrationInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: RestartDelegatedUserRegistrationRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1419

updateApplicationComplete

updateApplicationComplete(request, signedChallenge): Promise<AppInfoWithPublicKey>
Parameters
- request: UpdateApplicationRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1243

updateApplicationInit

updateApplicationInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: UpdateApplicationRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:1222

updatePersonalAccessTokenComplete

updatePersonalAccessTokenComplete(request, signedChallenge): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: UpdatePersonalAccessTokenRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:468

updatePersonalAccessTokenInit

updatePersonalAccessTokenInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: UpdatePersonalAccessTokenRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:447

updateServiceAccountComplete

updateServiceAccountComplete(request, signedChallenge): Promise<UserAccessTokenInformation>
Parameters
- request: UpdateServiceAccountRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:723

updateServiceAccountInit

updateServiceAccountInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: UpdateServiceAccountRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:702

updateUserComplete

updateUserComplete(request, signedChallenge): Promise<UserInfo>
Parameters
- request: UpdateUserRequest
- signedChallenge: SignUserActionChallengeRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:988

updateUserInit

updateUserInit(request): Promise<UserActionChallengeResponse>
Parameters
- request: UpdateUserRequest
Returns Promise<UserActionChallengeResponse>
- Defined in packages/sdk/codegen/Auth/DelegatedAuthClient.ts:967

Generated using TypeDoc