# Get SSO config

Retrieve the SSO configuration for a dashboard, including service provider metadata.

Source: https://statusdashboard.com/docs/api/status-dashboards/dashboards/sso/get

`GET /app/dashboards/{id}/sso`

Returns the current SSO configuration for a dashboard, along with the service provider (SP) metadata values needed to configure an identity provider. Requires the **SSO** feature entitlement.

The client secret is never returned.

***

## Path parameters
| Parameter | Description                |
| --------- | -------------------------- |
| `id`      | The UUID of the dashboard. |

***

## Request
See [API Basics](/docs/api) for required headers.

This endpoint takes no request body.

***

## Sample request
```bash
curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sso \
  -H "Authorization: Bearer bcf847abf5c6:def456"
```

## Sample response
**Status: `200 OK`**

```json
{
  "enabled": true,
  "providerType": "SAML",
  "cognitoProviderName": "DASHBOARD-A1B2C3D4",
  "samlMetadataXml": "<?xml version=\"1.0\"?>...",
  "idpLogoutUrl": "https://idp.example.com/logout",
  "idpDomainUrl": "https://auth.example.statusdashboard.com",
  "spEntityId": "urn:amazon:cognito:sp:us-east-1_abc123"
}
```

When no SSO provider is configured, the response still returns `200` with `enabled: false` and all provider fields omitted:

```json
{
  "enabled": false,
  "idpDomainUrl": "https://auth.example.statusdashboard.com",
  "spEntityId": "urn:amazon:cognito:sp:us-east-1_abc123"
}
```

***

## Response fields
| Field                       | Type                              | Description                                                                                                                                      |
| --------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `enabled`                   | boolean                           | Whether SSO is currently enforced for visitors.                                                                                                  |
| `providerType`              | `"SAML"` \| `"OIDC"` \| undefined | The configured provider protocol. Absent if no provider is configured.                                                                           |
| `cognitoProviderName`       | string \| undefined               | Internal provider name. Absent if no provider is configured.                                                                                     |
| `samlMetadataXml`           | string \| undefined               | The IdP metadata XML (SAML only).                                                                                                                |
| `oidcIssuer`                | string \| undefined               | Issuer URL (OIDC only).                                                                                                                          |
| `oidcClientId`              | string \| undefined               | Client ID (OIDC only).                                                                                                                           |
| `oidcAuthorizationEndpoint` | string \| undefined               | Authorization endpoint URL (OIDC only).                                                                                                          |
| `oidcTokenEndpoint`         | string \| undefined               | Token endpoint URL (OIDC only).                                                                                                                  |
| `oidcUserInfoEndpoint`      | string \| undefined               | UserInfo endpoint URL (OIDC only).                                                                                                               |
| `oidcJwksUri`               | string \| undefined               | JWKS URI (OIDC only).                                                                                                                            |
| `idpLogoutUrl`              | string \| undefined               | The IdP's single logout URL, auto-extracted from SAML metadata on save. Used to redirect visitors after they sign out.                           |
| `idpDomainUrl`              | string                            | The Cognito base URL for this dashboard's user pool. Use this to derive the ACS URL (`{idpDomainUrl}/saml2/idpresponse`) and other SP endpoints. |
| `spEntityId`                | string                            | The entity ID (audience URI) to use when registering this SP in your IdP.                                                                        |

***

## Error responses
| Status | When                                                                 |
| ------ | -------------------------------------------------------------------- |
| `403`  | SSO feature not enabled on the plan.                                 |
| `404`  | Dashboard not found or does not belong to the caller's organization. |