Constructors Protected constructornew Auth Client( _identity: Identity , _key: SignIdentity , _chain: null | DelegationChain , _storage: AuthClientStorage , idleManager: undefined | IdleManager , _createOptions: undefined | AuthClientCreateOptions , _idpWindow?: Window , _eventHandler?: ( ( event: MessageEvent < any > ) => void ) ) : AuthClient Parameters _identity: Identity _key: SignIdentity _chain: null | DelegationChain _storage: AuthClientStorage idleManager: undefined | IdleManager Optional _idpWindow: Window Optional _eventHandler: ( ( event: MessageEvent < any > ) => void ) ( event: MessageEvent < any > ) : void Methods Private _get Event Handler_get Event Handler( identityProviderUrl: URL , options?: AuthClientLoginOptions ) : ( ( event: MessageEvent < any > ) => Promise < void > ) Parameters Returns ( ( event: MessageEvent < any > ) => Promise < void > ) ( event: MessageEvent < any > ) : Promise < void > Parameters Returns Promise < void > Private _handle Failure_handle Failure( errorMessage?: string , onError?: ( ( error?: string ) => void ) ) : void Parameters Optional errorMessage: string Optional onError: ( ( error?: string ) => void ) Returns void Private _handle Success_handle Success( message: InternetIdentityAuthResponseSuccess , onSuccess?: ( ( ) => void ) ) : Promise < void > Parameters message: InternetIdentityAuthResponseSuccess Optional onSuccess: ( ( ) => void ) Returns Promise < void > Private _remove Event Listener_remove Event Listener( ) : void is Authenticated is Authenticated( ) : Promise < boolean > login login( options?: { derivationOrigin?: string | URL ; identityProvider?: string | URL ; maxTimeToLive?: bigint ; onError?: ( ( error?: string ) => void ) | ( ( error?: string ) => Promise < void > ) ; onSuccess?: ( ( ) => void ) | ( ( ) => Promise < void > ) ; windowOpenerFeatures?: string } ) : Promise < void > Parameters Optional options: { derivationOrigin?: string | URL ; identityProvider?: string | URL ; maxTimeToLive?: bigint ; onError?: ( ( error?: string ) => void ) | ( ( error?: string ) => Promise < void > ) ; onSuccess?: ( ( ) => void ) | ( ( ) => Promise < void > ) ; windowOpenerFeatures?: string } Optional derivation Origin?: string | URL Optional identity Provider?: string | URL Optional max Time To Live?: bigint Optional on Error?: ( ( error?: string ) => void ) | ( ( error?: string ) => Promise < void > ) Optional on Success?: ( ( ) => void ) | ( ( ) => Promise < void > ) Optional window Opener Features?: string Returns Promise < void > logout logout( options?: { returnTo?: string } ) : Promise < void > Parameters options: { returnTo?: string } = {} Optional return To?: string Returns Promise < void > Static createcreate( options?: { identity?: SignIdentity ; idleOptions?: IdleOptions ; keyType?: BaseKeyType ; storage?: AuthClientStorage } ) : Promise < AuthClient > Parameters options: { identity?: SignIdentity ; idleOptions?: IdleOptions ; keyType?: BaseKeyType ; storage?: AuthClientStorage } = {} Optional identity?: SignIdentity Optional idle Options?: IdleOptions Optional key Type?: BaseKeyType Optional storage?: AuthClientStorage Legend Constructor Property Method Private property Private method Settings Theme OS Light Dark
Tool to manage authentication and identity
AuthClient