Skip to content
  • Auto
  • Light
  • Dark
Get Started

Settings

Settings

Settings

Get
client.settings.retrieveAwsExternalID(RequestOptionsoptions?): awsExternalIdAwsExternalIDSettingRetrieveAwsExternalIDResponse
get/api/v1/settings/aws-external-id

SettingsDomains

Update
client.settings.domains.update(DomainUpdateParamsbody?, RequestOptionsoptions?): listunionDomainUpdateResponse
put/api/v1/settings/domains
List
client.settings.domains.list(DomainListParamsquery?, RequestOptionsoptions?): listunionnextPageTokenstringDomainListResponse
get/api/v1/settings/domains
Org Domain
OrgDomain

The OrgDomain message.

ShowShow
idstring
optional

The id field.

createdAtstring
optional
formatdate-time
deletedAtstring
optional
formatdate-time
domainstring
optional

The domain field.

updatedAtstring
optional
formatdate-time

SettingsSession

Get
client.settings.session.retrieve(RequestOptionsoptions?): sessionSettingsSessionSettingsSessionRetrieveResponse
get/api/v1/settings/session
Update
client.settings.session.update(SessionUpdateParamsbody?, RequestOptionsoptions?): sessionSettingsSessionSettingsSessionUpdateResponse
post/api/v1/settings/session
Test Source Ip
client.settings.session.testSourceIP(SessionTestSourceIPParamsbody?, RequestOptionsoptions?): allowedbooleancheckedIpstringdetailsDetailsSessionTestSourceIPResponse
post/api/v1/settings/session/test-source-ip
Cidr Restriction
CidrRestriction

The CIDRRestriction message.

ShowShow
enabledboolean
optional

The enabled field.

sourceCidrunion
optional
Array<string> | null

The sourceCidr field.

Session Settings
SessionSettings

The SessionSettings message.

ShowShow
connectorSourceenabledbooleansourceCidrunionCidrRestriction
optional

The CIDRRestriction message.

maxSessionLengthstring
optional
formatduration
pccAdminSourceenabledbooleansourceCidrunionCidrRestriction
optional

The CIDRRestriction message.

pccUserSourceenabledbooleansourceCidrunionCidrRestriction
optional

The CIDRRestriction message.

ssoAdminSourceenabledbooleansourceCidrunionCidrRestriction
optional

The CIDRRestriction message.

ssoUserSourceenabledbooleansourceCidrunionCidrRestriction
optional

The CIDRRestriction message.