Class AuthClient

Hierarchy

AuthClient

Index

Constructors

Properties

Methods

activateApplication activateCredential activatePersonalAccessToken activateServiceAccount activateUser archiveApplication archivePersonalAccessToken archiveServiceAccount archiveUser createApplication createCodeUserActionSignature createCodeUserActionSignatureChallenge createDelegatedUserLogin createDelegatedUserRecovery createDelegatedUserRegistration createPersonalAccessToken createServiceAccount createUser createUserActionSignature createUserActionSignatureChallenge createUserActionSignatureFromCode createUserCredential createUserCredentialChallenge createUserRecovery createUserRegistration deactivateApplication deactivateCredential deactivatePersonalAccessToken deactivateServiceAccount deactivateUser getApplication getPersonalAccessTokens getServiceAccount getUser listApplications listPersonalAccessTokens listServiceAccounts listUserCredentials listUsers restartDelegatedUserRegistration updateApplication updatePersonalAccessToken updateServiceAccount updateUser

Constructors

constructor

new AuthClient(apiOptions): AuthClient
Parameters
- apiOptions: DfnsApiClientOptions
Returns AuthClient
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:7

Properties

`Private` apiOptions

apiOptions: DfnsApiClientOptions

Methods

activateApplication

activateApplication(request): Promise<AppInfoWithPublicKey>
Parameters
- request: ActivateApplicationRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:647

activateCredential

activateCredential(request): Promise<GenericSuccessMessage>
Parameters
- request: ActivateCredentialRequest
Returns Promise<GenericSuccessMessage>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:128

activatePersonalAccessToken

activatePersonalAccessToken(request): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: ActivatePersonalAccessTokenRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:307

activateServiceAccount

activateServiceAccount(request): Promise<UserAccessTokenInformation>
Parameters
- request: ActivateServiceAccountRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:419

activateUser

activateUser(request): Promise<UserInfo>
Parameters
- request: ActivateUserRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:535

archiveApplication

archiveApplication(request): Promise<AppInfoWithPublicKey>
Parameters
- request: ArchiveApplicationRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:631

archivePersonalAccessToken

archivePersonalAccessToken(request): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: ArchivePersonalAccessTokenRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:291

archiveServiceAccount

archiveServiceAccount(request): Promise<UserAccessTokenInformation>
Parameters
- request: ArchiveServiceAccountRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:403

archiveUser

archiveUser(request): Promise<UserInfo>
Parameters
- request: ArchiveUserRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:519

createApplication

createApplication(request): Promise<AppInfoWithPublicKey>
Parameters
- request: CreateApplicationRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:581

createCodeUserActionSignature

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

createCodeUserActionSignatureChallenge

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

createDelegatedUserLogin

createDelegatedUserLogin(request): Promise<UserLogin>
Parameters
- request: CreateDelegatedUserLoginRequest
Returns Promise<UserLogin>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:43

createDelegatedUserRecovery

createDelegatedUserRecovery(request): Promise<UserRecoveryChallenge>
Parameters
- request: CreateDelegatedUserRecoveryRequest
Returns Promise<UserRecoveryChallenge>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:713

createDelegatedUserRegistration

createDelegatedUserRegistration(request): Promise<UserRegistrationChallenge>
Parameters
- request: CreateDelegatedUserRegistrationRequest
Returns Promise<UserRegistrationChallenge>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:9

createPersonalAccessToken

createPersonalAccessToken(request): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: CreatePersonalAccessTokenRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:241

createServiceAccount

createServiceAccount(request): Promise<UserAccessTokenInformation>
Parameters
- request: CreateServiceAccountRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:353

createUser

createUser(request): Promise<UserInfo>
Parameters
- request: CreateUserRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:471

createUserActionSignature

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

createUserActionSignatureChallenge

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

createUserActionSignatureFromCode

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

createUserCredential

createUserCredential(request): Promise<CredentialInfo>
Parameters
- request: CreateUserCredentialRequest
Returns Promise<CredentialInfo>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:111

createUserCredentialChallenge

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

createUserRecovery

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

createUserRegistration

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

deactivateApplication

deactivateApplication(request): Promise<AppInfoWithPublicKey>
Parameters
- request: DeactivateApplicationRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:663

deactivateCredential

deactivateCredential(request): Promise<GenericSuccessMessage>
Parameters
- request: DeactivateCredentialRequest
Returns Promise<GenericSuccessMessage>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:145

deactivatePersonalAccessToken

deactivatePersonalAccessToken(request): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: DeactivatePersonalAccessTokenRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:323

deactivateServiceAccount

deactivateServiceAccount(request): Promise<UserAccessTokenInformation>
Parameters
- request: DeactivateServiceAccountRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:438

deactivateUser

deactivateUser(request): Promise<UserInfo>
Parameters
- request: DeactivateUserRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:551

getApplication

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

getPersonalAccessTokens

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

getServiceAccount

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

getUser

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

listApplications

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

listPersonalAccessTokens

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

listServiceAccounts

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

listUserCredentials

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

listUsers

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

restartDelegatedUserRegistration

restartDelegatedUserRegistration(request): Promise<UserRegistrationChallenge>
Parameters
- request: RestartDelegatedUserRegistrationRequest
Returns Promise<UserRegistrationChallenge>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:696

updateApplication

updateApplication(request): Promise<AppInfoWithPublicKey>
Parameters
- request: UpdateApplicationRequest
Returns Promise<AppInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:614

updatePersonalAccessToken

updatePersonalAccessToken(request): Promise<AccessTokenInfoWithPublicKey>
Parameters
- request: UpdatePersonalAccessTokenRequest
Returns Promise<AccessTokenInfoWithPublicKey>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:274

updateServiceAccount

updateServiceAccount(request): Promise<UserAccessTokenInformation>
Parameters
- request: UpdateServiceAccountRequest
Returns Promise<UserAccessTokenInformation>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:386

updateUser

updateUser(request): Promise<UserInfo>
Parameters
- request: UpdateUserRequest
Returns Promise<UserInfo>
- Defined in packages/sdk/codegen/Auth/AuthClient.ts:502

Generated using TypeDoc