files.com 1.1.333 → 1.1.335
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/partner.md +158 -0
- data/docs/permission.md +8 -2
- data/docs/site.md +2 -0
- data/docs/sso_strategy.md +4 -2
- data/docs/user.md +16 -0
- data/lib/files.com/models/partner.rb +206 -0
- data/lib/files.com/models/permission.rb +15 -2
- data/lib/files.com/models/sso_strategy.rb +6 -1
- data/lib/files.com/models/user.rb +30 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '069ce0338ba864f9b384c60459108b58f30319121283d230d73258e8845cbd4a'
|
|
4
|
+
data.tar.gz: 0d3638dbf344e7471f8ea4a35a5b5ef9f4bc06011784a532bb15089fbd0372f7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2425013e7e2a06c03e7bfb339fa0560a556ed4a24b8df6e9db634027e800921c0afb6716ac02a84d9d0645e8e6287689cab601ba233e1927697427586ea0a7c7
|
|
7
|
+
data.tar.gz: 17e33d86ab1726138963e01b3a3bde214faf4874d0d0321b142790c53b0277924a2dda230a36430b41dc2496a1050203406bbee8c949420c43253a324e8aec3f
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.335
|
data/docs/partner.md
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# Partner
|
|
2
|
+
|
|
3
|
+
## Example Partner Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"allow_bypassing_2fa_policies": true,
|
|
8
|
+
"allow_credential_changes": true,
|
|
9
|
+
"allow_user_creation": true,
|
|
10
|
+
"id": 1,
|
|
11
|
+
"name": "Acme Corp",
|
|
12
|
+
"notes": "This is a note about the partner.",
|
|
13
|
+
"root_folder": "/AcmeCorp"
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
18
|
+
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
19
|
+
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
20
|
+
* `id` (int64): The unique ID of the Partner.
|
|
21
|
+
* `name` (string): The name of the Partner.
|
|
22
|
+
* `notes` (string): Notes about this Partner.
|
|
23
|
+
* `root_folder` (string): The root folder path for this Partner.
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## List Partners
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
Files::Partner.list
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
|
|
36
|
+
* `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.
|
|
37
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
38
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Show Partner
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
Files::Partner.find(id)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Parameters
|
|
50
|
+
|
|
51
|
+
* `id` (int64): Required - Partner ID.
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Create Partner
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
Files::Partner.create(
|
|
60
|
+
allow_bypassing_2fa_policies: false,
|
|
61
|
+
allow_credential_changes: false,
|
|
62
|
+
allow_user_creation: false,
|
|
63
|
+
name: "Acme Corp",
|
|
64
|
+
notes: "This is a note about the partner.",
|
|
65
|
+
root_folder: "/AcmeCorp"
|
|
66
|
+
)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
72
|
+
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
73
|
+
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
74
|
+
* `name` (string): The name of the Partner.
|
|
75
|
+
* `notes` (string): Notes about this Partner.
|
|
76
|
+
* `root_folder` (string): The root folder path for this Partner.
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Update Partner
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
Files::Partner.update(id,
|
|
85
|
+
allow_bypassing_2fa_policies: false,
|
|
86
|
+
allow_credential_changes: false,
|
|
87
|
+
allow_user_creation: false,
|
|
88
|
+
name: "Acme Corp",
|
|
89
|
+
notes: "This is a note about the partner.",
|
|
90
|
+
root_folder: "/AcmeCorp"
|
|
91
|
+
)
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
* `id` (int64): Required - Partner ID.
|
|
97
|
+
* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
98
|
+
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
99
|
+
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
100
|
+
* `name` (string): The name of the Partner.
|
|
101
|
+
* `notes` (string): Notes about this Partner.
|
|
102
|
+
* `root_folder` (string): The root folder path for this Partner.
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## Delete Partner
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
Files::Partner.delete(id)
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Parameters
|
|
114
|
+
|
|
115
|
+
* `id` (int64): Required - Partner ID.
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Update Partner
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
partner = Files::Partner.find(id)
|
|
124
|
+
|
|
125
|
+
partner.update(
|
|
126
|
+
allow_bypassing_2fa_policies: false,
|
|
127
|
+
allow_credential_changes: false,
|
|
128
|
+
allow_user_creation: false,
|
|
129
|
+
name: "Acme Corp",
|
|
130
|
+
notes: "This is a note about the partner.",
|
|
131
|
+
root_folder: "/AcmeCorp"
|
|
132
|
+
)
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
* `id` (int64): Required - Partner ID.
|
|
138
|
+
* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
139
|
+
* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
140
|
+
* `allow_user_creation` (boolean): Allow Partner Admins to create users.
|
|
141
|
+
* `name` (string): The name of the Partner.
|
|
142
|
+
* `notes` (string): Notes about this Partner.
|
|
143
|
+
* `root_folder` (string): The root folder path for this Partner.
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Delete Partner
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
partner = Files::Partner.find(id)
|
|
152
|
+
|
|
153
|
+
partner.delete
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Parameters
|
|
157
|
+
|
|
158
|
+
* `id` (int64): Required - Partner ID.
|
data/docs/permission.md
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
"username": "user",
|
|
11
11
|
"group_id": 1,
|
|
12
12
|
"group_name": "example",
|
|
13
|
+
"partner_id": 1,
|
|
13
14
|
"permission": "full",
|
|
14
15
|
"recursive": true,
|
|
15
16
|
"site_id": 1
|
|
@@ -22,6 +23,7 @@
|
|
|
22
23
|
* `username` (string): Username (if applicable)
|
|
23
24
|
* `group_id` (int64): Group ID
|
|
24
25
|
* `group_name` (string): Group name (if applicable)
|
|
26
|
+
* `partner_id` (int64): Partner ID (if applicable)
|
|
25
27
|
* `permission` (string): Permission type. See the table referenced in the documentation for an explanation of each permission.
|
|
26
28
|
* `recursive` (boolean): Recursive: does this permission apply to subfolders?
|
|
27
29
|
* `site_id` (int64): Site ID
|
|
@@ -36,6 +38,7 @@ Files::Permission.list(
|
|
|
36
38
|
path: "example",
|
|
37
39
|
include_groups: false,
|
|
38
40
|
group_id: 1,
|
|
41
|
+
partner_id: 1,
|
|
39
42
|
user_id: 1
|
|
40
43
|
)
|
|
41
44
|
```
|
|
@@ -44,12 +47,13 @@ Files::Permission.list(
|
|
|
44
47
|
|
|
45
48
|
* `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.
|
|
46
49
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
47
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path`, `user_id` or `id`.
|
|
48
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]`, `[ user_id, group_id ]` or `[ user_id, group_id, path ]`.
|
|
50
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path`, `user_id`, `partner_id` or `id`.
|
|
51
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id`, `partner_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ partner_id, path ]`, `[ user_id, path ]`, `[ user_id, group_id ]`, `[ user_id, group_id, path ]`, `[ user_id, group_id, partner_id ]` or `[ user_id, group_id, partner_id, path ]`.
|
|
49
52
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
|
50
53
|
* `path` (string): Permission path. If provided, will scope all permissions(including upward) to this path.
|
|
51
54
|
* `include_groups` (boolean): If searching by user or group, also include user's permissions that are inherited from its groups?
|
|
52
55
|
* `group_id` (string):
|
|
56
|
+
* `partner_id` (string):
|
|
53
57
|
* `user_id` (string):
|
|
54
58
|
|
|
55
59
|
|
|
@@ -63,6 +67,7 @@ Files::Permission.create(
|
|
|
63
67
|
group_id: 1,
|
|
64
68
|
permission: "full",
|
|
65
69
|
recursive: false,
|
|
70
|
+
partner_id: 1,
|
|
66
71
|
user_id: 1,
|
|
67
72
|
username: "user",
|
|
68
73
|
group_name: "example",
|
|
@@ -76,6 +81,7 @@ Files::Permission.create(
|
|
|
76
81
|
* `group_id` (int64): Group ID. Provide `group_name` or `group_id`
|
|
77
82
|
* `permission` (string): Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
|
78
83
|
* `recursive` (boolean): Apply to subfolders recursively?
|
|
84
|
+
* `partner_id` (int64): Partner ID if this Permission belongs to a partner.
|
|
79
85
|
* `user_id` (int64): User ID. Provide `username` or `user_id`
|
|
80
86
|
* `username` (string): User username. Provide `username` or `user_id`
|
|
81
87
|
* `group_name` (string): Group name. Provide `group_name` or `group_id`
|
data/docs/site.md
CHANGED
|
@@ -237,6 +237,7 @@
|
|
|
237
237
|
"disabled": true,
|
|
238
238
|
"disabled_expired_or_inactive": true,
|
|
239
239
|
"email": "john.doe@files.com",
|
|
240
|
+
"filesystem_layout": "site_root",
|
|
240
241
|
"first_login_at": "2000-01-01T01:00:00Z",
|
|
241
242
|
"ftp_permission": true,
|
|
242
243
|
"group_ids": "example",
|
|
@@ -258,6 +259,7 @@
|
|
|
258
259
|
"notes": "Internal notes on this user.",
|
|
259
260
|
"notification_daily_send_time": 18,
|
|
260
261
|
"office_integration_enabled": true,
|
|
262
|
+
"partner_id": 1,
|
|
261
263
|
"password_set_at": "2000-01-01T01:00:00Z",
|
|
262
264
|
"password_validity_days": 1,
|
|
263
265
|
"public_keys_count": 1,
|
data/docs/sso_strategy.md
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"scim_username": "example",
|
|
21
21
|
"scim_oauth_access_token": "example",
|
|
22
22
|
"scim_oauth_access_token_expires_at": "example",
|
|
23
|
-
"subdomain": "
|
|
23
|
+
"subdomain": "",
|
|
24
24
|
"provision_users": true,
|
|
25
25
|
"provision_groups": true,
|
|
26
26
|
"deprovision_users": true,
|
|
@@ -41,6 +41,7 @@
|
|
|
41
41
|
"provision_time_zone": "Eastern Time (US & Canada)",
|
|
42
42
|
"provision_company": "ACME Corp.",
|
|
43
43
|
"provision_require_2fa": "always_require",
|
|
44
|
+
"provision_filesystem_layout": "integration_centric",
|
|
44
45
|
"provider_identifier": "",
|
|
45
46
|
"ldap_base_dn": "example",
|
|
46
47
|
"ldap_domain": "mysite.com",
|
|
@@ -71,7 +72,7 @@
|
|
|
71
72
|
* `scim_username` (string): SCIM username.
|
|
72
73
|
* `scim_oauth_access_token` (string): SCIM OAuth Access Token.
|
|
73
74
|
* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
|
|
74
|
-
* `subdomain` (string): Subdomain
|
|
75
|
+
* `subdomain` (string): Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
75
76
|
* `provision_users` (boolean): Auto-provision users?
|
|
76
77
|
* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
|
|
77
78
|
* `deprovision_users` (boolean): Auto-deprovision users?
|
|
@@ -92,6 +93,7 @@
|
|
|
92
93
|
* `provision_time_zone` (string): Default time zone for auto provisioned users.
|
|
93
94
|
* `provision_company` (string): Default company for auto provisioned users.
|
|
94
95
|
* `provision_require_2fa` (string): 2FA required setting for auto provisioned users.
|
|
96
|
+
* `provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
|
|
95
97
|
* `provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
|
|
96
98
|
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
|
97
99
|
* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
|
data/docs/user.md
CHANGED
|
@@ -24,6 +24,7 @@
|
|
|
24
24
|
"disabled": true,
|
|
25
25
|
"disabled_expired_or_inactive": true,
|
|
26
26
|
"email": "john.doe@files.com",
|
|
27
|
+
"filesystem_layout": "site_root",
|
|
27
28
|
"first_login_at": "2000-01-01T01:00:00Z",
|
|
28
29
|
"ftp_permission": true,
|
|
29
30
|
"group_ids": "example",
|
|
@@ -45,6 +46,7 @@
|
|
|
45
46
|
"notes": "Internal notes on this user.",
|
|
46
47
|
"notification_daily_send_time": 18,
|
|
47
48
|
"office_integration_enabled": true,
|
|
49
|
+
"partner_id": 1,
|
|
48
50
|
"password_set_at": "2000-01-01T01:00:00Z",
|
|
49
51
|
"password_validity_days": 1,
|
|
50
52
|
"public_keys_count": 1,
|
|
@@ -93,6 +95,7 @@
|
|
|
93
95
|
* `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
|
|
94
96
|
* `disabled_expired_or_inactive` (boolean): Computed property that returns true if user disabled or expired or inactive.
|
|
95
97
|
* `email` (email): User email address
|
|
98
|
+
* `filesystem_layout` (string): File system layout
|
|
96
99
|
* `first_login_at` (date-time): User's first login time
|
|
97
100
|
* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
|
|
98
101
|
* `group_ids` (string): Comma-separated list of group IDs of which this user is a member
|
|
@@ -114,6 +117,7 @@
|
|
|
114
117
|
* `notes` (string): Any internal notes on the user
|
|
115
118
|
* `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
|
|
116
119
|
* `office_integration_enabled` (boolean): Enable integration with Office for the web?
|
|
120
|
+
* `partner_id` (int64): Partner ID if this user belongs to a Partner
|
|
117
121
|
* `password_set_at` (date-time): Last time the user's password was set
|
|
118
122
|
* `password_validity_days` (int64): Number of days to allow user to use the same password
|
|
119
123
|
* `public_keys_count` (int64): Number of public keys associated with this user
|
|
@@ -213,6 +217,7 @@ Files::User.create(
|
|
|
213
217
|
bypass_site_allowed_ips: false,
|
|
214
218
|
dav_permission: true,
|
|
215
219
|
disabled: true,
|
|
220
|
+
filesystem_layout: "site_root",
|
|
216
221
|
ftp_permission: true,
|
|
217
222
|
header_text: "User-specific message.",
|
|
218
223
|
language: "en",
|
|
@@ -221,6 +226,7 @@ Files::User.create(
|
|
|
221
226
|
company: "ACME Corp.",
|
|
222
227
|
notes: "Internal notes on this user.",
|
|
223
228
|
office_integration_enabled: true,
|
|
229
|
+
partner_id: 1,
|
|
224
230
|
password_validity_days: 1,
|
|
225
231
|
readonly_site_admin: true,
|
|
226
232
|
receive_admin_alerts: true,
|
|
@@ -265,6 +271,7 @@ Files::User.create(
|
|
|
265
271
|
* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
|
|
266
272
|
* `dav_permission` (boolean): Can the user connect with WebDAV?
|
|
267
273
|
* `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
|
|
274
|
+
* `filesystem_layout` (string): File system layout
|
|
268
275
|
* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
|
|
269
276
|
* `header_text` (string): Text to display to the user in the header of the UI
|
|
270
277
|
* `language` (string): Preferred language
|
|
@@ -273,6 +280,7 @@ Files::User.create(
|
|
|
273
280
|
* `company` (string): User's company
|
|
274
281
|
* `notes` (string): Any internal notes on the user
|
|
275
282
|
* `office_integration_enabled` (boolean): Enable integration with Office for the web?
|
|
283
|
+
* `partner_id` (int64): Partner ID if this user belongs to a Partner
|
|
276
284
|
* `password_validity_days` (int64): Number of days to allow user to use the same password
|
|
277
285
|
* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
278
286
|
* `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
|
|
@@ -352,6 +360,7 @@ Files::User.update(id,
|
|
|
352
360
|
bypass_site_allowed_ips: false,
|
|
353
361
|
dav_permission: true,
|
|
354
362
|
disabled: true,
|
|
363
|
+
filesystem_layout: "site_root",
|
|
355
364
|
ftp_permission: true,
|
|
356
365
|
header_text: "User-specific message.",
|
|
357
366
|
language: "en",
|
|
@@ -360,6 +369,7 @@ Files::User.update(id,
|
|
|
360
369
|
company: "ACME Corp.",
|
|
361
370
|
notes: "Internal notes on this user.",
|
|
362
371
|
office_integration_enabled: true,
|
|
372
|
+
partner_id: 1,
|
|
363
373
|
password_validity_days: 1,
|
|
364
374
|
readonly_site_admin: true,
|
|
365
375
|
receive_admin_alerts: true,
|
|
@@ -406,6 +416,7 @@ Files::User.update(id,
|
|
|
406
416
|
* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
|
|
407
417
|
* `dav_permission` (boolean): Can the user connect with WebDAV?
|
|
408
418
|
* `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
|
|
419
|
+
* `filesystem_layout` (string): File system layout
|
|
409
420
|
* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
|
|
410
421
|
* `header_text` (string): Text to display to the user in the header of the UI
|
|
411
422
|
* `language` (string): Preferred language
|
|
@@ -414,6 +425,7 @@ Files::User.update(id,
|
|
|
414
425
|
* `company` (string): User's company
|
|
415
426
|
* `notes` (string): Any internal notes on the user
|
|
416
427
|
* `office_integration_enabled` (boolean): Enable integration with Office for the web?
|
|
428
|
+
* `partner_id` (int64): Partner ID if this user belongs to a Partner
|
|
417
429
|
* `password_validity_days` (int64): Number of days to allow user to use the same password
|
|
418
430
|
* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
419
431
|
* `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
|
|
@@ -518,6 +530,7 @@ user.update(
|
|
|
518
530
|
bypass_site_allowed_ips: false,
|
|
519
531
|
dav_permission: true,
|
|
520
532
|
disabled: true,
|
|
533
|
+
filesystem_layout: "site_root",
|
|
521
534
|
ftp_permission: true,
|
|
522
535
|
header_text: "User-specific message.",
|
|
523
536
|
language: "en",
|
|
@@ -526,6 +539,7 @@ user.update(
|
|
|
526
539
|
company: "ACME Corp.",
|
|
527
540
|
notes: "Internal notes on this user.",
|
|
528
541
|
office_integration_enabled: true,
|
|
542
|
+
partner_id: 1,
|
|
529
543
|
password_validity_days: 1,
|
|
530
544
|
readonly_site_admin: true,
|
|
531
545
|
receive_admin_alerts: true,
|
|
@@ -572,6 +586,7 @@ user.update(
|
|
|
572
586
|
* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
|
|
573
587
|
* `dav_permission` (boolean): Can the user connect with WebDAV?
|
|
574
588
|
* `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
|
|
589
|
+
* `filesystem_layout` (string): File system layout
|
|
575
590
|
* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
|
|
576
591
|
* `header_text` (string): Text to display to the user in the header of the UI
|
|
577
592
|
* `language` (string): Preferred language
|
|
@@ -580,6 +595,7 @@ user.update(
|
|
|
580
595
|
* `company` (string): User's company
|
|
581
596
|
* `notes` (string): Any internal notes on the user
|
|
582
597
|
* `office_integration_enabled` (boolean): Enable integration with Office for the web?
|
|
598
|
+
* `partner_id` (int64): Partner ID if this user belongs to a Partner
|
|
583
599
|
* `password_validity_days` (int64): Number of days to allow user to use the same password
|
|
584
600
|
* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
585
601
|
* `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class Partner
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
13
|
+
def allow_bypassing_2fa_policies
|
|
14
|
+
@attributes[:allow_bypassing_2fa_policies]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def allow_bypassing_2fa_policies=(value)
|
|
18
|
+
@attributes[:allow_bypassing_2fa_policies] = value
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
22
|
+
def allow_credential_changes
|
|
23
|
+
@attributes[:allow_credential_changes]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def allow_credential_changes=(value)
|
|
27
|
+
@attributes[:allow_credential_changes] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# boolean - Allow Partner Admins to create users.
|
|
31
|
+
def allow_user_creation
|
|
32
|
+
@attributes[:allow_user_creation]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def allow_user_creation=(value)
|
|
36
|
+
@attributes[:allow_user_creation] = value
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# int64 - The unique ID of the Partner.
|
|
40
|
+
def id
|
|
41
|
+
@attributes[:id]
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def id=(value)
|
|
45
|
+
@attributes[:id] = value
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# string - The name of the Partner.
|
|
49
|
+
def name
|
|
50
|
+
@attributes[:name]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def name=(value)
|
|
54
|
+
@attributes[:name] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - Notes about this Partner.
|
|
58
|
+
def notes
|
|
59
|
+
@attributes[:notes]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def notes=(value)
|
|
63
|
+
@attributes[:notes] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# string - The root folder path for this Partner.
|
|
67
|
+
def root_folder
|
|
68
|
+
@attributes[:root_folder]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def root_folder=(value)
|
|
72
|
+
@attributes[:root_folder] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Parameters:
|
|
76
|
+
# allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
77
|
+
# allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
78
|
+
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
79
|
+
# name - string - The name of the Partner.
|
|
80
|
+
# notes - string - Notes about this Partner.
|
|
81
|
+
# root_folder - string - The root folder path for this Partner.
|
|
82
|
+
def update(params = {})
|
|
83
|
+
params ||= {}
|
|
84
|
+
params[:id] = @attributes[:id]
|
|
85
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
86
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
87
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
88
|
+
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
89
|
+
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
90
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
91
|
+
|
|
92
|
+
Api.send_request("/partners/#{@attributes[:id]}", :patch, params, @options)
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
def delete(params = {})
|
|
96
|
+
params ||= {}
|
|
97
|
+
params[:id] = @attributes[:id]
|
|
98
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
99
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
100
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
101
|
+
|
|
102
|
+
Api.send_request("/partners/#{@attributes[:id]}", :delete, params, @options)
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
def destroy(params = {})
|
|
106
|
+
delete(params)
|
|
107
|
+
nil
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
def save
|
|
111
|
+
if @attributes[:id]
|
|
112
|
+
new_obj = update(@attributes)
|
|
113
|
+
else
|
|
114
|
+
new_obj = Partner.create(@attributes, @options)
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
@attributes = new_obj.attributes
|
|
118
|
+
true
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Parameters:
|
|
122
|
+
# 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.
|
|
123
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
124
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
|
|
125
|
+
def self.list(params = {}, options = {})
|
|
126
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
127
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
128
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
129
|
+
|
|
130
|
+
List.new(Partner, params) do
|
|
131
|
+
Api.send_request("/partners", :get, params, options)
|
|
132
|
+
end
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
def self.all(params = {}, options = {})
|
|
136
|
+
list(params, options)
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Parameters:
|
|
140
|
+
# id (required) - int64 - Partner ID.
|
|
141
|
+
def self.find(id, params = {}, options = {})
|
|
142
|
+
params ||= {}
|
|
143
|
+
params[:id] = id
|
|
144
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
145
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
146
|
+
|
|
147
|
+
response, options = Api.send_request("/partners/#{params[:id]}", :get, params, options)
|
|
148
|
+
Partner.new(response.data, options)
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
def self.get(id, params = {}, options = {})
|
|
152
|
+
find(id, params, options)
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# Parameters:
|
|
156
|
+
# allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
157
|
+
# allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
158
|
+
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
159
|
+
# name - string - The name of the Partner.
|
|
160
|
+
# notes - string - Notes about this Partner.
|
|
161
|
+
# root_folder - string - The root folder path for this Partner.
|
|
162
|
+
def self.create(params = {}, options = {})
|
|
163
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
164
|
+
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
165
|
+
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
166
|
+
|
|
167
|
+
response, options = Api.send_request("/partners", :post, params, options)
|
|
168
|
+
Partner.new(response.data, options)
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Parameters:
|
|
172
|
+
# allow_bypassing_2fa_policies - boolean - Allow users created under this Partner to bypass Two-Factor Authentication policies.
|
|
173
|
+
# allow_credential_changes - boolean - Allow Partner Admins to change or reset credentials for users belonging to this Partner.
|
|
174
|
+
# allow_user_creation - boolean - Allow Partner Admins to create users.
|
|
175
|
+
# name - string - The name of the Partner.
|
|
176
|
+
# notes - string - Notes about this Partner.
|
|
177
|
+
# root_folder - string - The root folder path for this Partner.
|
|
178
|
+
def self.update(id, params = {}, options = {})
|
|
179
|
+
params ||= {}
|
|
180
|
+
params[:id] = id
|
|
181
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
182
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
183
|
+
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
184
|
+
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
185
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
186
|
+
|
|
187
|
+
response, options = Api.send_request("/partners/#{params[:id]}", :patch, params, options)
|
|
188
|
+
Partner.new(response.data, options)
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
def self.delete(id, params = {}, options = {})
|
|
192
|
+
params ||= {}
|
|
193
|
+
params[:id] = id
|
|
194
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
195
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
196
|
+
|
|
197
|
+
Api.send_request("/partners/#{params[:id]}", :delete, params, options)
|
|
198
|
+
nil
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
def self.destroy(id, params = {}, options = {})
|
|
202
|
+
delete(id, params, options)
|
|
203
|
+
nil
|
|
204
|
+
end
|
|
205
|
+
end
|
|
206
|
+
end
|
|
@@ -63,6 +63,15 @@ module Files
|
|
|
63
63
|
@attributes[:group_name] = value
|
|
64
64
|
end
|
|
65
65
|
|
|
66
|
+
# int64 - Partner ID (if applicable)
|
|
67
|
+
def partner_id
|
|
68
|
+
@attributes[:partner_id]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def partner_id=(value)
|
|
72
|
+
@attributes[:partner_id] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
66
75
|
# string - Permission type. See the table referenced in the documentation for an explanation of each permission.
|
|
67
76
|
def permission
|
|
68
77
|
@attributes[:permission]
|
|
@@ -119,12 +128,13 @@ module Files
|
|
|
119
128
|
# Parameters:
|
|
120
129
|
# 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.
|
|
121
130
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
122
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path`, `user_id` or `id`.
|
|
123
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]`, `[ user_id, group_id ]` or `[ user_id, group_id, path ]`.
|
|
131
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path`, `user_id`, `partner_id` or `id`.
|
|
132
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id`, `partner_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ partner_id, path ]`, `[ user_id, path ]`, `[ user_id, group_id ]`, `[ user_id, group_id, path ]`, `[ user_id, group_id, partner_id ]` or `[ user_id, group_id, partner_id, path ]`.
|
|
124
133
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
|
125
134
|
# path - string - Permission path. If provided, will scope all permissions(including upward) to this path.
|
|
126
135
|
# include_groups - boolean - If searching by user or group, also include user's permissions that are inherited from its groups?
|
|
127
136
|
# group_id - string
|
|
137
|
+
# partner_id - string
|
|
128
138
|
# user_id - string
|
|
129
139
|
def self.list(params = {}, options = {})
|
|
130
140
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -134,6 +144,7 @@ module Files
|
|
|
134
144
|
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
|
135
145
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
136
146
|
raise InvalidParameterError.new("Bad parameter: group_id must be an String") if params[:group_id] and !params[:group_id].is_a?(String)
|
|
147
|
+
raise InvalidParameterError.new("Bad parameter: partner_id must be an String") if params[:partner_id] and !params[:partner_id].is_a?(String)
|
|
137
148
|
raise InvalidParameterError.new("Bad parameter: user_id must be an String") if params[:user_id] and !params[:user_id].is_a?(String)
|
|
138
149
|
|
|
139
150
|
List.new(Permission, params) do
|
|
@@ -150,6 +161,7 @@ module Files
|
|
|
150
161
|
# group_id - int64 - Group ID. Provide `group_name` or `group_id`
|
|
151
162
|
# permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
|
152
163
|
# recursive - boolean - Apply to subfolders recursively?
|
|
164
|
+
# partner_id - int64 - Partner ID if this Permission belongs to a partner.
|
|
153
165
|
# user_id - int64 - User ID. Provide `username` or `user_id`
|
|
154
166
|
# username - string - User username. Provide `username` or `user_id`
|
|
155
167
|
# group_name - string - Group name. Provide `group_name` or `group_id`
|
|
@@ -158,6 +170,7 @@ module Files
|
|
|
158
170
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
159
171
|
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
|
|
160
172
|
raise InvalidParameterError.new("Bad parameter: permission must be an String") if params[:permission] and !params[:permission].is_a?(String)
|
|
173
|
+
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
161
174
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
162
175
|
raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
|
|
163
176
|
raise InvalidParameterError.new("Bad parameter: group_name must be an String") if params[:group_name] and !params[:group_name].is_a?(String)
|
|
@@ -89,7 +89,7 @@ module Files
|
|
|
89
89
|
@attributes[:scim_oauth_access_token_expires_at]
|
|
90
90
|
end
|
|
91
91
|
|
|
92
|
-
# string - Subdomain
|
|
92
|
+
# string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
|
93
93
|
def subdomain
|
|
94
94
|
@attributes[:subdomain]
|
|
95
95
|
end
|
|
@@ -194,6 +194,11 @@ module Files
|
|
|
194
194
|
@attributes[:provision_require_2fa]
|
|
195
195
|
end
|
|
196
196
|
|
|
197
|
+
# string - File System layout to use for auto provisioned users.
|
|
198
|
+
def provision_filesystem_layout
|
|
199
|
+
@attributes[:provision_filesystem_layout]
|
|
200
|
+
end
|
|
201
|
+
|
|
197
202
|
# string - URL-friendly, unique identifier for Azure SAML configuration
|
|
198
203
|
def provider_identifier
|
|
199
204
|
@attributes[:provider_identifier]
|
|
@@ -167,6 +167,15 @@ module Files
|
|
|
167
167
|
@attributes[:email] = value
|
|
168
168
|
end
|
|
169
169
|
|
|
170
|
+
# string - File system layout
|
|
171
|
+
def filesystem_layout
|
|
172
|
+
@attributes[:filesystem_layout]
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
def filesystem_layout=(value)
|
|
176
|
+
@attributes[:filesystem_layout] = value
|
|
177
|
+
end
|
|
178
|
+
|
|
170
179
|
# date-time - User's first login time
|
|
171
180
|
def first_login_at
|
|
172
181
|
@attributes[:first_login_at]
|
|
@@ -356,6 +365,15 @@ module Files
|
|
|
356
365
|
@attributes[:office_integration_enabled] = value
|
|
357
366
|
end
|
|
358
367
|
|
|
368
|
+
# int64 - Partner ID if this user belongs to a Partner
|
|
369
|
+
def partner_id
|
|
370
|
+
@attributes[:partner_id]
|
|
371
|
+
end
|
|
372
|
+
|
|
373
|
+
def partner_id=(value)
|
|
374
|
+
@attributes[:partner_id] = value
|
|
375
|
+
end
|
|
376
|
+
|
|
359
377
|
# date-time - Last time the user's password was set
|
|
360
378
|
def password_set_at
|
|
361
379
|
@attributes[:password_set_at]
|
|
@@ -753,6 +771,7 @@ module Files
|
|
|
753
771
|
# bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists?
|
|
754
772
|
# dav_permission - boolean - Can the user connect with WebDAV?
|
|
755
773
|
# disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
|
|
774
|
+
# filesystem_layout - string - File system layout
|
|
756
775
|
# ftp_permission - boolean - Can the user access with FTP/FTPS?
|
|
757
776
|
# header_text - string - Text to display to the user in the header of the UI
|
|
758
777
|
# language - string - Preferred language
|
|
@@ -761,6 +780,7 @@ module Files
|
|
|
761
780
|
# company - string - User's company
|
|
762
781
|
# notes - string - Any internal notes on the user
|
|
763
782
|
# office_integration_enabled - boolean - Enable integration with Office for the web?
|
|
783
|
+
# partner_id - int64 - Partner ID if this user belongs to a Partner
|
|
764
784
|
# password_validity_days - int64 - Number of days to allow user to use the same password
|
|
765
785
|
# readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
766
786
|
# receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
|
|
@@ -797,12 +817,14 @@ module Files
|
|
|
797
817
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
798
818
|
raise InvalidParameterError.new("Bad parameter: authenticate_until must be an String") if params[:authenticate_until] and !params[:authenticate_until].is_a?(String)
|
|
799
819
|
raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
|
|
820
|
+
raise InvalidParameterError.new("Bad parameter: filesystem_layout must be an String") if params[:filesystem_layout] and !params[:filesystem_layout].is_a?(String)
|
|
800
821
|
raise InvalidParameterError.new("Bad parameter: header_text must be an String") if params[:header_text] and !params[:header_text].is_a?(String)
|
|
801
822
|
raise InvalidParameterError.new("Bad parameter: language must be an String") if params[:language] and !params[:language].is_a?(String)
|
|
802
823
|
raise InvalidParameterError.new("Bad parameter: notification_daily_send_time must be an Integer") if params[:notification_daily_send_time] and !params[:notification_daily_send_time].is_a?(Integer)
|
|
803
824
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
804
825
|
raise InvalidParameterError.new("Bad parameter: company must be an String") if params[:company] and !params[:company].is_a?(String)
|
|
805
826
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
827
|
+
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
806
828
|
raise InvalidParameterError.new("Bad parameter: password_validity_days must be an Integer") if params[:password_validity_days] and !params[:password_validity_days].is_a?(Integer)
|
|
807
829
|
raise InvalidParameterError.new("Bad parameter: require_login_by must be an String") if params[:require_login_by] and !params[:require_login_by].is_a?(String)
|
|
808
830
|
raise InvalidParameterError.new("Bad parameter: ssl_required must be an String") if params[:ssl_required] and !params[:ssl_required].is_a?(String)
|
|
@@ -919,6 +941,7 @@ module Files
|
|
|
919
941
|
# bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists?
|
|
920
942
|
# dav_permission - boolean - Can the user connect with WebDAV?
|
|
921
943
|
# disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
|
|
944
|
+
# filesystem_layout - string - File system layout
|
|
922
945
|
# ftp_permission - boolean - Can the user access with FTP/FTPS?
|
|
923
946
|
# header_text - string - Text to display to the user in the header of the UI
|
|
924
947
|
# language - string - Preferred language
|
|
@@ -927,6 +950,7 @@ module Files
|
|
|
927
950
|
# company - string - User's company
|
|
928
951
|
# notes - string - Any internal notes on the user
|
|
929
952
|
# office_integration_enabled - boolean - Enable integration with Office for the web?
|
|
953
|
+
# partner_id - int64 - Partner ID if this user belongs to a Partner
|
|
930
954
|
# password_validity_days - int64 - Number of days to allow user to use the same password
|
|
931
955
|
# readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
932
956
|
# receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
|
|
@@ -958,12 +982,14 @@ module Files
|
|
|
958
982
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
959
983
|
raise InvalidParameterError.new("Bad parameter: authenticate_until must be an String") if params[:authenticate_until] and !params[:authenticate_until].is_a?(String)
|
|
960
984
|
raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
|
|
985
|
+
raise InvalidParameterError.new("Bad parameter: filesystem_layout must be an String") if params[:filesystem_layout] and !params[:filesystem_layout].is_a?(String)
|
|
961
986
|
raise InvalidParameterError.new("Bad parameter: header_text must be an String") if params[:header_text] and !params[:header_text].is_a?(String)
|
|
962
987
|
raise InvalidParameterError.new("Bad parameter: language must be an String") if params[:language] and !params[:language].is_a?(String)
|
|
963
988
|
raise InvalidParameterError.new("Bad parameter: notification_daily_send_time must be an Integer") if params[:notification_daily_send_time] and !params[:notification_daily_send_time].is_a?(Integer)
|
|
964
989
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
965
990
|
raise InvalidParameterError.new("Bad parameter: company must be an String") if params[:company] and !params[:company].is_a?(String)
|
|
966
991
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
992
|
+
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
967
993
|
raise InvalidParameterError.new("Bad parameter: password_validity_days must be an Integer") if params[:password_validity_days] and !params[:password_validity_days].is_a?(Integer)
|
|
968
994
|
raise InvalidParameterError.new("Bad parameter: require_login_by must be an String") if params[:require_login_by] and !params[:require_login_by].is_a?(String)
|
|
969
995
|
raise InvalidParameterError.new("Bad parameter: ssl_required must be an String") if params[:ssl_required] and !params[:ssl_required].is_a?(String)
|
|
@@ -1034,6 +1060,7 @@ module Files
|
|
|
1034
1060
|
# bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists?
|
|
1035
1061
|
# dav_permission - boolean - Can the user connect with WebDAV?
|
|
1036
1062
|
# disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
|
|
1063
|
+
# filesystem_layout - string - File system layout
|
|
1037
1064
|
# ftp_permission - boolean - Can the user access with FTP/FTPS?
|
|
1038
1065
|
# header_text - string - Text to display to the user in the header of the UI
|
|
1039
1066
|
# language - string - Preferred language
|
|
@@ -1042,6 +1069,7 @@ module Files
|
|
|
1042
1069
|
# company - string - User's company
|
|
1043
1070
|
# notes - string - Any internal notes on the user
|
|
1044
1071
|
# office_integration_enabled - boolean - Enable integration with Office for the web?
|
|
1072
|
+
# partner_id - int64 - Partner ID if this user belongs to a Partner
|
|
1045
1073
|
# password_validity_days - int64 - Number of days to allow user to use the same password
|
|
1046
1074
|
# readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
|
|
1047
1075
|
# receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
|
|
@@ -1077,12 +1105,14 @@ module Files
|
|
|
1077
1105
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
1078
1106
|
raise InvalidParameterError.new("Bad parameter: authenticate_until must be an String") if params[:authenticate_until] and !params[:authenticate_until].is_a?(String)
|
|
1079
1107
|
raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
|
|
1108
|
+
raise InvalidParameterError.new("Bad parameter: filesystem_layout must be an String") if params[:filesystem_layout] and !params[:filesystem_layout].is_a?(String)
|
|
1080
1109
|
raise InvalidParameterError.new("Bad parameter: header_text must be an String") if params[:header_text] and !params[:header_text].is_a?(String)
|
|
1081
1110
|
raise InvalidParameterError.new("Bad parameter: language must be an String") if params[:language] and !params[:language].is_a?(String)
|
|
1082
1111
|
raise InvalidParameterError.new("Bad parameter: notification_daily_send_time must be an Integer") if params[:notification_daily_send_time] and !params[:notification_daily_send_time].is_a?(Integer)
|
|
1083
1112
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
1084
1113
|
raise InvalidParameterError.new("Bad parameter: company must be an String") if params[:company] and !params[:company].is_a?(String)
|
|
1085
1114
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
1115
|
+
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
1086
1116
|
raise InvalidParameterError.new("Bad parameter: password_validity_days must be an Integer") if params[:password_validity_days] and !params[:password_validity_days].is_a?(Integer)
|
|
1087
1117
|
raise InvalidParameterError.new("Bad parameter: require_login_by must be an String") if params[:require_login_by] and !params[:require_login_by].is_a?(String)
|
|
1088
1118
|
raise InvalidParameterError.new("Bad parameter: ssl_required must be an String") if params[:ssl_required] and !params[:ssl_required].is_a?(String)
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
|
@@ -96,6 +96,7 @@ require "files.com/models/message_comment_reaction"
|
|
|
96
96
|
require "files.com/models/message_reaction"
|
|
97
97
|
require "files.com/models/notification"
|
|
98
98
|
require "files.com/models/outbound_connection_log"
|
|
99
|
+
require "files.com/models/partner"
|
|
99
100
|
require "files.com/models/payment"
|
|
100
101
|
require "files.com/models/payment_line_item"
|
|
101
102
|
require "files.com/models/permission"
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: files.com
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.1.
|
|
4
|
+
version: 1.1.335
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-10-
|
|
11
|
+
date: 2025-10-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|
|
@@ -221,6 +221,7 @@ files:
|
|
|
221
221
|
- docs/message_reaction.md
|
|
222
222
|
- docs/notification.md
|
|
223
223
|
- docs/outbound_connection_log.md
|
|
224
|
+
- docs/partner.md
|
|
224
225
|
- docs/payment.md
|
|
225
226
|
- docs/payment_line_item.md
|
|
226
227
|
- docs/permission.md
|
|
@@ -334,6 +335,7 @@ files:
|
|
|
334
335
|
- lib/files.com/models/message_reaction.rb
|
|
335
336
|
- lib/files.com/models/notification.rb
|
|
336
337
|
- lib/files.com/models/outbound_connection_log.rb
|
|
338
|
+
- lib/files.com/models/partner.rb
|
|
337
339
|
- lib/files.com/models/payment.rb
|
|
338
340
|
- lib/files.com/models/payment_line_item.rb
|
|
339
341
|
- lib/files.com/models/permission.rb
|