Interface HttpAuthScheme`Internal`

Interface that defines an HttpAuthScheme

interface HttpAuthScheme {
    schemeId: string;
    signer: HttpSigner;
    identityProvider(
        config: IdentityProviderConfig,
    ): IdentityProvider<Identity>;
}

Index

Properties

schemeId signer

Methods

identityProvider

Properties

schemeId

schemeId: string

ID for an HttpAuthScheme, typically the absolute shape ID of a Smithy auth trait.

signer

signer: HttpSigner

HttpSigner corresponding to an HttpAuthScheme.

Methods

identityProvider

identityProvider(config: IdentityProviderConfig): IdentityProvider<Identity>
Gets the IdentityProvider corresponding to an HttpAuthScheme.
Parameters
- config: IdentityProviderConfig
Returns IdentityProvider<Identity>
- Defined in node_modules/@smithy/types/dist-types/auth/HttpAuthScheme.d.ts:22