---
title: "PUT /v1/sso/setup/draft"
method: PUT
path: "/v1/sso/setup/draft"
tags: ["SsoSetup"]
---

# PUT /v1/sso/setup/draft

`PUT /v1/sso/setup/draft`

## Request

- Base URL: `https://api.succeedms.com`
- URL: `https://api.succeedms.com/v1/sso/setup/draft`
- Auth: none declared
- TypeScript: <https://skmtc.dev/succeedms/apis/succeed-site/docs/v1/sso/setup/draft/put.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- SsoSetupDraftRequest
  - `Step` integer
  - `IdpProvider` string
  - `Protocol` string
  - `MetadataSource` string
  - `MetadataUrl` string
  - `MetadataXml` string
  - `MetadataXmlBase64` string
  - `EntityId` string
  - `SsoLoginUrl` string
  - `Certificate` string
  - `HandshakeComplete` boolean
  - `ClientId` string
  - `ClientSecret` string
  - `DiscoveryUrl` string
  - `TokenEndpoint` string
  - `AuthorizationEndpoint` string
  - `Scope` string
  - `EmailDomains` string[]
  - `RequireAdmin` boolean
  - `RequireEmployee` boolean
  - `AutoCreate` boolean
  - `AttrEmail` string
  - `AttrFirstName` string
  - `AttrLastName` string
  - `AttrDepartment` string
  - `DefaultRole` string

## Response `200`

OK

- object

## Changes

- **2026-10-01** `e35f63822704`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/succeedms/apis/succeed-site/changes/v1/sso/setup/draft/put.md)

---

[API](https://skmtc.dev/succeedms/apis/succeed-site.md) - [All operations](https://skmtc.dev/succeedms/apis/succeed-site/llms.txt) - [OpenAPI document](https://skmtc.dev/succeedms/apis/succeed-site/revisions/e35f63822704?raw)