Sign in
Organizations

Fetch current organization settings

get/organization/settings

Response

OK

idinteger required

The ID of the organization

resource_type'Organization' required

The resource type of the organization

namestring required

The name of the organization

domainstring required

The domain of the organization.

logostring uri nullable required

The URL to the logo of the organization.

addressstring nullable required

The address of the organization.

descriptionstring nullable required

The description of the organization

device_logins_expire_afterinteger nullable required

The device login expiration in seconds. If not defined, it defaults to 2 weeks of inactivity.

places_countinteger required

Count of all the places within the organization.

scim_enabledboolean required

Whether SCIM is enabled for the organization.

sso_flow_enabledboolean required

Whether the organization has SSO flow enabled. Mutually exclusive with password flow.

sso_expiration_override_enabledboolean required

Whether the organization should override length of SSO session.

sso_expiration_overrideinteger nullable required

The length of the SSO session (in seconds) that will override the default passed from Identity Provider.

metadatastring nullable required

The SSO metadata of the organization.

time_zonestring required

The time zone of the organization. It should be a <a href="https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones"> valid IANA time zone name.</a>

web_authentication_api_enabledboolean required

Whether web authentication api is enabled. Only for organizations using SSO and IdP authentication is done using WebAuthn.

apple_pass_enabledboolean required

Whether Apple Pass is enabled for the organization.

created_atstring date-time required

When the organization was created

updated_atstring date-time required

When the organization was updated

user_idinteger required

The user ID of the organization

transfer_to_idinteger nullable required

The transfer_to ID of the organization

imagestring nullable required
colorstring nullable required
sp_certificate_expires_atstring nullable required

When the encryption certificate expires at.

sp_certificate_requiredboolean required

Whether an encryption certificate is required.

sp_certificatestring nullable required

The encryption certificate of the organization.

identity_provider_issuer_urlstring uri nullable required

The identity provider issuer url for the organization.

sso_configuredboolean nullable required

Whether the SSO configuration is set and working. It will be set to true after the first sign-in via SSO. Changing the SSO configuration will reset it back to false.

scim_configuredboolean nullable required

Whether the SCIM configuration is set and working. It will be set to true after first successful SCIM request. Resetting the SCIM token will set it back to false.

Example response

{
  "time_zone": "Europe/London"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.