Frodo Library - v4.0.0-24
    Preparing search index...

    Type Alias WSFed

    type WSFed = {
        createAuthenticationPolicy(
            authenticationPolicyRequest: WSFedAuthenticationPolicyRequest,
        ): Promise<WSFedAuthenticationPolicy>;
        createAuthenticationPolicyContract(
            authenticationPolicyContractRequest: WSFedAuthenticationPolicyContractRequest,
        ): Promise<WSFedAuthenticationPolicyContract>;
        createIdpAdapter(idpAdapter: WSFedIdpAdapter): Promise<WSFedIdpAdapter>;
        createSpConnection(
            spConnection: WSFedSpConnection,
        ): Promise<WSFedSpConnection>;
        deleteIdpAdapterById(id: string): Promise<void>;
        deleteSigningKeyPairById(id: string): Promise<void>;
        deleteSigningKeyPairCertificate(keyPairId: string): Promise<void>;
        generateSigningKeyPair(params: WSFedSigningKeyPairRequest): Promise<string>;
        readAuthenticationPolicyById(
            id: string,
        ): Promise<WSFedAuthenticationPolicy>;
        readAuthenticationPolicyContractById(
            id: string,
        ): Promise<WSFedAuthenticationPolicyContract>;
        readFederationInfo(): Promise<WSFedFederationInfo>;
        readIdpAdapterById(id: string): Promise<WSFedIdpAdapter>;
        readIdpAdapters(): Promise<WSFedIdpAdapter[]>;
        readSigningKeyPairById(id: string): Promise<WSFedSigningKeyPair>;
        readSigningKeyPairCertificate(keyPairId: string): Promise<string>;
        readSpConnectionById(id: string): Promise<WSFedSpConnection>;
        readSpConnections(): Promise<WSFedSpConnection[]>;
        readVirtualHostNames(): Promise<string[]>;
        updateAuthenticationPolicyById(
            id: string,
            authenticationPolicyRequest: WSFedAuthenticationPolicyRequest,
        ): Promise<WSFedAuthenticationPolicy>;
        updateAuthenticationPolicyContractById(
            id: string,
            authenticationPolicyContractRequest: WSFedAuthenticationPolicyContractRequest,
        ): Promise<WSFedAuthenticationPolicyContract>;
        updateFederationInfo(
            federationInfo: WSFedFederationInfo,
        ): Promise<WSFedFederationInfo>;
        updateIdpAdapterById(
            id: string,
            idpAdapter: WSFedIdpAdapter,
        ): Promise<WSFedIdpAdapter>;
        updateOrCreateSigningKeyPairCertificate(
            keyPairId: string,
            certificate: string,
        ): Promise<string>;
        updateSpConnectionById(
            id: string,
            spConnection: WSFedSpConnection,
        ): Promise<WSFedSpConnection>;
    }
    Index

    Methods

    createAuthenticationPolicy createAuthenticationPolicyContract createIdpAdapter createSpConnection deleteIdpAdapterById deleteSigningKeyPairById deleteSigningKeyPairCertificate generateSigningKeyPair readAuthenticationPolicyById readAuthenticationPolicyContractById readFederationInfo readIdpAdapterById readIdpAdapters readSigningKeyPairById readSigningKeyPairCertificate readSpConnectionById readSpConnections readVirtualHostNames updateAuthenticationPolicyById updateAuthenticationPolicyContractById updateFederationInfo updateIdpAdapterById updateOrCreateSigningKeyPairCertificate updateSpConnectionById

    Methods

    • Delete IdP adapter by ID

      Parameters

      • id: string

        IdP adapter ID

      Returns Promise<void>

      a promise that resolves when the IdP adapter is deleted

    • Delete signing key pair by id

      Parameters

      • id: string

        signing key pair ID

      Returns Promise<void>

      a promise that resolves when the signing key pair is deleted

    • Delete signing key pair certificate

      Parameters

      • keyPairId: string

        signing key pair ID

      Returns Promise<void>

      a promise that resolves when the signing key pair certificate is deleted

    • Generate signing key pair add params for key type and key size to be passed to the API. Also, update the return type to be string instead of unknown to be consistent with the rest of the codebase.

      Parameters

      Returns Promise<string>

      a promise resolving to the generated public key

    • Read signing key pair certificate

      Parameters

      • keyPairId: string

        signing key pair ID

      Returns Promise<string>

      a promise resolving to the signing key pair certificate

    • Read virtual host names

      Returns Promise<string[]>

      a promise resolving to an array of virtual host names

    • Update or create signing key pair certificate

      Parameters

      • keyPairId: string

        signing key pair ID

      • certificate: string

        the certificate to update or create for the signing key pair

      Returns Promise<string>

      a promise resolving to the updated or created signing key pair certificate

    Settings

    Member Visibility

    On This Page

    Methods