'hosted' or 'remote'
Object representing a SAML entity provider
Base64-encoded metadata XML. Only required for remote providers
a promise that resolves to a saml2 entity provider object
Delete an entity provider. The response can be saved to file as is.
Provider entity id
Promise resolving to a Saml2ExportInterface object.
Delete all entity providers.
Promise resolving to an array of Saml2ProviderSkeleton objects.
Export a single entity provider. The response can be saved to file as is.
Provider entity id
Optionaloptions: Saml2EntitiesExportOptionsexport options
Promise resolving to a Saml2ExportInterface object.
Export all entity providers. The response can be saved to file as is.
Optionaloptions: Saml2EntitiesExportOptionsexport options
Promise resolving to a Saml2ExportInterface object.
Get a SAML2 entity provider's metadata by entity id
SAML2 entity id
a promise that resolves to an object containing a SAML2 metadata
Get a SAML2 entity provider's metadata URL by entity id
SAML2 entity id
the URL to get the metadata from
Import a SAML entity provider
Provider entity id
Import data
Optionaloptions: Saml2EntitiesImportOptionsimport options
a promise resolving to a provider object
Import SAML entity providers
Import data
Optionaloptions: Saml2EntitiesImportOptionsimport options
a promise resolving to an array of provider objects
Export a single entity provider. The response can be saved to file as is.
Provider entity id
Promise resolving to a Saml2ExportInterface object.
Provider entity id
Promise resolving to a Saml2ExportInterface object.
Read all SAML2 entity provider stubs
a promise that resolves to an array of saml2 entity stubs
Update SAML2 entity provider
Entity provider location (hosted or remote)
Object representing a SAML entity provider
OptionalentityId: stringSAML2 entity id
a promise that resolves to a saml2 entity provider object
Get a SAML2 entity provider's metadata by entity id
SAML2 entity id
a promise that resolves to an object containing a SAML2 metadata
since v2.0.0 use getSaml2ProviderMetadata instead
getSaml2ProviderMetadata(entityId: string): Promise<any>
Get a SAML2 entity provider's metadata URL by entity id
SAML2 entity id
the URL to get the metadata from
since v2.0.0 use getSaml2ProviderMetadataUrl instead
getSaml2ProviderMetadataUrl(entityId: string): string
Export a single entity provider. The response can be saved to file as is.
Provider entity id
Promise resolving to a Saml2ExportInterface object.
since v2.0.0 use readSaml2Provider instead
readSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>
Provider entity id
Promise resolving to a Saml2ExportInterface object.
since v2.0.0 use readSaml2ProviderStub instead
readSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>
Get SAML2 entity provider stubs
a promise that resolves to an array of saml2 entity stubs
since v2.0.0 use readSaml2ProviderStubs instead
readSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>
Create a SAML2 entity provider