Skip to main content
POST
Create SAML connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

appID
string
required

The id of the app the request refers to. An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

providerID
string
required

The SAML provider identifier.

Examples:

"okta"

"google"

"jumpcloud"

Body

application/json
name
string
required
Example:

"Acme Okta"

behavior
object
required
enabled
boolean
Example:

true

domain
string

App domain baked into the SP endpoints. Optional when the app has exactly one active domain; required for multi-domain apps.

Example:

"session.acme.com"

idp_metadata_url
string<uri>

HTTPS URL to the IdP's metadata document. Provide exactly one IdP source.

Example:

"https://acme.okta.com/app/abc/sso/saml/metadata"

idp_metadata_xml
string

Raw or base64-encoded IdP metadata XML (for air-gapped IdPs). Provide exactly one IdP source.

idp
object

Explicit IdP block. Provide this only when you are not using idp_metadata_url or idp_metadata_xml. Certificates accept raw PEM or base64-wrapped PEM.

mapping
object

Maps SAML assertion attributes to user profile fields. Defaults are applied per provider when omitted.

Response

Created

connection
object
required