Skip to content

Update a SAML provider.

PUT
/api/admin/saml-providers/{id}
Code sample: Shell / cURL
curl --request PUT \
--url https://auth.example.com/api/admin/saml-providers/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "Example SAML IdP", "enabled": true, "config": { "ssoUrl": "https://idp.example.com/sso" } }'
id
required
string
Media type application/json
object
name
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
Example
{
"name": "Example SAML IdP",
"enabled": true,
"config": {
"ssoUrl": "https://idp.example.com/sso"
}
}

Successful JSON response.

Media type application/json
object
id
required
string
name
required
string
providerType
required
string
Allowed values: saml_idp saml_sp
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"
}