Note: Nintex Apps data centers are located in West US and Australia (AUS). In-region processing of Nintex Apps data is only available in these regions.

Sites

The site object is a singular JSON file which contains the main configurations for the tenant.

Field Name	Type	Description
name	String	The name of the site
localization	JSON Object	A localization object.
sso	JSON Object	An sso object.
security	JSON Object	A security object.

localization Object

Contains the settings for the site's locale and localization options, which involve time zone and language.

Field Name	Type	Description
defaultLocale	String	Sets the main geographic location of the site. Relates to the Default Locale property
defaultLanguage	String	Sets the default language location for users of the site. Relates to the Default Language property
defaultTimezone	String	Sets the default timezone for users of the site. Relates to the Default Time Zone property

sso Object

Contains the properties for the site's single sign-on (SSO) configuration.

Field Name	Type	Description
enabled	Boolean	Determines whether or not SSO is enabled for the site
loginHeading	String	Relates to the SSO Login Heading value. null unless the Use Custom SSO Login Heading property is checked in the Nintex Apps UI
loginSubHeading	String	Relates to the SSO Login Subheading value. null unless the Use Custom SSO Login Subheading property is checked in the Nintex Apps UI
ssoLoginOnly	Boolean	Relates to the Hide Username/Password Login option property

security Object

Contains the properties for the site's security settings, available via Settings > Site > Security.

Field Name	Type	Description
sessionActivityTimeout	Number	The amount of time—in minutes—before Nintex Apps requires a new login, and thus a new session
passwordTokenExpiration	Number	The amount of time—in minutes—that a password reset token is viable
roamingSessions	Boolean	Determines whether or not roaming sessions—which allow user sessions to be persist across access different IP addresses—is activated for the site
ipWhitelist	[String]	Relates to the IP Whitelist site property, an array of strings containing the IP addresses through which the Nintex Apps site can be accessed.