@valon-technologies/gestalt
    Preparing search index...

    Class Authentication

    Authentication models the shared Gestalt authentication protocol.

    Index

    Constructors

    constructor

    Methods

    authorize authorizeRaw token tokenRaw introspect introspectRaw listGrants getGrant getGrantRaw revokeGrant revokeGrantRaw

    Constructors

    • Parameters

      • transport: Transport
      • Optionaloptions: { timeoutMs?: number }

      Returns Authentication

    Methods

    • Parameters

      • responseType: string
      • clientId: string
      • redirectUri: string
      • scope: string
      • state: string

      Returns Promise<AuthorizeResponse>

    • Parameters

      • request: {
            responseType?: string;
            clientId?: string;
            redirectUri?: string;
            scope?: string;
            state?: string;
        }
        • OptionalresponseType?: string

          response_type is typically "code".

        • OptionalclientId?: string
        • OptionalredirectUri?: string
        • Optionalscope?: string
        • Optionalstate?: string

      Returns Promise<AuthorizeResponse>

    • Parameters

      • grantType: string
      • code: string
      • redirectUri: string
      • clientId: string
      • state: string
      • scope: string
      • subjectToken: string
      • subjectTokenType: string

      Returns Promise<TokenResponse>

    • Parameters

      • request: {
            grantType?: string;
            code?: string;
            redirectUri?: string;
            clientId?: string;
            state?: string;
            scope?: string;
            subjectToken?: string;
            subjectTokenType?: string;
        }
        • OptionalgrantType?: string

          grant_type is "authorization_code" or "urn:ietf:params:oauth:grant-type:token-exchange".

        • Optionalcode?: string
        • OptionalredirectUri?: string
        • OptionalclientId?: string
        • Optionalstate?: string

          state correlates authorization-code exchanges with Authorize.

        • Optionalscope?: string

          scope is the requested scope for issued tokens.

        • OptionalsubjectToken?: string

          subject_token is the bearer token being exchanged per RFC 8693.

        • OptionalsubjectTokenType?: string

          subject_token_type is the RFC 8693 token type for subject_token.

      Returns Promise<TokenResponse>

    • Parameters

      • request: { token?: string; tokenTypeHint?: string }
        • Optionaltoken?: string
        • OptionaltokenTypeHint?: string

          token_type_hint is "access_token" or "refresh_token".

      Returns Promise<IntrospectResponse>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods