iam.sso-connections.updateChange settings, turn the connection on or off, or enforce it
enabled requires at least one verified domain; enforced requires enabled. Enforcing refuses password sign-in for addresses on the verified domains, except the organization owner
Request syntax
PATCH /iam/api/sso-connections/{id}
{
"name": "string",
"enabled": "boolean",
"enforced": "boolean",
"defaultRole": "enum",
"groupsClaim": "string",
"oidc": "object",
"saml": "object"
}Path parameters
idRequiredstring
Constraints: uuid
Request body
nameOptionalstring
A new name for the connection
Constraints: 1-100 chars
enabledOptionalboolean
true lets people sign in through the connection (needs a verified domain); false stops it and its enforcement
enforcedOptionalboolean
true refuses password sign-in for addresses on the verified domains, except the organization owner; needs enabled
defaultRoleOptionalenum
The organization role a person gets when single sign-on first adds them
One of:
admin,member,viewer,billinggroupsClaimOptionalstring
The OIDC claim or SAML attribute that lists the person’s groups at the identity provider (groups until changed)
Constraints: 1-256 chars
oidcOptionalobject
New OIDC settings {issuer, clientId, clientSecret}; leave out clientSecret to keep the stored one. A new issuer or client ID unlinks the accounts linked through the old one
Constraints: JSON
samlOptionalobject
New SAML settings {idpSsoUrl, idpEntityId, idpCertificate, allowSha1}. A new URL, entity ID or certificate unlinks the accounts linked through the old one
Constraints: JSON
Response
200 with the updated connection, as get describes it.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow iam:UpdateSsoConnection on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud iam sso-connections update idcurl -X PATCH "https://console.platform-development.deutschecloud.app/iam/api/sso-connections/id" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_sso-connections_update.