Create a SAML provider.
POST
/api/admin/saml-providers
Code sample: Shell / cURL
curl --request POST \ --url https://auth.example.com/api/admin/saml-providers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Example SAML IdP", "providerType": "saml_idp", "config": { "entityId": "https://idp.example.com/metadata", "ssoUrl": "https://idp.example.com/sso", "certificate": "-----BEGIN CERTIFICATE-----..." } }'Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type application/json
object
name
required
string
providerType
required
string
config
object
entityId
string
ssoUrl
string format: uri
acsUrl
string format: uri
certificate
string
metadataUrl
string format: uri
metadataXml
string
nameIdFormat
string
metadataNameIdFormats
Array<string>
key
additional properties
enabled
boolean
metadataUrl
string format: uri
metadataXml
string
samlProfile
string
attributePresetId
string
Example
{ "name": "Example SAML IdP", "providerType": "saml_idp", "config": { "entityId": "https://idp.example.com/metadata", "ssoUrl": "https://idp.example.com/sso", "certificate": "-----BEGIN CERTIFICATE-----..." }}Responses
Section titled “ Responses ”Successful JSON response.
Media type application/json
object
id
required
string
name
required
string
providerType
required
string
config
required
object
entityId
string
ssoUrl
string format: uri
acsUrl
string format: uri
certificate
string
metadataUrl
string format: uri
metadataXml
string
nameIdFormat
string
metadataNameIdFormats
Array<string>
key
additional properties
enabled
required
boolean
createdAt
string format: date-time
updatedAt
string format: date-time
Example
{ "id": "provider_123", "name": "Example SAML IdP", "providerType": "saml_idp", "config": { "entityId": "https://idp.example.com/metadata", "ssoUrl": "https://idp.example.com/sso" }, "enabled": true, "createdAt": "2026-06-19T00:00:00.000Z", "updatedAt": "2026-06-19T00:00:00.000Z"}Successful JSON response.
Media type application/json
object
id
required
string
name
required
string
providerType
required
string
config
required
object
entityId
string
ssoUrl
string format: uri
acsUrl
string format: uri
certificate
string
metadataUrl
string format: uri
metadataXml
string
nameIdFormat
string
metadataNameIdFormats
Array<string>
key
additional properties
enabled
required
boolean
createdAt
string format: date-time
updatedAt
string format: date-time
Example
{ "id": "provider_123", "name": "Example SAML IdP", "providerType": "saml_idp", "config": { "entityId": "https://idp.example.com/metadata", "ssoUrl": "https://idp.example.com/sso" }, "enabled": true, "createdAt": "2026-06-19T00:00:00.000Z", "updatedAt": "2026-06-19T00:00:00.000Z"}