files.com 1.1.670 → 1.1.671

data/docs/sso_strategy.md

@@ -111,6 +111,13 @@
 * `ldap_type` (string): LDAP server type
 * `ldap_username` (string): Username for signing in to LDAP server.
 * `ldap_username_field` (string): LDAP username field
+* `client_id` (string): OAuth Client ID for your auth provider.
+* `client_secret` (string): OAuth Client Secret for your auth provider.
+* `ldap_password` (string): Password for signing in to LDAP server.
+* `logo_delete` (boolean): If true, the logo will be deleted.
+* `logo_file` (file): A logo to display on the login page.
+* `reset_scim_oauth_access_token` (boolean): If true, perform a reset on SCIM OAuth access token
+* `scim_password` (string): SCIM password applicable to basic authentication.
 
 
 ---
@@ -141,6 +148,124 @@ Files::SsoStrategy.find(id)
 * `id` (int64): Required - Sso Strategy ID.
 
 
+---
+
+## Create SSO Strategy
+
+```
+Files::SsoStrategy.create(
+  client_id: "[client id]", 
+  client_secret: "[client secret]", 
+  logo_delete: false, 
+  reset_scim_oauth_access_token: false, 
+  deprovision_behavior: "disable", 
+  deprovision_groups: false, 
+  deprovision_users: false, 
+  display_on_login_page: true, 
+  enabled: true, 
+  label: "My Corporate SSO Provider", 
+  ldap_base_dn: "example", 
+  ldap_domain: "mysite.com", 
+  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", 
+  protocol: "oauth2", 
+  provider: "okta", 
+  provider_identifier: "provider_identifier", 
+  provision_company: "ACME Corp.", 
+  provision_dav_permission: true, 
+  provision_email_signup_groups: "Employees", 
+  provision_filesystem_layout: "integration_centric", 
+  provision_ftp_permission: true, 
+  provision_group_admin_groups: "Employees", 
+  provision_group_default: "Employees", 
+  provision_group_exclusion: "Employees", 
+  provision_group_inclusion: "Employees", 
+  provision_group_required: "example", 
+  provision_groups: false, 
+  provision_readonly_site_admin_groups: "Employees", 
+  provision_require_2fa: "always_require", 
+  provision_sftp_permission: true, 
+  provision_site_admin_groups: "Employees", 
+  provision_time_zone: "Eastern Time (US & Canada)", 
+  provision_users: false, 
+  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_oauth_access_token_expires_at: "example", 
+  scim_username: "example", 
+  subdomain: "subdomain"
+)
+```
+
+### Parameters
+
+* `client_id` (string): OAuth Client ID for your auth provider.
+* `client_secret` (string): OAuth Client Secret for your auth provider.
+* `ldap_password` (string): Password for signing in to LDAP server.
+* `logo_delete` (boolean): If true, the logo will be deleted.
+* `logo_file` (file): A logo to display on the login page.
+* `reset_scim_oauth_access_token` (boolean): If true, perform a reset on SCIM OAuth access token
+* `scim_password` (string): SCIM password applicable to basic authentication.
+* `deprovision_behavior` (string): Method used for deprovisioning users.
+* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
+* `deprovision_users` (boolean): Auto-deprovision users?
+* `display_on_login_page` (boolean): Should this strategy be displayed on the login page?
+* `enabled` (boolean): Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
+* `label` (string): Custom label for the SSO provider on the login page.
+* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
+* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
+* `ldap_host` (string): LDAP host
+* `ldap_host_2` (string): LDAP backup host
+* `ldap_host_3` (string): LDAP backup host
+* `ldap_port` (int64): LDAP port
+* `ldap_provisioning_enabled` (boolean): Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
+* `ldap_secure` (boolean): Use secure LDAP?
+* `ldap_type` (string): LDAP server type
+* `ldap_username` (string): Username for signing in to LDAP server.
+* `ldap_username_field` (string): LDAP username field
+* `protocol` (string): SSO Protocol
+* `provider` (string): Provider name
+* `provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
+* `provision_company` (string): Default company for auto provisioned users.
+* `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
+* `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
+* `provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
+* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
+* `provision_group_admin_groups` (string): Comma-separated list of group names whose members will be provisioned as Group Admins.
+* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
+* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
+* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
+* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
+* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
+* `provision_readonly_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Read-Only Site Admins.
+* `provision_require_2fa` (string): 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_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
+* `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
+* `provision_time_zone` (string): Default time zone for auto provisioned users.
+* `provision_users` (boolean): Auto-provision users?
+* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
+* `saml_provider_issuer_url` (string): Identity provider issuer url
+* `saml_provider_metadata_content` (string): Custom identity provider metadata
+* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
+* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
+* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
+* `scim_authentication_method` (string): SCIM authentication type.
+* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
+* `scim_username` (string): SCIM username.
+* `subdomain` (string): Subdomain or domain name for your auth provider.   Example: `https://[subdomain].okta.com/`
+
+
 ---
 
 ## Synchronize provisioning data with the SSO remote server
@@ -154,6 +279,151 @@ Files::SsoStrategy.sync(id)
 * `id` (int64): Required - Sso Strategy ID.
 
 
+---
+
+## Create an export CSV of SSO Strategy resources
+
+```
+Files::SsoStrategy.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+
+
+---
+
+## Update SSO Strategy
+
+```
+Files::SsoStrategy.update(id, 
+  client_id: "[client id]", 
+  client_secret: "[client secret]", 
+  logo_delete: false, 
+  reset_scim_oauth_access_token: false, 
+  deprovision_behavior: "disable", 
+  deprovision_groups: false, 
+  deprovision_users: false, 
+  display_on_login_page: true, 
+  enabled: true, 
+  label: "My Corporate SSO Provider", 
+  ldap_base_dn: "example", 
+  ldap_domain: "mysite.com", 
+  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", 
+  protocol: "oauth2", 
+  provider: "okta", 
+  provider_identifier: "provider_identifier", 
+  provision_company: "ACME Corp.", 
+  provision_dav_permission: true, 
+  provision_email_signup_groups: "Employees", 
+  provision_filesystem_layout: "integration_centric", 
+  provision_ftp_permission: true, 
+  provision_group_admin_groups: "Employees", 
+  provision_group_default: "Employees", 
+  provision_group_exclusion: "Employees", 
+  provision_group_inclusion: "Employees", 
+  provision_group_required: "example", 
+  provision_groups: false, 
+  provision_readonly_site_admin_groups: "Employees", 
+  provision_require_2fa: "always_require", 
+  provision_sftp_permission: true, 
+  provision_site_admin_groups: "Employees", 
+  provision_time_zone: "Eastern Time (US & Canada)", 
+  provision_users: false, 
+  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_oauth_access_token_expires_at: "example", 
+  scim_username: "example", 
+  subdomain: "subdomain"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sso Strategy ID.
+* `client_id` (string): OAuth Client ID for your auth provider.
+* `client_secret` (string): OAuth Client Secret for your auth provider.
+* `ldap_password` (string): Password for signing in to LDAP server.
+* `logo_delete` (boolean): If true, the logo will be deleted.
+* `logo_file` (file): A logo to display on the login page.
+* `reset_scim_oauth_access_token` (boolean): If true, perform a reset on SCIM OAuth access token
+* `scim_password` (string): SCIM password applicable to basic authentication.
+* `deprovision_behavior` (string): Method used for deprovisioning users.
+* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
+* `deprovision_users` (boolean): Auto-deprovision users?
+* `display_on_login_page` (boolean): Should this strategy be displayed on the login page?
+* `enabled` (boolean): Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
+* `label` (string): Custom label for the SSO provider on the login page.
+* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
+* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
+* `ldap_host` (string): LDAP host
+* `ldap_host_2` (string): LDAP backup host
+* `ldap_host_3` (string): LDAP backup host
+* `ldap_port` (int64): LDAP port
+* `ldap_provisioning_enabled` (boolean): Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
+* `ldap_secure` (boolean): Use secure LDAP?
+* `ldap_type` (string): LDAP server type
+* `ldap_username` (string): Username for signing in to LDAP server.
+* `ldap_username_field` (string): LDAP username field
+* `protocol` (string): SSO Protocol
+* `provider` (string): Provider name
+* `provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
+* `provision_company` (string): Default company for auto provisioned users.
+* `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
+* `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
+* `provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
+* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
+* `provision_group_admin_groups` (string): Comma-separated list of group names whose members will be provisioned as Group Admins.
+* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
+* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
+* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
+* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
+* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
+* `provision_readonly_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Read-Only Site Admins.
+* `provision_require_2fa` (string): 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_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
+* `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
+* `provision_time_zone` (string): Default time zone for auto provisioned users.
+* `provision_users` (boolean): Auto-provision users?
+* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
+* `saml_provider_issuer_url` (string): Identity provider issuer url
+* `saml_provider_metadata_content` (string): Custom identity provider metadata
+* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
+* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
+* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
+* `scim_authentication_method` (string): SCIM authentication type.
+* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
+* `scim_username` (string): SCIM username.
+* `subdomain` (string): Subdomain or domain name for your auth provider.   Example: `https://[subdomain].okta.com/`
+
+
+---
+
+## Delete SSO Strategy
+
+```
+Files::SsoStrategy.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sso Strategy ID.
+
+
 ---
 
 ## Synchronize provisioning data with the SSO remote server
@@ -167,3 +437,139 @@ sso_strategy.sync
 ### Parameters
 
 * `id` (int64): Required - Sso Strategy ID.
+
+
+---
+
+## Update SSO Strategy
+
+```
+sso_strategy = Files::SsoStrategy.find(id)
+
+sso_strategy.update(
+  client_id: "[client id]",
+  client_secret: "[client secret]",
+  logo_delete: false,
+  reset_scim_oauth_access_token: false,
+  deprovision_behavior: "disable",
+  deprovision_groups: false,
+  deprovision_users: false,
+  display_on_login_page: true,
+  enabled: true,
+  label: "My Corporate SSO Provider",
+  ldap_base_dn: "example",
+  ldap_domain: "mysite.com",
+  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",
+  protocol: "oauth2",
+  provider: "okta",
+  provider_identifier: "provider_identifier",
+  provision_company: "ACME Corp.",
+  provision_dav_permission: true,
+  provision_email_signup_groups: "Employees",
+  provision_filesystem_layout: "integration_centric",
+  provision_ftp_permission: true,
+  provision_group_admin_groups: "Employees",
+  provision_group_default: "Employees",
+  provision_group_exclusion: "Employees",
+  provision_group_inclusion: "Employees",
+  provision_group_required: "example",
+  provision_groups: false,
+  provision_readonly_site_admin_groups: "Employees",
+  provision_require_2fa: "always_require",
+  provision_sftp_permission: true,
+  provision_site_admin_groups: "Employees",
+  provision_time_zone: "Eastern Time (US & Canada)",
+  provision_users: false,
+  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_oauth_access_token_expires_at: "example",
+  scim_username: "example",
+  subdomain: "subdomain"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sso Strategy ID.
+* `client_id` (string): OAuth Client ID for your auth provider.
+* `client_secret` (string): OAuth Client Secret for your auth provider.
+* `ldap_password` (string): Password for signing in to LDAP server.
+* `logo_delete` (boolean): If true, the logo will be deleted.
+* `logo_file` (file): A logo to display on the login page.
+* `reset_scim_oauth_access_token` (boolean): If true, perform a reset on SCIM OAuth access token
+* `scim_password` (string): SCIM password applicable to basic authentication.
+* `deprovision_behavior` (string): Method used for deprovisioning users.
+* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
+* `deprovision_users` (boolean): Auto-deprovision users?
+* `display_on_login_page` (boolean): Should this strategy be displayed on the login page?
+* `enabled` (boolean): Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
+* `label` (string): Custom label for the SSO provider on the login page.
+* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
+* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
+* `ldap_host` (string): LDAP host
+* `ldap_host_2` (string): LDAP backup host
+* `ldap_host_3` (string): LDAP backup host
+* `ldap_port` (int64): LDAP port
+* `ldap_provisioning_enabled` (boolean): Use LDAP server settings for scheduled provisioning while using this SSO provider for authentication?
+* `ldap_secure` (boolean): Use secure LDAP?
+* `ldap_type` (string): LDAP server type
+* `ldap_username` (string): Username for signing in to LDAP server.
+* `ldap_username_field` (string): LDAP username field
+* `protocol` (string): SSO Protocol
+* `provider` (string): Provider name
+* `provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
+* `provision_company` (string): Default company for auto provisioned users.
+* `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
+* `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
+* `provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
+* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
+* `provision_group_admin_groups` (string): Comma-separated list of group names whose members will be provisioned as Group Admins.
+* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
+* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
+* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
+* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
+* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
+* `provision_readonly_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Read-Only Site Admins.
+* `provision_require_2fa` (string): 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_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
+* `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
+* `provision_time_zone` (string): Default time zone for auto provisioned users.
+* `provision_users` (boolean): Auto-provision users?
+* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
+* `saml_provider_issuer_url` (string): Identity provider issuer url
+* `saml_provider_metadata_content` (string): Custom identity provider metadata
+* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
+* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
+* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
+* `scim_authentication_method` (string): SCIM authentication type.
+* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
+* `scim_username` (string): SCIM username.
+* `subdomain` (string): Subdomain or domain name for your auth provider.   Example: `https://[subdomain].okta.com/`
+
+
+---
+
+## Delete SSO Strategy
+
+```
+sso_strategy = Files::SsoStrategy.find(id)
+
+sso_strategy.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Sso Strategy ID.