---
title: "Get SSO configuration"
method: GET
path: "/sso/configs/{name}"
tags: ["SSO"]
---

# Get SSO configuration

`GET /sso/configs/{name}`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/sso/configs/{name}`
- Auth: none declared

Returns the SSO configuration.

## Path parameters

- `name` string, required

## Response `200`

The SSO configuration document

- IapSsoSchema: Schema describing an SSO configuration object
  - `name` string, required: Name of the SSO configuration
  - `ssoType` 'saml', required: Single sign on type, SAML, OpenID, etc.
  - `settings` IapSsoSchemaSettings, required
    - `description` string: A description of the sso configuration
    - `issuer` string, required: Issuer identity provider
    - `loginURL` string, required: Login URL for SSO identity provider
    - `logoutURL` string: Logout URL for SSO identity provider
    - `certificate` string, required: Security certificate
    - `samlEmailAttribute` string: Attribute containing user email address
    - `samlUserNameAttribute` string, required: Attribute containing the full user name
    - `samlGroupsAttribute` string, required: Attribute containing the name of the groups property
    - `samlFirstNameAttribute` string: Attribute containing the first name of the user
    - `forceLogin` boolean, required: A boolean flag indicating if a user is forced to login
    - `disableAuthnContext` boolean: A boolean flag determining if we check how a user logged in
  - `active` boolean: Whether or not the SSO Config is selected for use. For 'active' to be true, 'tested' must also be true.
  - `tested` boolean: Whether the sso config was tested

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)