iam.sso-connections.get

Describe one connection, with the values to enter at the identity provider

GET /iam/api/sso-connections/{id}IAM iam:GetSsoConnectionRead

Request syntax

GET /iam/api/sso-connections/{id}

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with the connection: id, name, protocol, enabled, enforced, defaultRole, groupsClaim, the identity provider’s settings (oidcIssuer and oidcClientId, or samlIdpSsoUrl, samlIdpEntityId and samlIdpCertificate), hasClientSecret (the secret itself is never returned), rn, serviceProvider (entityId, acsUrl and metadataUrl for SAML, redirectUri for OIDC), and domains, each with verifiedAt and the TXT record that proves 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:GetSsoConnection 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 get id

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_get.