---
title: SSO
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[IAM](https://developers.cloudflare.com/api/typescript/resources/iam)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# SSO

##### [Get all SSO connectors](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/sso/methods/list)

client.iam.sso.list(SSOListParams { account\_id } params, RequestOptionsoptions?): SinglePage<[SSOListResponse](https://developers.cloudflare.com/api/typescript/resources/iam#%28resource%29%20iam.sso%20%3E%20%28model%29%20sso%5Flist%5Fresponse%20%3E%20%28schema%29) { id, created\_on, email\_domain, 4 more } \>

GET/accounts/{account\_id}/sso\_connectors

##### [Get single SSO connector](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/sso/methods/get)

client.iam.sso.get(stringssoConnectorID, SSOGetParams { account\_id } params, RequestOptionsoptions?): [SSOGetResponse](https://developers.cloudflare.com/api/typescript/resources/iam#%28resource%29%20iam.sso%20%3E%20%28model%29%20sso%5Fget%5Fresponse%20%3E%20%28schema%29) { id, created\_on, email\_domain, 4 more } 

GET/accounts/{account\_id}/sso\_connectors/{sso\_connector\_id}

##### [Initialize new SSO connector](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/sso/methods/create)

client.iam.sso.create(SSOCreateParams { account\_id, email\_domain, begin\_verification, use\_fedramp\_language } params, RequestOptionsoptions?): [SSOCreateResponse](https://developers.cloudflare.com/api/typescript/resources/iam#%28resource%29%20iam.sso%20%3E%20%28model%29%20sso%5Fcreate%5Fresponse%20%3E%20%28schema%29) { id, created\_on, email\_domain, 4 more } 

POST/accounts/{account\_id}/sso\_connectors

##### [Update SSO connector state](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/sso/methods/update)

client.iam.sso.update(stringssoConnectorID, SSOUpdateParams { account\_id, enabled, use\_fedramp\_language } params, RequestOptionsoptions?): [SSOUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/iam#%28resource%29%20iam.sso%20%3E%20%28model%29%20sso%5Fupdate%5Fresponse%20%3E%20%28schema%29) { id, created\_on, email\_domain, 4 more } 

PATCH/accounts/{account\_id}/sso\_connectors/{sso\_connector\_id}

##### [Delete SSO connector](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/sso/methods/delete)

client.iam.sso.delete(stringssoConnectorID, SSODeleteParams { account\_id } params, RequestOptionsoptions?): [SSODeleteResponse](https://developers.cloudflare.com/api/typescript/resources/iam#%28resource%29%20iam.sso%20%3E%20%28model%29%20sso%5Fdelete%5Fresponse%20%3E%20%28schema%29) { id } | null

DELETE/accounts/{account\_id}/sso\_connectors/{sso\_connector\_id}

##### [Begin SSO connector verification](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/sso/methods/begin%5Fverification)

client.iam.sso.beginVerification(stringssoConnectorID, SSOBeginVerificationParams { account\_id } params, RequestOptionsoptions?): [SSOBeginVerificationResponse](https://developers.cloudflare.com/api/typescript/resources/iam#%28resource%29%20iam.sso%20%3E%20%28model%29%20sso%5Fbegin%5Fverification%5Fresponse%20%3E%20%28schema%29) { errors, messages, success } 

POST/accounts/{account\_id}/sso\_connectors/{sso\_connector\_id}/begin\_verification

##### ModelsExpand Collapse 

SSOListResponse { id, created\_on, email\_domain, 4 more } 

id?: string

SSO Connector identifier tag.

maxLength32

minLength32

created\_on?: string

Timestamp for the creation of the SSO connector

formatdate-time

email\_domain?: string

enabled?: boolean

updated\_on?: string

Timestamp for the last update of the SSO connector

formatdate-time

use\_fedramp\_language?: boolean

Controls the display of FedRAMP language to the user during SSO login

verification?: Verification { code, status } 

code?: string

DNS verification code. Add this entire string to the DNS TXT record of the email domain to validate ownership.

status?: "awaiting" | "pending" | "failed" | "verified"

The status of the verification code from the verification process.

One of the following:

"awaiting"

"pending"

"failed"

"verified"

SSOGetResponse { id, created\_on, email\_domain, 4 more } 

id?: string

SSO Connector identifier tag.

maxLength32

minLength32

created\_on?: string

Timestamp for the creation of the SSO connector

formatdate-time

email\_domain?: string

enabled?: boolean

updated\_on?: string

Timestamp for the last update of the SSO connector

formatdate-time

use\_fedramp\_language?: boolean

Controls the display of FedRAMP language to the user during SSO login

verification?: Verification { code, status } 

code?: string

DNS verification code. Add this entire string to the DNS TXT record of the email domain to validate ownership.

status?: "awaiting" | "pending" | "failed" | "verified"

The status of the verification code from the verification process.

One of the following:

"awaiting"

"pending"

"failed"

"verified"

SSOCreateResponse { id, created\_on, email\_domain, 4 more } 

id?: string

SSO Connector identifier tag.

maxLength32

minLength32

created\_on?: string

Timestamp for the creation of the SSO connector

formatdate-time

email\_domain?: string

enabled?: boolean

updated\_on?: string

Timestamp for the last update of the SSO connector

formatdate-time

use\_fedramp\_language?: boolean

Controls the display of FedRAMP language to the user during SSO login

verification?: Verification { code, status } 

code?: string

DNS verification code. Add this entire string to the DNS TXT record of the email domain to validate ownership.

status?: "awaiting" | "pending" | "failed" | "verified"

The status of the verification code from the verification process.

One of the following:

"awaiting"

"pending"

"failed"

"verified"

SSOUpdateResponse { id, created\_on, email\_domain, 4 more } 

id?: string

SSO Connector identifier tag.

maxLength32

minLength32

created\_on?: string

Timestamp for the creation of the SSO connector

formatdate-time

email\_domain?: string

enabled?: boolean

updated\_on?: string

Timestamp for the last update of the SSO connector

formatdate-time

use\_fedramp\_language?: boolean

Controls the display of FedRAMP language to the user during SSO login

verification?: Verification { code, status } 

code?: string

DNS verification code. Add this entire string to the DNS TXT record of the email domain to validate ownership.

status?: "awaiting" | "pending" | "failed" | "verified"

The status of the verification code from the verification process.

One of the following:

"awaiting"

"pending"

"failed"

"verified"

SSODeleteResponse { id } 

id: string

Identifier

maxLength32

minLength32

SSOBeginVerificationResponse { errors, messages, success } 

errors: Array<Error\>

code: number

minimum1000

message: string

documentation\_url?: string

source?: Source { pointer } 

pointer?: string

messages: Array<Message\>

code: number

minimum1000

message: string

documentation\_url?: string

source?: Source { pointer } 

pointer?: string

success: true

Whether the API call was successful.