Schema Reference
The application schema is used to configure the objects returned from a connector.
Note
-
The Account Schema tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as Entitlement or Multi-Valued. Refer to Managing Source Account Schemas for more information.
-
The schema attributes that are not present by default must be defined as strings if not specified.
The Files.com connector uses the following default correlation and object configurations.
Default Account Schema
Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.
The set of account attributes each source stores and how they're organized is known as the account's schema. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to Managing Source Account Schemas for more information.
Default Account ID
SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as account IDs.
Caution
Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
To resolve issues caused by changing account IDs, reconfigure them to their default values.
The following table lists the default account IDs for this connector:
| Account ID | Schema Object Type |
|---|---|
| id | User |
Default Account Attributes
The Files.com connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.
| Attribute Name | Description |
|---|---|
| id | User ID. |
| username | User's username. |
| created_at | When this user was created. |
| group_ids | Comma-separated list of group IDs of which this user is a member. |
| last_logged_in | Timestamp of the user's last login. |
| ftp_permission | Indicates whether the user can access with FTP/FTPS. |
| allowed_ips | A list of allowed IPs if applicable. Newline delimited. |
| attachments_permission | DEPRECATED: If true, the user can create Bundles (aka Share Links). Use the bundle permission instead. |
| user_root | Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Not used for API, Desktop, or Web interface. |
| user_home | Home folder for FTP/SFTP. Not used for API, Desktop, or Web interface. |
| site_id | Site ID. |
| admin_group_ids | List of group IDs of which this user is an administrator. |
| api_keys_count | Number of API keys associated with this user. |
| billable | Indicates whether this a billable user record. |
| billing_permission | Indicates whether this user is allowed to perform operations on the account, payments, and invoices. |
| User email address. | |
| days_remaining_until_password_expire | Number of days remaining until password expires. |
| time_zone | User time zone. |
| avatar_url | URL holding the user's avatar. |
| authentication_method | Indicates the user authentication method. Possible values: password, sso, none, email_signup, password_with_imported_hash, password_and_ssh_key. |
| bypass_site_allowed_ips | Indicates if this user is allowed to skip site-wide IP blacklists. |
| bypass_user_lifecycle_rules | Indicates if this users is exempt from user lifecycle rules. |
| dav_permission | Indicates if the user can connect with WebDAV. |
| header_text | Text to display to the user in the header of the UI. |
| language | Preferred language. |
| last_login_at | User's most recent login time via any protocol. |
| last_web_login_at | User's most recent login time via web. |
| last_ftp_login_at | User's most recent login time via FTP. |
| last_sftp_login_at | User's most recent login time via SFTP. |
| last_dav_login_at | User's most recent login time via WebDAV. |
| last_desktop_login_at | User's most recent login time via Desktop app. |
| last_restapi_login_at | User's most recent login time via Rest API. |
| last_active_at | User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation. |
| last_protocol_cipher | The most recent protocol and cipher used. |
| lockout_expires | Time in the future that the user will no longer be locked out if applicable. |
| company | User's company. |
| notes | Any internal notes on the user. |
| notification_daily_send_time | Hour of the day at which daily notifications should be sent. Can be in range 0 to 23. |
| office_integration_enabled | Indicates whether integration with Office for the web is enabled. |
| password_set_at | Last time the user's password was set. |
| password_validity_days | Number of days to allow user to use the same password. |
| public_keys_count | Number of public keys associated with this user. |
| receive_admin_alerts | Indicates whether the user should receive admin alerts such as certificate expiration notifications and overages. |
| require_2fa | 2FA required setting. Possible values: use_system_setting, always_require, never_require. |
| require_login_by | Require login by. |
| active_2fa | Indicates if 2FA is active for the user. |
| require_password_change | Indicates whether a password change is required upon next user login. |
| password_expired | Indicates whether the user's password is expired. |
| authenticate_until | Scheduled Date/Time at which user will be deactivated. |
| disabled | Indicates if a user has been disabled? Disabled users cannot log in, and do not count for billing purposes. |
| readonly_site_admin | Indicates whether the user is allowed to view all (non-billing) site configuration for this site. |
| restapi_permission | Indicates if the user can access the Web app, Desktop app, SDKs, or REST API. |
| self_managed | Does this user manage its own credentials or is it a shared/bot user. |
| sftp_permission | Can the user access with SFTP. |
| site_admin | Is the user an administrator for this site. |
| sso_strategy_id | SSO (Single Sign On) strategy ID for the user, if applicable. |
| subscribe_to_newsletter | Is the user subscribed to the newsletter. |
| type_of_2fa | Type(s) of 2FA methods in use, for programmatic use. |
| type_of_2fa_for_display | Type(s) of 2FA methods in use, formatted for displaying in the UI. |
| password_expire_at | Password expiration datetime. |
Default Entitlement Attributes
Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to Managing Entitlements for more information.
Caution
Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.
Default Group Attributes
The Files.com connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.
| Attribute Name | Description |
|---|---|
| id | Group ID |
| name | Group name |
| notes | Description of the group |
| auto_join | Group notes |
| admin_ids | A list of group admin user IDs. If sent as a string, should be comma-delimited. |
| ftp_permission | If true, users in this group can use FTP to login. Overrides a false value of ftp_permission on the user level. |
| sftp_permission | If true, users in this group can use SFTP to login. Overrides a false value of sftp_permission on the user level. |
| dav_permission | If true, users in this group can use WebDAV to login. Overrides a false value of dav_permission on the user level. |
| restapi_permission | If true, users in this group can use the REST API to login. Overrides a false value of restapi_permission on the user level. |
| allowed_ips | A list of allowed IPs if applicable. Newline delimited. |