@lumoauth/api-client 1.5.0 → 1.6.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 (248) hide show
  1. package/.openapi-generator/FILES +12 -2
  2. package/README.md +10 -3
  3. package/api/admin-abac-api.ts +18 -5
  4. package/api/admin-agents-api.ts +50 -5
  5. package/api/admin-audit-logs-api.ts +15 -15
  6. package/api/admin-email-api.ts +15 -15
  7. package/api/admin-groups-api.ts +15 -15
  8. package/api/admin-mfa-api.ts +10 -10
  9. package/api/admin-oauth-clients-api.ts +15 -15
  10. package/api/admin-roles-api.ts +20 -20
  11. package/api/admin-settings-api.ts +112 -60
  12. package/api/admin-users-api.ts +320 -31
  13. package/api/agents-api.ts +5 -5
  14. package/api/authorization-api.ts +20 -20
  15. package/api/oauth-api.ts +116 -5
  16. package/api/ssf-api.ts +10 -10
  17. package/dist/api/admin-abac-api.d.ts +10 -2
  18. package/dist/api/admin-abac-api.js +10 -5
  19. package/dist/api/admin-agents-api.d.ts +37 -2
  20. package/dist/api/admin-agents-api.js +37 -6
  21. package/dist/api/admin-audit-logs-api.d.ts +15 -15
  22. package/dist/api/admin-audit-logs-api.js +12 -12
  23. package/dist/api/admin-email-api.d.ts +15 -15
  24. package/dist/api/admin-email-api.js +12 -12
  25. package/dist/api/admin-groups-api.d.ts +15 -15
  26. package/dist/api/admin-groups-api.js +12 -12
  27. package/dist/api/admin-mfa-api.d.ts +10 -10
  28. package/dist/api/admin-mfa-api.js +8 -8
  29. package/dist/api/admin-oauth-clients-api.d.ts +15 -15
  30. package/dist/api/admin-oauth-clients-api.js +12 -12
  31. package/dist/api/admin-roles-api.d.ts +20 -20
  32. package/dist/api/admin-roles-api.js +16 -16
  33. package/dist/api/admin-settings-api.d.ts +82 -48
  34. package/dist/api/admin-settings-api.js +68 -52
  35. package/dist/api/admin-users-api.d.ts +201 -22
  36. package/dist/api/admin-users-api.js +185 -28
  37. package/dist/api/agents-api.d.ts +5 -5
  38. package/dist/api/agents-api.js +4 -4
  39. package/dist/api/authorization-api.d.ts +20 -20
  40. package/dist/api/authorization-api.js +16 -16
  41. package/dist/api/oauth-api.d.ts +70 -5
  42. package/dist/api/oauth-api.js +76 -4
  43. package/dist/api/ssf-api.d.ts +10 -10
  44. package/dist/api/ssf-api.js +8 -8
  45. package/dist/esm/api/admin-abac-api.d.ts +10 -2
  46. package/dist/esm/api/admin-abac-api.js +10 -5
  47. package/dist/esm/api/admin-agents-api.d.ts +37 -2
  48. package/dist/esm/api/admin-agents-api.js +36 -5
  49. package/dist/esm/api/admin-audit-logs-api.d.ts +15 -15
  50. package/dist/esm/api/admin-audit-logs-api.js +12 -12
  51. package/dist/esm/api/admin-email-api.d.ts +15 -15
  52. package/dist/esm/api/admin-email-api.js +12 -12
  53. package/dist/esm/api/admin-groups-api.d.ts +15 -15
  54. package/dist/esm/api/admin-groups-api.js +12 -12
  55. package/dist/esm/api/admin-mfa-api.d.ts +10 -10
  56. package/dist/esm/api/admin-mfa-api.js +8 -8
  57. package/dist/esm/api/admin-oauth-clients-api.d.ts +15 -15
  58. package/dist/esm/api/admin-oauth-clients-api.js +12 -12
  59. package/dist/esm/api/admin-roles-api.d.ts +20 -20
  60. package/dist/esm/api/admin-roles-api.js +16 -16
  61. package/dist/esm/api/admin-settings-api.d.ts +82 -48
  62. package/dist/esm/api/admin-settings-api.js +69 -53
  63. package/dist/esm/api/admin-users-api.d.ts +201 -22
  64. package/dist/esm/api/admin-users-api.js +184 -27
  65. package/dist/esm/api/agents-api.d.ts +5 -5
  66. package/dist/esm/api/agents-api.js +4 -4
  67. package/dist/esm/api/authorization-api.d.ts +20 -20
  68. package/dist/esm/api/authorization-api.js +16 -16
  69. package/dist/esm/api/oauth-api.d.ts +70 -5
  70. package/dist/esm/api/oauth-api.js +76 -4
  71. package/dist/esm/api/ssf-api.d.ts +10 -10
  72. package/dist/esm/api/ssf-api.js +8 -8
  73. package/dist/esm/models/abac-attribute-definition.d.ts +6 -0
  74. package/dist/esm/models/abac-policy.d.ts +7 -1
  75. package/dist/esm/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
  76. package/dist/esm/models/admin-groups-list-response.d.ts +6 -0
  77. package/dist/esm/models/admin-mcp-servers-list-response.d.ts +8 -3
  78. package/dist/esm/models/admin-settings-all-response-data-general.d.ts +13 -1
  79. package/dist/esm/models/admin-settings-all-response-data.d.ts +4 -5
  80. package/dist/esm/models/admin-settings-email-get-response.d.ts +4 -5
  81. package/dist/esm/models/admin-settings-general-get-response-data.d.ts +4 -10
  82. package/dist/esm/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
  83. package/dist/esm/models/ask-response.d.ts +15 -0
  84. package/dist/esm/models/ask-response.js +10 -1
  85. package/dist/esm/models/attest-response.d.ts +2 -2
  86. package/dist/esm/models/authorization-server-metadata.d.ts +8 -2
  87. package/dist/esm/models/check-email-first-request.d.ts +30 -0
  88. package/dist/esm/models/check-email-first-request.js +14 -0
  89. package/dist/esm/models/check-email-first-response.d.ts +42 -0
  90. package/dist/esm/models/check-email-first-response.js +14 -0
  91. package/dist/esm/models/email-sender-settings.d.ts +62 -0
  92. package/dist/esm/models/email-sender-settings.js +22 -0
  93. package/dist/esm/models/get-me-response.d.ts +18 -0
  94. package/dist/esm/models/get-server-challenge-response.d.ts +3 -2
  95. package/dist/esm/models/get-server-challenge-response.js +1 -0
  96. package/dist/esm/models/index.d.ts +6 -1
  97. package/dist/esm/models/index.js +6 -1
  98. package/dist/esm/models/introspect-response.d.ts +6 -0
  99. package/dist/esm/models/issue-agent-token-request.d.ts +6 -0
  100. package/dist/esm/models/list-users-response.d.ts +6 -0
  101. package/dist/esm/models/oauth-scope.d.ts +1 -7
  102. package/dist/esm/models/open-id-configuration.d.ts +3 -3
  103. package/dist/esm/models/put-admin-settings-branding-update-response.d.ts +6 -0
  104. package/dist/esm/models/put-admin-settings-email-update-request.d.ts +36 -0
  105. package/dist/esm/models/put-admin-settings-email-update-request.js +14 -0
  106. package/dist/esm/models/put-admin-settings-email-update-response.d.ts +4 -5
  107. package/dist/esm/models/put-admin-settings-general-update-request.d.ts +30 -0
  108. package/dist/esm/models/put-admin-settings-general-update-request.js +14 -0
  109. package/dist/esm/models/put-admin-settings-general-update-response-data.d.ts +1 -7
  110. package/dist/esm/models/register-client-response.d.ts +0 -24
  111. package/dist/esm/models/registered-client-metadata.d.ts +0 -24
  112. package/dist/esm/models/social-login-provider.d.ts +2 -1
  113. package/dist/esm/models/user.d.ts +12 -0
  114. package/dist/esm/models/userinfo-response.d.ts +4 -12
  115. package/dist/esm/models/userinfo-response.js +0 -2
  116. package/dist/models/abac-attribute-definition.d.ts +6 -0
  117. package/dist/models/abac-policy.d.ts +7 -1
  118. package/dist/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
  119. package/dist/models/admin-groups-list-response.d.ts +6 -0
  120. package/dist/models/admin-mcp-servers-list-response.d.ts +8 -3
  121. package/dist/models/admin-settings-all-response-data-general.d.ts +13 -1
  122. package/dist/models/admin-settings-all-response-data.d.ts +4 -5
  123. package/dist/models/admin-settings-email-get-response.d.ts +4 -5
  124. package/dist/models/admin-settings-general-get-response-data.d.ts +4 -10
  125. package/dist/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
  126. package/dist/models/ask-response.d.ts +15 -0
  127. package/dist/models/ask-response.js +11 -0
  128. package/dist/models/attest-response.d.ts +2 -2
  129. package/dist/models/authorization-server-metadata.d.ts +8 -2
  130. package/dist/models/check-email-first-request.d.ts +30 -0
  131. package/dist/models/check-email-first-request.js +15 -0
  132. package/dist/models/check-email-first-response.d.ts +42 -0
  133. package/dist/models/check-email-first-response.js +15 -0
  134. package/dist/models/email-sender-settings.d.ts +62 -0
  135. package/dist/models/email-sender-settings.js +25 -0
  136. package/dist/models/get-me-response.d.ts +18 -0
  137. package/dist/models/get-server-challenge-response.d.ts +3 -2
  138. package/dist/models/get-server-challenge-response.js +1 -0
  139. package/dist/models/index.d.ts +6 -1
  140. package/dist/models/index.js +6 -1
  141. package/dist/models/introspect-response.d.ts +6 -0
  142. package/dist/models/issue-agent-token-request.d.ts +6 -0
  143. package/dist/models/list-users-response.d.ts +6 -0
  144. package/dist/models/oauth-scope.d.ts +1 -7
  145. package/dist/models/open-id-configuration.d.ts +3 -3
  146. package/dist/models/put-admin-settings-branding-update-response.d.ts +6 -0
  147. package/dist/models/put-admin-settings-email-update-request.d.ts +36 -0
  148. package/dist/models/put-admin-settings-email-update-request.js +15 -0
  149. package/dist/models/put-admin-settings-email-update-response.d.ts +4 -5
  150. package/dist/models/put-admin-settings-general-update-request.d.ts +30 -0
  151. package/dist/models/put-admin-settings-general-update-request.js +15 -0
  152. package/dist/models/put-admin-settings-general-update-response-data.d.ts +1 -7
  153. package/dist/models/register-client-response.d.ts +0 -24
  154. package/dist/models/registered-client-metadata.d.ts +0 -24
  155. package/dist/models/social-login-provider.d.ts +2 -1
  156. package/dist/models/user.d.ts +12 -0
  157. package/dist/models/userinfo-response.d.ts +4 -12
  158. package/dist/models/userinfo-response.js +0 -2
  159. package/docs/AbacAttributeDefinition.md +2 -0
  160. package/docs/AbacPolicy.md +3 -1
  161. package/docs/AdminAbacApi.md +14 -9
  162. package/docs/AdminAgentsApi.md +7 -1
  163. package/docs/AdminAnalyticsDashboardResponseDataAudit.md +1 -1
  164. package/docs/AdminAuditLogsApi.md +3 -0
  165. package/docs/AdminEmailApi.md +3 -0
  166. package/docs/AdminGroupsApi.md +3 -0
  167. package/docs/AdminGroupsListResponse.md +2 -0
  168. package/docs/AdminMcpServersListResponse.md +3 -1
  169. package/docs/AdminMfaApi.md +4 -2
  170. package/docs/AdminOAuthClientsApi.md +3 -1
  171. package/docs/AdminOrganizationsApi.md +13 -5
  172. package/docs/AdminRolesApi.md +10 -0
  173. package/docs/AdminSettingsAllResponseData.md +1 -1
  174. package/docs/AdminSettingsAllResponseDataGeneral.md +5 -1
  175. package/docs/AdminSettingsApi.md +54 -12
  176. package/docs/AdminSettingsEmailGetResponse.md +1 -1
  177. package/docs/AdminSettingsGeneralGetResponseData.md +4 -6
  178. package/docs/AdminUsersApi.md +104 -2
  179. package/docs/AdminUsersRestoreResponse.md +22 -0
  180. package/docs/AgentsApi.md +2 -2
  181. package/docs/AskResponse.md +2 -0
  182. package/docs/AttestResponse.md +1 -1
  183. package/docs/AuthorizationApi.md +4 -4
  184. package/docs/AuthorizationServerMetadata.md +4 -2
  185. package/docs/CheckEmailFirstRequest.md +22 -0
  186. package/docs/CheckEmailFirstResponse.md +26 -0
  187. package/docs/EmailSenderSettings.md +31 -0
  188. package/docs/GetMeResponse.md +6 -0
  189. package/docs/GetServerChallengeResponse.md +1 -1
  190. package/docs/IdentityApi.md +2 -2
  191. package/docs/IntrospectResponse.md +2 -0
  192. package/docs/IssueAgentTokenRequest.md +2 -0
  193. package/docs/ListUsersResponse.md +2 -0
  194. package/docs/McpApi.md +5 -6
  195. package/docs/OAuthApi.md +72 -12
  196. package/docs/OAuthScope.md +1 -3
  197. package/docs/OIDCApi.md +4 -4
  198. package/docs/OpenIdConfiguration.md +3 -3
  199. package/docs/PutAdminSettingsBrandingUpdateResponse.md +2 -0
  200. package/docs/PutAdminSettingsEmailUpdateRequest.md +24 -0
  201. package/docs/PutAdminSettingsEmailUpdateResponse.md +1 -1
  202. package/docs/PutAdminSettingsGeneralUpdateRequest.md +22 -0
  203. package/docs/PutAdminSettingsGeneralUpdateResponseData.md +1 -3
  204. package/docs/RegisterClientResponse.md +0 -8
  205. package/docs/RegisteredClientMetadata.md +0 -8
  206. package/docs/SocialLoginProvider.md +1 -1
  207. package/docs/SsfApi.md +2 -0
  208. package/docs/User.md +4 -0
  209. package/docs/UserinfoResponse.md +3 -5
  210. package/docs/WellKnownApi.md +2 -2
  211. package/models/abac-attribute-definition.ts +6 -0
  212. package/models/abac-policy.ts +7 -1
  213. package/models/admin-analytics-dashboard-response-data-audit.ts +1 -1
  214. package/models/admin-groups-list-response.ts +6 -0
  215. package/models/admin-mcp-servers-list-response.ts +8 -5
  216. package/models/admin-settings-all-response-data-general.ts +13 -1
  217. package/models/admin-settings-all-response-data.ts +6 -3
  218. package/models/admin-settings-email-get-response.ts +6 -3
  219. package/models/admin-settings-general-get-response-data.ts +4 -10
  220. package/models/{admin-mcp-servers-list-response-meta.ts → admin-users-restore-response.ts} +11 -14
  221. package/models/ask-response.ts +17 -0
  222. package/models/attest-response.ts +2 -2
  223. package/models/authorization-server-metadata.ts +8 -2
  224. package/models/check-email-first-request.ts +36 -0
  225. package/models/check-email-first-response.ts +48 -0
  226. package/models/email-sender-settings.ts +70 -0
  227. package/models/get-me-response.ts +18 -0
  228. package/models/get-server-challenge-response.ts +3 -2
  229. package/models/index.ts +6 -1
  230. package/models/introspect-response.ts +6 -0
  231. package/models/issue-agent-token-request.ts +6 -0
  232. package/models/list-users-response.ts +6 -0
  233. package/models/oauth-scope.ts +1 -7
  234. package/models/open-id-configuration.ts +3 -3
  235. package/models/put-admin-settings-branding-update-response.ts +6 -0
  236. package/models/put-admin-settings-email-update-request.ts +42 -0
  237. package/models/put-admin-settings-email-update-response.ts +6 -3
  238. package/models/put-admin-settings-general-update-request.ts +36 -0
  239. package/models/put-admin-settings-general-update-response-data.ts +1 -7
  240. package/models/register-client-response.ts +0 -24
  241. package/models/registered-client-metadata.ts +0 -24
  242. package/models/social-login-provider.ts +2 -1
  243. package/models/user.ts +12 -0
  244. package/models/userinfo-response.ts +4 -12
  245. package/package.json +1 -1
  246. package/docs/AdminMcpServersListResponseMeta.md +0 -24
  247. /package/dist/esm/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
  248. /package/dist/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
@@ -51,28 +51,28 @@ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configu
51
51
  */
52
52
  checkAbacBulk: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53
53
  /**
54
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
54
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
55
55
  * @summary Check whether the subject holds all of the permissions
56
56
  * @param {*} [options] Override http request option.
57
57
  * @throws {RequiredError}
58
58
  */
59
59
  checkAllPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
60
60
  /**
61
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
61
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
62
62
  * @summary Check whether the subject holds any of the permissions
63
63
  * @param {*} [options] Override http request option.
64
64
  * @throws {RequiredError}
65
65
  */
66
66
  checkAnyPermission: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67
67
  /**
68
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
68
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
69
69
  * @summary Check one permission
70
70
  * @param {*} [options] Override http request option.
71
71
  * @throws {RequiredError}
72
72
  */
73
73
  checkPermission: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
74
74
  /**
75
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
75
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
76
76
  * @summary Check up to 100 permissions in one call
77
77
  * @param {*} [options] Override http request option.
78
78
  * @throws {RequiredError}
@@ -202,28 +202,28 @@ export declare const AuthorizationApiFp: (configuration?: Configuration) => {
202
202
  */
203
203
  checkAbacBulk(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckAbacBulkResponse>>;
204
204
  /**
205
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
205
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
206
206
  * @summary Check whether the subject holds all of the permissions
207
207
  * @param {*} [options] Override http request option.
208
208
  * @throws {RequiredError}
209
209
  */
210
210
  checkAllPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckAnyPermissionResponse>>;
211
211
  /**
212
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
212
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
213
213
  * @summary Check whether the subject holds any of the permissions
214
214
  * @param {*} [options] Override http request option.
215
215
  * @throws {RequiredError}
216
216
  */
217
217
  checkAnyPermission(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckAnyPermissionResponse>>;
218
218
  /**
219
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
219
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
220
220
  * @summary Check one permission
221
221
  * @param {*} [options] Override http request option.
222
222
  * @throws {RequiredError}
223
223
  */
224
224
  checkPermission(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckPermissionResponse>>;
225
225
  /**
226
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
226
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
227
227
  * @summary Check up to 100 permissions in one call
228
228
  * @param {*} [options] Override http request option.
229
229
  * @throws {RequiredError}
@@ -353,28 +353,28 @@ export declare const AuthorizationApiFactory: (configuration?: Configuration, ba
353
353
  */
354
354
  checkAbacBulk(requestParameters: AuthorizationApiCheckAbacBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise<CheckAbacBulkResponse>;
355
355
  /**
356
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
356
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
357
357
  * @summary Check whether the subject holds all of the permissions
358
358
  * @param {*} [options] Override http request option.
359
359
  * @throws {RequiredError}
360
360
  */
361
361
  checkAllPermissions(options?: RawAxiosRequestConfig): AxiosPromise<CheckAnyPermissionResponse>;
362
362
  /**
363
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
363
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
364
364
  * @summary Check whether the subject holds any of the permissions
365
365
  * @param {*} [options] Override http request option.
366
366
  * @throws {RequiredError}
367
367
  */
368
368
  checkAnyPermission(options?: RawAxiosRequestConfig): AxiosPromise<CheckAnyPermissionResponse>;
369
369
  /**
370
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
370
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
371
371
  * @summary Check one permission
372
372
  * @param {*} [options] Override http request option.
373
373
  * @throws {RequiredError}
374
374
  */
375
375
  checkPermission(options?: RawAxiosRequestConfig): AxiosPromise<CheckPermissionResponse>;
376
376
  /**
377
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
377
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
378
378
  * @summary Check up to 100 permissions in one call
379
379
  * @param {*} [options] Override http request option.
380
380
  * @throws {RequiredError}
@@ -498,7 +498,7 @@ export interface AuthorizationApiInterface {
498
498
  */
499
499
  checkAbacBulk(requestParameters: AuthorizationApiCheckAbacBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise<CheckAbacBulkResponse>;
500
500
  /**
501
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
501
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
502
502
  * @summary Check whether the subject holds all of the permissions
503
503
  * @param {*} [options] Override http request option.
504
504
  * @throws {RequiredError}
@@ -506,7 +506,7 @@ export interface AuthorizationApiInterface {
506
506
  */
507
507
  checkAllPermissions(options?: RawAxiosRequestConfig): AxiosPromise<CheckAnyPermissionResponse>;
508
508
  /**
509
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
509
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
510
510
  * @summary Check whether the subject holds any of the permissions
511
511
  * @param {*} [options] Override http request option.
512
512
  * @throws {RequiredError}
@@ -514,7 +514,7 @@ export interface AuthorizationApiInterface {
514
514
  */
515
515
  checkAnyPermission(options?: RawAxiosRequestConfig): AxiosPromise<CheckAnyPermissionResponse>;
516
516
  /**
517
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
517
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
518
518
  * @summary Check one permission
519
519
  * @param {*} [options] Override http request option.
520
520
  * @throws {RequiredError}
@@ -522,7 +522,7 @@ export interface AuthorizationApiInterface {
522
522
  */
523
523
  checkPermission(options?: RawAxiosRequestConfig): AxiosPromise<CheckPermissionResponse>;
524
524
  /**
525
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
525
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
526
526
  * @summary Check up to 100 permissions in one call
527
527
  * @param {*} [options] Override http request option.
528
528
  * @throws {RequiredError}
@@ -844,7 +844,7 @@ export declare class AuthorizationApi extends BaseAPI implements AuthorizationAp
844
844
  */
845
845
  checkAbacBulk(requestParameters: AuthorizationApiCheckAbacBulkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckAbacBulkResponse, any, {}>>;
846
846
  /**
847
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
847
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
848
848
  * @summary Check whether the subject holds all of the permissions
849
849
  * @param {*} [options] Override http request option.
850
850
  * @throws {RequiredError}
@@ -852,7 +852,7 @@ export declare class AuthorizationApi extends BaseAPI implements AuthorizationAp
852
852
  */
853
853
  checkAllPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckAnyPermissionResponse, any, {}>>;
854
854
  /**
855
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
855
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
856
856
  * @summary Check whether the subject holds any of the permissions
857
857
  * @param {*} [options] Override http request option.
858
858
  * @throws {RequiredError}
@@ -860,7 +860,7 @@ export declare class AuthorizationApi extends BaseAPI implements AuthorizationAp
860
860
  */
861
861
  checkAnyPermission(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckAnyPermissionResponse, any, {}>>;
862
862
  /**
863
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
863
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
864
864
  * @summary Check one permission
865
865
  * @param {*} [options] Override http request option.
866
866
  * @throws {RequiredError}
@@ -868,7 +868,7 @@ export declare class AuthorizationApi extends BaseAPI implements AuthorizationAp
868
868
  */
869
869
  checkPermission(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckPermissionResponse, any, {}>>;
870
870
  /**
871
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
871
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
872
872
  * @summary Check up to 100 permissions in one call
873
873
  * @param {*} [options] Override http request option.
874
874
  * @throws {RequiredError}
@@ -97,7 +97,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
97
97
  };
98
98
  }),
99
99
  /**
100
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
100
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
101
101
  * @summary Check whether the subject holds all of the permissions
102
102
  * @param {*} [options] Override http request option.
103
103
  * @throws {RequiredError}
@@ -127,7 +127,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
127
127
  };
128
128
  }),
129
129
  /**
130
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
130
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
131
131
  * @summary Check whether the subject holds any of the permissions
132
132
  * @param {*} [options] Override http request option.
133
133
  * @throws {RequiredError}
@@ -157,7 +157,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
157
157
  };
158
158
  }),
159
159
  /**
160
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
160
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
161
161
  * @summary Check one permission
162
162
  * @param {*} [options] Override http request option.
163
163
  * @throws {RequiredError}
@@ -187,7 +187,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
187
187
  };
188
188
  }),
189
189
  /**
190
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
190
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
191
191
  * @summary Check up to 100 permissions in one call
192
192
  * @param {*} [options] Override http request option.
193
193
  * @throws {RequiredError}
@@ -678,7 +678,7 @@ export const AuthorizationApiFp = function (configuration) {
678
678
  });
679
679
  },
680
680
  /**
681
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
681
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
682
682
  * @summary Check whether the subject holds all of the permissions
683
683
  * @param {*} [options] Override http request option.
684
684
  * @throws {RequiredError}
@@ -693,7 +693,7 @@ export const AuthorizationApiFp = function (configuration) {
693
693
  });
694
694
  },
695
695
  /**
696
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
696
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
697
697
  * @summary Check whether the subject holds any of the permissions
698
698
  * @param {*} [options] Override http request option.
699
699
  * @throws {RequiredError}
@@ -708,7 +708,7 @@ export const AuthorizationApiFp = function (configuration) {
708
708
  });
709
709
  },
710
710
  /**
711
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
711
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
712
712
  * @summary Check one permission
713
713
  * @param {*} [options] Override http request option.
714
714
  * @throws {RequiredError}
@@ -723,7 +723,7 @@ export const AuthorizationApiFp = function (configuration) {
723
723
  });
724
724
  },
725
725
  /**
726
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
726
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
727
727
  * @summary Check up to 100 permissions in one call
728
728
  * @param {*} [options] Override http request option.
729
729
  * @throws {RequiredError}
@@ -964,7 +964,7 @@ export const AuthorizationApiFactory = function (configuration, basePath, axios)
964
964
  return localVarFp.checkAbacBulk(requestParameters.orgId, options).then((request) => request(axios, basePath));
965
965
  },
966
966
  /**
967
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
967
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
968
968
  * @summary Check whether the subject holds all of the permissions
969
969
  * @param {*} [options] Override http request option.
970
970
  * @throws {RequiredError}
@@ -973,7 +973,7 @@ export const AuthorizationApiFactory = function (configuration, basePath, axios)
973
973
  return localVarFp.checkAllPermissions(options).then((request) => request(axios, basePath));
974
974
  },
975
975
  /**
976
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
976
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
977
977
  * @summary Check whether the subject holds any of the permissions
978
978
  * @param {*} [options] Override http request option.
979
979
  * @throws {RequiredError}
@@ -982,7 +982,7 @@ export const AuthorizationApiFactory = function (configuration, basePath, axios)
982
982
  return localVarFp.checkAnyPermission(options).then((request) => request(axios, basePath));
983
983
  },
984
984
  /**
985
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
985
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
986
986
  * @summary Check one permission
987
987
  * @param {*} [options] Override http request option.
988
988
  * @throws {RequiredError}
@@ -991,7 +991,7 @@ export const AuthorizationApiFactory = function (configuration, basePath, axios)
991
991
  return localVarFp.checkPermission(options).then((request) => request(axios, basePath));
992
992
  },
993
993
  /**
994
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
994
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
995
995
  * @summary Check up to 100 permissions in one call
996
996
  * @param {*} [options] Override http request option.
997
997
  * @throws {RequiredError}
@@ -1147,7 +1147,7 @@ export class AuthorizationApi extends BaseAPI {
1147
1147
  return AuthorizationApiFp(this.configuration).checkAbacBulk(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
1148
1148
  }
1149
1149
  /**
1150
- * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
1150
+ * POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
1151
1151
  * @summary Check whether the subject holds all of the permissions
1152
1152
  * @param {*} [options] Override http request option.
1153
1153
  * @throws {RequiredError}
@@ -1157,7 +1157,7 @@ export class AuthorizationApi extends BaseAPI {
1157
1157
  return AuthorizationApiFp(this.configuration).checkAllPermissions(options).then((request) => request(this.axios, this.basePath));
1158
1158
  }
1159
1159
  /**
1160
- * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
1160
+ * POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
1161
1161
  * @summary Check whether the subject holds any of the permissions
1162
1162
  * @param {*} [options] Override http request option.
1163
1163
  * @throws {RequiredError}
@@ -1167,7 +1167,7 @@ export class AuthorizationApi extends BaseAPI {
1167
1167
  return AuthorizationApiFp(this.configuration).checkAnyPermission(options).then((request) => request(this.axios, this.basePath));
1168
1168
  }
1169
1169
  /**
1170
- * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"document_id\": 123, \"owner_id\": 456}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
1170
+ * POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"resource_id\": \"doc-123\"}, // read: resource_id + defined environment attribute slugs \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — defaults to the caller } All four check endpoints accept the optional `subject`. Naming a subject other than the caller requires the `authz.check` permission or the `authz:check` scope (403 `insufficient_permissions` otherwise) — see ThirdPartySubjectGuard.
1171
1171
  * @summary Check one permission
1172
1172
  * @param {*} [options] Override http request option.
1173
1173
  * @throws {RequiredError}
@@ -1177,7 +1177,7 @@ export class AuthorizationApi extends BaseAPI {
1177
1177
  return AuthorizationApiFp(this.configuration).checkPermission(options).then((request) => request(this.axios, this.basePath));
1178
1178
  }
1179
1179
  /**
1180
- * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"document_id\": 123}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
1180
+ * POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"resource_id\": \"doc-123\"}, \"subject\": {\"type\": \"user\", \"id\": \"<uuid>\"} // optional — see /check }
1181
1181
  * @summary Check up to 100 permissions in one call
1182
1182
  * @param {*} [options] Override http request option.
1183
1183
  * @throws {RequiredError}
@@ -13,6 +13,8 @@ import type { Configuration } from '../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { BackchannelAuthorizeResponse } from '../models';
16
+ import type { CheckEmailFirstRequest } from '../models';
17
+ import type { CheckEmailFirstResponse } from '../models';
16
18
  import type { DeviceAuthorizationResponse } from '../models';
17
19
  import type { IntrospectResponse } from '../models';
18
20
  import type { ParResponse } from '../models';
@@ -43,6 +45,15 @@ export declare const OAuthApiAxiosParamCreator: (configuration?: Configuration)
43
45
  * @throws {RequiredError}
44
46
  */
45
47
  backchannelAuthorize: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
48
+ /**
49
+ * For applications that render their own sign-in form. Returns the sign-in methods that the organization offers, so that the form can show the next step after an address was typed. The answer does not depend on the address: `exists` is always `true`, and a known address and a new one get the same answer. Takes no credential and signs nobody in. A browser request must come from one of the allowed origins of the application named by `client_id`.
50
+ * @summary Sign-in methods for an email-first form
51
+ * @param {string} orgId
52
+ * @param {CheckEmailFirstRequest} checkEmailFirstRequest
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ checkEmailFirst: (orgId: string, checkEmailFirstRequest: CheckEmailFirstRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
57
  /**
47
58
  * Starts the device authorization grant for a client registered for urn:ietf:params:oauth:grant-type:device_code. Public clients send client_id only; confidential clients must authenticate. The device then polls the token endpoint with the device_code.
48
59
  * @summary Device authorization request (RFC 8628)
@@ -93,7 +104,7 @@ export declare const OAuthApiAxiosParamCreator: (configuration?: Configuration)
93
104
  */
94
105
  par: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
95
106
  /**
96
- * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
107
+ * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it. Refused with invalid_client_metadata: grant_types other than authorization_code and refresh_token, response_types other than code and none, subject_type other than public, sector_identifier_uri, request_uris, userinfo_signed_response_alg, an id_token_signed_response_alg other than the organization\'s signing algorithm, and every encryption member (id_token_encrypted_response_*, userinfo_encrypted_response_*, request_object_encryption_*, authorization_encrypted_response_*).
97
108
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
98
109
  * @param {string} orgId
99
110
  * @param {*} [options] Override http request option.
@@ -206,6 +217,15 @@ export declare const OAuthApiFp: (configuration?: Configuration) => {
206
217
  * @throws {RequiredError}
207
218
  */
208
219
  backchannelAuthorize(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BackchannelAuthorizeResponse>>;
220
+ /**
221
+ * For applications that render their own sign-in form. Returns the sign-in methods that the organization offers, so that the form can show the next step after an address was typed. The answer does not depend on the address: `exists` is always `true`, and a known address and a new one get the same answer. Takes no credential and signs nobody in. A browser request must come from one of the allowed origins of the application named by `client_id`.
222
+ * @summary Sign-in methods for an email-first form
223
+ * @param {string} orgId
224
+ * @param {CheckEmailFirstRequest} checkEmailFirstRequest
225
+ * @param {*} [options] Override http request option.
226
+ * @throws {RequiredError}
227
+ */
228
+ checkEmailFirst(orgId: string, checkEmailFirstRequest: CheckEmailFirstRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckEmailFirstResponse>>;
209
229
  /**
210
230
  * Starts the device authorization grant for a client registered for urn:ietf:params:oauth:grant-type:device_code. Public clients send client_id only; confidential clients must authenticate. The device then polls the token endpoint with the device_code.
211
231
  * @summary Device authorization request (RFC 8628)
@@ -256,7 +276,7 @@ export declare const OAuthApiFp: (configuration?: Configuration) => {
256
276
  */
257
277
  par(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParResponse>>;
258
278
  /**
259
- * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
279
+ * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it. Refused with invalid_client_metadata: grant_types other than authorization_code and refresh_token, response_types other than code and none, subject_type other than public, sector_identifier_uri, request_uris, userinfo_signed_response_alg, an id_token_signed_response_alg other than the organization\'s signing algorithm, and every encryption member (id_token_encrypted_response_*, userinfo_encrypted_response_*, request_object_encryption_*, authorization_encrypted_response_*).
260
280
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
261
281
  * @param {string} orgId
262
282
  * @param {*} [options] Override http request option.
@@ -369,6 +389,14 @@ export declare const OAuthApiFactory: (configuration?: Configuration, basePath?:
369
389
  * @throws {RequiredError}
370
390
  */
371
391
  backchannelAuthorize(requestParameters: OAuthApiBackchannelAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<BackchannelAuthorizeResponse>;
392
+ /**
393
+ * For applications that render their own sign-in form. Returns the sign-in methods that the organization offers, so that the form can show the next step after an address was typed. The answer does not depend on the address: `exists` is always `true`, and a known address and a new one get the same answer. Takes no credential and signs nobody in. A browser request must come from one of the allowed origins of the application named by `client_id`.
394
+ * @summary Sign-in methods for an email-first form
395
+ * @param {OAuthApiCheckEmailFirstRequest} requestParameters Request parameters.
396
+ * @param {*} [options] Override http request option.
397
+ * @throws {RequiredError}
398
+ */
399
+ checkEmailFirst(requestParameters: OAuthApiCheckEmailFirstRequest, options?: RawAxiosRequestConfig): AxiosPromise<CheckEmailFirstResponse>;
372
400
  /**
373
401
  * Starts the device authorization grant for a client registered for urn:ietf:params:oauth:grant-type:device_code. Public clients send client_id only; confidential clients must authenticate. The device then polls the token endpoint with the device_code.
374
402
  * @summary Device authorization request (RFC 8628)
@@ -418,7 +446,7 @@ export declare const OAuthApiFactory: (configuration?: Configuration, basePath?:
418
446
  */
419
447
  par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse>;
420
448
  /**
421
- * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
449
+ * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it. Refused with invalid_client_metadata: grant_types other than authorization_code and refresh_token, response_types other than code and none, subject_type other than public, sector_identifier_uri, request_uris, userinfo_signed_response_alg, an id_token_signed_response_alg other than the organization\'s signing algorithm, and every encryption member (id_token_encrypted_response_*, userinfo_encrypted_response_*, request_object_encryption_*, authorization_encrypted_response_*).
422
450
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
423
451
  * @param {OAuthApiRegisterClientRequest} requestParameters Request parameters.
424
452
  * @param {*} [options] Override http request option.
@@ -530,6 +558,15 @@ export interface OAuthApiInterface {
530
558
  * @memberof OAuthApiInterface
531
559
  */
532
560
  backchannelAuthorize(requestParameters: OAuthApiBackchannelAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<BackchannelAuthorizeResponse>;
561
+ /**
562
+ * For applications that render their own sign-in form. Returns the sign-in methods that the organization offers, so that the form can show the next step after an address was typed. The answer does not depend on the address: `exists` is always `true`, and a known address and a new one get the same answer. Takes no credential and signs nobody in. A browser request must come from one of the allowed origins of the application named by `client_id`.
563
+ * @summary Sign-in methods for an email-first form
564
+ * @param {OAuthApiCheckEmailFirstRequest} requestParameters Request parameters.
565
+ * @param {*} [options] Override http request option.
566
+ * @throws {RequiredError}
567
+ * @memberof OAuthApiInterface
568
+ */
569
+ checkEmailFirst(requestParameters: OAuthApiCheckEmailFirstRequest, options?: RawAxiosRequestConfig): AxiosPromise<CheckEmailFirstResponse>;
533
570
  /**
534
571
  * Starts the device authorization grant for a client registered for urn:ietf:params:oauth:grant-type:device_code. Public clients send client_id only; confidential clients must authenticate. The device then polls the token endpoint with the device_code.
535
572
  * @summary Device authorization request (RFC 8628)
@@ -585,7 +622,7 @@ export interface OAuthApiInterface {
585
622
  */
586
623
  par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse>;
587
624
  /**
588
- * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
625
+ * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it. Refused with invalid_client_metadata: grant_types other than authorization_code and refresh_token, response_types other than code and none, subject_type other than public, sector_identifier_uri, request_uris, userinfo_signed_response_alg, an id_token_signed_response_alg other than the organization\'s signing algorithm, and every encryption member (id_token_encrypted_response_*, userinfo_encrypted_response_*, request_object_encryption_*, authorization_encrypted_response_*).
589
626
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
590
627
  * @param {OAuthApiRegisterClientRequest} requestParameters Request parameters.
591
628
  * @param {*} [options] Override http request option.
@@ -710,6 +747,25 @@ export interface OAuthApiBackchannelAuthorizeRequest {
710
747
  */
711
748
  readonly orgId: string;
712
749
  }
750
+ /**
751
+ * Request parameters for checkEmailFirst operation in OAuthApi.
752
+ * @export
753
+ * @interface OAuthApiCheckEmailFirstRequest
754
+ */
755
+ export interface OAuthApiCheckEmailFirstRequest {
756
+ /**
757
+ *
758
+ * @type {string}
759
+ * @memberof OAuthApiCheckEmailFirst
760
+ */
761
+ readonly orgId: string;
762
+ /**
763
+ *
764
+ * @type {CheckEmailFirstRequest}
765
+ * @memberof OAuthApiCheckEmailFirst
766
+ */
767
+ readonly checkEmailFirstRequest: CheckEmailFirstRequest;
768
+ }
713
769
  /**
714
770
  * Request parameters for deviceAuthorization operation in OAuthApi.
715
771
  * @export
@@ -986,6 +1042,15 @@ export declare class OAuthApi extends BaseAPI implements OAuthApiInterface {
986
1042
  * @memberof OAuthApi
987
1043
  */
988
1044
  backchannelAuthorize(requestParameters: OAuthApiBackchannelAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BackchannelAuthorizeResponse, any, {}>>;
1045
+ /**
1046
+ * For applications that render their own sign-in form. Returns the sign-in methods that the organization offers, so that the form can show the next step after an address was typed. The answer does not depend on the address: `exists` is always `true`, and a known address and a new one get the same answer. Takes no credential and signs nobody in. A browser request must come from one of the allowed origins of the application named by `client_id`.
1047
+ * @summary Sign-in methods for an email-first form
1048
+ * @param {OAuthApiCheckEmailFirstRequest} requestParameters Request parameters.
1049
+ * @param {*} [options] Override http request option.
1050
+ * @throws {RequiredError}
1051
+ * @memberof OAuthApi
1052
+ */
1053
+ checkEmailFirst(requestParameters: OAuthApiCheckEmailFirstRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckEmailFirstResponse, any, {}>>;
989
1054
  /**
990
1055
  * Starts the device authorization grant for a client registered for urn:ietf:params:oauth:grant-type:device_code. Public clients send client_id only; confidential clients must authenticate. The device then polls the token endpoint with the device_code.
991
1056
  * @summary Device authorization request (RFC 8628)
@@ -1041,7 +1106,7 @@ export declare class OAuthApi extends BaseAPI implements OAuthApiInterface {
1041
1106
  */
1042
1107
  par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParResponse, any, {}>>;
1043
1108
  /**
1044
- * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
1109
+ * Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it. Refused with invalid_client_metadata: grant_types other than authorization_code and refresh_token, response_types other than code and none, subject_type other than public, sector_identifier_uri, request_uris, userinfo_signed_response_alg, an id_token_signed_response_alg other than the organization\'s signing algorithm, and every encryption member (id_token_encrypted_response_*, userinfo_encrypted_response_*, request_object_encryption_*, authorization_encrypted_response_*).
1045
1110
  * @summary Dynamic client registration (RFC 7591 / OIDC DCR)
1046
1111
  * @param {OAuthApiRegisterClientRequest} requestParameters Request parameters.
1047
1112
  * @param {*} [options] Override http request option.