Set IdP initiated auth config

PUT /api/sso-connectors/{id}/idp-initiated-auth-config

Set IdP initiated authentication config for a given SAML SSO connector. Any existing IdP initiated auth config will be overwritten.

Path parameters

id string Required

The unique identifier of the sso connector.

application/json

Body object Required

defaultApplicationId string Required

Minimum length is 1, maximum length is 21.
redirectUri string | null
authParameters object

Additional properties are allowed.
Hide authParameters attribute Show authParameters attribute object
- scope string
autoSendAuthorizationRequest boolean(true) Required

Responses

200 application/json

The updated IdP initiated auth config.
Hide response attributes Show response attributes object
- tenantId string Required
  
  Maximum length is 21.
- connectorId string Required
  
  Minimum length is 1, maximum length is 128.
- defaultApplicationId string Required
  
  Minimum length is 1, maximum length is 21.
- redirectUri string | null Required
- authParameters object Required
  
  Additional properties are allowed.
  
  Hide authParameters attribute Show authParameters attribute object
  
  scope string
- autoSendAuthorizationRequest boolean Required
- clientIdpInitiatedAuthCallbackUri string | null Required
- createdAt number Required
400

The request body is invalid. The SSO connector is not a SAML connector or the application is not a Traditional web application.
401

Unauthorized
403

Forbidden
404

SSO connector or application not found.

PUT /api/sso-connectors/{id}/idp-initiated-auth-config

curl \
 -X PUT https://[tenant_id].logto.app/api/sso-connectors/{id}/idp-initiated-auth-config \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"defaultApplicationId":"string","clientIdpInitiatedAuthCallbackUri":"string","autoSendAuthorizationRequest":true}'

Request examples

{
  "defaultApplicationId": "string",
  "clientIdpInitiatedAuthCallbackUri": "string",
  "autoSendAuthorizationRequest": true
}

{
  "defaultApplicationId": "string",
  "redirectUri": "string",
  "authParameters": {
    "scope": "string"
  },
  "autoSendAuthorizationRequest": true
}

Response examples (200)

{
  "tenantId": "string",
  "connectorId": "string",
  "defaultApplicationId": "string",
  "redirectUri": "string",
  "authParameters": {
    "scope": "string"
  },
  "autoSendAuthorizationRequest": true,
  "clientIdpInitiatedAuthCallbackUri": "string",
  "createdAt": 42.0
}