com.files.models

Class SsoStrategy

java.lang.Object

com.files.models.SsoStrategy

All Implemented Interfaces:

ModelInterface

public class SsoStrategy
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	deprovisionBehavior Method used for deprovisioning users.
Boolean	deprovisionGroups Auto-deprovision group membership based on group memberships on the SSO side?
Boolean	deprovisionUsers Auto-deprovision users?
Boolean	enabled Is strategy enabled?
Long	id ID
String	label Custom label for the SSO provider on the login page.
String	ldapBaseDn Base DN for looking up users in LDAP server
String	ldapDomain Domain name that will be appended to LDAP usernames
String	ldapHost LDAP host
String	ldapHost2 LDAP backup host
String	ldapHost3 LDAP backup host
Long	ldapPort LDAP port
Boolean	ldapSecure Use secure LDAP?
String	ldapUsername Username for signing in to LDAP server.
String	ldapUsernameField LDAP username field
String	logoUrl URL holding a custom logo for the SSO provider on the login page.
String	protocol SSO Protocol
String	provider Provider name
Boolean	provisionAttachmentsPermission
String	provisionCompany Default company for auto provisioned users.
Boolean	provisionDavPermission Auto-provisioned users get WebDAV permission?
String	provisionEmailSignupGroups Comma-separated list of group names whose members will be created with email_signup authentication.
Boolean	provisionFtpPermission Auto-provisioned users get FTP permission?
String	provisionGroupAdminGroups Comma-separated list of group names whose members will be provisioned as Group Admins.
String	provisionGroupDefault Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
String	provisionGroupExclusion Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
String	provisionGroupInclusion Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
String	provisionGroupRequired Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
Boolean	provisionGroups Auto-provision group membership based on group memberships on the SSO side?
String	provisionRequire2fa 2FA required setting for auto provisioned users.
Boolean	provisionSftpPermission Auto-provisioned users get SFTP permission?
String	provisionSiteAdminGroups Comma-separated list of group names whose members will be created as Site Admins.
String	provisionTimeZone Default time zone for auto provisioned users.
Boolean	provisionUsers Auto-provision users?
String	samlProviderCertFingerprint Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
String	samlProviderIssuerUrl Identity provider issuer url
String	samlProviderMetadataContent Custom identity provider metadata
String	samlProviderMetadataUrl Metadata URL for the SAML identity provider
String	samlProviderSloTargetUrl Identity provider SLO endpoint
String	samlProviderSsoTargetUrl Identity provider SSO endpoint if saml_provider_metadata_url is not available.
String	scimAuthenticationMethod SCIM authentication type.
String	scimOauthAccessToken SCIM OAuth Access Token.
String	scimOauthAccessTokenExpiresAt SCIM OAuth Access Token Expiration Time.
String	scimUsername SCIM username.
String	subdomain Subdomain
Long	userCount Count of users with this SSO Strategy

Constructor Summary

Constructors

Constructor and Description
SsoStrategy()
SsoStrategy(HashMap<String,Object> parameters)
SsoStrategy(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<SsoStrategy>	all()
static ListIterator<SsoStrategy>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static SsoStrategy	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static SsoStrategy	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Sso Strategy ID.
static SsoStrategy	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static SsoStrategy	get()
static SsoStrategy	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<SsoStrategy>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<SsoStrategy>	list(HashMap<String,Object> parameters)
static ListIterator<SsoStrategy>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	sync() Synchronize provisioning data with the SSO remote server
static void	sync(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	sync(Long id, HashMap<String,Object> parameters) Synchronize provisioning data with the SSO remote server
static void	sync(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

protocol

public String protocol

SSO Protocol

provider

public String provider

Provider name

label

public String label

Custom label for the SSO provider on the login page.

logoUrl

public String logoUrl

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

id

public Long id

ID

userCount

public Long userCount

Count of users with this SSO Strategy

samlProviderCertFingerprint

public String samlProviderCertFingerprint

Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.

samlProviderIssuerUrl

public String samlProviderIssuerUrl

Identity provider issuer url

samlProviderMetadataContent

public String samlProviderMetadataContent

Custom identity provider metadata

samlProviderMetadataUrl

public String samlProviderMetadataUrl

Metadata URL for the SAML identity provider

samlProviderSloTargetUrl

public String samlProviderSloTargetUrl

Identity provider SLO endpoint

samlProviderSsoTargetUrl

public String samlProviderSsoTargetUrl

Identity provider SSO endpoint if saml_provider_metadata_url is not available.

scimAuthenticationMethod

public String scimAuthenticationMethod

SCIM authentication type.

scimUsername

public String scimUsername

SCIM username.

scimOauthAccessToken

public String scimOauthAccessToken

SCIM OAuth Access Token.

scimOauthAccessTokenExpiresAt

public String scimOauthAccessTokenExpiresAt

SCIM OAuth Access Token Expiration Time.

subdomain

public String subdomain

Subdomain

provisionUsers

public Boolean provisionUsers

Auto-provision users?

provisionGroups

public Boolean provisionGroups

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

deprovisionUsers

public Boolean deprovisionUsers

Auto-deprovision users?

deprovisionGroups

public Boolean deprovisionGroups

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

deprovisionBehavior

public String deprovisionBehavior

Method used for deprovisioning users.

provisionGroupDefault

public String provisionGroupDefault

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

provisionGroupExclusion

public String provisionGroupExclusion

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

provisionGroupInclusion

public String provisionGroupInclusion

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

provisionGroupRequired

public String provisionGroupRequired

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

provisionEmailSignupGroups

public String provisionEmailSignupGroups

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

provisionSiteAdminGroups

public String provisionSiteAdminGroups

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

provisionGroupAdminGroups

public String provisionGroupAdminGroups

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

provisionAttachmentsPermission

public Boolean provisionAttachmentsPermission

provisionDavPermission

public Boolean provisionDavPermission

Auto-provisioned users get WebDAV permission?

provisionFtpPermission

public Boolean provisionFtpPermission

Auto-provisioned users get FTP permission?

provisionSftpPermission

public Boolean provisionSftpPermission

Auto-provisioned users get SFTP permission?

provisionTimeZone

public String provisionTimeZone

Default time zone for auto provisioned users.

provisionCompany

public String provisionCompany

Default company for auto provisioned users.

provisionRequire2fa

public String provisionRequire2fa

2FA required setting for auto provisioned users.

ldapBaseDn

public String ldapBaseDn

Base DN for looking up users in LDAP server

ldapDomain

public String ldapDomain

Domain name that will be appended to LDAP usernames

enabled

public Boolean enabled

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

ldapHost

public String ldapHost

LDAP host

ldapHost2

public String ldapHost2

LDAP backup host

ldapHost3

public String ldapHost3

LDAP backup host

ldapPort

public Long ldapPort

LDAP port

ldapSecure

public Boolean ldapSecure

Use secure LDAP?

ldapUsername

public String ldapUsername

Username for signing in to LDAP server.

ldapUsernameField

public String ldapUsernameField

LDAP username field

Constructor Detail

SsoStrategy

public SsoStrategy()

SsoStrategy

public SsoStrategy(HashMap<String,Object> parameters)

SsoStrategy

public SsoStrategy(HashMap<String,Object> parameters,
                   HashMap<String,Object> options)

Method Detail

sync

public void sync()
          throws IOException

Synchronize provisioning data with the SSO remote server

Throws:

IOException

list

public static ListIterator<SsoStrategy> list()
                                      throws RuntimeException

Parameters: cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).

Throws:

RuntimeException

list

public static ListIterator<SsoStrategy> list(HashMap<String,Object> parameters)
                                      throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<SsoStrategy> list(HashMap<String,Object> parameters,
                                             HashMap<String,Object> options)
                                      throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<SsoStrategy> all()
                                     throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<SsoStrategy> all(HashMap<String,Object> parameters,
                                            HashMap<String,Object> options)
                                     throws RuntimeException

Throws:

RuntimeException

find

public static SsoStrategy find(Long id,
                               HashMap<String,Object> parameters)
                        throws RuntimeException

Parameters: id (required) - int64 - Sso Strategy ID.

Throws:

RuntimeException

find

public static SsoStrategy find(HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException

Throws:

RuntimeException

find

public static SsoStrategy find(Long id,
                               HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException

Throws:

RuntimeException

get

public static SsoStrategy get()
                       throws RuntimeException

Throws:

RuntimeException

get

public static SsoStrategy get(Long id,
                              HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:

RuntimeException

sync

public static void sync(Long id,
                        HashMap<String,Object> parameters)
                 throws RuntimeException

Synchronize provisioning data with the SSO remote server

Throws:

RuntimeException

sync

public static void sync(HashMap<String,Object> parameters,
                        HashMap<String,Object> options)
                 throws RuntimeException

Throws:

RuntimeException

sync

public static void sync(Long id,
                        HashMap<String,Object> parameters,
                        HashMap<String,Object> options)
                 throws RuntimeException

Throws:

RuntimeException