iam.sso-connections.set-group-mappings

Replace the IdP group → IAM group mappings

PUT /iam/api/sso-connections/{id}/group-mappingsIAM iam:UpdateSsoConnectionChanges stateDestructive

At every SSO sign-in, membership in each mapped IAM group is set to what the IdP says; memberships added by hand and SCIM-managed groups are never touched. A leading / on a group path is ignored.

Request syntax

PUT /iam/api/sso-connections/{id}/group-mappings
{
  "mappings": "array of json"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • mappingsRequired

    array of json

    Every mapping, as {idpGroup, iamGroupId}: idpGroup as the identity provider sends it (a name, a path, a DN or an object ID); an empty list removes them all

Response

200 with { groupsClaim, mappings }: the mappings now stored, as group-mappings shows them. A group of another organization or one SCIM manages is refused (400).

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 set-group-mappings id --mappings '["example"]'

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_set-group-mappings.