@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.
- package/.openapi-generator/FILES +12 -2
- package/README.md +10 -3
- package/api/admin-abac-api.ts +18 -5
- package/api/admin-agents-api.ts +50 -5
- package/api/admin-audit-logs-api.ts +15 -15
- package/api/admin-email-api.ts +15 -15
- package/api/admin-groups-api.ts +15 -15
- package/api/admin-mfa-api.ts +10 -10
- package/api/admin-oauth-clients-api.ts +15 -15
- package/api/admin-roles-api.ts +20 -20
- package/api/admin-settings-api.ts +112 -60
- package/api/admin-users-api.ts +320 -31
- package/api/agents-api.ts +5 -5
- package/api/authorization-api.ts +20 -20
- package/api/oauth-api.ts +116 -5
- package/api/ssf-api.ts +10 -10
- package/dist/api/admin-abac-api.d.ts +10 -2
- package/dist/api/admin-abac-api.js +10 -5
- package/dist/api/admin-agents-api.d.ts +37 -2
- package/dist/api/admin-agents-api.js +37 -6
- package/dist/api/admin-audit-logs-api.d.ts +15 -15
- package/dist/api/admin-audit-logs-api.js +12 -12
- package/dist/api/admin-email-api.d.ts +15 -15
- package/dist/api/admin-email-api.js +12 -12
- package/dist/api/admin-groups-api.d.ts +15 -15
- package/dist/api/admin-groups-api.js +12 -12
- package/dist/api/admin-mfa-api.d.ts +10 -10
- package/dist/api/admin-mfa-api.js +8 -8
- package/dist/api/admin-oauth-clients-api.d.ts +15 -15
- package/dist/api/admin-oauth-clients-api.js +12 -12
- package/dist/api/admin-roles-api.d.ts +20 -20
- package/dist/api/admin-roles-api.js +16 -16
- package/dist/api/admin-settings-api.d.ts +82 -48
- package/dist/api/admin-settings-api.js +68 -52
- package/dist/api/admin-users-api.d.ts +201 -22
- package/dist/api/admin-users-api.js +185 -28
- package/dist/api/agents-api.d.ts +5 -5
- package/dist/api/agents-api.js +4 -4
- package/dist/api/authorization-api.d.ts +20 -20
- package/dist/api/authorization-api.js +16 -16
- package/dist/api/oauth-api.d.ts +70 -5
- package/dist/api/oauth-api.js +76 -4
- package/dist/api/ssf-api.d.ts +10 -10
- package/dist/api/ssf-api.js +8 -8
- package/dist/esm/api/admin-abac-api.d.ts +10 -2
- package/dist/esm/api/admin-abac-api.js +10 -5
- package/dist/esm/api/admin-agents-api.d.ts +37 -2
- package/dist/esm/api/admin-agents-api.js +36 -5
- package/dist/esm/api/admin-audit-logs-api.d.ts +15 -15
- package/dist/esm/api/admin-audit-logs-api.js +12 -12
- package/dist/esm/api/admin-email-api.d.ts +15 -15
- package/dist/esm/api/admin-email-api.js +12 -12
- package/dist/esm/api/admin-groups-api.d.ts +15 -15
- package/dist/esm/api/admin-groups-api.js +12 -12
- package/dist/esm/api/admin-mfa-api.d.ts +10 -10
- package/dist/esm/api/admin-mfa-api.js +8 -8
- package/dist/esm/api/admin-oauth-clients-api.d.ts +15 -15
- package/dist/esm/api/admin-oauth-clients-api.js +12 -12
- package/dist/esm/api/admin-roles-api.d.ts +20 -20
- package/dist/esm/api/admin-roles-api.js +16 -16
- package/dist/esm/api/admin-settings-api.d.ts +82 -48
- package/dist/esm/api/admin-settings-api.js +69 -53
- package/dist/esm/api/admin-users-api.d.ts +201 -22
- package/dist/esm/api/admin-users-api.js +184 -27
- package/dist/esm/api/agents-api.d.ts +5 -5
- package/dist/esm/api/agents-api.js +4 -4
- package/dist/esm/api/authorization-api.d.ts +20 -20
- package/dist/esm/api/authorization-api.js +16 -16
- package/dist/esm/api/oauth-api.d.ts +70 -5
- package/dist/esm/api/oauth-api.js +76 -4
- package/dist/esm/api/ssf-api.d.ts +10 -10
- package/dist/esm/api/ssf-api.js +8 -8
- package/dist/esm/models/abac-attribute-definition.d.ts +6 -0
- package/dist/esm/models/abac-policy.d.ts +7 -1
- package/dist/esm/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/esm/models/admin-groups-list-response.d.ts +6 -0
- package/dist/esm/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/esm/models/admin-settings-all-response-data-general.d.ts +13 -1
- package/dist/esm/models/admin-settings-all-response-data.d.ts +4 -5
- package/dist/esm/models/admin-settings-email-get-response.d.ts +4 -5
- package/dist/esm/models/admin-settings-general-get-response-data.d.ts +4 -10
- package/dist/esm/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
- package/dist/esm/models/ask-response.d.ts +15 -0
- package/dist/esm/models/ask-response.js +10 -1
- package/dist/esm/models/attest-response.d.ts +2 -2
- package/dist/esm/models/authorization-server-metadata.d.ts +8 -2
- package/dist/esm/models/check-email-first-request.d.ts +30 -0
- package/dist/esm/models/check-email-first-request.js +14 -0
- package/dist/esm/models/check-email-first-response.d.ts +42 -0
- package/dist/esm/models/check-email-first-response.js +14 -0
- package/dist/esm/models/email-sender-settings.d.ts +62 -0
- package/dist/esm/models/email-sender-settings.js +22 -0
- package/dist/esm/models/get-me-response.d.ts +18 -0
- package/dist/esm/models/get-server-challenge-response.d.ts +3 -2
- package/dist/esm/models/get-server-challenge-response.js +1 -0
- package/dist/esm/models/index.d.ts +6 -1
- package/dist/esm/models/index.js +6 -1
- package/dist/esm/models/introspect-response.d.ts +6 -0
- package/dist/esm/models/issue-agent-token-request.d.ts +6 -0
- package/dist/esm/models/list-users-response.d.ts +6 -0
- package/dist/esm/models/oauth-scope.d.ts +1 -7
- package/dist/esm/models/open-id-configuration.d.ts +3 -3
- package/dist/esm/models/put-admin-settings-branding-update-response.d.ts +6 -0
- package/dist/esm/models/put-admin-settings-email-update-request.d.ts +36 -0
- package/dist/esm/models/put-admin-settings-email-update-request.js +14 -0
- package/dist/esm/models/put-admin-settings-email-update-response.d.ts +4 -5
- package/dist/esm/models/put-admin-settings-general-update-request.d.ts +30 -0
- package/dist/esm/models/put-admin-settings-general-update-request.js +14 -0
- package/dist/esm/models/put-admin-settings-general-update-response-data.d.ts +1 -7
- package/dist/esm/models/register-client-response.d.ts +0 -24
- package/dist/esm/models/registered-client-metadata.d.ts +0 -24
- package/dist/esm/models/social-login-provider.d.ts +2 -1
- package/dist/esm/models/user.d.ts +12 -0
- package/dist/esm/models/userinfo-response.d.ts +4 -12
- package/dist/esm/models/userinfo-response.js +0 -2
- package/dist/models/abac-attribute-definition.d.ts +6 -0
- package/dist/models/abac-policy.d.ts +7 -1
- package/dist/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/models/admin-groups-list-response.d.ts +6 -0
- package/dist/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/models/admin-settings-all-response-data-general.d.ts +13 -1
- package/dist/models/admin-settings-all-response-data.d.ts +4 -5
- package/dist/models/admin-settings-email-get-response.d.ts +4 -5
- package/dist/models/admin-settings-general-get-response-data.d.ts +4 -10
- package/dist/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
- package/dist/models/ask-response.d.ts +15 -0
- package/dist/models/ask-response.js +11 -0
- package/dist/models/attest-response.d.ts +2 -2
- package/dist/models/authorization-server-metadata.d.ts +8 -2
- package/dist/models/check-email-first-request.d.ts +30 -0
- package/dist/models/check-email-first-request.js +15 -0
- package/dist/models/check-email-first-response.d.ts +42 -0
- package/dist/models/check-email-first-response.js +15 -0
- package/dist/models/email-sender-settings.d.ts +62 -0
- package/dist/models/email-sender-settings.js +25 -0
- package/dist/models/get-me-response.d.ts +18 -0
- package/dist/models/get-server-challenge-response.d.ts +3 -2
- package/dist/models/get-server-challenge-response.js +1 -0
- package/dist/models/index.d.ts +6 -1
- package/dist/models/index.js +6 -1
- package/dist/models/introspect-response.d.ts +6 -0
- package/dist/models/issue-agent-token-request.d.ts +6 -0
- package/dist/models/list-users-response.d.ts +6 -0
- package/dist/models/oauth-scope.d.ts +1 -7
- package/dist/models/open-id-configuration.d.ts +3 -3
- package/dist/models/put-admin-settings-branding-update-response.d.ts +6 -0
- package/dist/models/put-admin-settings-email-update-request.d.ts +36 -0
- package/dist/models/put-admin-settings-email-update-request.js +15 -0
- package/dist/models/put-admin-settings-email-update-response.d.ts +4 -5
- package/dist/models/put-admin-settings-general-update-request.d.ts +30 -0
- package/dist/models/put-admin-settings-general-update-request.js +15 -0
- package/dist/models/put-admin-settings-general-update-response-data.d.ts +1 -7
- package/dist/models/register-client-response.d.ts +0 -24
- package/dist/models/registered-client-metadata.d.ts +0 -24
- package/dist/models/social-login-provider.d.ts +2 -1
- package/dist/models/user.d.ts +12 -0
- package/dist/models/userinfo-response.d.ts +4 -12
- package/dist/models/userinfo-response.js +0 -2
- package/docs/AbacAttributeDefinition.md +2 -0
- package/docs/AbacPolicy.md +3 -1
- package/docs/AdminAbacApi.md +14 -9
- package/docs/AdminAgentsApi.md +7 -1
- package/docs/AdminAnalyticsDashboardResponseDataAudit.md +1 -1
- package/docs/AdminAuditLogsApi.md +3 -0
- package/docs/AdminEmailApi.md +3 -0
- package/docs/AdminGroupsApi.md +3 -0
- package/docs/AdminGroupsListResponse.md +2 -0
- package/docs/AdminMcpServersListResponse.md +3 -1
- package/docs/AdminMfaApi.md +4 -2
- package/docs/AdminOAuthClientsApi.md +3 -1
- package/docs/AdminOrganizationsApi.md +13 -5
- package/docs/AdminRolesApi.md +10 -0
- package/docs/AdminSettingsAllResponseData.md +1 -1
- package/docs/AdminSettingsAllResponseDataGeneral.md +5 -1
- package/docs/AdminSettingsApi.md +54 -12
- package/docs/AdminSettingsEmailGetResponse.md +1 -1
- package/docs/AdminSettingsGeneralGetResponseData.md +4 -6
- package/docs/AdminUsersApi.md +104 -2
- package/docs/AdminUsersRestoreResponse.md +22 -0
- package/docs/AgentsApi.md +2 -2
- package/docs/AskResponse.md +2 -0
- package/docs/AttestResponse.md +1 -1
- package/docs/AuthorizationApi.md +4 -4
- package/docs/AuthorizationServerMetadata.md +4 -2
- package/docs/CheckEmailFirstRequest.md +22 -0
- package/docs/CheckEmailFirstResponse.md +26 -0
- package/docs/EmailSenderSettings.md +31 -0
- package/docs/GetMeResponse.md +6 -0
- package/docs/GetServerChallengeResponse.md +1 -1
- package/docs/IdentityApi.md +2 -2
- package/docs/IntrospectResponse.md +2 -0
- package/docs/IssueAgentTokenRequest.md +2 -0
- package/docs/ListUsersResponse.md +2 -0
- package/docs/McpApi.md +5 -6
- package/docs/OAuthApi.md +72 -12
- package/docs/OAuthScope.md +1 -3
- package/docs/OIDCApi.md +4 -4
- package/docs/OpenIdConfiguration.md +3 -3
- package/docs/PutAdminSettingsBrandingUpdateResponse.md +2 -0
- package/docs/PutAdminSettingsEmailUpdateRequest.md +24 -0
- package/docs/PutAdminSettingsEmailUpdateResponse.md +1 -1
- package/docs/PutAdminSettingsGeneralUpdateRequest.md +22 -0
- package/docs/PutAdminSettingsGeneralUpdateResponseData.md +1 -3
- package/docs/RegisterClientResponse.md +0 -8
- package/docs/RegisteredClientMetadata.md +0 -8
- package/docs/SocialLoginProvider.md +1 -1
- package/docs/SsfApi.md +2 -0
- package/docs/User.md +4 -0
- package/docs/UserinfoResponse.md +3 -5
- package/docs/WellKnownApi.md +2 -2
- package/models/abac-attribute-definition.ts +6 -0
- package/models/abac-policy.ts +7 -1
- package/models/admin-analytics-dashboard-response-data-audit.ts +1 -1
- package/models/admin-groups-list-response.ts +6 -0
- package/models/admin-mcp-servers-list-response.ts +8 -5
- package/models/admin-settings-all-response-data-general.ts +13 -1
- package/models/admin-settings-all-response-data.ts +6 -3
- package/models/admin-settings-email-get-response.ts +6 -3
- package/models/admin-settings-general-get-response-data.ts +4 -10
- package/models/{admin-mcp-servers-list-response-meta.ts → admin-users-restore-response.ts} +11 -14
- package/models/ask-response.ts +17 -0
- package/models/attest-response.ts +2 -2
- package/models/authorization-server-metadata.ts +8 -2
- package/models/check-email-first-request.ts +36 -0
- package/models/check-email-first-response.ts +48 -0
- package/models/email-sender-settings.ts +70 -0
- package/models/get-me-response.ts +18 -0
- package/models/get-server-challenge-response.ts +3 -2
- package/models/index.ts +6 -1
- package/models/introspect-response.ts +6 -0
- package/models/issue-agent-token-request.ts +6 -0
- package/models/list-users-response.ts +6 -0
- package/models/oauth-scope.ts +1 -7
- package/models/open-id-configuration.ts +3 -3
- package/models/put-admin-settings-branding-update-response.ts +6 -0
- package/models/put-admin-settings-email-update-request.ts +42 -0
- package/models/put-admin-settings-email-update-response.ts +6 -3
- package/models/put-admin-settings-general-update-request.ts +36 -0
- package/models/put-admin-settings-general-update-response-data.ts +1 -7
- package/models/register-client-response.ts +0 -24
- package/models/registered-client-metadata.ts +0 -24
- package/models/social-login-provider.ts +2 -1
- package/models/user.ts +12 -0
- package/models/userinfo-response.ts +4 -12
- package/package.json +1 -1
- package/docs/AdminMcpServersListResponseMeta.md +0 -24
- /package/dist/esm/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
- /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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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\": {\"
|
|
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}
|
|
@@ -100,7 +100,7 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
|
|
|
100
100
|
};
|
|
101
101
|
}),
|
|
102
102
|
/**
|
|
103
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
103
|
+
* 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 }
|
|
104
104
|
* @summary Check whether the subject holds all of the permissions
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
106
106
|
* @throws {RequiredError}
|
|
@@ -130,7 +130,7 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
|
|
|
130
130
|
};
|
|
131
131
|
}),
|
|
132
132
|
/**
|
|
133
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
133
|
+
* 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 }
|
|
134
134
|
* @summary Check whether the subject holds any of the permissions
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
@@ -160,7 +160,7 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
|
|
|
160
160
|
};
|
|
161
161
|
}),
|
|
162
162
|
/**
|
|
163
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
163
|
+
* 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.
|
|
164
164
|
* @summary Check one permission
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
166
166
|
* @throws {RequiredError}
|
|
@@ -190,7 +190,7 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
|
|
|
190
190
|
};
|
|
191
191
|
}),
|
|
192
192
|
/**
|
|
193
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
193
|
+
* 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 }
|
|
194
194
|
* @summary Check up to 100 permissions in one call
|
|
195
195
|
* @param {*} [options] Override http request option.
|
|
196
196
|
* @throws {RequiredError}
|
|
@@ -682,7 +682,7 @@ const AuthorizationApiFp = function (configuration) {
|
|
|
682
682
|
});
|
|
683
683
|
},
|
|
684
684
|
/**
|
|
685
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
685
|
+
* 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 }
|
|
686
686
|
* @summary Check whether the subject holds all of the permissions
|
|
687
687
|
* @param {*} [options] Override http request option.
|
|
688
688
|
* @throws {RequiredError}
|
|
@@ -697,7 +697,7 @@ const AuthorizationApiFp = function (configuration) {
|
|
|
697
697
|
});
|
|
698
698
|
},
|
|
699
699
|
/**
|
|
700
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
700
|
+
* 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 }
|
|
701
701
|
* @summary Check whether the subject holds any of the permissions
|
|
702
702
|
* @param {*} [options] Override http request option.
|
|
703
703
|
* @throws {RequiredError}
|
|
@@ -712,7 +712,7 @@ const AuthorizationApiFp = function (configuration) {
|
|
|
712
712
|
});
|
|
713
713
|
},
|
|
714
714
|
/**
|
|
715
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
715
|
+
* 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.
|
|
716
716
|
* @summary Check one permission
|
|
717
717
|
* @param {*} [options] Override http request option.
|
|
718
718
|
* @throws {RequiredError}
|
|
@@ -727,7 +727,7 @@ const AuthorizationApiFp = function (configuration) {
|
|
|
727
727
|
});
|
|
728
728
|
},
|
|
729
729
|
/**
|
|
730
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
730
|
+
* 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 }
|
|
731
731
|
* @summary Check up to 100 permissions in one call
|
|
732
732
|
* @param {*} [options] Override http request option.
|
|
733
733
|
* @throws {RequiredError}
|
|
@@ -969,7 +969,7 @@ const AuthorizationApiFactory = function (configuration, basePath, axios) {
|
|
|
969
969
|
return localVarFp.checkAbacBulk(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
970
970
|
},
|
|
971
971
|
/**
|
|
972
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
972
|
+
* 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 }
|
|
973
973
|
* @summary Check whether the subject holds all of the permissions
|
|
974
974
|
* @param {*} [options] Override http request option.
|
|
975
975
|
* @throws {RequiredError}
|
|
@@ -978,7 +978,7 @@ const AuthorizationApiFactory = function (configuration, basePath, axios) {
|
|
|
978
978
|
return localVarFp.checkAllPermissions(options).then((request) => request(axios, basePath));
|
|
979
979
|
},
|
|
980
980
|
/**
|
|
981
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
981
|
+
* 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 }
|
|
982
982
|
* @summary Check whether the subject holds any of the permissions
|
|
983
983
|
* @param {*} [options] Override http request option.
|
|
984
984
|
* @throws {RequiredError}
|
|
@@ -987,7 +987,7 @@ const AuthorizationApiFactory = function (configuration, basePath, axios) {
|
|
|
987
987
|
return localVarFp.checkAnyPermission(options).then((request) => request(axios, basePath));
|
|
988
988
|
},
|
|
989
989
|
/**
|
|
990
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
990
|
+
* 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.
|
|
991
991
|
* @summary Check one permission
|
|
992
992
|
* @param {*} [options] Override http request option.
|
|
993
993
|
* @throws {RequiredError}
|
|
@@ -996,7 +996,7 @@ const AuthorizationApiFactory = function (configuration, basePath, axios) {
|
|
|
996
996
|
return localVarFp.checkPermission(options).then((request) => request(axios, basePath));
|
|
997
997
|
},
|
|
998
998
|
/**
|
|
999
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
999
|
+
* 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 }
|
|
1000
1000
|
* @summary Check up to 100 permissions in one call
|
|
1001
1001
|
* @param {*} [options] Override http request option.
|
|
1002
1002
|
* @throws {RequiredError}
|
|
@@ -1153,7 +1153,7 @@ class AuthorizationApi extends base_1.BaseAPI {
|
|
|
1153
1153
|
return (0, exports.AuthorizationApiFp)(this.configuration).checkAbacBulk(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1154
1154
|
}
|
|
1155
1155
|
/**
|
|
1156
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
1156
|
+
* 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 }
|
|
1157
1157
|
* @summary Check whether the subject holds all of the permissions
|
|
1158
1158
|
* @param {*} [options] Override http request option.
|
|
1159
1159
|
* @throws {RequiredError}
|
|
@@ -1163,7 +1163,7 @@ class AuthorizationApi extends base_1.BaseAPI {
|
|
|
1163
1163
|
return (0, exports.AuthorizationApiFp)(this.configuration).checkAllPermissions(options).then((request) => request(this.axios, this.basePath));
|
|
1164
1164
|
}
|
|
1165
1165
|
/**
|
|
1166
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
1166
|
+
* 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 }
|
|
1167
1167
|
* @summary Check whether the subject holds any of the permissions
|
|
1168
1168
|
* @param {*} [options] Override http request option.
|
|
1169
1169
|
* @throws {RequiredError}
|
|
@@ -1173,7 +1173,7 @@ class AuthorizationApi extends base_1.BaseAPI {
|
|
|
1173
1173
|
return (0, exports.AuthorizationApiFp)(this.configuration).checkAnyPermission(options).then((request) => request(this.axios, this.basePath));
|
|
1174
1174
|
}
|
|
1175
1175
|
/**
|
|
1176
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
1176
|
+
* 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.
|
|
1177
1177
|
* @summary Check one permission
|
|
1178
1178
|
* @param {*} [options] Override http request option.
|
|
1179
1179
|
* @throws {RequiredError}
|
|
@@ -1183,7 +1183,7 @@ class AuthorizationApi extends base_1.BaseAPI {
|
|
|
1183
1183
|
return (0, exports.AuthorizationApiFp)(this.configuration).checkPermission(options).then((request) => request(this.axios, this.basePath));
|
|
1184
1184
|
}
|
|
1185
1185
|
/**
|
|
1186
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
1186
|
+
* 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 }
|
|
1187
1187
|
* @summary Check up to 100 permissions in one call
|
|
1188
1188
|
* @param {*} [options] Override http request option.
|
|
1189
1189
|
* @throws {RequiredError}
|
package/dist/api/oauth-api.d.ts
CHANGED
|
@@ -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.
|