losant_rest 2.1.2 → 2.2.0

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.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +767 -0
  3. data/docs/flow.md +1 -0
  4. data/docs/flowVersions.md +1 -0
  5. data/docs/flows.md +1 -0
  6. data/docs/userOauthClient.md +125 -0
  7. data/docs/userOauthClients.md +87 -0
  8. data/lib/platform_rest/client.rb +10 -2
  9. data/lib/platform_rest/flow.rb +2 -0
  10. data/lib/platform_rest/flow_versions.rb +2 -0
  11. data/lib/platform_rest/flows.rb +2 -0
  12. data/lib/platform_rest/user_oauth_client.rb +170 -0
  13. data/lib/platform_rest/user_oauth_clients.rb +132 -0
  14. data/lib/platform_rest/version.rb +1 -1
  15. data/lib/platform_rest.rb +2 -0
  16. data/schemas/apiTokenPost.json +7 -0
  17. data/schemas/githubLogin.json +7 -0
  18. data/schemas/instanceSandbox.json +6 -0
  19. data/schemas/instanceSandboxes.json +6 -0
  20. data/schemas/me.json +15 -0
  21. data/schemas/mePatch.json +9 -0
  22. data/schemas/samlResponse.json +7 -0
  23. data/schemas/userCredentials.json +7 -0
  24. data/schemas/userOauthClient.json +125 -0
  25. data/schemas/userOauthClientPatch.json +113 -0
  26. data/schemas/userOauthClientPost.json +117 -0
  27. data/schemas/userOauthClients.json +166 -0
  28. data/schemas/userPost.json +16 -0
  29. metadata +9 -1
data/schemas/instanceSandbox.json CHANGED
@@ -173,6 +173,9 @@
173
173
  "notebook": {
174
174
  "type": "integer"
175
175
  },
176
+ "oauthclient": {
177
+ "type": "integer"
178
+ },
176
179
  "privatefile": {
177
180
  "type": "integer"
178
181
  },
@@ -281,6 +284,9 @@
281
284
  "notebookCount": {
282
285
  "type": "integer"
283
286
  },
287
+ "oauthClientCount": {
288
+ "type": "integer"
289
+ },
284
290
  "resourceJobCount": {
285
291
  "type": "integer"
286
292
  },
data/schemas/instanceSandboxes.json CHANGED
@@ -184,6 +184,9 @@
184
184
  "notebook": {
185
185
  "type": "integer"
186
186
  },
187
+ "oauthclient": {
188
+ "type": "integer"
189
+ },
187
190
  "privatefile": {
188
191
  "type": "integer"
189
192
  },
@@ -292,6 +295,9 @@
292
295
  "notebookCount": {
293
296
  "type": "integer"
294
297
  },
298
+ "oauthClientCount": {
299
+ "type": "integer"
300
+ },
295
301
  "resourceJobCount": {
296
302
  "type": "integer"
297
303
  },
data/schemas/me.json CHANGED
@@ -61,6 +61,15 @@
61
61
  "type": "string",
62
62
  "maxLength": 1024
63
63
  },
64
+ "state": {
65
+ "type": "string",
66
+ "maxLength": 1024
67
+ },
68
+ "country": {
69
+ "type": "string",
70
+ "minLength": 1,
71
+ "maxLength": 1024
72
+ },
64
73
  "tokenCutoff": {
65
74
  "type": "string",
66
75
  "format": "date-time"
@@ -151,6 +160,9 @@
151
160
  "notebook": {
152
161
  "type": "integer"
153
162
  },
163
+ "oauthclient": {
164
+ "type": "integer"
165
+ },
154
166
  "privatefile": {
155
167
  "type": "integer"
156
168
  },
@@ -970,6 +982,9 @@
970
982
  "notebookCount": {
971
983
  "type": "integer"
972
984
  },
985
+ "oauthClientCount": {
986
+ "type": "integer"
987
+ },
973
988
  "resourceJobCount": {
974
989
  "type": "integer"
975
990
  },
data/schemas/mePatch.json CHANGED
@@ -36,6 +36,15 @@
36
36
  "type": "string",
37
37
  "maxLength": 1024
38
38
  },
39
+ "state": {
40
+ "type": "string",
41
+ "maxLength": 1024
42
+ },
43
+ "country": {
44
+ "type": "string",
45
+ "minLength": 1,
46
+ "maxLength": 1024
47
+ },
39
48
  "password": {
40
49
  "type": "string",
41
50
  "minLength": 12,
data/schemas/samlResponse.json CHANGED
@@ -509,6 +509,13 @@
509
509
  "userOauthTokens.*",
510
510
  "userOauthTokens.get",
511
511
  "userOauthTokens.post",
512
+ "userOauthClient.*",
513
+ "userOauthClient.get",
514
+ "userOauthClient.patch",
515
+ "userOauthClient.delete",
516
+ "userOauthClients.*",
517
+ "userOauthClients.get",
518
+ "userOauthClients.post",
512
519
  "applicationTemplate.*",
513
520
  "applicationTemplate.get",
514
521
  "applicationTemplates.*",
data/schemas/userCredentials.json CHANGED
@@ -513,6 +513,13 @@
513
513
  "userOauthTokens.*",
514
514
  "userOauthTokens.get",
515
515
  "userOauthTokens.post",
516
+ "userOauthClient.*",
517
+ "userOauthClient.get",
518
+ "userOauthClient.patch",
519
+ "userOauthClient.delete",
520
+ "userOauthClients.*",
521
+ "userOauthClients.get",
522
+ "userOauthClients.post",
516
523
  "applicationTemplate.*",
517
524
  "applicationTemplate.get",
518
525
  "applicationTemplates.*",
data/schemas/userOauthClient.json ADDED
@@ -0,0 +1,125 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "id": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "creationDate": {
10
+ "type": "string",
11
+ "format": "date-time"
12
+ },
13
+ "lastUpdated": {
14
+ "type": "string",
15
+ "format": "date-time"
16
+ },
17
+ "client_id": {
18
+ "type": "string",
19
+ "description": "Unique client identifier"
20
+ },
21
+ "client_secret": {
22
+ "type": "string",
23
+ "description": "Client secret. Only ever included in the response to the initial creation request."
24
+ },
25
+ "client_name": {
26
+ "type": "string",
27
+ "minLength": 1,
28
+ "maxLength": 255
29
+ },
30
+ "description": {
31
+ "type": "string",
32
+ "maxLength": 32767
33
+ },
34
+ "client_uri": {
35
+ "type": "string",
36
+ "format": "uri",
37
+ "maxLength": 1024
38
+ },
39
+ "logo_uri": {
40
+ "type": "string",
41
+ "format": "uri",
42
+ "maxLength": 32768,
43
+ "description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
44
+ },
45
+ "redirect_uris": {
46
+ "type": "array",
47
+ "minItems": 1,
48
+ "maxItems": 25,
49
+ "items": {
50
+ "type": "string",
51
+ "format": "uri",
52
+ "maxLength": 1024
53
+ },
54
+ "description": "Array of redirect URIs for use in redirect-based flows"
55
+ },
56
+ "grant_types": {
57
+ "type": "array",
58
+ "items": {
59
+ "type": "string",
60
+ "enum": [
61
+ "authorization_code",
62
+ "refresh_token"
63
+ ]
64
+ },
65
+ "description": "Array of OAuth 2.0 grant types"
66
+ },
67
+ "response_types": {
68
+ "type": "array",
69
+ "items": {
70
+ "type": "string",
71
+ "enum": [
72
+ "code"
73
+ ]
74
+ },
75
+ "description": "Array of OAuth 2.0 response types"
76
+ },
77
+ "token_endpoint_auth_method": {
78
+ "type": "string",
79
+ "description": "Authentication method for the token endpoint",
80
+ "enum": [
81
+ "client_secret_basic",
82
+ "client_secret_post",
83
+ "none"
84
+ ]
85
+ },
86
+ "scope": {
87
+ "type": "array",
88
+ "uniqueItems": true,
89
+ "items": {
90
+ "type": "string",
91
+ "description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
92
+ "enum": [
93
+ "all.Application.read",
94
+ "all.Application.bounded",
95
+ "only.Organization.read",
96
+ "only.Organization.bounded",
97
+ "all.Organization.read",
98
+ "all.Organization.bounded",
99
+ "only.User.read"
100
+ ]
101
+ },
102
+ "description": "API scopes this client may request"
103
+ },
104
+ "contacts": {
105
+ "type": "array",
106
+ "maxItems": 10,
107
+ "items": {
108
+ "type": "string",
109
+ "format": "email",
110
+ "maxLength": 1024
111
+ },
112
+ "description": "Contact email addresses for this client"
113
+ },
114
+ "tos_uri": {
115
+ "type": "string",
116
+ "format": "uri",
117
+ "maxLength": 1024
118
+ },
119
+ "policy_uri": {
120
+ "type": "string",
121
+ "format": "uri",
122
+ "maxLength": 1024
123
+ }
124
+ }
125
+ }
data/schemas/userOauthClientPatch.json ADDED
@@ -0,0 +1,113 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "client_name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "client_uri": {
15
+ "oneOf": [
16
+ {
17
+ "type": "string",
18
+ "format": "uri",
19
+ "maxLength": 1024
20
+ },
21
+ {
22
+ "type": "null"
23
+ }
24
+ ]
25
+ },
26
+ "logo_uri": {
27
+ "oneOf": [
28
+ {
29
+ "type": "string",
30
+ "format": "uri",
31
+ "maxLength": 32768,
32
+ "description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
33
+ },
34
+ {
35
+ "type": "null"
36
+ }
37
+ ]
38
+ },
39
+ "redirect_uris": {
40
+ "type": "array",
41
+ "minItems": 1,
42
+ "maxItems": 25,
43
+ "items": {
44
+ "type": "string",
45
+ "format": "uri",
46
+ "maxLength": 1024
47
+ },
48
+ "description": "Array of redirect URIs for use in redirect-based flows"
49
+ },
50
+ "token_endpoint_auth_method": {
51
+ "type": "string",
52
+ "description": "Authentication method for the token endpoint",
53
+ "enum": [
54
+ "client_secret_basic",
55
+ "client_secret_post",
56
+ "none"
57
+ ]
58
+ },
59
+ "scope": {
60
+ "type": "array",
61
+ "uniqueItems": true,
62
+ "items": {
63
+ "type": "string",
64
+ "description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
65
+ "enum": [
66
+ "all.Application.read",
67
+ "all.Application.bounded",
68
+ "only.Organization.read",
69
+ "only.Organization.bounded",
70
+ "all.Organization.read",
71
+ "all.Organization.bounded",
72
+ "only.User.read"
73
+ ]
74
+ },
75
+ "description": "API scopes this client may request"
76
+ },
77
+ "contacts": {
78
+ "type": "array",
79
+ "maxItems": 10,
80
+ "items": {
81
+ "type": "string",
82
+ "format": "email",
83
+ "maxLength": 1024
84
+ },
85
+ "description": "Contact email addresses for this client"
86
+ },
87
+ "tos_uri": {
88
+ "oneOf": [
89
+ {
90
+ "type": "string",
91
+ "format": "uri",
92
+ "maxLength": 1024
93
+ },
94
+ {
95
+ "type": "null"
96
+ }
97
+ ]
98
+ },
99
+ "policy_uri": {
100
+ "oneOf": [
101
+ {
102
+ "type": "string",
103
+ "format": "uri",
104
+ "maxLength": 1024
105
+ },
106
+ {
107
+ "type": "null"
108
+ }
109
+ ]
110
+ }
111
+ },
112
+ "additionalProperties": false
113
+ }
data/schemas/userOauthClientPost.json ADDED
@@ -0,0 +1,117 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "client_name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "client_uri": {
15
+ "oneOf": [
16
+ {
17
+ "type": "string",
18
+ "format": "uri",
19
+ "maxLength": 1024
20
+ },
21
+ {
22
+ "type": "null"
23
+ }
24
+ ]
25
+ },
26
+ "logo_uri": {
27
+ "oneOf": [
28
+ {
29
+ "type": "string",
30
+ "format": "uri",
31
+ "maxLength": 32768,
32
+ "description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
33
+ },
34
+ {
35
+ "type": "null"
36
+ }
37
+ ]
38
+ },
39
+ "redirect_uris": {
40
+ "type": "array",
41
+ "minItems": 1,
42
+ "maxItems": 25,
43
+ "items": {
44
+ "type": "string",
45
+ "format": "uri",
46
+ "maxLength": 1024
47
+ },
48
+ "description": "Array of redirect URIs for use in redirect-based flows"
49
+ },
50
+ "token_endpoint_auth_method": {
51
+ "type": "string",
52
+ "description": "Authentication method for the token endpoint",
53
+ "enum": [
54
+ "client_secret_basic",
55
+ "client_secret_post",
56
+ "none"
57
+ ]
58
+ },
59
+ "scope": {
60
+ "type": "array",
61
+ "uniqueItems": true,
62
+ "items": {
63
+ "type": "string",
64
+ "description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
65
+ "enum": [
66
+ "all.Application.read",
67
+ "all.Application.bounded",
68
+ "only.Organization.read",
69
+ "only.Organization.bounded",
70
+ "all.Organization.read",
71
+ "all.Organization.bounded",
72
+ "only.User.read"
73
+ ]
74
+ },
75
+ "description": "API scopes this client may request"
76
+ },
77
+ "contacts": {
78
+ "type": "array",
79
+ "maxItems": 10,
80
+ "items": {
81
+ "type": "string",
82
+ "format": "email",
83
+ "maxLength": 1024
84
+ },
85
+ "description": "Contact email addresses for this client"
86
+ },
87
+ "tos_uri": {
88
+ "oneOf": [
89
+ {
90
+ "type": "string",
91
+ "format": "uri",
92
+ "maxLength": 1024
93
+ },
94
+ {
95
+ "type": "null"
96
+ }
97
+ ]
98
+ },
99
+ "policy_uri": {
100
+ "oneOf": [
101
+ {
102
+ "type": "string",
103
+ "format": "uri",
104
+ "maxLength": 1024
105
+ },
106
+ {
107
+ "type": "null"
108
+ }
109
+ ]
110
+ }
111
+ },
112
+ "additionalProperties": false,
113
+ "required": [
114
+ "client_name",
115
+ "redirect_uris"
116
+ ]
117
+ }
data/schemas/userOauthClients.json ADDED
@@ -0,0 +1,166 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "User OAuth Client",
9
+ "description": "Schema for a single private OAuth client",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "creationDate": {
17
+ "type": "string",
18
+ "format": "date-time"
19
+ },
20
+ "lastUpdated": {
21
+ "type": "string",
22
+ "format": "date-time"
23
+ },
24
+ "client_id": {
25
+ "type": "string",
26
+ "description": "Unique client identifier"
27
+ },
28
+ "client_secret": {
29
+ "type": "string",
30
+ "description": "Client secret. Only ever included in the response to the initial creation request."
31
+ },
32
+ "client_name": {
33
+ "type": "string",
34
+ "minLength": 1,
35
+ "maxLength": 255
36
+ },
37
+ "description": {
38
+ "type": "string",
39
+ "maxLength": 32767
40
+ },
41
+ "client_uri": {
42
+ "type": "string",
43
+ "format": "uri",
44
+ "maxLength": 1024
45
+ },
46
+ "logo_uri": {
47
+ "type": "string",
48
+ "format": "uri",
49
+ "maxLength": 32768,
50
+ "description": "URL of the client's logo. May be an http(s) URL or a data:image/* URI."
51
+ },
52
+ "redirect_uris": {
53
+ "type": "array",
54
+ "minItems": 1,
55
+ "maxItems": 25,
56
+ "items": {
57
+ "type": "string",
58
+ "format": "uri",
59
+ "maxLength": 1024
60
+ },
61
+ "description": "Array of redirect URIs for use in redirect-based flows"
62
+ },
63
+ "grant_types": {
64
+ "type": "array",
65
+ "items": {
66
+ "type": "string",
67
+ "enum": [
68
+ "authorization_code",
69
+ "refresh_token"
70
+ ]
71
+ },
72
+ "description": "Array of OAuth 2.0 grant types"
73
+ },
74
+ "response_types": {
75
+ "type": "array",
76
+ "items": {
77
+ "type": "string",
78
+ "enum": [
79
+ "code"
80
+ ]
81
+ },
82
+ "description": "Array of OAuth 2.0 response types"
83
+ },
84
+ "token_endpoint_auth_method": {
85
+ "type": "string",
86
+ "description": "Authentication method for the token endpoint",
87
+ "enum": [
88
+ "client_secret_basic",
89
+ "client_secret_post",
90
+ "none"
91
+ ]
92
+ },
93
+ "scope": {
94
+ "type": "array",
95
+ "uniqueItems": true,
96
+ "items": {
97
+ "type": "string",
98
+ "description": "OAuth-supported user-context API scope. See the `scopes_supported` field of the OAuth authorization server metadata document at /.well-known/oauth-authorization-server for the authoritative list.",
99
+ "enum": [
100
+ "all.Application.read",
101
+ "all.Application.bounded",
102
+ "only.Organization.read",
103
+ "only.Organization.bounded",
104
+ "all.Organization.read",
105
+ "all.Organization.bounded",
106
+ "only.User.read"
107
+ ]
108
+ },
109
+ "description": "API scopes this client may request"
110
+ },
111
+ "contacts": {
112
+ "type": "array",
113
+ "maxItems": 10,
114
+ "items": {
115
+ "type": "string",
116
+ "format": "email",
117
+ "maxLength": 1024
118
+ },
119
+ "description": "Contact email addresses for this client"
120
+ },
121
+ "tos_uri": {
122
+ "type": "string",
123
+ "format": "uri",
124
+ "maxLength": 1024
125
+ },
126
+ "policy_uri": {
127
+ "type": "string",
128
+ "format": "uri",
129
+ "maxLength": 1024
130
+ }
131
+ }
132
+ }
133
+ },
134
+ "count": {
135
+ "type": "integer"
136
+ },
137
+ "totalCount": {
138
+ "type": "integer"
139
+ },
140
+ "perPage": {
141
+ "type": "integer"
142
+ },
143
+ "page": {
144
+ "type": "integer"
145
+ },
146
+ "filter": {
147
+ "type": "string"
148
+ },
149
+ "filterField": {
150
+ "type": "string"
151
+ },
152
+ "sortField": {
153
+ "type": "string"
154
+ },
155
+ "sortDirection": {
156
+ "type": "string",
157
+ "enum": [
158
+ "asc",
159
+ "desc",
160
+ "ASC",
161
+ "DESC",
162
+ ""
163
+ ]
164
+ }
165
+ }
166
+ }
data/schemas/userPost.json CHANGED
@@ -36,6 +36,15 @@
36
36
  "type": "string",
37
37
  "maxLength": 1024
38
38
  },
39
+ "state": {
40
+ "type": "string",
41
+ "maxLength": 1024
42
+ },
43
+ "country": {
44
+ "type": "string",
45
+ "minLength": 1,
46
+ "maxLength": 1024
47
+ },
39
48
  "oauth": {
40
49
  "type": "object",
41
50
  "properties": {
@@ -571,6 +580,13 @@
571
580
  "userOauthTokens.*",
572
581
  "userOauthTokens.get",
573
582
  "userOauthTokens.post",
583
+ "userOauthClient.*",
584
+ "userOauthClient.get",
585
+ "userOauthClient.patch",
586
+ "userOauthClient.delete",
587
+ "userOauthClients.*",
588
+ "userOauthClients.get",
589
+ "userOauthClients.post",
574
590
  "applicationTemplate.*",
575
591
  "applicationTemplate.get",
576
592
  "applicationTemplates.*",