config properties saml

Version

v1.2.0

saml Type

object (saml)

saml Properties

Property	Type	Required	Nullable	Defined by
enabled	boolean	Optional	cannot be null	Config
endpoint_url	string	Optional	cannot be null	Config
audience_uri	string	Optional	cannot be null	Config
default_redirect_url	string	Optional	cannot be null	Config
allowed_redirect_urls	array	Optional	cannot be null	Config
options	object	Optional	cannot be null	Config
identity_providers	array	Optional	cannot be null	Config

enabled

enabled determines whether the SAML API endpoints are available.

enabled

• is optional

• cannot be null

enabled Type

boolean

endpoint_url

endpoint is URL at which the SAML endpoints like metadata, callback, etc. are available (e.g. {YOUR_BACKEND_INSTANCE}/api).

Will be provided as metadata for IdP.

endpoint_url

• is optional

• cannot be null

endpoint_url Type

string

audience_uri

audience_uri determines the intended recipient or audience for the SAML Assertion.

audience_uri

• is optional

• cannot be null

audience_uri Type

string

default_redirect_url

default_redirect_url is the URL to redirect to in case of errors or when no allowed_redirect_url is provided.

default_redirect_url

• is optional

• cannot be null

default_redirect_url Type

string

allowed_redirect_urls

allowed_redirect_urls is a list of URLs the backend is allowed to redirect to after third party sign-in was successful.

Supports wildcard matching through globbing. e.g. https://*.example.com will allow https://foo.example.com and https://bar.example.com to be accepted.

Globbing is also supported for paths, e.g. https://foo.example.com/* will match https://foo.example.com/page1 and https://foo.example.com/page2.

A double asterisk (**) acts as a "super"-wildcard/match-all.

See here for more on globbinh.

allowed_redirect_urls

• is optional

• cannot be null

allowed_redirect_urls Type

string[]

options

options allows setting optional features for service provider operations.

options

• is optional

• cannot be null

options Type

object (options)

identity_providers

identity_providers is a list of SAML identity providers.

identity_providers

• is optional

• cannot be null

identity_providers Type

object[] (Details)