Interface: CredentialsProviderOptions<C>
@divine/uri.CredentialsProviderOptions
Parameters for a CredentialsProvider.
Type parameters
| Name | Type | Description |
|---|---|---|
C | extends Credentials | The type of credentials that is to be provied. |
Properties
authScheme
• authScheme: AuthScheme<C>
The AuthScheme that needs the credentials.
Defined in
authorization
• Optional authorization: Authorization
If mode is verify, the untrusted authorization header that was provided.
Defined in
challenge
• Optional challenge: WWWAuthenticate
If mode is retrieve, the challenge the credential provider should respond to.
Defined in
identity
• Optional identity: string
If mode is verify, the identity of the credentials that should be verified.
Defined in
mode
• mode: "retrieve" | "verify"
If credentials should be provided (retrieve) or checked for validity (verify).
Defined in
request
• Optional request: AuthSchemeRequest
The request that should be authenticated.