Type Alias Saml2

Type declaration

• createSaml2Provider:function

  • createSaml2Provider(
        location: Saml2ProiderLocation,
        providerData: Saml2ProviderSkeleton,
        metaData: string,
    ): Promise<Saml2ProviderSkeleton>

    Create a SAML2 entity provider

    Parameters

    • location: Saml2ProiderLocation

      'hosted' or 'remote'
    • providerData: Saml2ProviderSkeleton

      Object representing a SAML entity provider
    • metaData: string

      Base64-encoded metadata XML. Only required for remote providers

    Returns Promise<Saml2ProviderSkeleton>

    a promise that resolves to a saml2 entity provider object

• deleteSaml2Provider:function

  • deleteSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>

    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.

• deleteSaml2Providers:function

  • deleteSaml2Providers(): Promise<Saml2ProviderSkeleton[]>

    Delete all entity providers.

    Returns Promise<Saml2ProviderSkeleton[]>

    Promise resolving to an array of Saml2ProviderSkeleton objects.

• exportSaml2Provider:function

  • exportSaml2Provider(
        entityId: string,
        options?: Saml2EntitiesExportOptions,
    ): Promise<Saml2ExportInterface>

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

    Parameters

    • entityId: string

      Provider entity id
    • Optionaloptions: Saml2EntitiesExportOptions

      export options

    Returns Promise<Saml2ExportInterface>

    Promise resolving to a Saml2ExportInterface object.

• exportSaml2Providers:function

  • exportSaml2Providers(
        options?: Saml2EntitiesExportOptions,
    ): Promise<Saml2ExportInterface>

    Export all entity providers. The response can be saved to file as is.

    Parameters

    • Optionaloptions: Saml2EntitiesExportOptions

      export options

    Returns Promise<Saml2ExportInterface>

    Promise resolving to a Saml2ExportInterface object.

• getProviderMetadata:function

  • getProviderMetadata(entityId: string): Promise<any>

    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

    Deprecated

    since v2.0.0 use getSaml2ProviderMetadata instead

    getSaml2ProviderMetadata(entityId: string): Promise<any>
    Copy

• getProviderMetadataUrl:function

  • getProviderMetadataUrl(entityId: string): string

    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

    Deprecated

    since v2.0.0 use getSaml2ProviderMetadataUrl instead

    getSaml2ProviderMetadataUrl(entityId: string): string
    Copy

• getSaml2Provider:function

  • getSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>

    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.

    Deprecated

    since v2.0.0 use readSaml2Provider instead

    readSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>
    Copy

• getSaml2ProviderMetadata:function

  • getSaml2ProviderMetadata(entityId: string): Promise<any>

    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

• getSaml2ProviderMetadataUrl:function

  • getSaml2ProviderMetadataUrl(entityId: string): string

    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

• getSaml2ProviderStub:function

  • getSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>

    Parameters

    • entityId: string

      Provider entity id

    Returns Promise<Saml2ProviderStub>

    Promise resolving to a Saml2ExportInterface object.

    Deprecated

    since v2.0.0 use readSaml2ProviderStub instead

    readSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>
    Copy

• getSaml2ProviderStubs:function

  • getSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>

    Get SAML2 entity provider stubs

    Returns Promise<Saml2ProviderStub[]>

    a promise that resolves to an array of saml2 entity stubs

    Deprecated

    since v2.0.0 use readSaml2ProviderStubs instead

    readSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>
    Copy

• importSaml2Provider:function

  • importSaml2Provider(
        entityId: string,
        importData: Saml2ExportInterface,
        options?: Saml2EntitiesImportOptions,
    ): Promise<Saml2ProviderSkeleton>

    Import a SAML entity provider

    Parameters

    • entityId: string

      Provider entity id
    • importData: Saml2ExportInterface

      Import data
    • Optionaloptions: Saml2EntitiesImportOptions

      import options

    Returns Promise<Saml2ProviderSkeleton>

    a promise resolving to a provider object

• importSaml2Providers:function

  • importSaml2Providers(
        importData: Saml2ExportInterface,
        options?: Saml2EntitiesImportOptions,
    ): Promise<Saml2ProviderSkeleton[]>

    Import SAML entity providers

    Parameters

    • importData: Saml2ExportInterface

      Import data
    • Optionaloptions: Saml2EntitiesImportOptions

      import options

    Returns Promise<Saml2ProviderSkeleton[]>

    a promise resolving to an array of provider objects

• readSaml2Provider:function

  • readSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>

    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.

• readSaml2ProviderStub:function

  • readSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>

    Parameters

    • entityId: string

      Provider entity id

    Returns Promise<Saml2ProviderStub>

    Promise resolving to a Saml2ExportInterface object.

• readSaml2ProviderStubs:function

  • readSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>

    Read all SAML2 entity provider stubs

    Returns Promise<Saml2ProviderStub[]>

    a promise that resolves to an array of saml2 entity stubs

• updateSaml2Provider:function

  • updateSaml2Provider(
        location: Saml2ProiderLocation,
        providerData: Saml2ProviderSkeleton,
        entityId?: string,
    ): Promise<Saml2ProviderSkeleton>

    Update SAML2 entity provider

    Parameters

    • location: Saml2ProiderLocation

      Entity provider location (hosted or remote)
    • providerData: Saml2ProviderSkeleton

      Object representing a SAML entity provider
    • OptionalentityId: string

      SAML2 entity id

    Returns Promise<Saml2ProviderSkeleton>

    a promise that resolves to a saml2 entity provider object