CreateUrlOptions | @dfinity/authentication

Options for createAuthenticationRequestUrl. All these options may be limited further by the identity provider, or an error can happen.

Hierarchy

CreateUrlOptions

Index

Properties

identityProvider
publicKey
redirectUri
scope

Properties

Optional identityProvider

identityProvider?: string | URL

The URL base to use for the identity provider. By default, this is "https://auth.ic0.app/authorize".

publicKey

publicKey: PublicKey

The public key to delegate to. This should be the public key of the session key.

Optional redirectUri

redirectUri?: string

The URI to redirect to, after authentication. By default, window.location.origin.

scope

scope: (string | Principal)[]

The scope of the delegation. This must contain at least one key and a maximum of four. This is validated in createAuthenticationRequestUrl but also will be validated as part of the identity provider.