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,
    ): 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,
    ): 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

Methods

createSaml2Provider deleteSaml2Provider deleteSaml2Providers exportSaml2Provider exportSaml2Providers getSaml2ProviderMetadata getSaml2ProviderMetadataUrl importSaml2Provider importSaml2Providers readSaml2Provider readSaml2ProviderStub readSaml2ProviderStubs updateSaml2Provider

Methods

createSaml2Provider

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
- Defined in ops/Saml2Ops.ts:61

deleteSaml2Provider

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.
- Defined in ops/Saml2Ops.ts:83

deleteSaml2Providers

deleteSaml2Providers(): Promise<Saml2ProviderSkeleton[]>
Delete all entity providers.

Returns Promise<Saml2ProviderSkeleton[]>
Promise resolving to an array of Saml2ProviderSkeleton objects.
- Defined in ops/Saml2Ops.ts:88

exportSaml2Provider

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.
- Defined in ops/Saml2Ops.ts:107

exportSaml2Providers

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.
- Defined in ops/Saml2Ops.ts:116

getSaml2ProviderMetadata

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
- Defined in ops/Saml2Ops.ts:100

getSaml2ProviderMetadataUrl

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
- Defined in ops/Saml2Ops.ts:94

importSaml2Provider

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
- Defined in ops/Saml2Ops.ts:126

importSaml2Providers

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
- Defined in ops/Saml2Ops.ts:137

readSaml2Provider

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.
- Defined in ops/Saml2Ops.ts:53

readSaml2ProviderStub

readSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>
Parameters
- entityId: string
  Provider entity id
Returns Promise<Saml2ProviderStub>
Promise resolving to a Saml2ExportInterface object.
- Defined in ops/Saml2Ops.ts:47

readSaml2ProviderStubs

readSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>
Read all SAML2 entity provider stubs

Returns Promise<Saml2ProviderStub[]>
a promise that resolves to an array of saml2 entity stubs
- Defined in ops/Saml2Ops.ts:41

updateSaml2Provider

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
- Defined in ops/Saml2Ops.ts:73

Type Alias Saml2

Index

Methods

Methods

createSaml2Provider

Parameters

Returns Promise<Saml2ProviderSkeleton>

deleteSaml2Provider

Parameters

Returns Promise<Saml2ProviderSkeleton>

deleteSaml2Providers

Returns Promise<Saml2ProviderSkeleton[]>

exportSaml2Provider

Parameters

Returns Promise<Saml2ExportInterface>

exportSaml2Providers

Parameters

Returns Promise<Saml2ExportInterface>

getSaml2ProviderMetadata

Parameters

Returns Promise<any>

getSaml2ProviderMetadataUrl

Parameters

Returns string

importSaml2Provider

Parameters

Returns Promise<Saml2ProviderSkeleton>

importSaml2Providers

Parameters

Returns Promise<Saml2ProviderSkeleton[]>

readSaml2Provider

Parameters

Returns Promise<Saml2ProviderSkeleton>

readSaml2ProviderStub

Parameters

Returns Promise<Saml2ProviderStub>

readSaml2ProviderStubs

Returns Promise<Saml2ProviderStub[]>

updateSaml2Provider

Parameters

Returns Promise<Saml2ProviderSkeleton>

Settings

On This Page