API Reference

IAM

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

SSO

Get all SSO connectors

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

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

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

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

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

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

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.