Skip to content

Organizations

Get SSO provider

Get an identity provider owned by the organization. Requires organization Admin access. OIDC client secrets are redacted and SAML private keys are omitted. Workspace API keys return `403`; use a personal API key or scoped OAuth token. OAuth scope: `api:read`.

GET/api/v2/organizations/{organizationId}/sso/providers/{providerId}

Get an identity provider owned by the organization. Requires organization Admin access. OIDC client secrets are redacted and SAML private keys are omitted. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:read.

Authentication

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

Send X-API-Key in the request header.

Alternatively

Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.

Authorization: Bearer YOUR_ACCESS_TOKEN

Required scopes: api:read

OAuth flows
json
{
  "authorizationCode": {
    "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
    "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "scopes": {
      "api:read": "Read your workspaces, workflows, files, tables, and logs",
      "api:write": "Read, create, change, run, and delete resources in your workspaces",
      "offline_access": "Stay signed in without asking again"
    }
  }
}

OAuth scope: api:read.

Path parameters

organizationIdstringRequired

Organization whose single sign-on settings and verified domains are managed.

minLength
1
providerIdstringRequired

Identity provider identifier.

minLength
1
maxLength
255

Responses

200

The identity provider with redacted configuration.

object

The identity provider with redacted configuration.

1 field
dataobjectRequired

Response data.

11 fields
idstringRequired

Provider record identifier.

minLength
1
providerIdstringRequired

Globally unique identity provider identifier.

minLength
1
providerTypestringRequired

Identity provider protocol.

enum
["oidc","saml"]
domainstringRequired

Email domain served by the provider.

domainKeystringRequired

Normalized email domain used for sign-in.

issuerstringRequired

Identity provider issuer URL.

oidcConfigvalueRequired

JSON configuration with the client secret redacted; null for SAML.

Schema details

Any of

Option 1string
Option 2null
samlConfigvalueRequired

JSON configuration without private keys; null for OIDC.

Schema details

Any of

Option 1string
Option 2null
jitProvisioningEnabledbooleanRequired

Whether successful SSO sign-in may add organization members, subject to membership and seat policies.

domainVerifiedbooleanRequired

Whether the provider has a verified domain grant.

isPrimarybooleanRequired

Whether this provider currently handles sign-in for its domain.

Additional properties are not allowed.

Additional properties are not allowed.

Response headers

X-RateLimit-Limitinteger

Maximum requests allowed in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Remaininginteger

Requests remaining in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Resetstring

ISO 8601 timestamp when the current rate-limit window resets.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Was this helpful?
Suggest an edit