Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
sso_strategies
SSO Strategies

Show SSO Strategy

Show SSO Strategy

get/sso_strategies/{id}

Path parameters

idinteger required

Sso Strategy ID.

Response

The SsoStrategies object.

protocol'oauth2' | 'saml' | 'active_directory' | 'open_ldap' | 'scim'

SSO Protocol

provider'google' | 'auth0' | 'okta' | 'azure' | 'box' | 'dropbox' | 'slack' | 'onelogin' | 'saml' | 'idaptive' | 'ldap' | 'scim' | 'jumpcloud' | 'duo'

Provider name

labelstring

Custom label for the SSO provider on the login page.

logo_urlstring

URL holding a custom logo for the SSO provider on the login page.

idinteger

ID

user_countinteger

Count of users with this SSO Strategy

saml_provider_cert_fingerprintstring

Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.

saml_provider_issuer_urlstring

Identity provider issuer url

saml_provider_metadata_contentstring

Custom identity provider metadata

saml_provider_metadata_urlstring

Metadata URL for the SAML identity provider

saml_provider_slo_target_urlstring

Identity provider SLO endpoint

saml_provider_sso_target_urlstring

Identity provider SSO endpoint if saml_provider_metadata_url is not available.

scim_authentication_method'none' | 'basic' | 'token'

SCIM authentication type.

scim_usernamestring

SCIM username.

scim_oauth_access_tokenstring

SCIM OAuth Access Token.

scim_oauth_access_token_expires_atstring

SCIM OAuth Access Token Expiration Time.

subdomainstring

Subdomain or domain name for your auth provider. Example: https://[subdomain].okta.com/

provision_usersboolean

Auto-provision users?

provision_groupsboolean

Auto-provision group membership based on group memberships on the SSO side?

deprovision_usersboolean

Auto-deprovision users?

deprovision_groupsboolean

Auto-deprovision group membership based on group memberships on the SSO side?

deprovision_behavior'disable' | 'delete'

Method used for deprovisioning users.

provision_group_defaultstring

Comma-separated list of group names for groups to automatically add all auto-provisioned users to.

provision_group_exclusionstring

Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.

provision_group_inclusionstring

Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.

provision_group_requiredstring

Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.

provision_email_signup_groupsstring

Comma-separated list of group names whose members will be created with email_signup authentication.

provision_readonly_site_admin_groupsstring

Comma-separated list of group names whose members will be created as Read-Only Site Admins.

provision_site_admin_groupsstring

Comma-separated list of group names whose members will be created as Site Admins.

provision_group_admin_groupsstring

Comma-separated list of group names whose members will be provisioned as Group Admins.

provision_attachments_permissionboolean
provision_dav_permissionboolean

Auto-provisioned users get WebDAV permission?

provision_ftp_permissionboolean

Auto-provisioned users get FTP permission?

provision_sftp_permissionboolean

Auto-provisioned users get SFTP permission?

provision_time_zonestring

Default time zone for auto provisioned users.

provision_companystring

Default company for auto provisioned users.

provision_require_2fa'use_system_setting' | 'always_require' | 'never_require'

2FA required setting for auto provisioned users. use_system_setting uses the site-wide setting, including SSO exemptions. always_require and never_require override the site-wide setting when user-level overrides are allowed.

provision_filesystem_layout'site_root' | 'user_root' | 'partner_root' | 'integration_centric'

File System layout to use for auto provisioned users.

provider_identifierstring

URL-friendly, unique identifier for Azure SAML configuration

ldap_base_dnstring

Base DN for looking up users in LDAP server

ldap_domainstring

Domain name that will be appended to LDAP usernames

enabledboolean

Is strategy enabled? This may become automatically set to false after a high number and duration of failures.

display_on_login_pageboolean

Should this strategy be displayed on the login page?

ldap_hoststring

LDAP host

ldap_host_2string

LDAP backup host

ldap_host_3string

LDAP backup host

ldap_portinteger

LDAP port

ldap_provisioning_enabledboolean

Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?

ldap_secureboolean

Use secure LDAP?

ldap_type'active_directory' | 'open_ldap'

LDAP server type

ldap_usernamestring

Username for signing in to LDAP server.

ldap_username_field'sAMAccountName' | 'userPrincipalName'

LDAP username field

Example response

{
  "protocol": "oauth2",
  "provider": "okta",
  "label": "My Corporate SSO Provider",
  "logo_url": "https://mysite.files.com/.../logo.png",
  "id": 1,
  "user_count": 1,
  "saml_provider_cert_fingerprint": "example",
  "saml_provider_issuer_url": "example",
  "saml_provider_metadata_content": "example",
  "saml_provider_metadata_url": "example",
  "saml_provider_slo_target_url": "example",
  "saml_provider_sso_target_url": "example",
  "scim_authentication_method": "example",
  "scim_username": "example",
  "scim_oauth_access_token": "example",
  "scim_oauth_access_token_expires_at": "example",
  "subdomain": "subdomain",
  "deprovision_behavior": "disable",
  "provision_group_default": "Employees",
  "provision_group_exclusion": "Employees",
  "provision_group_inclusion": "Employees",
  "provision_group_required": "example",
  "provision_email_signup_groups": "Employees",
  "provision_readonly_site_admin_groups": "Employees",
  "provision_site_admin_groups": "Employees",
  "provision_group_admin_groups": "Employees",
  "provision_attachments_permission": true,
  "provision_dav_permission": true,
  "provision_ftp_permission": true,
  "provision_sftp_permission": true,
  "provision_time_zone": "Eastern Time (US & Canada)",
  "provision_company": "ACME Corp.",
  "provision_require_2fa": "always_require",
  "provision_filesystem_layout": "integration_centric",
  "provider_identifier": "provider_identifier",
  "ldap_base_dn": "example",
  "ldap_domain": "mysite.com",
  "enabled": true,
  "display_on_login_page": true,
  "ldap_host": "ldap.site.com",
  "ldap_host_2": "ldap2.site.com",
  "ldap_host_3": "ldap3.site.com",
  "ldap_port": 1,
  "ldap_provisioning_enabled": true,
  "ldap_secure": true,
  "ldap_type": "active_directory",
  "ldap_username": "[ldap username]",
  "ldap_username_field": "sAMAccountName"
}