losant_rest 2.0.0 → 2.1.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 (232) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +2454 -666
  3. data/docs/application.md +21 -21
  4. data/docs/applicationApiToken.md +1 -1
  5. data/docs/applicationApiTokens.md +1 -1
  6. data/docs/applicationCertificate.md +3 -3
  7. data/docs/applicationCertificateAuthorities.md +2 -2
  8. data/docs/applicationCertificateAuthority.md +3 -3
  9. data/docs/applicationCertificates.md +2 -2
  10. data/docs/applicationDashboard.md +4 -4
  11. data/docs/applicationDashboards.md +2 -2
  12. data/docs/applicationJobLog.md +1 -1
  13. data/docs/applicationJobLogs.md +1 -1
  14. data/docs/applicationKey.md +3 -3
  15. data/docs/applicationKeys.md +2 -2
  16. data/docs/applicationTemplate.md +1 -1
  17. data/docs/applicationTemplates.md +3 -3
  18. data/docs/applications.md +4 -4
  19. data/docs/auditLog.md +1 -1
  20. data/docs/auditLogs.md +1 -1
  21. data/docs/credential.md +4 -4
  22. data/docs/credentials.md +2 -2
  23. data/docs/dashboard.md +3 -3
  24. data/docs/dashboards.md +2 -2
  25. data/docs/data.md +3 -3
  26. data/docs/dataTable.md +5 -5
  27. data/docs/dataTableRow.md +3 -3
  28. data/docs/dataTableRows.md +6 -6
  29. data/docs/dataTables.md +2 -2
  30. data/docs/device.md +14 -14
  31. data/docs/deviceAttribute.md +3 -3
  32. data/docs/deviceAttributes.md +2 -2
  33. data/docs/deviceRecipe.md +4 -4
  34. data/docs/deviceRecipes.md +2 -2
  35. data/docs/devices.md +14 -14
  36. data/docs/edgeDeployment.md +1 -1
  37. data/docs/edgeDeployments.md +4 -4
  38. data/docs/embeddedDeployment.md +1 -1
  39. data/docs/embeddedDeployments.md +5 -5
  40. data/docs/event.md +3 -3
  41. data/docs/events.md +6 -6
  42. data/docs/experience.md +2 -2
  43. data/docs/experienceDomain.md +3 -3
  44. data/docs/experienceDomains.md +2 -2
  45. data/docs/experienceEndpoint.md +4 -4
  46. data/docs/experienceEndpoints.md +3 -3
  47. data/docs/experienceGroup.md +3 -3
  48. data/docs/experienceGroups.md +2 -2
  49. data/docs/experienceSlug.md +3 -3
  50. data/docs/experienceSlugs.md +2 -2
  51. data/docs/experienceUser.md +3 -3
  52. data/docs/experienceUsers.md +2 -2
  53. data/docs/experienceVersion.md +3 -3
  54. data/docs/experienceVersions.md +2 -2
  55. data/docs/experienceView.md +4 -4
  56. data/docs/experienceViews.md +2 -2
  57. data/docs/file.md +5 -5
  58. data/docs/files.md +2 -2
  59. data/docs/flow.md +11 -11
  60. data/docs/flowVersion.md +6 -6
  61. data/docs/flowVersions.md +3 -3
  62. data/docs/flows.md +5 -5
  63. data/docs/instance.md +8 -8
  64. data/docs/instanceApiToken.md +1 -1
  65. data/docs/instanceApiTokens.md +1 -1
  66. data/docs/instanceAuditLog.md +1 -1
  67. data/docs/instanceAuditLogs.md +1 -1
  68. data/docs/instanceCustomNode.md +5 -5
  69. data/docs/instanceCustomNodes.md +2 -2
  70. data/docs/instanceMember.md +1 -1
  71. data/docs/instanceMembers.md +1 -1
  72. data/docs/instanceNotificationRule.md +5 -5
  73. data/docs/instanceNotificationRules.md +2 -2
  74. data/docs/instanceOrg.md +7 -7
  75. data/docs/instanceOrgInvite.md +1 -1
  76. data/docs/instanceOrgInvites.md +1 -1
  77. data/docs/instanceOrgMember.md +1 -1
  78. data/docs/instanceOrgMembers.md +1 -1
  79. data/docs/instanceOrgs.md +2 -2
  80. data/docs/instanceSandbox.md +7 -7
  81. data/docs/instanceSandboxes.md +1 -1
  82. data/docs/instances.md +1 -1
  83. data/docs/integration.md +3 -3
  84. data/docs/integrations.md +2 -2
  85. data/docs/me.md +20 -20
  86. data/docs/notebook.md +9 -9
  87. data/docs/notebooks.md +2 -2
  88. data/docs/org.md +13 -13
  89. data/docs/orgs.md +2 -2
  90. data/docs/privateFile.md +5 -5
  91. data/docs/privateFiles.md +2 -2
  92. data/docs/resourceJob.md +6 -6
  93. data/docs/resourceJobs.md +2 -2
  94. data/docs/userApiToken.md +3 -3
  95. data/docs/userApiTokens.md +2 -2
  96. data/docs/userOauthToken.md +125 -0
  97. data/docs/userOauthTokens.md +87 -0
  98. data/docs/webhook.md +3 -3
  99. data/docs/webhooks.md +2 -2
  100. data/lib/platform_rest/application.rb +20 -20
  101. data/lib/platform_rest/application_api_token.rb +1 -1
  102. data/lib/platform_rest/application_api_tokens.rb +1 -1
  103. data/lib/platform_rest/application_certificate.rb +3 -3
  104. data/lib/platform_rest/application_certificate_authorities.rb +2 -2
  105. data/lib/platform_rest/application_certificate_authority.rb +3 -3
  106. data/lib/platform_rest/application_certificates.rb +2 -2
  107. data/lib/platform_rest/application_dashboard.rb +4 -4
  108. data/lib/platform_rest/application_dashboards.rb +2 -2
  109. data/lib/platform_rest/application_job_log.rb +1 -1
  110. data/lib/platform_rest/application_job_logs.rb +1 -1
  111. data/lib/platform_rest/application_key.rb +3 -3
  112. data/lib/platform_rest/application_keys.rb +2 -2
  113. data/lib/platform_rest/application_template.rb +1 -1
  114. data/lib/platform_rest/application_templates.rb +3 -3
  115. data/lib/platform_rest/applications.rb +3 -3
  116. data/lib/platform_rest/audit_log.rb +1 -1
  117. data/lib/platform_rest/audit_logs.rb +1 -1
  118. data/lib/platform_rest/client.rb +10 -2
  119. data/lib/platform_rest/credential.rb +4 -4
  120. data/lib/platform_rest/credentials.rb +2 -2
  121. data/lib/platform_rest/dashboard.rb +3 -3
  122. data/lib/platform_rest/dashboards.rb +2 -2
  123. data/lib/platform_rest/data.rb +3 -3
  124. data/lib/platform_rest/data_table.rb +5 -5
  125. data/lib/platform_rest/data_table_row.rb +3 -3
  126. data/lib/platform_rest/data_table_rows.rb +6 -6
  127. data/lib/platform_rest/data_tables.rb +2 -2
  128. data/lib/platform_rest/device.rb +14 -14
  129. data/lib/platform_rest/device_attribute.rb +3 -3
  130. data/lib/platform_rest/device_attributes.rb +2 -2
  131. data/lib/platform_rest/device_recipe.rb +4 -4
  132. data/lib/platform_rest/device_recipes.rb +2 -2
  133. data/lib/platform_rest/devices.rb +14 -14
  134. data/lib/platform_rest/edge_deployment.rb +1 -1
  135. data/lib/platform_rest/edge_deployments.rb +4 -4
  136. data/lib/platform_rest/embedded_deployment.rb +1 -1
  137. data/lib/platform_rest/embedded_deployments.rb +5 -5
  138. data/lib/platform_rest/event.rb +3 -3
  139. data/lib/platform_rest/events.rb +6 -6
  140. data/lib/platform_rest/experience.rb +2 -2
  141. data/lib/platform_rest/experience_domain.rb +3 -3
  142. data/lib/platform_rest/experience_domains.rb +2 -2
  143. data/lib/platform_rest/experience_endpoint.rb +4 -4
  144. data/lib/platform_rest/experience_endpoints.rb +3 -3
  145. data/lib/platform_rest/experience_group.rb +3 -3
  146. data/lib/platform_rest/experience_groups.rb +2 -2
  147. data/lib/platform_rest/experience_slug.rb +3 -3
  148. data/lib/platform_rest/experience_slugs.rb +2 -2
  149. data/lib/platform_rest/experience_user.rb +3 -3
  150. data/lib/platform_rest/experience_users.rb +2 -2
  151. data/lib/platform_rest/experience_version.rb +3 -3
  152. data/lib/platform_rest/experience_versions.rb +2 -2
  153. data/lib/platform_rest/experience_view.rb +4 -4
  154. data/lib/platform_rest/experience_views.rb +2 -2
  155. data/lib/platform_rest/file.rb +4 -4
  156. data/lib/platform_rest/files.rb +2 -2
  157. data/lib/platform_rest/flow.rb +11 -11
  158. data/lib/platform_rest/flow_version.rb +6 -6
  159. data/lib/platform_rest/flow_versions.rb +3 -3
  160. data/lib/platform_rest/flows.rb +5 -5
  161. data/lib/platform_rest/instance.rb +8 -8
  162. data/lib/platform_rest/instance_api_token.rb +1 -1
  163. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  164. data/lib/platform_rest/instance_audit_log.rb +1 -1
  165. data/lib/platform_rest/instance_audit_logs.rb +1 -1
  166. data/lib/platform_rest/instance_custom_node.rb +5 -5
  167. data/lib/platform_rest/instance_custom_nodes.rb +2 -2
  168. data/lib/platform_rest/instance_member.rb +1 -1
  169. data/lib/platform_rest/instance_members.rb +1 -1
  170. data/lib/platform_rest/instance_notification_rule.rb +5 -5
  171. data/lib/platform_rest/instance_notification_rules.rb +2 -2
  172. data/lib/platform_rest/instance_org.rb +7 -7
  173. data/lib/platform_rest/instance_org_invite.rb +1 -1
  174. data/lib/platform_rest/instance_org_invites.rb +1 -1
  175. data/lib/platform_rest/instance_org_member.rb +1 -1
  176. data/lib/platform_rest/instance_org_members.rb +1 -1
  177. data/lib/platform_rest/instance_orgs.rb +2 -2
  178. data/lib/platform_rest/instance_sandbox.rb +7 -7
  179. data/lib/platform_rest/instance_sandboxes.rb +1 -1
  180. data/lib/platform_rest/instances.rb +1 -1
  181. data/lib/platform_rest/integration.rb +3 -3
  182. data/lib/platform_rest/integrations.rb +2 -2
  183. data/lib/platform_rest/me.rb +20 -20
  184. data/lib/platform_rest/notebook.rb +8 -8
  185. data/lib/platform_rest/notebooks.rb +2 -2
  186. data/lib/platform_rest/org.rb +13 -13
  187. data/lib/platform_rest/orgs.rb +2 -2
  188. data/lib/platform_rest/private_file.rb +4 -4
  189. data/lib/platform_rest/private_files.rb +2 -2
  190. data/lib/platform_rest/resource_job.rb +6 -6
  191. data/lib/platform_rest/resource_jobs.rb +2 -2
  192. data/lib/platform_rest/user_api_token.rb +3 -3
  193. data/lib/platform_rest/user_api_tokens.rb +2 -2
  194. data/lib/platform_rest/user_oauth_token.rb +170 -0
  195. data/lib/platform_rest/user_oauth_tokens.rb +132 -0
  196. data/lib/platform_rest/version.rb +1 -1
  197. data/lib/platform_rest/webhook.rb +3 -3
  198. data/lib/platform_rest/webhooks.rb +2 -2
  199. data/lib/platform_rest.rb +2 -0
  200. data/schemas/apiToken.json +100 -0
  201. data/schemas/apiTokenPatch.json +100 -0
  202. data/schemas/apiTokenPost.json +118 -0
  203. data/schemas/apiTokens.json +100 -0
  204. data/schemas/applicationDashboardPost.json +4 -0
  205. data/schemas/dashboard.json +4 -0
  206. data/schemas/dashboardPatch.json +4 -0
  207. data/schemas/dashboardPost.json +4 -0
  208. data/schemas/dashboards.json +4 -0
  209. data/schemas/githubLogin.json +18 -0
  210. data/schemas/instanceOrgMemberPatch.json +2 -2
  211. data/schemas/instanceOrgMemberPost.json +4 -4
  212. data/schemas/instanceOrgPost.json +4 -4
  213. data/schemas/oauthClient.json +107 -0
  214. data/schemas/oauthClientPost.json +89 -0
  215. data/schemas/oauthDcrError.json +23 -0
  216. data/schemas/oauthError.json +31 -0
  217. data/schemas/org.json +2 -2
  218. data/schemas/orgInvite.json +2 -2
  219. data/schemas/orgInviteCollection.json +2 -2
  220. data/schemas/orgInvitePost.json +2 -2
  221. data/schemas/orgInvites.json +2 -2
  222. data/schemas/orgMemberPatch.json +2 -2
  223. data/schemas/orgRoleInfo.json +2 -2
  224. data/schemas/orgs.json +2 -2
  225. data/schemas/samlResponse.json +18 -0
  226. data/schemas/userCredentials.json +18 -0
  227. data/schemas/userOauthToken.json +207 -0
  228. data/schemas/userOauthTokenPatch.json +123 -0
  229. data/schemas/userOauthTokenPost.json +197 -0
  230. data/schemas/userOauthTokens.json +248 -0
  231. data/schemas/userPost.json +18 -0
  232. metadata +13 -1
data/schemas/userOauthToken.json ADDED
@@ -0,0 +1,207 @@
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
+ "oauthTokenId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "name": {
14
+ "type": "string",
15
+ "minLength": 1,
16
+ "maxLength": 255
17
+ },
18
+ "description": {
19
+ "type": "string",
20
+ "maxLength": 32767
21
+ },
22
+ "creationDate": {
23
+ "type": "string",
24
+ "format": "date-time"
25
+ },
26
+ "lastUpdated": {
27
+ "type": "string",
28
+ "format": "date-time"
29
+ },
30
+ "expirationDate": {
31
+ "type": "string",
32
+ "format": "date-time"
33
+ },
34
+ "defaultRole": {
35
+ "type": "string",
36
+ "enum": [
37
+ "admin",
38
+ "edit",
39
+ "collaborate",
40
+ "view",
41
+ "none"
42
+ ]
43
+ },
44
+ "orgRoles": {
45
+ "type": "array",
46
+ "items": {
47
+ "type": "object",
48
+ "properties": {
49
+ "orgId": {
50
+ "oneOf": [
51
+ {
52
+ "type": "string",
53
+ "pattern": "^[A-Fa-f\\d]{24}$"
54
+ },
55
+ {
56
+ "type": "string",
57
+ "enum": [
58
+ "sandbox"
59
+ ]
60
+ }
61
+ ]
62
+ },
63
+ "role": {
64
+ "type": "string",
65
+ "enum": [
66
+ "admin",
67
+ "edit",
68
+ "collaborate",
69
+ "view",
70
+ "none"
71
+ ]
72
+ },
73
+ "applicationRoles": {
74
+ "type": "array",
75
+ "items": {
76
+ "type": "object",
77
+ "properties": {
78
+ "resourceId": {
79
+ "type": "string",
80
+ "pattern": "^[A-Fa-f\\d]{24}$"
81
+ },
82
+ "role": {
83
+ "type": "string",
84
+ "enum": [
85
+ "collaborate",
86
+ "view",
87
+ "none"
88
+ ]
89
+ }
90
+ },
91
+ "required": [
92
+ "resourceId",
93
+ "role"
94
+ ],
95
+ "additionalProperties": false
96
+ },
97
+ "maxItems": 100
98
+ },
99
+ "dashboardRoles": {
100
+ "type": "array",
101
+ "items": {
102
+ "type": "object",
103
+ "properties": {
104
+ "resourceId": {
105
+ "type": "string",
106
+ "pattern": "^[A-Fa-f\\d]{24}$"
107
+ },
108
+ "role": {
109
+ "type": "string",
110
+ "enum": [
111
+ "collaborate",
112
+ "view",
113
+ "none"
114
+ ]
115
+ }
116
+ },
117
+ "required": [
118
+ "resourceId",
119
+ "role"
120
+ ],
121
+ "additionalProperties": false
122
+ },
123
+ "maxItems": 100
124
+ }
125
+ },
126
+ "required": [
127
+ "orgId",
128
+ "role"
129
+ ],
130
+ "additionalProperties": false
131
+ },
132
+ "maxItems": 25
133
+ },
134
+ "scope": {
135
+ "type": "array",
136
+ "uniqueItems": true,
137
+ "items": {
138
+ "type": "string",
139
+ "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.",
140
+ "enum": [
141
+ "all.Application.read",
142
+ "all.Application.bounded",
143
+ "only.Organization.read",
144
+ "only.Organization.bounded",
145
+ "all.Organization.read",
146
+ "all.Organization.bounded",
147
+ "only.User.read"
148
+ ]
149
+ },
150
+ "description": "API scopes for this OAuth client"
151
+ },
152
+ "status": {
153
+ "type": "string",
154
+ "enum": [
155
+ "active",
156
+ "inactive"
157
+ ]
158
+ },
159
+ "oauth": {
160
+ "type": "object",
161
+ "properties": {
162
+ "client_id": {
163
+ "type": "string",
164
+ "minLength": 24,
165
+ "maxLength": 1024,
166
+ "description": "The registered OAuth client ID (ObjectId or HTTPS URL for CIMD)"
167
+ },
168
+ "client_name": {
169
+ "type": "string",
170
+ "maxLength": 255,
171
+ "description": "Human-readable name of the OAuth client (from client registration)"
172
+ },
173
+ "client_uri": {
174
+ "type": "string",
175
+ "maxLength": 1024,
176
+ "description": "Informational URL for the OAuth client's homepage (from client registration)"
177
+ },
178
+ "logo_uri": {
179
+ "type": "string",
180
+ "maxLength": 32768,
181
+ "description": "Logo URL for the OAuth client (http(s) URL or data: URI, from client registration)"
182
+ },
183
+ "redirect_uri": {
184
+ "type": "string",
185
+ "format": "uri",
186
+ "maxLength": 1024
187
+ },
188
+ "resource": {
189
+ "type": "array",
190
+ "items": {
191
+ "type": "string",
192
+ "format": "uri",
193
+ "maxLength": 1024
194
+ },
195
+ "description": "Resource indicator(s) per RFC 8707 — audience(s) this token is bound to"
196
+ },
197
+ "authorizationStatus": {
198
+ "type": "string",
199
+ "enum": [
200
+ "pending",
201
+ "authorized"
202
+ ]
203
+ }
204
+ }
205
+ }
206
+ }
207
+ }
data/schemas/userOauthTokenPatch.json ADDED
@@ -0,0 +1,123 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "defaultRole": {
15
+ "type": "string",
16
+ "enum": [
17
+ "admin",
18
+ "edit",
19
+ "collaborate",
20
+ "view",
21
+ "none"
22
+ ]
23
+ },
24
+ "orgRoles": {
25
+ "type": "array",
26
+ "items": {
27
+ "type": "object",
28
+ "properties": {
29
+ "orgId": {
30
+ "oneOf": [
31
+ {
32
+ "type": "string",
33
+ "pattern": "^[A-Fa-f\\d]{24}$"
34
+ },
35
+ {
36
+ "type": "string",
37
+ "enum": [
38
+ "sandbox"
39
+ ]
40
+ }
41
+ ]
42
+ },
43
+ "role": {
44
+ "type": "string",
45
+ "enum": [
46
+ "admin",
47
+ "edit",
48
+ "collaborate",
49
+ "view",
50
+ "none"
51
+ ]
52
+ },
53
+ "applicationRoles": {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "object",
57
+ "properties": {
58
+ "resourceId": {
59
+ "type": "string",
60
+ "pattern": "^[A-Fa-f\\d]{24}$"
61
+ },
62
+ "role": {
63
+ "type": "string",
64
+ "enum": [
65
+ "collaborate",
66
+ "view",
67
+ "none"
68
+ ]
69
+ }
70
+ },
71
+ "required": [
72
+ "resourceId",
73
+ "role"
74
+ ],
75
+ "additionalProperties": false
76
+ },
77
+ "maxItems": 100
78
+ },
79
+ "dashboardRoles": {
80
+ "type": "array",
81
+ "items": {
82
+ "type": "object",
83
+ "properties": {
84
+ "resourceId": {
85
+ "type": "string",
86
+ "pattern": "^[A-Fa-f\\d]{24}$"
87
+ },
88
+ "role": {
89
+ "type": "string",
90
+ "enum": [
91
+ "collaborate",
92
+ "view",
93
+ "none"
94
+ ]
95
+ }
96
+ },
97
+ "required": [
98
+ "resourceId",
99
+ "role"
100
+ ],
101
+ "additionalProperties": false
102
+ },
103
+ "maxItems": 100
104
+ }
105
+ },
106
+ "required": [
107
+ "orgId",
108
+ "role"
109
+ ],
110
+ "additionalProperties": false
111
+ },
112
+ "maxItems": 25
113
+ },
114
+ "status": {
115
+ "type": "string",
116
+ "enum": [
117
+ "active",
118
+ "inactive"
119
+ ]
120
+ }
121
+ },
122
+ "additionalProperties": false
123
+ }
data/schemas/userOauthTokenPost.json ADDED
@@ -0,0 +1,197 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "expirationDate": {
15
+ "oneOf": [
16
+ {
17
+ "type": "string",
18
+ "format": "date-time"
19
+ },
20
+ {
21
+ "type": "null"
22
+ }
23
+ ],
24
+ "description": "Session expiration. Omit for the default 1-year session, pass an ISO date for a specific expiration, or pass null for a session that does not expire."
25
+ },
26
+ "oauth": {
27
+ "type": "object",
28
+ "properties": {
29
+ "client_id": {
30
+ "type": "string",
31
+ "minLength": 24,
32
+ "maxLength": 1024,
33
+ "description": "The registered OAuth client ID (ObjectId or HTTPS URL for CIMD)"
34
+ },
35
+ "redirect_uri": {
36
+ "type": "string",
37
+ "format": "uri",
38
+ "maxLength": 1024
39
+ },
40
+ "resource": {
41
+ "type": "array",
42
+ "maxItems": 10,
43
+ "items": {
44
+ "type": "string",
45
+ "format": "uri",
46
+ "maxLength": 1024
47
+ },
48
+ "description": "Resource indicator(s) per RFC 8707 — absolute URI(s) identifying the audience(s) this token is being requested for"
49
+ },
50
+ "code_challenge": {
51
+ "type": "string",
52
+ "minLength": 43,
53
+ "maxLength": 128,
54
+ "pattern": "^[A-Za-z0-9_-]+$",
55
+ "description": "PKCE code challenge (RFC 7636 base64url, 43-128 chars)"
56
+ },
57
+ "code_challenge_method": {
58
+ "type": "string",
59
+ "enum": [
60
+ "S256"
61
+ ],
62
+ "description": "PKCE code challenge method"
63
+ }
64
+ },
65
+ "additionalProperties": false,
66
+ "required": [
67
+ "client_id",
68
+ "redirect_uri",
69
+ "code_challenge",
70
+ "code_challenge_method"
71
+ ]
72
+ },
73
+ "defaultRole": {
74
+ "type": "string",
75
+ "enum": [
76
+ "admin",
77
+ "edit",
78
+ "collaborate",
79
+ "view",
80
+ "none"
81
+ ]
82
+ },
83
+ "orgRoles": {
84
+ "type": "array",
85
+ "items": {
86
+ "type": "object",
87
+ "properties": {
88
+ "orgId": {
89
+ "oneOf": [
90
+ {
91
+ "type": "string",
92
+ "pattern": "^[A-Fa-f\\d]{24}$"
93
+ },
94
+ {
95
+ "type": "string",
96
+ "enum": [
97
+ "sandbox"
98
+ ]
99
+ }
100
+ ]
101
+ },
102
+ "role": {
103
+ "type": "string",
104
+ "enum": [
105
+ "admin",
106
+ "edit",
107
+ "collaborate",
108
+ "view",
109
+ "none"
110
+ ]
111
+ },
112
+ "applicationRoles": {
113
+ "type": "array",
114
+ "items": {
115
+ "type": "object",
116
+ "properties": {
117
+ "resourceId": {
118
+ "type": "string",
119
+ "pattern": "^[A-Fa-f\\d]{24}$"
120
+ },
121
+ "role": {
122
+ "type": "string",
123
+ "enum": [
124
+ "collaborate",
125
+ "view",
126
+ "none"
127
+ ]
128
+ }
129
+ },
130
+ "required": [
131
+ "resourceId",
132
+ "role"
133
+ ],
134
+ "additionalProperties": false
135
+ },
136
+ "maxItems": 100
137
+ },
138
+ "dashboardRoles": {
139
+ "type": "array",
140
+ "items": {
141
+ "type": "object",
142
+ "properties": {
143
+ "resourceId": {
144
+ "type": "string",
145
+ "pattern": "^[A-Fa-f\\d]{24}$"
146
+ },
147
+ "role": {
148
+ "type": "string",
149
+ "enum": [
150
+ "collaborate",
151
+ "view",
152
+ "none"
153
+ ]
154
+ }
155
+ },
156
+ "required": [
157
+ "resourceId",
158
+ "role"
159
+ ],
160
+ "additionalProperties": false
161
+ },
162
+ "maxItems": 100
163
+ }
164
+ },
165
+ "required": [
166
+ "orgId",
167
+ "role"
168
+ ],
169
+ "additionalProperties": false
170
+ },
171
+ "maxItems": 25
172
+ },
173
+ "scope": {
174
+ "type": "array",
175
+ "uniqueItems": true,
176
+ "items": {
177
+ "type": "string",
178
+ "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.",
179
+ "enum": [
180
+ "all.Application.read",
181
+ "all.Application.bounded",
182
+ "only.Organization.read",
183
+ "only.Organization.bounded",
184
+ "all.Organization.read",
185
+ "all.Organization.bounded",
186
+ "only.User.read"
187
+ ]
188
+ },
189
+ "description": "API scopes for this OAuth client"
190
+ }
191
+ },
192
+ "additionalProperties": false,
193
+ "required": [
194
+ "name",
195
+ "oauth"
196
+ ]
197
+ }