Skip to content
Cloudflare API
Start here
API Reference
IAM

SSO

Get all SSO connectors
iam.sso.list(SSOListParams**kwargs) -> SyncSinglePage[SSOListResponse]
GET/accounts/{account_id}/sso_connectors
Get single SSO connector
iam.sso.get(strsso_connector_id, SSOGetParams**kwargs) -> SSOGetResponse
GET/accounts/{account_id}/sso_connectors/{sso_connector_id}
Initialize new SSO connector
iam.sso.create(SSOCreateParams**kwargs) -> SSOCreateResponse
POST/accounts/{account_id}/sso_connectors
Update SSO connector state
iam.sso.update(strsso_connector_id, SSOUpdateParams**kwargs) -> SSOUpdateResponse
PATCH/accounts/{account_id}/sso_connectors/{sso_connector_id}
Delete SSO connector
iam.sso.delete(strsso_connector_id, SSODeleteParams**kwargs) -> SSODeleteResponse
DELETE/accounts/{account_id}/sso_connectors/{sso_connector_id}
Begin SSO connector verification
iam.sso.begin_verification(strsso_connector_id, SSOBeginVerificationParams**kwargs) -> SSOBeginVerificationResponse
POST/accounts/{account_id}/sso_connectors/{sso_connector_id}/begin_verification
ModelsExpand Collapse
class SSOListResponse: …
id: Optional[str]

SSO Connector identifier tag.

maxLength32
minLength32
created_on: Optional[datetime]

Timestamp for the creation of the SSO connector

formatdate-time
email_domain: Optional[str]
enabled: Optional[bool]
updated_on: Optional[datetime]

Timestamp for the last update of the SSO connector

formatdate-time
use_fedramp_language: Optional[bool]

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

verification: Optional[Verification]
code: Optional[str]

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

status: Optional[Literal["awaiting", "pending", "failed", "verified"]]

The status of the verification code from the verification process.

One of the following:
"awaiting"
"pending"
"failed"
"verified"
class SSOGetResponse: …
id: Optional[str]

SSO Connector identifier tag.

maxLength32
minLength32
created_on: Optional[datetime]

Timestamp for the creation of the SSO connector

formatdate-time
email_domain: Optional[str]
enabled: Optional[bool]
updated_on: Optional[datetime]

Timestamp for the last update of the SSO connector

formatdate-time
use_fedramp_language: Optional[bool]

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

verification: Optional[Verification]
code: Optional[str]

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

status: Optional[Literal["awaiting", "pending", "failed", "verified"]]

The status of the verification code from the verification process.

One of the following:
"awaiting"
"pending"
"failed"
"verified"
class SSOCreateResponse: …
id: Optional[str]

SSO Connector identifier tag.

maxLength32
minLength32
created_on: Optional[datetime]

Timestamp for the creation of the SSO connector

formatdate-time
email_domain: Optional[str]
enabled: Optional[bool]
updated_on: Optional[datetime]

Timestamp for the last update of the SSO connector

formatdate-time
use_fedramp_language: Optional[bool]

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

verification: Optional[Verification]
code: Optional[str]

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

status: Optional[Literal["awaiting", "pending", "failed", "verified"]]

The status of the verification code from the verification process.

One of the following:
"awaiting"
"pending"
"failed"
"verified"
class SSOUpdateResponse: …
id: Optional[str]

SSO Connector identifier tag.

maxLength32
minLength32
created_on: Optional[datetime]

Timestamp for the creation of the SSO connector

formatdate-time
email_domain: Optional[str]
enabled: Optional[bool]
updated_on: Optional[datetime]

Timestamp for the last update of the SSO connector

formatdate-time
use_fedramp_language: Optional[bool]

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

verification: Optional[Verification]
code: Optional[str]

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

status: Optional[Literal["awaiting", "pending", "failed", "verified"]]

The status of the verification code from the verification process.

One of the following:
"awaiting"
"pending"
"failed"
"verified"
class SSODeleteResponse: …
id: str

Identifier

maxLength32
minLength32
class SSOBeginVerificationResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.