--- title: SSO --- [Skip to content](#_top) [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]() {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]() {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]() {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]() {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]() {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_verification) client.iam.sso.beginVerification(stringssoConnectorID, SSOBeginVerificationParams {account\_id } params, RequestOptionsoptions?): [SSOBeginVerificationResponse]() {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 Link to this property created\_on?: string Timestamp for the creation of the SSO connector formatdate-time Link to this property email\_domain?: string Link to this property enabled?: boolean Link to this property updated\_on?: string Timestamp for the last update of the SSO connector formatdate-time Link to this property use\_fedramp\_language?: boolean Controls the display of FedRAMP language to the user during SSO login Link to this property

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. Link to this property

status?: "awaiting"| "pending"| "failed"| "verified" The status of the verification code from the verification process.

One of the following: "awaiting" Link to this property "pending" Link to this property "failed" Link to this property "verified" Link to this property

Link to this property

[Link to this property](<#(resource)%20iam.sso%20%3E%20(model)%20sso_list_response%20%3E%20(schema)>)

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

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. Link to this property

status?: "awaiting"| "pending"| "failed"| "verified" The status of the verification code from the verification process.

One of the following: "awaiting" Link to this property "pending" Link to this property "failed" Link to this property "verified" Link to this property

Link to this property

[Link to this property](<#(resource)%20iam.sso%20%3E%20(model)%20sso_get_response%20%3E%20(schema)>)

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

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. Link to this property

status?: "awaiting"| "pending"| "failed"| "verified" The status of the verification code from the verification process.

One of the following: "awaiting" Link to this property "pending" Link to this property "failed" Link to this property "verified" Link to this property

Link to this property

[Link to this property](<#(resource)%20iam.sso%20%3E%20(model)%20sso_create_response%20%3E%20(schema)>)

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

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. Link to this property

status?: "awaiting"| "pending"| "failed"| "verified" The status of the verification code from the verification process.

One of the following: "awaiting" Link to this property "pending" Link to this property "failed" Link to this property "verified" Link to this property

Link to this property

[Link to this property](<#(resource)%20iam.sso%20%3E%20(model)%20sso_update_response%20%3E%20(schema)>)

SSODeleteResponse {id }

id: string Identifier maxLength32 minLength32 Link to this property

[Link to this property](<#(resource)%20iam.sso%20%3E%20(model)%20sso_delete_response%20%3E%20(schema)>)

SSOBeginVerificationResponse {errors, messages, success }

errors: Array<Error>

code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

messages: Array<Message>

code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

Link to this property success: true Whether the API call was successful. Link to this property

[Link to this property](<#(resource)%20iam.sso%20%3E%20(model)%20sso_begin_verification_response%20%3E%20(schema)>)