Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias Saml2

    type Saml2 = {
        createSaml2Provider(
            location: Saml2ProiderLocation,
            providerData: Saml2ProviderSkeleton,
            metaData: string,
        ): Promise<Saml2ProviderSkeleton>;
        deleteSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
        deleteSaml2Providers(): Promise<Saml2ProviderSkeleton[]>;
        exportSaml2Provider(
            entityId: string,
            options?: Saml2EntitiesExportOptions,
        ): Promise<Saml2ExportInterface>;
        exportSaml2Providers(
            options?: Saml2EntitiesExportOptions,
            resultCallback?: ResultCallback<Saml2ProviderSkeleton>,
        ): Promise<Saml2ExportInterface>;
        getSaml2ProviderMetadata(entityId: string): Promise<any>;
        getSaml2ProviderMetadataUrl(entityId: string): string;
        importSaml2Provider(
            entityId: string,
            importData: Saml2ExportInterface,
            options?: Saml2EntitiesImportOptions,
        ): Promise<Saml2ProviderSkeleton>;
        importSaml2Providers(
            importData: Saml2ExportInterface,
            options?: Saml2EntitiesImportOptions,
            resultCallback?: ResultCallback<Saml2ProviderSkeleton>,
        ): Promise<Saml2ProviderSkeleton[]>;
        readSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
        readSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>;
        readSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>;
        updateSaml2Provider(
            location: Saml2ProiderLocation,
            providerData: Saml2ProviderSkeleton,
            entityId?: string,
        ): Promise<Saml2ProviderSkeleton>;
    }
    Index
    • Delete an entity provider. The response can be saved to file as is.

      Parameters

      • entityId: string

        Provider entity id

      Returns Promise<Saml2ProviderSkeleton>

      Promise resolving to a Saml2ExportInterface object.

    • Delete all entity providers. Every provider is tried: a provider that cannot be deleted does not stop the others.

      Returns Promise<Saml2ProviderSkeleton[]>

      Promise resolving to an array of Saml2ProviderSkeleton objects.

      If the providers cannot be read, or if any provider cannot be deleted. The error carries one nested error per failed provider, naming it.

    • Get a SAML2 entity provider's metadata by entity id

      Parameters

      • entityId: string

        SAML2 entity id

      Returns Promise<any>

      a promise that resolves to an object containing a SAML2 metadata

    • Get a SAML2 entity provider's metadata URL by entity id

      Parameters

      • entityId: string

        SAML2 entity id

      Returns string

      the URL to get the metadata from

    • Export a single entity provider. The response can be saved to file as is.

      Parameters

      • entityId: string

        Provider entity id

      Returns Promise<Saml2ProviderSkeleton>

      Promise resolving to a Saml2ExportInterface object.