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

    Constructors

    • Parameters

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

      Returns ExternalCredentials

    Methods

    • Parameters

      • Optionalcredential: {
            id?: string;
            subject?: string;
            audience?: string;
            qualifier?: string;
            metadataJson?: string;
            createdAt?: Date;
            updatedAt?: Date;
            credential?:
                | { case: undefined; value?: undefined }
                | {
                    case: "grant";
                    value: {
                        accessToken?: string;
                        refreshToken?: string;
                        scope?: string;
                        expiresAt?: Date;
                        lastRefreshedAt?: Date;
                        refreshErrorCount?: number;
                    };
                }
                | {
                    case: "client";
                    value: {
                        clientId?: string;
                        clientSecret?: string;
                        clientSecretExpiresAt?: Date;
                    };
                }
                | { case: "opaque"; value: { fields?: { [key: string]: string } } };
        }

      Returns Promise<ExternalCredential>

    • Parameters

      • request: {
            credential?: {
                id?: string;
                subject?: string;
                audience?: string;
                qualifier?: string;
                metadataJson?: string;
                createdAt?: Date;
                updatedAt?: Date;
                credential?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "grant";
                        value: {
                            accessToken?: string;
                            refreshToken?: string;
                            scope?: string;
                            expiresAt?: Date;
                            lastRefreshedAt?: Date;
                            refreshErrorCount?: number;
                        };
                    }
                    | {
                        case: "client";
                        value: {
                            clientId?: string;
                            clientSecret?: string;
                            clientSecretExpiresAt?: Date;
                        };
                    }
                    | { case: "opaque"; value: { fields?: { [key: string]: string } } };
            };
        }

      Returns Promise<ExternalCredential>

    • Parameters

      • Optionalcredential: {
            id?: string;
            subject?: string;
            audience?: string;
            qualifier?: string;
            metadataJson?: string;
            createdAt?: Date;
            updatedAt?: Date;
            credential?:
                | { case: undefined; value?: undefined }
                | {
                    case: "grant";
                    value: {
                        accessToken?: string;
                        refreshToken?: string;
                        scope?: string;
                        expiresAt?: Date;
                        lastRefreshedAt?: Date;
                        refreshErrorCount?: number;
                    };
                }
                | {
                    case: "client";
                    value: {
                        clientId?: string;
                        clientSecret?: string;
                        clientSecretExpiresAt?: Date;
                    };
                }
                | { case: "opaque"; value: { fields?: { [key: string]: string } } };
        }

      Returns Promise<ExternalCredential>

    • Parameters

      • request: {
            credential?: {
                id?: string;
                subject?: string;
                audience?: string;
                qualifier?: string;
                metadataJson?: string;
                createdAt?: Date;
                updatedAt?: Date;
                credential?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "grant";
                        value: {
                            accessToken?: string;
                            refreshToken?: string;
                            scope?: string;
                            expiresAt?: Date;
                            lastRefreshedAt?: Date;
                            refreshErrorCount?: number;
                        };
                    }
                    | {
                        case: "client";
                        value: {
                            clientId?: string;
                            clientSecret?: string;
                            clientSecretExpiresAt?: Date;
                        };
                    }
                    | { case: "opaque"; value: { fields?: { [key: string]: string } } };
            };
        }

      Returns Promise<ExternalCredential>

    • Parameters

      • subject: string
      • audience: string
      • qualifier: string

      Returns Promise<ExternalCredential>

    • Parameters

      • request: { subject?: string; audience?: string; qualifier?: string }

      Returns Promise<ExternalCredential>

    • Parameters

      • subject: string
      • Optionaloptions: { audience?: string }

      Returns Promise<ExternalCredential[]>

    • Parameters

      • id: string

      Returns Promise<void>

    • Parameters

      • request: { id?: string }

      Returns Promise<void>

    • Parameters

      • provider: string
      • connection: string
      • connectionId: string
      • mode: string
      • Optionalauth: {
            type?: string;
            token?: string;
            tokenPrefix?: string;
            grantType?: string;
            tokenUrl?: string;
            clientId?: string;
            clientSecret?: string;
            clientAuth?: string;
            tokenExchange?: string;
            scopes?: string[];
            scopeParam?: string;
            scopeSeparator?: string;
            tokenParams?: { [key: string]: string };
            refreshParams?: { [key: string]: string };
            acceptHeader?: string;
            accessTokenPath?: string;
            tokenExchangeDrivers?: {
                type?: string;
                targetPrincipal?: string;
                scopes?: string[];
                lifetimeSeconds?: number;
                endpoint?: string;
                params?: { [key: string]: string };
            }[];
            refreshToken?: string;
        }

      Returns Promise<void>

    • Parameters

      • request: {
            provider?: string;
            connection?: string;
            connectionId?: string;
            mode?: string;
            auth?: {
                type?: string;
                token?: string;
                tokenPrefix?: string;
                grantType?: string;
                tokenUrl?: string;
                clientId?: string;
                clientSecret?: string;
                clientAuth?: string;
                tokenExchange?: string;
                scopes?: string[];
                scopeParam?: string;
                scopeSeparator?: string;
                tokenParams?: { [key: string]: string };
                refreshParams?: { [key: string]: string };
                acceptHeader?: string;
                accessTokenPath?: string;
                tokenExchangeDrivers?: {
                    type?: string;
                    targetPrincipal?: string;
                    scopes?: string[];
                    lifetimeSeconds?: number;
                    endpoint?: string;
                    params?: { [key: string]: string };
                }[];
                refreshToken?: string;
            };
            connectionParams?: { [key: string]: string };
        }

      Returns Promise<void>

    • Parameters

      • provider: string
      • connection: string
      • connectionId: string
      • mode: string
      • credentialSubjectId: string
      • actorSubjectId: string
      • instance: string
      • Optionalauth: {
            type?: string;
            token?: string;
            tokenPrefix?: string;
            grantType?: string;
            tokenUrl?: string;
            clientId?: string;
            clientSecret?: string;
            clientAuth?: string;
            tokenExchange?: string;
            scopes?: string[];
            scopeParam?: string;
            scopeSeparator?: string;
            tokenParams?: { [key: string]: string };
            refreshParams?: { [key: string]: string };
            acceptHeader?: string;
            accessTokenPath?: string;
            tokenExchangeDrivers?: {
                type?: string;
                targetPrincipal?: string;
                scopes?: string[];
                lifetimeSeconds?: number;
                endpoint?: string;
                params?: { [key: string]: string };
            }[];
            refreshToken?: string;
        }

      Returns Promise<ResolveExternalCredentialResponse>

    • Parameters

      • request: {
            provider?: string;
            connection?: string;
            connectionId?: string;
            mode?: string;
            credentialSubjectId?: string;
            actorSubjectId?: string;
            instance?: string;
            auth?: {
                type?: string;
                token?: string;
                tokenPrefix?: string;
                grantType?: string;
                tokenUrl?: string;
                clientId?: string;
                clientSecret?: string;
                clientAuth?: string;
                tokenExchange?: string;
                scopes?: string[];
                scopeParam?: string;
                scopeSeparator?: string;
                tokenParams?: { [key: string]: string };
                refreshParams?: { [key: string]: string };
                acceptHeader?: string;
                accessTokenPath?: string;
                tokenExchangeDrivers?: {
                    type?: string;
                    targetPrincipal?: string;
                    scopes?: string[];
                    lifetimeSeconds?: number;
                    endpoint?: string;
                    params?: { [key: string]: string };
                }[];
                refreshToken?: string;
            };
            connectionParams?: { [key: string]: string };
        }

      Returns Promise<ResolveExternalCredentialResponse>

    • Parameters

      • provider: string
      • connection: string
      • connectionId: string
      • credentialSubjectId: string
      • actorSubjectId: string
      • instance: string
      • credentialJson: string
      • Optionalauth: {
            type?: string;
            token?: string;
            tokenPrefix?: string;
            grantType?: string;
            tokenUrl?: string;
            clientId?: string;
            clientSecret?: string;
            clientAuth?: string;
            tokenExchange?: string;
            scopes?: string[];
            scopeParam?: string;
            scopeSeparator?: string;
            tokenParams?: { [key: string]: string };
            refreshParams?: { [key: string]: string };
            acceptHeader?: string;
            accessTokenPath?: string;
            tokenExchangeDrivers?: {
                type?: string;
                targetPrincipal?: string;
                scopes?: string[];
                lifetimeSeconds?: number;
                endpoint?: string;
                params?: { [key: string]: string };
            }[];
            refreshToken?: string;
        }

      Returns Promise<ExternalCredentialTokenResponse | undefined>

    • Parameters

      • request: {
            provider?: string;
            connection?: string;
            connectionId?: string;
            credentialSubjectId?: string;
            actorSubjectId?: string;
            instance?: string;
            auth?: {
                type?: string;
                token?: string;
                tokenPrefix?: string;
                grantType?: string;
                tokenUrl?: string;
                clientId?: string;
                clientSecret?: string;
                clientAuth?: string;
                tokenExchange?: string;
                scopes?: string[];
                scopeParam?: string;
                scopeSeparator?: string;
                tokenParams?: { [key: string]: string };
                refreshParams?: { [key: string]: string };
                acceptHeader?: string;
                accessTokenPath?: string;
                tokenExchangeDrivers?: {
                    type?: string;
                    targetPrincipal?: string;
                    scopes?: string[];
                    lifetimeSeconds?: number;
                    endpoint?: string;
                    params?: { [key: string]: string };
                }[];
                refreshToken?: string;
            };
            credentialJson?: string;
            connectionParams?: { [key: string]: string };
        }

      Returns Promise<ExchangeExternalCredentialResponse>