Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
List SSO configurations for the tenant
Returns the Single Sign-On configuration records visible in the active scope, powering the SSO page on route
load. Each record carries the enablement flag, federation protocol (SAML 2.0 or OIDC), display name shown on
the sign-in button, IdP metadata URL, entity ID / issuer, the service-provider ACS (reply) URL, the X.509
signing certificate used to validate IdP assertions, the "disable local password sign-in" policy flag, the
verified domains list and the last metadata sync time. The certificate field holds the public signing
certificate only — no private material is ever returned.
Validation: scopeId must reference a scope the caller can access (unknown → 404 NOT_FOUND); caller
needs IAM read permission in the tenant (else 403 FORBIDDEN); malformed pagination parameters → 422
VALIDATION_FAILED.
Async & state: Synchronous read; no state change. No SSE frames are emitted by this read.
Errors: 401 unauthenticated; 403 caller lacks IAM read permission; 404 scope not found; 422 malformed
query parameters; 500 read-model unavailable.
Idempotency/Concurrency: Safe, cacheable; no idempotency key required. The response ETag can be supplied
as If-Match on the PATCH update.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
region?stringRestrict the result set to a single region.
^[a-z][a-z0-9-]{1,39}$q?stringFree-text search.
sort?stringField to sort by (entity-specific; defaults to the entity's natural order).
order?stringSort direction.
"asc""asc""desc"page?integer1-based page number.
1 <= value1pageSize?integerItems per page (max 200).
1 <= value <= 20050Paginated collection of SSO configuration records (typically a single tenant-level record).
application/json- response
data*array<>meta*Pagination envelope metadata. List responses are always { data, meta } — never a naked array.
curl -X GET "https://example.com/scopes/string/iam/sso"{ "data": [ { "enabled": true, "protocol": "SAML", "displayName": "string", "idpMetadataUrl": "string", "entityId": "string", "acsUrl": "string", "certificate": "string", "disableLocalPassword": true, "lastSync": "2019-08-24T14:15:22Z", "domains": [ "string" ] } ], "meta": { "page": 1, "pageSize": 1, "total": 0, "hasNext": true }}