files.com 1.0.16 → 1.0.17
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/account_line_item.md +3 -3
- data/docs/action.md +1 -1
- data/docs/api_key.md +6 -6
- data/docs/bundle.md +3 -3
- data/docs/file.md +6 -6
- data/docs/folder.md +2 -2
- data/docs/history.md +1 -1
- data/docs/invoice.md +3 -3
- data/docs/invoice_line_item.md +4 -4
- data/docs/payment.md +21 -3
- data/docs/payment_line_item.md +2 -2
- data/docs/project.md +15 -3
- data/docs/public_key.md +1 -1
- data/docs/site.md +7 -7
- data/docs/sso_strategy.md +0 -189
- data/docs/usage_snapshot.md +4 -4
- data/docs/user.md +8 -8
- data/docs/user_cipher_use.md +2 -2
- data/lib/files.com.rb +1 -0
- data/lib/files.com/models/payment.rb +17 -0
- data/lib/files.com/models/project.rb +22 -7
- data/lib/files.com/models/sso_strategy.rb +0 -310
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 04423a3de6bfbfe3477fe46d18c3d9e8ef07eff99d848689d5f918adb36f4b6b
|
4
|
+
data.tar.gz: f4b4a3ec19dc7c7d767d6f0d4b0df16b2f8a06add70dbf7f9a189f9251c4542c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 302d85e9814224c3f75ef3a44affaeeb1be13557f28a2b414896e11a3c299963127211ac34b2e1bc0ee76d199cec3e35f6c39a620efb958eac9d79d4cc6b1c52
|
7
|
+
data.tar.gz: a081b0527dbd36c7f5265e2347bf468e23b23876867af6fe81058c311b3800347d76ac721fdfce4bd5659c50565376d934b190c4e259ee4edd384ff21af8b7fa
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.17
|
data/docs/account_line_item.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
"id": 1,
|
8
8
|
"amount": "",
|
9
9
|
"balance": "",
|
10
|
-
"created_at": "2000-01-
|
10
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"currency": "USD",
|
12
12
|
"download_uri": "https://url...",
|
13
13
|
"invoice_line_items": [
|
@@ -17,11 +17,11 @@
|
|
17
17
|
"payment_line_items": [
|
18
18
|
|
19
19
|
],
|
20
|
-
"payment_reversed_at": "2000-01-
|
20
|
+
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
21
21
|
"payment_type": "",
|
22
22
|
"site_name": "My Site",
|
23
23
|
"type": "invoice",
|
24
|
-
"updated_at": "2000-01-
|
24
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
25
25
|
}
|
26
26
|
```
|
27
27
|
|
data/docs/action.md
CHANGED
data/docs/api_key.md
CHANGED
@@ -6,10 +6,10 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
|
9
|
-
"created_at": "2000-01-
|
10
|
-
"expires_at": "2000-01-
|
9
|
+
"created_at": "2000-01-01T01:00:00Z",
|
10
|
+
"expires_at": "2000-01-01T01:00:00Z",
|
11
11
|
"key": "[key]",
|
12
|
-
"last_use_at": "2000-01-
|
12
|
+
"last_use_at": "2000-01-01T01:00:00Z",
|
13
13
|
"name": "My Main API Key",
|
14
14
|
"permission_set": "full",
|
15
15
|
"platform": "win32",
|
@@ -80,7 +80,7 @@ Files::ApiKey.create(
|
|
80
80
|
user_id: 1,
|
81
81
|
name: "My Key",
|
82
82
|
permission_set: "full",
|
83
|
-
expires_at: "2000-01-
|
83
|
+
expires_at: "2000-01-01T01:00:00Z"
|
84
84
|
)
|
85
85
|
```
|
86
86
|
|
@@ -100,7 +100,7 @@ Files::ApiKey.create(
|
|
100
100
|
Files::ApiKey.update(
|
101
101
|
name: "My Key",
|
102
102
|
permission_set: "full",
|
103
|
-
expires_at: "2000-01-
|
103
|
+
expires_at: "2000-01-01T01:00:00Z"
|
104
104
|
)
|
105
105
|
```
|
106
106
|
|
@@ -129,7 +129,7 @@ api_key = Files::ApiKey.find(1)
|
|
129
129
|
api_key.update(
|
130
130
|
name: "My Key",
|
131
131
|
permission_set: "full",
|
132
|
-
expires_at: "2000-01-
|
132
|
+
expires_at: "2000-01-01T01:00:00Z"
|
133
133
|
)
|
134
134
|
```
|
135
135
|
|
data/docs/bundle.md
CHANGED
@@ -6,9 +6,9 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"code": "abc123",
|
9
|
-
"created_at": "2000-01-
|
9
|
+
"created_at": "2000-01-01T01:00:00Z",
|
10
10
|
"description": "The public description of the bundle.",
|
11
|
-
"expires_at": "2000-01-
|
11
|
+
"expires_at": "2000-01-01T01:00:00Z",
|
12
12
|
"paths": [
|
13
13
|
|
14
14
|
],
|
@@ -76,7 +76,7 @@ Files::Bundle.create(
|
|
76
76
|
user_id: 1,
|
77
77
|
paths: ["file.txt"],
|
78
78
|
password: "Password",
|
79
|
-
expires_at: "2000-01-
|
79
|
+
expires_at: "2000-01-01T01:00:00Z",
|
80
80
|
description: "Public description",
|
81
81
|
note: "Internal Note"
|
82
82
|
)
|
data/docs/file.md
CHANGED
@@ -12,8 +12,8 @@ may places where a Ruby File object can be used.
|
|
12
12
|
"display_name": "file.txt",
|
13
13
|
"type": "file",
|
14
14
|
"size": 1024,
|
15
|
-
"mtime": "2000-01-
|
16
|
-
"provided_mtime": "2000-01-
|
15
|
+
"mtime": "2000-01-01T01:00:00Z",
|
16
|
+
"provided_mtime": "2000-01-01T01:00:00Z",
|
17
17
|
"crc32": "70976923",
|
18
18
|
"md5": "17c54824e9931a4688ca032d03f6663c",
|
19
19
|
"mime_type": "application/octet-stream",
|
@@ -84,7 +84,7 @@ Files::File.create(path,
|
|
84
84
|
mkdir_parents: true,
|
85
85
|
part: 1,
|
86
86
|
parts: 1,
|
87
|
-
provided_mtime: "2000-01-
|
87
|
+
provided_mtime: "2000-01-01T01:00:00Z",
|
88
88
|
restart: 1,
|
89
89
|
size: 1,
|
90
90
|
with_rename: true
|
@@ -115,7 +115,7 @@ Files::File.create(path,
|
|
115
115
|
|
116
116
|
```
|
117
117
|
Files::File.update(path,
|
118
|
-
provided_mtime: "2000-01-
|
118
|
+
provided_mtime: "2000-01-01T01:00:00Z",
|
119
119
|
priority_color: "red"
|
120
120
|
)
|
121
121
|
```
|
@@ -174,7 +174,7 @@ file.create(
|
|
174
174
|
mkdir_parents: true,
|
175
175
|
part: 1,
|
176
176
|
parts: 1,
|
177
|
-
provided_mtime: "2000-01-
|
177
|
+
provided_mtime: "2000-01-01T01:00:00Z",
|
178
178
|
restart: 1,
|
179
179
|
size: 1,
|
180
180
|
with_rename: true
|
@@ -206,7 +206,7 @@ file.create(
|
|
206
206
|
```
|
207
207
|
file = Files::File.find(1)
|
208
208
|
file.update(
|
209
|
-
provided_mtime: "2000-01-
|
209
|
+
provided_mtime: "2000-01-01T01:00:00Z",
|
210
210
|
priority_color: "red"
|
211
211
|
)
|
212
212
|
```
|
data/docs/folder.md
CHANGED
@@ -14,8 +14,8 @@ Files::Dir is an alias of Files::Folder
|
|
14
14
|
"display_name": "file.txt",
|
15
15
|
"type": "file",
|
16
16
|
"size": 1024,
|
17
|
-
"mtime": "2000-01-
|
18
|
-
"provided_mtime": "2000-01-
|
17
|
+
"mtime": "2000-01-01T01:00:00Z",
|
18
|
+
"provided_mtime": "2000-01-01T01:00:00Z",
|
19
19
|
"crc32": "70976923",
|
20
20
|
"md5": "17c54824e9931a4688ca032d03f6663c",
|
21
21
|
"mime_type": "application/octet-stream",
|
data/docs/history.md
CHANGED
data/docs/invoice.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
"id": 1,
|
8
8
|
"amount": "",
|
9
9
|
"balance": "",
|
10
|
-
"created_at": "2000-01-
|
10
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"currency": "USD",
|
12
12
|
"download_uri": "https://url...",
|
13
13
|
"invoice_line_items": [
|
@@ -17,11 +17,11 @@
|
|
17
17
|
"payment_line_items": [
|
18
18
|
|
19
19
|
],
|
20
|
-
"payment_reversed_at": "2000-01-
|
20
|
+
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
21
21
|
"payment_type": "",
|
22
22
|
"site_name": "My Site",
|
23
23
|
"type": "invoice",
|
24
|
-
"updated_at": "2000-01-
|
24
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
25
25
|
}
|
26
26
|
```
|
27
27
|
|
data/docs/invoice_line_item.md
CHANGED
@@ -5,12 +5,12 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"amount": "",
|
8
|
-
"created_at": "2000-01-
|
8
|
+
"created_at": "2000-01-01T01:00:00Z",
|
9
9
|
"description": "Service from 2019-01-01 through 2019-12-31",
|
10
10
|
"type": "invoice",
|
11
|
-
"service_end_at": "2000-01-
|
12
|
-
"service_start_at": "2000-01-
|
13
|
-
"updated_at": "2000-01-
|
11
|
+
"service_end_at": "2000-01-01T01:00:00Z",
|
12
|
+
"service_start_at": "2000-01-01T01:00:00Z",
|
13
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
14
14
|
"plan": "Enterprise",
|
15
15
|
"site": "My site"
|
16
16
|
}
|
data/docs/payment.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
"id": 1,
|
8
8
|
"amount": "",
|
9
9
|
"balance": "",
|
10
|
-
"created_at": "2000-01-
|
10
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"currency": "USD",
|
12
12
|
"download_uri": "https://url...",
|
13
13
|
"invoice_line_items": [
|
@@ -17,11 +17,11 @@
|
|
17
17
|
"payment_line_items": [
|
18
18
|
|
19
19
|
],
|
20
|
-
"payment_reversed_at": "2000-01-
|
20
|
+
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
21
21
|
"payment_type": "",
|
22
22
|
"site_name": "My Site",
|
23
23
|
"type": "invoice",
|
24
|
-
"updated_at": "2000-01-
|
24
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
25
25
|
}
|
26
26
|
```
|
27
27
|
|
@@ -41,6 +41,24 @@
|
|
41
41
|
* `updated_at` (date-time): Line item updated at
|
42
42
|
|
43
43
|
|
44
|
+
---
|
45
|
+
|
46
|
+
## List Payments
|
47
|
+
|
48
|
+
```
|
49
|
+
Files::Payment.list(
|
50
|
+
page: 1,
|
51
|
+
per_page: 1
|
52
|
+
)
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
* `page` (int64): Current page number.
|
58
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
59
|
+
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
60
|
+
|
61
|
+
|
44
62
|
---
|
45
63
|
|
46
64
|
## Show Payment
|
data/docs/payment_line_item.md
CHANGED
data/docs/project.md
CHANGED
@@ -15,10 +15,10 @@
|
|
15
15
|
|
16
16
|
---
|
17
17
|
|
18
|
-
## List Projects
|
18
|
+
## List Projects
|
19
19
|
|
20
20
|
```
|
21
|
-
Files::Project.
|
21
|
+
Files::Project.list(
|
22
22
|
page: 1,
|
23
23
|
per_page: 1
|
24
24
|
)
|
@@ -29,7 +29,19 @@ Files::Project.list_for(path,
|
|
29
29
|
* `page` (int64): Current page number.
|
30
30
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
31
31
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
32
|
-
|
32
|
+
|
33
|
+
|
34
|
+
---
|
35
|
+
|
36
|
+
## Show Project
|
37
|
+
|
38
|
+
```
|
39
|
+
Files::Project.find(id)
|
40
|
+
```
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
* `id` (int64): Required - Project ID.
|
33
45
|
|
34
46
|
|
35
47
|
---
|
data/docs/public_key.md
CHANGED
data/docs/site.md
CHANGED
@@ -20,7 +20,7 @@
|
|
20
20
|
"color2_text": "#0066a7",
|
21
21
|
"color2_top": "#000000",
|
22
22
|
"color2_top_text": "#ffffff",
|
23
|
-
"created_at": "2000-01-
|
23
|
+
"created_at": "2000-01-01T01:00:00Z",
|
24
24
|
"currency": "USD",
|
25
25
|
"custom_namespace": true,
|
26
26
|
"days_to_retain_backups": 30,
|
@@ -38,7 +38,7 @@
|
|
38
38
|
"icon16": "",
|
39
39
|
"icon32": "",
|
40
40
|
"icon48": "",
|
41
|
-
"immutable_files_set_at": "2000-01-
|
41
|
+
"immutable_files_set_at": "2000-01-01T01:00:00Z",
|
42
42
|
"include_password_in_welcome_email": true,
|
43
43
|
"language": "en",
|
44
44
|
"ldap_base_dn": "",
|
@@ -63,7 +63,7 @@
|
|
63
63
|
"next_billing_amount": "",
|
64
64
|
"next_billing_date": "Apr 20",
|
65
65
|
"opt_out_global": true,
|
66
|
-
"overage_notified_at": "2000-01-
|
66
|
+
"overage_notified_at": "2000-01-01T01:00:00Z",
|
67
67
|
"overage_notify": true,
|
68
68
|
"overdue": true,
|
69
69
|
"password_min_length": 1,
|
@@ -75,7 +75,7 @@
|
|
75
75
|
"password_validity_days": 1,
|
76
76
|
"phone": "555-555-5555",
|
77
77
|
"require_2fa": true,
|
78
|
-
"require_2fa_stop_time": "2000-01-
|
78
|
+
"require_2fa_stop_time": "2000-01-01T01:00:00Z",
|
79
79
|
"require_2fa_user_type": "`site_admins`",
|
80
80
|
"session": "",
|
81
81
|
"session_pinned_by_ip": true,
|
@@ -91,11 +91,11 @@
|
|
91
91
|
"session_expiry": 6,
|
92
92
|
"ssl_required": true,
|
93
93
|
"subdomain": "mysite",
|
94
|
-
"switch_to_plan_date": "2000-01-
|
94
|
+
"switch_to_plan_date": "2000-01-01T01:00:00Z",
|
95
95
|
"tls_disabled": true,
|
96
96
|
"trial_days_left": 1,
|
97
|
-
"trial_until": "2000-01-
|
98
|
-
"updated_at": "2000-01-
|
97
|
+
"trial_until": "2000-01-01T01:00:00Z",
|
98
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
99
99
|
"use_provided_modified_at": true,
|
100
100
|
"user": "",
|
101
101
|
"user_lockout": true,
|
data/docs/sso_strategy.md
CHANGED
@@ -51,9 +51,6 @@
|
|
51
51
|
* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
|
52
52
|
* `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
|
53
53
|
* `provision_time_zone` (string): Default time zone for auto provisioned users.
|
54
|
-
* `client_id` (string): OAuth Client ID for your auth provider.
|
55
|
-
* `client_secret` (string): OAuth Client Secret for your auth provider.
|
56
|
-
* `scim_password` (string): Password for scim integration if using basic auth
|
57
54
|
|
58
55
|
|
59
56
|
---
|
@@ -85,189 +82,3 @@ Files::SsoStrategy.find(id)
|
|
85
82
|
### Parameters
|
86
83
|
|
87
84
|
* `id` (int64): Required - Sso Strategy ID.
|
88
|
-
|
89
|
-
|
90
|
-
---
|
91
|
-
|
92
|
-
## Create Sso Strategy
|
93
|
-
|
94
|
-
```
|
95
|
-
Files::SsoStrategy.create(
|
96
|
-
provider: "okta",
|
97
|
-
subdomain: "subdomain",
|
98
|
-
client_id: "[client id]",
|
99
|
-
client_secret: "[client secret]",
|
100
|
-
protocol: "okta",
|
101
|
-
provision_users: true,
|
102
|
-
provision_groups: true,
|
103
|
-
provision_group_default: "Employees",
|
104
|
-
provision_group_exclusion: "Employees",
|
105
|
-
provision_group_inclusion: "Employees",
|
106
|
-
provision_attachments_permission: true,
|
107
|
-
provision_dav_permission: true,
|
108
|
-
provision_ftp_permission: true,
|
109
|
-
provision_sftp_permission: true,
|
110
|
-
provision_time_zone: "Eastern Time (US & Canada)"
|
111
|
-
)
|
112
|
-
```
|
113
|
-
|
114
|
-
### Parameters
|
115
|
-
|
116
|
-
* `provider` (string): Required - One of the following: google, auth0, okta, atlassian, azure, box, dropbox, slack, ubuntu, onelogin, saml, idaptive
|
117
|
-
* `subdomain` (string): Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
118
|
-
* `client_id` (string): OAuth Client ID for your auth provider.
|
119
|
-
* `client_secret` (string): OAuth Client Secret for your auth provider.
|
120
|
-
* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
|
121
|
-
* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
122
|
-
* `saml_provider_issuer_url` (string): Identity provider issuer url
|
123
|
-
* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
|
124
|
-
* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
125
|
-
* `scim_authentication_method` (string): The authentication method to use when using scim provisioning
|
126
|
-
* `scim_password` (string): Password for scim integration if using basic auth
|
127
|
-
* `scim_username` (string): Username for scim integration
|
128
|
-
* `protocol` (string): SSO Protocol
|
129
|
-
* `provision_users` (boolean): Auto-provision users?
|
130
|
-
* `provision_groups` (boolean): Auto-provision group memberships?
|
131
|
-
* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
132
|
-
* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
133
|
-
* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
134
|
-
* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
135
|
-
* `provision_attachments_permission` (boolean): Provisioned users to get sharing permission?
|
136
|
-
* `provision_dav_permission` (boolean): Provisioned users to get WebDAV permission?
|
137
|
-
* `provision_ftp_permission` (boolean): Provisioned users to get FTP permission?
|
138
|
-
* `provision_sftp_permission` (boolean): Provisioned users to get SFTP permission?
|
139
|
-
* `provision_time_zone` (string): Default timezone to use for provisioned users
|
140
|
-
|
141
|
-
|
142
|
-
---
|
143
|
-
|
144
|
-
## Update Sso Strategy
|
145
|
-
|
146
|
-
```
|
147
|
-
Files::SsoStrategy.update(id,
|
148
|
-
provider: "okta",
|
149
|
-
subdomain: "subdomain",
|
150
|
-
client_id: "[client id]",
|
151
|
-
client_secret: "[client secret]",
|
152
|
-
protocol: "okta",
|
153
|
-
provision_users: true,
|
154
|
-
provision_groups: true,
|
155
|
-
provision_group_default: "Employees",
|
156
|
-
provision_group_exclusion: "Employees",
|
157
|
-
provision_group_inclusion: "Employees",
|
158
|
-
provision_attachments_permission: true,
|
159
|
-
provision_dav_permission: true,
|
160
|
-
provision_ftp_permission: true,
|
161
|
-
provision_sftp_permission: true,
|
162
|
-
provision_time_zone: "Eastern Time (US & Canada)"
|
163
|
-
)
|
164
|
-
```
|
165
|
-
|
166
|
-
### Parameters
|
167
|
-
|
168
|
-
* `id` (int64): Required - Sso Strategy ID.
|
169
|
-
* `provider` (string): Required - One of the following: google, auth0, okta, atlassian, azure, box, dropbox, slack, ubuntu, onelogin, saml, idaptive
|
170
|
-
* `subdomain` (string): Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
171
|
-
* `client_id` (string): OAuth Client ID for your auth provider.
|
172
|
-
* `client_secret` (string): OAuth Client Secret for your auth provider.
|
173
|
-
* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
|
174
|
-
* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
175
|
-
* `saml_provider_issuer_url` (string): Identity provider issuer url
|
176
|
-
* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
|
177
|
-
* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
178
|
-
* `scim_authentication_method` (string): The authentication method to use when using scim provisioning
|
179
|
-
* `scim_password` (string): Password for scim integration if using basic auth
|
180
|
-
* `scim_username` (string): Username for scim integration
|
181
|
-
* `protocol` (string): SSO Protocol
|
182
|
-
* `provision_users` (boolean): Auto-provision users?
|
183
|
-
* `provision_groups` (boolean): Auto-provision group memberships?
|
184
|
-
* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
185
|
-
* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
186
|
-
* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
187
|
-
* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
188
|
-
* `provision_attachments_permission` (boolean): Provisioned users to get sharing permission?
|
189
|
-
* `provision_dav_permission` (boolean): Provisioned users to get WebDAV permission?
|
190
|
-
* `provision_ftp_permission` (boolean): Provisioned users to get FTP permission?
|
191
|
-
* `provision_sftp_permission` (boolean): Provisioned users to get SFTP permission?
|
192
|
-
* `provision_time_zone` (string): Default timezone to use for provisioned users
|
193
|
-
|
194
|
-
|
195
|
-
---
|
196
|
-
|
197
|
-
## Delete Sso Strategy
|
198
|
-
|
199
|
-
```
|
200
|
-
Files::SsoStrategy.delete(id)
|
201
|
-
```
|
202
|
-
|
203
|
-
### Parameters
|
204
|
-
|
205
|
-
* `id` (int64): Required - Sso Strategy ID.
|
206
|
-
|
207
|
-
|
208
|
-
---
|
209
|
-
|
210
|
-
## Update Sso Strategy
|
211
|
-
|
212
|
-
```
|
213
|
-
sso_strategy = Files::SsoStrategy.find(1)
|
214
|
-
sso_strategy.update(
|
215
|
-
provider: "okta",
|
216
|
-
subdomain: "subdomain",
|
217
|
-
client_id: "[client id]",
|
218
|
-
client_secret: "[client secret]",
|
219
|
-
protocol: "okta",
|
220
|
-
provision_users: true,
|
221
|
-
provision_groups: true,
|
222
|
-
provision_group_default: "Employees",
|
223
|
-
provision_group_exclusion: "Employees",
|
224
|
-
provision_group_inclusion: "Employees",
|
225
|
-
provision_attachments_permission: true,
|
226
|
-
provision_dav_permission: true,
|
227
|
-
provision_ftp_permission: true,
|
228
|
-
provision_sftp_permission: true,
|
229
|
-
provision_time_zone: "Eastern Time (US & Canada)"
|
230
|
-
)
|
231
|
-
```
|
232
|
-
|
233
|
-
### Parameters
|
234
|
-
|
235
|
-
* `id` (int64): Required - Sso Strategy ID.
|
236
|
-
* `provider` (string): Required - One of the following: google, auth0, okta, atlassian, azure, box, dropbox, slack, ubuntu, onelogin, saml, idaptive
|
237
|
-
* `subdomain` (string): Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
238
|
-
* `client_id` (string): OAuth Client ID for your auth provider.
|
239
|
-
* `client_secret` (string): OAuth Client Secret for your auth provider.
|
240
|
-
* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
|
241
|
-
* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
242
|
-
* `saml_provider_issuer_url` (string): Identity provider issuer url
|
243
|
-
* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
|
244
|
-
* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
245
|
-
* `scim_authentication_method` (string): The authentication method to use when using scim provisioning
|
246
|
-
* `scim_password` (string): Password for scim integration if using basic auth
|
247
|
-
* `scim_username` (string): Username for scim integration
|
248
|
-
* `protocol` (string): SSO Protocol
|
249
|
-
* `provision_users` (boolean): Auto-provision users?
|
250
|
-
* `provision_groups` (boolean): Auto-provision group memberships?
|
251
|
-
* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
252
|
-
* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
253
|
-
* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
254
|
-
* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
255
|
-
* `provision_attachments_permission` (boolean): Provisioned users to get sharing permission?
|
256
|
-
* `provision_dav_permission` (boolean): Provisioned users to get WebDAV permission?
|
257
|
-
* `provision_ftp_permission` (boolean): Provisioned users to get FTP permission?
|
258
|
-
* `provision_sftp_permission` (boolean): Provisioned users to get SFTP permission?
|
259
|
-
* `provision_time_zone` (string): Default timezone to use for provisioned users
|
260
|
-
|
261
|
-
|
262
|
-
---
|
263
|
-
|
264
|
-
## Delete Sso Strategy
|
265
|
-
|
266
|
-
```
|
267
|
-
sso_strategy = Files::SsoStrategy.find(1)
|
268
|
-
sso_strategy.delete
|
269
|
-
```
|
270
|
-
|
271
|
-
### Parameters
|
272
|
-
|
273
|
-
* `id` (int64): Required - Sso Strategy ID.
|
data/docs/usage_snapshot.md
CHANGED
@@ -5,14 +5,14 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
-
"start_at": "2000-01-
|
9
|
-
"end_at": "2000-01-
|
10
|
-
"created_at": "2000-01-
|
8
|
+
"start_at": "2000-01-01T01:00:00Z",
|
9
|
+
"end_at": "2000-01-01T01:00:00Z",
|
10
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"current_storage": "",
|
12
12
|
"high_water_storage": "",
|
13
13
|
"total_downloads": 1,
|
14
14
|
"total_uploads": 1,
|
15
|
-
"updated_at": "2000-01-
|
15
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
16
16
|
"usage_by_top_level_dir": "",
|
17
17
|
"root_storage": "",
|
18
18
|
"deleted_files_counted_in_minimum": "",
|
data/docs/user.md
CHANGED
@@ -12,11 +12,11 @@
|
|
12
12
|
"allowed_ips": "127.0.0.1",
|
13
13
|
"attachments_permission": true,
|
14
14
|
"api_keys_count": 1,
|
15
|
-
"authenticate_until": "2000-01-
|
15
|
+
"authenticate_until": "2000-01-01T01:00:00Z",
|
16
16
|
"authentication_method": "password",
|
17
17
|
"avatar_url": "",
|
18
18
|
"bypass_site_allowed_ips": true,
|
19
|
-
"created_at": "2000-01-
|
19
|
+
"created_at": "2000-01-01T01:00:00Z",
|
20
20
|
"dav_permission": true,
|
21
21
|
"disabled": true,
|
22
22
|
"email": "john.doe@files.com",
|
@@ -25,13 +25,13 @@
|
|
25
25
|
|
26
26
|
],
|
27
27
|
"language": "en",
|
28
|
-
"last_login_at": "2000-01-
|
28
|
+
"last_login_at": "2000-01-01T01:00:00Z",
|
29
29
|
"last_protocol_cipher": "",
|
30
|
-
"lockout_expires": "2000-01-
|
30
|
+
"lockout_expires": "2000-01-01T01:00:00Z",
|
31
31
|
"name": "John Doe",
|
32
32
|
"notes": "Internal notes on this user.",
|
33
33
|
"notification_daily_send_time": 18,
|
34
|
-
"password_set_at": "2000-01-
|
34
|
+
"password_set_at": "2000-01-01T01:00:00Z",
|
35
35
|
"password_validity_days": 1,
|
36
36
|
"public_keys_count": 1,
|
37
37
|
"receive_admin_alerts": true,
|
@@ -155,7 +155,7 @@ Files::User.create(
|
|
155
155
|
announcements_read: true,
|
156
156
|
allowed_ips: "127.0.0.1",
|
157
157
|
attachments_permission: true,
|
158
|
-
authenticate_until: "2000-01-
|
158
|
+
authenticate_until: "2000-01-01T01:00:00Z",
|
159
159
|
authentication_method: "password",
|
160
160
|
bypass_site_allowed_ips: true,
|
161
161
|
dav_permission: true,
|
@@ -273,7 +273,7 @@ Files::User.update(id,
|
|
273
273
|
announcements_read: true,
|
274
274
|
allowed_ips: "127.0.0.1",
|
275
275
|
attachments_permission: true,
|
276
|
-
authenticate_until: "2000-01-
|
276
|
+
authenticate_until: "2000-01-01T01:00:00Z",
|
277
277
|
authentication_method: "password",
|
278
278
|
bypass_site_allowed_ips: true,
|
279
279
|
dav_permission: true,
|
@@ -409,7 +409,7 @@ user.update(
|
|
409
409
|
announcements_read: true,
|
410
410
|
allowed_ips: "127.0.0.1",
|
411
411
|
attachments_permission: true,
|
412
|
-
authenticate_until: "2000-01-
|
412
|
+
authenticate_until: "2000-01-01T01:00:00Z",
|
413
413
|
authentication_method: "password",
|
414
414
|
bypass_site_allowed_ips: true,
|
415
415
|
dav_permission: true,
|
data/docs/user_cipher_use.md
CHANGED
@@ -6,9 +6,9 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"protocol_cipher": "TLSv1.2; ECDHE-RSA-AES256-GCM-SHA384",
|
9
|
-
"created_at": "2000-01-
|
9
|
+
"created_at": "2000-01-01T01:00:00Z",
|
10
10
|
"interface": "restapi",
|
11
|
-
"updated_at": "2000-01-
|
11
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
12
12
|
"user_id": 1
|
13
13
|
}
|
14
14
|
```
|
data/lib/files.com.rb
CHANGED
@@ -60,6 +60,7 @@ require "files.com/models/remote_server"
|
|
60
60
|
require "files.com/models/request"
|
61
61
|
require "files.com/models/session"
|
62
62
|
require "files.com/models/site"
|
63
|
+
require "files.com/models/sso_strategy"
|
63
64
|
require "files.com/models/status"
|
64
65
|
require "files.com/models/style"
|
65
66
|
require "files.com/models/usage_daily_snapshot"
|
@@ -79,6 +79,23 @@ module Files
|
|
79
79
|
@attributes[:updated_at]
|
80
80
|
end
|
81
81
|
|
82
|
+
# Parameters:
|
83
|
+
# page - integer - Current page number.
|
84
|
+
# per_page - integer - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
85
|
+
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
86
|
+
def self.list(params = {}, options = {})
|
87
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
88
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
89
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
90
|
+
|
91
|
+
response, options = Api.send_request("/payments", :get, params, options)
|
92
|
+
response.data.map { |object| AccountLineItem.new(object, options) }
|
93
|
+
end
|
94
|
+
|
95
|
+
def self.all(params = {}, options = {})
|
96
|
+
list(params, options)
|
97
|
+
end
|
98
|
+
|
82
99
|
# Parameters:
|
83
100
|
# id (required) - integer - Payment ID.
|
84
101
|
def self.find(id, params = {}, options = {})
|
@@ -68,20 +68,35 @@ module Files
|
|
68
68
|
# page - integer - Current page number.
|
69
69
|
# per_page - integer - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
70
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
71
|
-
|
72
|
-
def self.list_for(path, params = {}, options = {})
|
73
|
-
params ||= {}
|
74
|
-
params[:path] = path
|
71
|
+
def self.list(params = {}, options = {})
|
75
72
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
76
73
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
77
74
|
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
78
|
-
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
79
|
-
raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
|
80
75
|
|
81
|
-
response, options = Api.send_request("/projects
|
76
|
+
response, options = Api.send_request("/projects", :get, params, options)
|
82
77
|
response.data.map { |object| Project.new(object, options) }
|
83
78
|
end
|
84
79
|
|
80
|
+
def self.all(params = {}, options = {})
|
81
|
+
list(params, options)
|
82
|
+
end
|
83
|
+
|
84
|
+
# Parameters:
|
85
|
+
# id (required) - integer - Project ID.
|
86
|
+
def self.find(id, params = {}, options = {})
|
87
|
+
params ||= {}
|
88
|
+
params[:id] = id
|
89
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
90
|
+
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
91
|
+
|
92
|
+
response, options = Api.send_request("/projects/#{params[:id]}", :get, params, options)
|
93
|
+
Project.new(response.data, options)
|
94
|
+
end
|
95
|
+
|
96
|
+
def self.get(id, params = {}, options = {})
|
97
|
+
find(id, params, options)
|
98
|
+
end
|
99
|
+
|
85
100
|
# Parameters:
|
86
101
|
# global_access (required) - string - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
|
87
102
|
def self.create(params = {}, options = {})
|
@@ -14,303 +14,111 @@ module Files
|
|
14
14
|
@attributes[:protocol]
|
15
15
|
end
|
16
16
|
|
17
|
-
def protocol=(value)
|
18
|
-
@attributes[:protocol] = value
|
19
|
-
end
|
20
|
-
|
21
17
|
# string - Provider name
|
22
18
|
def provider
|
23
19
|
@attributes[:provider]
|
24
20
|
end
|
25
21
|
|
26
|
-
def provider=(value)
|
27
|
-
@attributes[:provider] = value
|
28
|
-
end
|
29
|
-
|
30
22
|
# int64 - ID
|
31
23
|
def id
|
32
24
|
@attributes[:id]
|
33
25
|
end
|
34
26
|
|
35
|
-
def id=(value)
|
36
|
-
@attributes[:id] = value
|
37
|
-
end
|
38
|
-
|
39
27
|
# string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
40
28
|
def saml_provider_cert_fingerprint
|
41
29
|
@attributes[:saml_provider_cert_fingerprint]
|
42
30
|
end
|
43
31
|
|
44
|
-
def saml_provider_cert_fingerprint=(value)
|
45
|
-
@attributes[:saml_provider_cert_fingerprint] = value
|
46
|
-
end
|
47
|
-
|
48
32
|
# string - Identity provider issuer url
|
49
33
|
def saml_provider_issuer_url
|
50
34
|
@attributes[:saml_provider_issuer_url]
|
51
35
|
end
|
52
36
|
|
53
|
-
def saml_provider_issuer_url=(value)
|
54
|
-
@attributes[:saml_provider_issuer_url] = value
|
55
|
-
end
|
56
|
-
|
57
37
|
# string - Metadata URL for the SAML identity provider
|
58
38
|
def saml_provider_metadata_url
|
59
39
|
@attributes[:saml_provider_metadata_url]
|
60
40
|
end
|
61
41
|
|
62
|
-
def saml_provider_metadata_url=(value)
|
63
|
-
@attributes[:saml_provider_metadata_url] = value
|
64
|
-
end
|
65
|
-
|
66
42
|
# string - Identity provider SLO endpoint
|
67
43
|
def saml_provider_slo_target_url
|
68
44
|
@attributes[:saml_provider_slo_target_url]
|
69
45
|
end
|
70
46
|
|
71
|
-
def saml_provider_slo_target_url=(value)
|
72
|
-
@attributes[:saml_provider_slo_target_url] = value
|
73
|
-
end
|
74
|
-
|
75
47
|
# string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
76
48
|
def saml_provider_sso_target_url
|
77
49
|
@attributes[:saml_provider_sso_target_url]
|
78
50
|
end
|
79
51
|
|
80
|
-
def saml_provider_sso_target_url=(value)
|
81
|
-
@attributes[:saml_provider_sso_target_url] = value
|
82
|
-
end
|
83
|
-
|
84
52
|
# string - SCIM authentication type.
|
85
53
|
def scim_authentication_method
|
86
54
|
@attributes[:scim_authentication_method]
|
87
55
|
end
|
88
56
|
|
89
|
-
def scim_authentication_method=(value)
|
90
|
-
@attributes[:scim_authentication_method] = value
|
91
|
-
end
|
92
|
-
|
93
57
|
# string - SCIM username.
|
94
58
|
def scim_username
|
95
59
|
@attributes[:scim_username]
|
96
60
|
end
|
97
61
|
|
98
|
-
def scim_username=(value)
|
99
|
-
@attributes[:scim_username] = value
|
100
|
-
end
|
101
|
-
|
102
62
|
# string - Subdomain
|
103
63
|
def subdomain
|
104
64
|
@attributes[:subdomain]
|
105
65
|
end
|
106
66
|
|
107
|
-
def subdomain=(value)
|
108
|
-
@attributes[:subdomain] = value
|
109
|
-
end
|
110
|
-
|
111
67
|
# boolean - Auto-provision users?
|
112
68
|
def provision_users
|
113
69
|
@attributes[:provision_users]
|
114
70
|
end
|
115
71
|
|
116
|
-
def provision_users=(value)
|
117
|
-
@attributes[:provision_users] = value
|
118
|
-
end
|
119
|
-
|
120
72
|
# boolean - Auto-provision group membership based on group memberships on the SSO side?
|
121
73
|
def provision_groups
|
122
74
|
@attributes[:provision_groups]
|
123
75
|
end
|
124
76
|
|
125
|
-
def provision_groups=(value)
|
126
|
-
@attributes[:provision_groups] = value
|
127
|
-
end
|
128
|
-
|
129
77
|
# string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
130
78
|
def provision_group_default
|
131
79
|
@attributes[:provision_group_default]
|
132
80
|
end
|
133
81
|
|
134
|
-
def provision_group_default=(value)
|
135
|
-
@attributes[:provision_group_default] = value
|
136
|
-
end
|
137
|
-
|
138
82
|
# string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
139
83
|
def provision_group_exclusion
|
140
84
|
@attributes[:provision_group_exclusion]
|
141
85
|
end
|
142
86
|
|
143
|
-
def provision_group_exclusion=(value)
|
144
|
-
@attributes[:provision_group_exclusion] = value
|
145
|
-
end
|
146
|
-
|
147
87
|
# string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
148
88
|
def provision_group_inclusion
|
149
89
|
@attributes[:provision_group_inclusion]
|
150
90
|
end
|
151
91
|
|
152
|
-
def provision_group_inclusion=(value)
|
153
|
-
@attributes[:provision_group_inclusion] = value
|
154
|
-
end
|
155
|
-
|
156
92
|
# string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
157
93
|
def provision_group_required
|
158
94
|
@attributes[:provision_group_required]
|
159
95
|
end
|
160
96
|
|
161
|
-
def provision_group_required=(value)
|
162
|
-
@attributes[:provision_group_required] = value
|
163
|
-
end
|
164
|
-
|
165
97
|
# boolean - Auto-provisioned users get Sharing permission?
|
166
98
|
def provision_attachments_permission
|
167
99
|
@attributes[:provision_attachments_permission]
|
168
100
|
end
|
169
101
|
|
170
|
-
def provision_attachments_permission=(value)
|
171
|
-
@attributes[:provision_attachments_permission] = value
|
172
|
-
end
|
173
|
-
|
174
102
|
# boolean - Auto-provisioned users get WebDAV permission?
|
175
103
|
def provision_dav_permission
|
176
104
|
@attributes[:provision_dav_permission]
|
177
105
|
end
|
178
106
|
|
179
|
-
def provision_dav_permission=(value)
|
180
|
-
@attributes[:provision_dav_permission] = value
|
181
|
-
end
|
182
|
-
|
183
107
|
# boolean - Auto-provisioned users get FTP permission?
|
184
108
|
def provision_ftp_permission
|
185
109
|
@attributes[:provision_ftp_permission]
|
186
110
|
end
|
187
111
|
|
188
|
-
def provision_ftp_permission=(value)
|
189
|
-
@attributes[:provision_ftp_permission] = value
|
190
|
-
end
|
191
|
-
|
192
112
|
# boolean - Auto-provisioned users get SFTP permission?
|
193
113
|
def provision_sftp_permission
|
194
114
|
@attributes[:provision_sftp_permission]
|
195
115
|
end
|
196
116
|
|
197
|
-
def provision_sftp_permission=(value)
|
198
|
-
@attributes[:provision_sftp_permission] = value
|
199
|
-
end
|
200
|
-
|
201
117
|
# string - Default time zone for auto provisioned users.
|
202
118
|
def provision_time_zone
|
203
119
|
@attributes[:provision_time_zone]
|
204
120
|
end
|
205
121
|
|
206
|
-
def provision_time_zone=(value)
|
207
|
-
@attributes[:provision_time_zone] = value
|
208
|
-
end
|
209
|
-
|
210
|
-
# string - OAuth Client ID for your auth provider.
|
211
|
-
def client_id
|
212
|
-
@attributes[:client_id]
|
213
|
-
end
|
214
|
-
|
215
|
-
def client_id=(value)
|
216
|
-
@attributes[:client_id] = value
|
217
|
-
end
|
218
|
-
|
219
|
-
# string - OAuth Client Secret for your auth provider.
|
220
|
-
def client_secret
|
221
|
-
@attributes[:client_secret]
|
222
|
-
end
|
223
|
-
|
224
|
-
def client_secret=(value)
|
225
|
-
@attributes[:client_secret] = value
|
226
|
-
end
|
227
|
-
|
228
|
-
# string - Password for scim integration if using basic auth
|
229
|
-
def scim_password
|
230
|
-
@attributes[:scim_password]
|
231
|
-
end
|
232
|
-
|
233
|
-
def scim_password=(value)
|
234
|
-
@attributes[:scim_password] = value
|
235
|
-
end
|
236
|
-
|
237
|
-
# Parameters:
|
238
|
-
# provider (required) - string - One of the following: google, auth0, okta, atlassian, azure, box, dropbox, slack, ubuntu, onelogin, saml, idaptive
|
239
|
-
# subdomain - string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
240
|
-
# client_id - string - OAuth Client ID for your auth provider.
|
241
|
-
# client_secret - string - OAuth Client Secret for your auth provider.
|
242
|
-
# saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
|
243
|
-
# saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
244
|
-
# saml_provider_issuer_url - string - Identity provider issuer url
|
245
|
-
# saml_provider_slo_target_url - string - Identity provider SLO endpoint
|
246
|
-
# saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
247
|
-
# scim_authentication_method - string - The authentication method to use when using scim provisioning
|
248
|
-
# scim_password - string - Password for scim integration if using basic auth
|
249
|
-
# scim_username - string - Username for scim integration
|
250
|
-
# protocol - string - SSO Protocol
|
251
|
-
# provision_users - boolean - Auto-provision users?
|
252
|
-
# provision_groups - boolean - Auto-provision group memberships?
|
253
|
-
# provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
254
|
-
# provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
255
|
-
# provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
256
|
-
# provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
257
|
-
# provision_attachments_permission - boolean - Provisioned users to get sharing permission?
|
258
|
-
# provision_dav_permission - boolean - Provisioned users to get WebDAV permission?
|
259
|
-
# provision_ftp_permission - boolean - Provisioned users to get FTP permission?
|
260
|
-
# provision_sftp_permission - boolean - Provisioned users to get SFTP permission?
|
261
|
-
# provision_time_zone - string - Default timezone to use for provisioned users
|
262
|
-
def update(params = {})
|
263
|
-
params ||= {}
|
264
|
-
params[:id] = @attributes[:id]
|
265
|
-
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
266
|
-
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
267
|
-
raise InvalidParameterError.new("Bad parameter: provider must be an String") if params.dig(:provider) and !params.dig(:provider).is_a?(String)
|
268
|
-
raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params.dig(:subdomain) and !params.dig(:subdomain).is_a?(String)
|
269
|
-
raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params.dig(:client_id) and !params.dig(:client_id).is_a?(String)
|
270
|
-
raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params.dig(:client_secret) and !params.dig(:client_secret).is_a?(String)
|
271
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_url must be an String") if params.dig(:saml_provider_metadata_url) and !params.dig(:saml_provider_metadata_url).is_a?(String)
|
272
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_cert_fingerprint must be an String") if params.dig(:saml_provider_cert_fingerprint) and !params.dig(:saml_provider_cert_fingerprint).is_a?(String)
|
273
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_issuer_url must be an String") if params.dig(:saml_provider_issuer_url) and !params.dig(:saml_provider_issuer_url).is_a?(String)
|
274
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_slo_target_url must be an String") if params.dig(:saml_provider_slo_target_url) and !params.dig(:saml_provider_slo_target_url).is_a?(String)
|
275
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_sso_target_url must be an String") if params.dig(:saml_provider_sso_target_url) and !params.dig(:saml_provider_sso_target_url).is_a?(String)
|
276
|
-
raise InvalidParameterError.new("Bad parameter: scim_authentication_method must be an String") if params.dig(:scim_authentication_method) and !params.dig(:scim_authentication_method).is_a?(String)
|
277
|
-
raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params.dig(:scim_password) and !params.dig(:scim_password).is_a?(String)
|
278
|
-
raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params.dig(:scim_username) and !params.dig(:scim_username).is_a?(String)
|
279
|
-
raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params.dig(:protocol) and !params.dig(:protocol).is_a?(String)
|
280
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_default must be an String") if params.dig(:provision_group_default) and !params.dig(:provision_group_default).is_a?(String)
|
281
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_exclusion must be an String") if params.dig(:provision_group_exclusion) and !params.dig(:provision_group_exclusion).is_a?(String)
|
282
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_inclusion must be an String") if params.dig(:provision_group_inclusion) and !params.dig(:provision_group_inclusion).is_a?(String)
|
283
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_required must be an String") if params.dig(:provision_group_required) and !params.dig(:provision_group_required).is_a?(String)
|
284
|
-
raise InvalidParameterError.new("Bad parameter: provision_time_zone must be an String") if params.dig(:provision_time_zone) and !params.dig(:provision_time_zone).is_a?(String)
|
285
|
-
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
286
|
-
raise MissingParameterError.new("Parameter missing: provider") unless params.dig(:provider)
|
287
|
-
|
288
|
-
Api.send_request("/sso_strategies/#{@attributes[:id]}", :patch, params, @options)
|
289
|
-
end
|
290
|
-
|
291
|
-
def delete(params = {})
|
292
|
-
params ||= {}
|
293
|
-
params[:id] = @attributes[:id]
|
294
|
-
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
295
|
-
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
296
|
-
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
297
|
-
|
298
|
-
Api.send_request("/sso_strategies/#{@attributes[:id]}", :delete, params, @options)
|
299
|
-
end
|
300
|
-
|
301
|
-
def destroy(params = {})
|
302
|
-
delete(params)
|
303
|
-
end
|
304
|
-
|
305
|
-
def save
|
306
|
-
if @attributes[:id]
|
307
|
-
update(@attributes)
|
308
|
-
else
|
309
|
-
new_obj = SsoStrategy.create(@attributes, @options)
|
310
|
-
@attributes = new_obj.attributes
|
311
|
-
end
|
312
|
-
end
|
313
|
-
|
314
122
|
# Parameters:
|
315
123
|
# page - integer - Current page number.
|
316
124
|
# per_page - integer - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
@@ -343,123 +151,5 @@ module Files
|
|
343
151
|
def self.get(id, params = {}, options = {})
|
344
152
|
find(id, params, options)
|
345
153
|
end
|
346
|
-
|
347
|
-
# Parameters:
|
348
|
-
# provider (required) - string - One of the following: google, auth0, okta, atlassian, azure, box, dropbox, slack, ubuntu, onelogin, saml, idaptive
|
349
|
-
# subdomain - string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
350
|
-
# client_id - string - OAuth Client ID for your auth provider.
|
351
|
-
# client_secret - string - OAuth Client Secret for your auth provider.
|
352
|
-
# saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
|
353
|
-
# saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
354
|
-
# saml_provider_issuer_url - string - Identity provider issuer url
|
355
|
-
# saml_provider_slo_target_url - string - Identity provider SLO endpoint
|
356
|
-
# saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
357
|
-
# scim_authentication_method - string - The authentication method to use when using scim provisioning
|
358
|
-
# scim_password - string - Password for scim integration if using basic auth
|
359
|
-
# scim_username - string - Username for scim integration
|
360
|
-
# protocol - string - SSO Protocol
|
361
|
-
# provision_users - boolean - Auto-provision users?
|
362
|
-
# provision_groups - boolean - Auto-provision group memberships?
|
363
|
-
# provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
364
|
-
# provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
365
|
-
# provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
366
|
-
# provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
367
|
-
# provision_attachments_permission - boolean - Provisioned users to get sharing permission?
|
368
|
-
# provision_dav_permission - boolean - Provisioned users to get WebDAV permission?
|
369
|
-
# provision_ftp_permission - boolean - Provisioned users to get FTP permission?
|
370
|
-
# provision_sftp_permission - boolean - Provisioned users to get SFTP permission?
|
371
|
-
# provision_time_zone - string - Default timezone to use for provisioned users
|
372
|
-
def self.create(params = {}, options = {})
|
373
|
-
raise InvalidParameterError.new("Bad parameter: provider must be an String") if params.dig(:provider) and !params.dig(:provider).is_a?(String)
|
374
|
-
raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params.dig(:subdomain) and !params.dig(:subdomain).is_a?(String)
|
375
|
-
raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params.dig(:client_id) and !params.dig(:client_id).is_a?(String)
|
376
|
-
raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params.dig(:client_secret) and !params.dig(:client_secret).is_a?(String)
|
377
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_url must be an String") if params.dig(:saml_provider_metadata_url) and !params.dig(:saml_provider_metadata_url).is_a?(String)
|
378
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_cert_fingerprint must be an String") if params.dig(:saml_provider_cert_fingerprint) and !params.dig(:saml_provider_cert_fingerprint).is_a?(String)
|
379
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_issuer_url must be an String") if params.dig(:saml_provider_issuer_url) and !params.dig(:saml_provider_issuer_url).is_a?(String)
|
380
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_slo_target_url must be an String") if params.dig(:saml_provider_slo_target_url) and !params.dig(:saml_provider_slo_target_url).is_a?(String)
|
381
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_sso_target_url must be an String") if params.dig(:saml_provider_sso_target_url) and !params.dig(:saml_provider_sso_target_url).is_a?(String)
|
382
|
-
raise InvalidParameterError.new("Bad parameter: scim_authentication_method must be an String") if params.dig(:scim_authentication_method) and !params.dig(:scim_authentication_method).is_a?(String)
|
383
|
-
raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params.dig(:scim_password) and !params.dig(:scim_password).is_a?(String)
|
384
|
-
raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params.dig(:scim_username) and !params.dig(:scim_username).is_a?(String)
|
385
|
-
raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params.dig(:protocol) and !params.dig(:protocol).is_a?(String)
|
386
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_default must be an String") if params.dig(:provision_group_default) and !params.dig(:provision_group_default).is_a?(String)
|
387
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_exclusion must be an String") if params.dig(:provision_group_exclusion) and !params.dig(:provision_group_exclusion).is_a?(String)
|
388
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_inclusion must be an String") if params.dig(:provision_group_inclusion) and !params.dig(:provision_group_inclusion).is_a?(String)
|
389
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_required must be an String") if params.dig(:provision_group_required) and !params.dig(:provision_group_required).is_a?(String)
|
390
|
-
raise InvalidParameterError.new("Bad parameter: provision_time_zone must be an String") if params.dig(:provision_time_zone) and !params.dig(:provision_time_zone).is_a?(String)
|
391
|
-
raise MissingParameterError.new("Parameter missing: provider") unless params.dig(:provider)
|
392
|
-
|
393
|
-
response, options = Api.send_request("/sso_strategies", :post, params, options)
|
394
|
-
SsoStrategy.new(response.data, options)
|
395
|
-
end
|
396
|
-
|
397
|
-
# Parameters:
|
398
|
-
# provider (required) - string - One of the following: google, auth0, okta, atlassian, azure, box, dropbox, slack, ubuntu, onelogin, saml, idaptive
|
399
|
-
# subdomain - string - Subdomain or domain name for your auth provider. Example: `https://[subdomain].okta.com/`
|
400
|
-
# client_id - string - OAuth Client ID for your auth provider.
|
401
|
-
# client_secret - string - OAuth Client Secret for your auth provider.
|
402
|
-
# saml_provider_metadata_url - string - Metadata URL for the SAML identity provider
|
403
|
-
# saml_provider_cert_fingerprint - string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
404
|
-
# saml_provider_issuer_url - string - Identity provider issuer url
|
405
|
-
# saml_provider_slo_target_url - string - Identity provider SLO endpoint
|
406
|
-
# saml_provider_sso_target_url - string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
407
|
-
# scim_authentication_method - string - The authentication method to use when using scim provisioning
|
408
|
-
# scim_password - string - Password for scim integration if using basic auth
|
409
|
-
# scim_username - string - Username for scim integration
|
410
|
-
# protocol - string - SSO Protocol
|
411
|
-
# provision_users - boolean - Auto-provision users?
|
412
|
-
# provision_groups - boolean - Auto-provision group memberships?
|
413
|
-
# provision_group_default - string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
414
|
-
# provision_group_exclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
415
|
-
# provision_group_inclusion - string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
416
|
-
# provision_group_required - string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
417
|
-
# provision_attachments_permission - boolean - Provisioned users to get sharing permission?
|
418
|
-
# provision_dav_permission - boolean - Provisioned users to get WebDAV permission?
|
419
|
-
# provision_ftp_permission - boolean - Provisioned users to get FTP permission?
|
420
|
-
# provision_sftp_permission - boolean - Provisioned users to get SFTP permission?
|
421
|
-
# provision_time_zone - string - Default timezone to use for provisioned users
|
422
|
-
def self.update(id, params = {}, options = {})
|
423
|
-
params ||= {}
|
424
|
-
params[:id] = id
|
425
|
-
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
426
|
-
raise InvalidParameterError.new("Bad parameter: provider must be an String") if params.dig(:provider) and !params.dig(:provider).is_a?(String)
|
427
|
-
raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params.dig(:subdomain) and !params.dig(:subdomain).is_a?(String)
|
428
|
-
raise InvalidParameterError.new("Bad parameter: client_id must be an String") if params.dig(:client_id) and !params.dig(:client_id).is_a?(String)
|
429
|
-
raise InvalidParameterError.new("Bad parameter: client_secret must be an String") if params.dig(:client_secret) and !params.dig(:client_secret).is_a?(String)
|
430
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_metadata_url must be an String") if params.dig(:saml_provider_metadata_url) and !params.dig(:saml_provider_metadata_url).is_a?(String)
|
431
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_cert_fingerprint must be an String") if params.dig(:saml_provider_cert_fingerprint) and !params.dig(:saml_provider_cert_fingerprint).is_a?(String)
|
432
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_issuer_url must be an String") if params.dig(:saml_provider_issuer_url) and !params.dig(:saml_provider_issuer_url).is_a?(String)
|
433
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_slo_target_url must be an String") if params.dig(:saml_provider_slo_target_url) and !params.dig(:saml_provider_slo_target_url).is_a?(String)
|
434
|
-
raise InvalidParameterError.new("Bad parameter: saml_provider_sso_target_url must be an String") if params.dig(:saml_provider_sso_target_url) and !params.dig(:saml_provider_sso_target_url).is_a?(String)
|
435
|
-
raise InvalidParameterError.new("Bad parameter: scim_authentication_method must be an String") if params.dig(:scim_authentication_method) and !params.dig(:scim_authentication_method).is_a?(String)
|
436
|
-
raise InvalidParameterError.new("Bad parameter: scim_password must be an String") if params.dig(:scim_password) and !params.dig(:scim_password).is_a?(String)
|
437
|
-
raise InvalidParameterError.new("Bad parameter: scim_username must be an String") if params.dig(:scim_username) and !params.dig(:scim_username).is_a?(String)
|
438
|
-
raise InvalidParameterError.new("Bad parameter: protocol must be an String") if params.dig(:protocol) and !params.dig(:protocol).is_a?(String)
|
439
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_default must be an String") if params.dig(:provision_group_default) and !params.dig(:provision_group_default).is_a?(String)
|
440
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_exclusion must be an String") if params.dig(:provision_group_exclusion) and !params.dig(:provision_group_exclusion).is_a?(String)
|
441
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_inclusion must be an String") if params.dig(:provision_group_inclusion) and !params.dig(:provision_group_inclusion).is_a?(String)
|
442
|
-
raise InvalidParameterError.new("Bad parameter: provision_group_required must be an String") if params.dig(:provision_group_required) and !params.dig(:provision_group_required).is_a?(String)
|
443
|
-
raise InvalidParameterError.new("Bad parameter: provision_time_zone must be an String") if params.dig(:provision_time_zone) and !params.dig(:provision_time_zone).is_a?(String)
|
444
|
-
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
445
|
-
raise MissingParameterError.new("Parameter missing: provider") unless params.dig(:provider)
|
446
|
-
|
447
|
-
response, options = Api.send_request("/sso_strategies/#{params[:id]}", :patch, params, options)
|
448
|
-
SsoStrategy.new(response.data, options)
|
449
|
-
end
|
450
|
-
|
451
|
-
def self.delete(id, params = {}, options = {})
|
452
|
-
params ||= {}
|
453
|
-
params[:id] = id
|
454
|
-
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
455
|
-
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
456
|
-
|
457
|
-
response, _options = Api.send_request("/sso_strategies/#{params[:id]}", :delete, params, options)
|
458
|
-
response.data
|
459
|
-
end
|
460
|
-
|
461
|
-
def self.destroy(id, params = {}, options = {})
|
462
|
-
delete(id, params, options)
|
463
|
-
end
|
464
154
|
end
|
465
155
|
end
|