'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. Every provider is tried: a provider that cannot be deleted does not stop the others.
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: Saml2EntitiesExportOptions
export options
Promise resolving to a Saml2ExportInterface object.
Export all entity providers. The response can be saved to file as is.
Optionaloptions: Saml2EntitiesExportOptions
export options
OptionalresultCallback: ResultCallback<Saml2ProviderSkeleton>
Optional callback to process individual results. When given, the outcome of every provider is passed to it as it happens (a failed provider as an error that names it) and a failed provider does not throw: the providers that could be exported are returned. Without it, the failures are collected and thrown as one error after every provider was tried. Failing to list the providers always throws.
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: Saml2EntitiesImportOptions
import options
a promise resolving to a provider object
Import SAML entity providers
Import data
Optionaloptions: Saml2EntitiesImportOptions
import options
OptionalresultCallback: ResultCallback<Saml2ProviderSkeleton>
Optional callback to process individual results. When given, the outcome of every provider is passed to it as it happens (a failed provider as an error that names it) and a failed provider does not throw: the providers that could be imported are returned. Without it, the failures are collected and thrown as one error after every provider was tried.
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: string
SAML2 entity id
a promise that resolves to a saml2 entity provider object
Create a SAML2 entity provider