@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
package/api/authorization-api.ts
CHANGED
|
@@ -138,7 +138,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
138
138
|
};
|
|
139
139
|
},
|
|
140
140
|
/**
|
|
141
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
141
|
+
* 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 }
|
|
142
142
|
* @summary Check whether the subject holds all of the permissions
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
@@ -175,7 +175,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
175
175
|
};
|
|
176
176
|
},
|
|
177
177
|
/**
|
|
178
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
178
|
+
* 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 }
|
|
179
179
|
* @summary Check whether the subject holds any of the permissions
|
|
180
180
|
* @param {*} [options] Override http request option.
|
|
181
181
|
* @throws {RequiredError}
|
|
@@ -212,7 +212,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
212
212
|
};
|
|
213
213
|
},
|
|
214
214
|
/**
|
|
215
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
215
|
+
* 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.
|
|
216
216
|
* @summary Check one permission
|
|
217
217
|
* @param {*} [options] Override http request option.
|
|
218
218
|
* @throws {RequiredError}
|
|
@@ -249,7 +249,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
249
249
|
};
|
|
250
250
|
},
|
|
251
251
|
/**
|
|
252
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
252
|
+
* 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 }
|
|
253
253
|
* @summary Check up to 100 permissions in one call
|
|
254
254
|
* @param {*} [options] Override http request option.
|
|
255
255
|
* @throws {RequiredError}
|
|
@@ -824,7 +824,7 @@ export const AuthorizationApiFp = function(configuration?: Configuration) {
|
|
|
824
824
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
825
825
|
},
|
|
826
826
|
/**
|
|
827
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
827
|
+
* 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 }
|
|
828
828
|
* @summary Check whether the subject holds all of the permissions
|
|
829
829
|
* @param {*} [options] Override http request option.
|
|
830
830
|
* @throws {RequiredError}
|
|
@@ -836,7 +836,7 @@ export const AuthorizationApiFp = function(configuration?: Configuration) {
|
|
|
836
836
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
837
837
|
},
|
|
838
838
|
/**
|
|
839
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
839
|
+
* 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 }
|
|
840
840
|
* @summary Check whether the subject holds any of the permissions
|
|
841
841
|
* @param {*} [options] Override http request option.
|
|
842
842
|
* @throws {RequiredError}
|
|
@@ -848,7 +848,7 @@ export const AuthorizationApiFp = function(configuration?: Configuration) {
|
|
|
848
848
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
849
849
|
},
|
|
850
850
|
/**
|
|
851
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
851
|
+
* 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.
|
|
852
852
|
* @summary Check one permission
|
|
853
853
|
* @param {*} [options] Override http request option.
|
|
854
854
|
* @throws {RequiredError}
|
|
@@ -860,7 +860,7 @@ export const AuthorizationApiFp = function(configuration?: Configuration) {
|
|
|
860
860
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
861
861
|
},
|
|
862
862
|
/**
|
|
863
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
863
|
+
* 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 }
|
|
864
864
|
* @summary Check up to 100 permissions in one call
|
|
865
865
|
* @param {*} [options] Override http request option.
|
|
866
866
|
* @throws {RequiredError}
|
|
@@ -1063,7 +1063,7 @@ export const AuthorizationApiFactory = function (configuration?: Configuration,
|
|
|
1063
1063
|
return localVarFp.checkAbacBulk(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1064
1064
|
},
|
|
1065
1065
|
/**
|
|
1066
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
1066
|
+
* 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 }
|
|
1067
1067
|
* @summary Check whether the subject holds all of the permissions
|
|
1068
1068
|
* @param {*} [options] Override http request option.
|
|
1069
1069
|
* @throws {RequiredError}
|
|
@@ -1072,7 +1072,7 @@ export const AuthorizationApiFactory = function (configuration?: Configuration,
|
|
|
1072
1072
|
return localVarFp.checkAllPermissions(options).then((request) => request(axios, basePath));
|
|
1073
1073
|
},
|
|
1074
1074
|
/**
|
|
1075
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
1075
|
+
* 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 }
|
|
1076
1076
|
* @summary Check whether the subject holds any of the permissions
|
|
1077
1077
|
* @param {*} [options] Override http request option.
|
|
1078
1078
|
* @throws {RequiredError}
|
|
@@ -1081,7 +1081,7 @@ export const AuthorizationApiFactory = function (configuration?: Configuration,
|
|
|
1081
1081
|
return localVarFp.checkAnyPermission(options).then((request) => request(axios, basePath));
|
|
1082
1082
|
},
|
|
1083
1083
|
/**
|
|
1084
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
1084
|
+
* 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.
|
|
1085
1085
|
* @summary Check one permission
|
|
1086
1086
|
* @param {*} [options] Override http request option.
|
|
1087
1087
|
* @throws {RequiredError}
|
|
@@ -1090,7 +1090,7 @@ export const AuthorizationApiFactory = function (configuration?: Configuration,
|
|
|
1090
1090
|
return localVarFp.checkPermission(options).then((request) => request(axios, basePath));
|
|
1091
1091
|
},
|
|
1092
1092
|
/**
|
|
1093
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
1093
|
+
* 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 }
|
|
1094
1094
|
* @summary Check up to 100 permissions in one call
|
|
1095
1095
|
* @param {*} [options] Override http request option.
|
|
1096
1096
|
* @throws {RequiredError}
|
|
@@ -1244,7 +1244,7 @@ export interface AuthorizationApiInterface {
|
|
|
1244
1244
|
checkAbacBulk(requestParameters: AuthorizationApiCheckAbacBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise<CheckAbacBulkResponse>;
|
|
1245
1245
|
|
|
1246
1246
|
/**
|
|
1247
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
1247
|
+
* 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 }
|
|
1248
1248
|
* @summary Check whether the subject holds all of the permissions
|
|
1249
1249
|
* @param {*} [options] Override http request option.
|
|
1250
1250
|
* @throws {RequiredError}
|
|
@@ -1253,7 +1253,7 @@ export interface AuthorizationApiInterface {
|
|
|
1253
1253
|
checkAllPermissions(options?: RawAxiosRequestConfig): AxiosPromise<CheckAnyPermissionResponse>;
|
|
1254
1254
|
|
|
1255
1255
|
/**
|
|
1256
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
1256
|
+
* 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 }
|
|
1257
1257
|
* @summary Check whether the subject holds any of the permissions
|
|
1258
1258
|
* @param {*} [options] Override http request option.
|
|
1259
1259
|
* @throws {RequiredError}
|
|
@@ -1262,7 +1262,7 @@ export interface AuthorizationApiInterface {
|
|
|
1262
1262
|
checkAnyPermission(options?: RawAxiosRequestConfig): AxiosPromise<CheckAnyPermissionResponse>;
|
|
1263
1263
|
|
|
1264
1264
|
/**
|
|
1265
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
1265
|
+
* 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.
|
|
1266
1266
|
* @summary Check one permission
|
|
1267
1267
|
* @param {*} [options] Override http request option.
|
|
1268
1268
|
* @throws {RequiredError}
|
|
@@ -1271,7 +1271,7 @@ export interface AuthorizationApiInterface {
|
|
|
1271
1271
|
checkPermission(options?: RawAxiosRequestConfig): AxiosPromise<CheckPermissionResponse>;
|
|
1272
1272
|
|
|
1273
1273
|
/**
|
|
1274
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
1274
|
+
* 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 }
|
|
1275
1275
|
* @summary Check up to 100 permissions in one call
|
|
1276
1276
|
* @param {*} [options] Override http request option.
|
|
1277
1277
|
* @throws {RequiredError}
|
|
@@ -1632,7 +1632,7 @@ export class AuthorizationApi extends BaseAPI implements AuthorizationApiInterfa
|
|
|
1632
1632
|
}
|
|
1633
1633
|
|
|
1634
1634
|
/**
|
|
1635
|
-
* POST /api/v1/authz/check-all Body: { \"permissions\": [\"document.edit\", \"document.publish\"], \"context\": {\"
|
|
1635
|
+
* 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 }
|
|
1636
1636
|
* @summary Check whether the subject holds all of the permissions
|
|
1637
1637
|
* @param {*} [options] Override http request option.
|
|
1638
1638
|
* @throws {RequiredError}
|
|
@@ -1643,7 +1643,7 @@ export class AuthorizationApi extends BaseAPI implements AuthorizationApiInterfa
|
|
|
1643
1643
|
}
|
|
1644
1644
|
|
|
1645
1645
|
/**
|
|
1646
|
-
* POST /api/v1/authz/check-any Body: { \"permissions\": [\"document.edit\", \"document.view\"], \"context\": {\"
|
|
1646
|
+
* 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 }
|
|
1647
1647
|
* @summary Check whether the subject holds any of the permissions
|
|
1648
1648
|
* @param {*} [options] Override http request option.
|
|
1649
1649
|
* @throws {RequiredError}
|
|
@@ -1654,7 +1654,7 @@ export class AuthorizationApi extends BaseAPI implements AuthorizationApiInterfa
|
|
|
1654
1654
|
}
|
|
1655
1655
|
|
|
1656
1656
|
/**
|
|
1657
|
-
* POST /api/v1/authz/check Body: { \"permission\": \"document.edit\", \"context\": {\"
|
|
1657
|
+
* 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.
|
|
1658
1658
|
* @summary Check one permission
|
|
1659
1659
|
* @param {*} [options] Override http request option.
|
|
1660
1660
|
* @throws {RequiredError}
|
|
@@ -1665,7 +1665,7 @@ export class AuthorizationApi extends BaseAPI implements AuthorizationApiInterfa
|
|
|
1665
1665
|
}
|
|
1666
1666
|
|
|
1667
1667
|
/**
|
|
1668
|
-
* POST /api/v1/authz/check-bulk Body: { \"permissions\": [\"document.edit\", \"document.delete\"], \"context\": {\"
|
|
1668
|
+
* 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 }
|
|
1669
1669
|
* @summary Check up to 100 permissions in one call
|
|
1670
1670
|
* @param {*} [options] Override http request option.
|
|
1671
1671
|
* @throws {RequiredError}
|
package/api/oauth-api.ts
CHANGED
|
@@ -24,6 +24,10 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
|
|
|
24
24
|
// @ts-ignore
|
|
25
25
|
import type { BackchannelAuthorizeResponse } from '../models';
|
|
26
26
|
// @ts-ignore
|
|
27
|
+
import type { CheckEmailFirstRequest } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import type { CheckEmailFirstResponse } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
27
31
|
import type { DeviceAuthorizationResponse } from '../models';
|
|
28
32
|
// @ts-ignore
|
|
29
33
|
import type { IntrospectResponse } from '../models';
|
|
@@ -119,6 +123,46 @@ export const OAuthApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
119
123
|
options: localVarRequestOptions,
|
|
120
124
|
};
|
|
121
125
|
},
|
|
126
|
+
/**
|
|
127
|
+
* 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`.
|
|
128
|
+
* @summary Sign-in methods for an email-first form
|
|
129
|
+
* @param {string} orgId
|
|
130
|
+
* @param {CheckEmailFirstRequest} checkEmailFirstRequest
|
|
131
|
+
* @param {*} [options] Override http request option.
|
|
132
|
+
* @throws {RequiredError}
|
|
133
|
+
*/
|
|
134
|
+
checkEmailFirst: async (orgId: string, checkEmailFirstRequest: CheckEmailFirstRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
135
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
136
|
+
assertParamExists('checkEmailFirst', 'orgId', orgId)
|
|
137
|
+
// verify required parameter 'checkEmailFirstRequest' is not null or undefined
|
|
138
|
+
assertParamExists('checkEmailFirst', 'checkEmailFirstRequest', checkEmailFirstRequest)
|
|
139
|
+
const localVarPath = `/orgs/{orgId}/api/v1/oauth/check-email`
|
|
140
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
141
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
142
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
143
|
+
let baseOptions;
|
|
144
|
+
if (configuration) {
|
|
145
|
+
baseOptions = configuration.baseOptions;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
149
|
+
const localVarHeaderParameter = {} as any;
|
|
150
|
+
const localVarQueryParameter = {} as any;
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
155
|
+
|
|
156
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
157
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
158
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
159
|
+
localVarRequestOptions.data = serializeDataIfNeeded(checkEmailFirstRequest, localVarRequestOptions, configuration)
|
|
160
|
+
|
|
161
|
+
return {
|
|
162
|
+
url: toPathString(localVarUrlObj),
|
|
163
|
+
options: localVarRequestOptions,
|
|
164
|
+
};
|
|
165
|
+
},
|
|
122
166
|
/**
|
|
123
167
|
* 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.
|
|
124
168
|
* @summary Device authorization request (RFC 8628)
|
|
@@ -347,7 +391,7 @@ export const OAuthApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
347
391
|
};
|
|
348
392
|
},
|
|
349
393
|
/**
|
|
350
|
-
* 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.
|
|
394
|
+
* 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_*).
|
|
351
395
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
352
396
|
* @param {string} orgId
|
|
353
397
|
* @param {*} [options] Override http request option.
|
|
@@ -789,6 +833,20 @@ export const OAuthApiFp = function(configuration?: Configuration) {
|
|
|
789
833
|
const localVarOperationServerBasePath = operationServerMap['OAuthApi.backchannelAuthorize']?.[localVarOperationServerIndex]?.url;
|
|
790
834
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
791
835
|
},
|
|
836
|
+
/**
|
|
837
|
+
* 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`.
|
|
838
|
+
* @summary Sign-in methods for an email-first form
|
|
839
|
+
* @param {string} orgId
|
|
840
|
+
* @param {CheckEmailFirstRequest} checkEmailFirstRequest
|
|
841
|
+
* @param {*} [options] Override http request option.
|
|
842
|
+
* @throws {RequiredError}
|
|
843
|
+
*/
|
|
844
|
+
async checkEmailFirst(orgId: string, checkEmailFirstRequest: CheckEmailFirstRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckEmailFirstResponse>> {
|
|
845
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkEmailFirst(orgId, checkEmailFirstRequest, options);
|
|
846
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
847
|
+
const localVarOperationServerBasePath = operationServerMap['OAuthApi.checkEmailFirst']?.[localVarOperationServerIndex]?.url;
|
|
848
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
849
|
+
},
|
|
792
850
|
/**
|
|
793
851
|
* 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.
|
|
794
852
|
* @summary Device authorization request (RFC 8628)
|
|
@@ -869,7 +927,7 @@ export const OAuthApiFp = function(configuration?: Configuration) {
|
|
|
869
927
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
870
928
|
},
|
|
871
929
|
/**
|
|
872
|
-
* 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.
|
|
930
|
+
* 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_*).
|
|
873
931
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
874
932
|
* @param {string} orgId
|
|
875
933
|
* @param {*} [options] Override http request option.
|
|
@@ -1045,6 +1103,16 @@ export const OAuthApiFactory = function (configuration?: Configuration, basePath
|
|
|
1045
1103
|
backchannelAuthorize(requestParameters: OAuthApiBackchannelAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<BackchannelAuthorizeResponse> {
|
|
1046
1104
|
return localVarFp.backchannelAuthorize(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1047
1105
|
},
|
|
1106
|
+
/**
|
|
1107
|
+
* 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`.
|
|
1108
|
+
* @summary Sign-in methods for an email-first form
|
|
1109
|
+
* @param {OAuthApiCheckEmailFirstRequest} requestParameters Request parameters.
|
|
1110
|
+
* @param {*} [options] Override http request option.
|
|
1111
|
+
* @throws {RequiredError}
|
|
1112
|
+
*/
|
|
1113
|
+
checkEmailFirst(requestParameters: OAuthApiCheckEmailFirstRequest, options?: RawAxiosRequestConfig): AxiosPromise<CheckEmailFirstResponse> {
|
|
1114
|
+
return localVarFp.checkEmailFirst(requestParameters.orgId, requestParameters.checkEmailFirstRequest, options).then((request) => request(axios, basePath));
|
|
1115
|
+
},
|
|
1048
1116
|
/**
|
|
1049
1117
|
* 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.
|
|
1050
1118
|
* @summary Device authorization request (RFC 8628)
|
|
@@ -1106,7 +1174,7 @@ export const OAuthApiFactory = function (configuration?: Configuration, basePath
|
|
|
1106
1174
|
return localVarFp.par(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1107
1175
|
},
|
|
1108
1176
|
/**
|
|
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.
|
|
1177
|
+
* 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_*).
|
|
1110
1178
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
1111
1179
|
* @param {OAuthApiRegisterClientRequest} requestParameters Request parameters.
|
|
1112
1180
|
* @param {*} [options] Override http request option.
|
|
@@ -1244,6 +1312,16 @@ export interface OAuthApiInterface {
|
|
|
1244
1312
|
*/
|
|
1245
1313
|
backchannelAuthorize(requestParameters: OAuthApiBackchannelAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<BackchannelAuthorizeResponse>;
|
|
1246
1314
|
|
|
1315
|
+
/**
|
|
1316
|
+
* 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`.
|
|
1317
|
+
* @summary Sign-in methods for an email-first form
|
|
1318
|
+
* @param {OAuthApiCheckEmailFirstRequest} requestParameters Request parameters.
|
|
1319
|
+
* @param {*} [options] Override http request option.
|
|
1320
|
+
* @throws {RequiredError}
|
|
1321
|
+
* @memberof OAuthApiInterface
|
|
1322
|
+
*/
|
|
1323
|
+
checkEmailFirst(requestParameters: OAuthApiCheckEmailFirstRequest, options?: RawAxiosRequestConfig): AxiosPromise<CheckEmailFirstResponse>;
|
|
1324
|
+
|
|
1247
1325
|
/**
|
|
1248
1326
|
* 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.
|
|
1249
1327
|
* @summary Device authorization request (RFC 8628)
|
|
@@ -1305,7 +1383,7 @@ export interface OAuthApiInterface {
|
|
|
1305
1383
|
par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse>;
|
|
1306
1384
|
|
|
1307
1385
|
/**
|
|
1308
|
-
* 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.
|
|
1386
|
+
* 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_*).
|
|
1309
1387
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
1310
1388
|
* @param {OAuthApiRegisterClientRequest} requestParameters Request parameters.
|
|
1311
1389
|
* @param {*} [options] Override http request option.
|
|
@@ -1444,6 +1522,27 @@ export interface OAuthApiBackchannelAuthorizeRequest {
|
|
|
1444
1522
|
readonly orgId: string
|
|
1445
1523
|
}
|
|
1446
1524
|
|
|
1525
|
+
/**
|
|
1526
|
+
* Request parameters for checkEmailFirst operation in OAuthApi.
|
|
1527
|
+
* @export
|
|
1528
|
+
* @interface OAuthApiCheckEmailFirstRequest
|
|
1529
|
+
*/
|
|
1530
|
+
export interface OAuthApiCheckEmailFirstRequest {
|
|
1531
|
+
/**
|
|
1532
|
+
*
|
|
1533
|
+
* @type {string}
|
|
1534
|
+
* @memberof OAuthApiCheckEmailFirst
|
|
1535
|
+
*/
|
|
1536
|
+
readonly orgId: string
|
|
1537
|
+
|
|
1538
|
+
/**
|
|
1539
|
+
*
|
|
1540
|
+
* @type {CheckEmailFirstRequest}
|
|
1541
|
+
* @memberof OAuthApiCheckEmailFirst
|
|
1542
|
+
*/
|
|
1543
|
+
readonly checkEmailFirstRequest: CheckEmailFirstRequest
|
|
1544
|
+
}
|
|
1545
|
+
|
|
1447
1546
|
/**
|
|
1448
1547
|
* Request parameters for deviceAuthorization operation in OAuthApi.
|
|
1449
1548
|
* @export
|
|
@@ -1748,6 +1847,18 @@ export class OAuthApi extends BaseAPI implements OAuthApiInterface {
|
|
|
1748
1847
|
return OAuthApiFp(this.configuration).backchannelAuthorize(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1749
1848
|
}
|
|
1750
1849
|
|
|
1850
|
+
/**
|
|
1851
|
+
* 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`.
|
|
1852
|
+
* @summary Sign-in methods for an email-first form
|
|
1853
|
+
* @param {OAuthApiCheckEmailFirstRequest} requestParameters Request parameters.
|
|
1854
|
+
* @param {*} [options] Override http request option.
|
|
1855
|
+
* @throws {RequiredError}
|
|
1856
|
+
* @memberof OAuthApi
|
|
1857
|
+
*/
|
|
1858
|
+
public checkEmailFirst(requestParameters: OAuthApiCheckEmailFirstRequest, options?: RawAxiosRequestConfig) {
|
|
1859
|
+
return OAuthApiFp(this.configuration).checkEmailFirst(requestParameters.orgId, requestParameters.checkEmailFirstRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1860
|
+
}
|
|
1861
|
+
|
|
1751
1862
|
/**
|
|
1752
1863
|
* 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.
|
|
1753
1864
|
* @summary Device authorization request (RFC 8628)
|
|
@@ -1821,7 +1932,7 @@ export class OAuthApi extends BaseAPI implements OAuthApiInterface {
|
|
|
1821
1932
|
}
|
|
1822
1933
|
|
|
1823
1934
|
/**
|
|
1824
|
-
* 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.
|
|
1935
|
+
* 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_*).
|
|
1825
1936
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
1826
1937
|
* @param {OAuthApiRegisterClientRequest} requestParameters Request parameters.
|
|
1827
1938
|
* @param {*} [options] Override http request option.
|
package/api/ssf-api.ts
CHANGED
|
@@ -121,7 +121,7 @@ export const SsfApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
121
121
|
};
|
|
122
122
|
},
|
|
123
123
|
/**
|
|
124
|
-
*
|
|
124
|
+
* Needs `webhooks.view` and `agents.view`, as the Security signals page in the portal does.
|
|
125
125
|
* @summary Read SSF stream configuration(s)
|
|
126
126
|
* @param {string} orgId
|
|
127
127
|
* @param {string} [streamId]
|
|
@@ -167,7 +167,7 @@ export const SsfApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
167
167
|
};
|
|
168
168
|
},
|
|
169
169
|
/**
|
|
170
|
-
*
|
|
170
|
+
* Needs `settings.manage`, as the portal does.
|
|
171
171
|
* @summary Request a stream verification event
|
|
172
172
|
* @param {string} orgId
|
|
173
173
|
* @param {*} [options] Override http request option.
|
|
@@ -245,7 +245,7 @@ export const SsfApiFp = function(configuration?: Configuration) {
|
|
|
245
245
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
246
246
|
},
|
|
247
247
|
/**
|
|
248
|
-
*
|
|
248
|
+
* Needs `webhooks.view` and `agents.view`, as the Security signals page in the portal does.
|
|
249
249
|
* @summary Read SSF stream configuration(s)
|
|
250
250
|
* @param {string} orgId
|
|
251
251
|
* @param {string} [streamId]
|
|
@@ -259,7 +259,7 @@ export const SsfApiFp = function(configuration?: Configuration) {
|
|
|
259
259
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
260
260
|
},
|
|
261
261
|
/**
|
|
262
|
-
*
|
|
262
|
+
* Needs `settings.manage`, as the portal does.
|
|
263
263
|
* @summary Request a stream verification event
|
|
264
264
|
* @param {string} orgId
|
|
265
265
|
* @param {*} [options] Override http request option.
|
|
@@ -302,7 +302,7 @@ export const SsfApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
302
302
|
return localVarFp.deleteStreamConfig(requestParameters.streamId, requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
303
303
|
},
|
|
304
304
|
/**
|
|
305
|
-
*
|
|
305
|
+
* Needs `webhooks.view` and `agents.view`, as the Security signals page in the portal does.
|
|
306
306
|
* @summary Read SSF stream configuration(s)
|
|
307
307
|
* @param {SsfApiGetStreamConfigRequest} requestParameters Request parameters.
|
|
308
308
|
* @param {*} [options] Override http request option.
|
|
@@ -312,7 +312,7 @@ export const SsfApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
312
312
|
return localVarFp.getStreamConfig(requestParameters.orgId, requestParameters.streamId, options).then((request) => request(axios, basePath));
|
|
313
313
|
},
|
|
314
314
|
/**
|
|
315
|
-
*
|
|
315
|
+
* Needs `settings.manage`, as the portal does.
|
|
316
316
|
* @summary Request a stream verification event
|
|
317
317
|
* @param {SsfApiVerifyStreamRequest} requestParameters Request parameters.
|
|
318
318
|
* @param {*} [options] Override http request option.
|
|
@@ -351,7 +351,7 @@ export interface SsfApiInterface {
|
|
|
351
351
|
deleteStreamConfig(requestParameters: SsfApiDeleteStreamConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
352
352
|
|
|
353
353
|
/**
|
|
354
|
-
*
|
|
354
|
+
* Needs `webhooks.view` and `agents.view`, as the Security signals page in the portal does.
|
|
355
355
|
* @summary Read SSF stream configuration(s)
|
|
356
356
|
* @param {SsfApiGetStreamConfigRequest} requestParameters Request parameters.
|
|
357
357
|
* @param {*} [options] Override http request option.
|
|
@@ -361,7 +361,7 @@ export interface SsfApiInterface {
|
|
|
361
361
|
getStreamConfig(requestParameters: SsfApiGetStreamConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamConfig200Response>;
|
|
362
362
|
|
|
363
363
|
/**
|
|
364
|
-
*
|
|
364
|
+
* Needs `settings.manage`, as the portal does.
|
|
365
365
|
* @summary Request a stream verification event
|
|
366
366
|
* @param {SsfApiVerifyStreamRequest} requestParameters Request parameters.
|
|
367
367
|
* @param {*} [options] Override http request option.
|
|
@@ -474,7 +474,7 @@ export class SsfApi extends BaseAPI implements SsfApiInterface {
|
|
|
474
474
|
}
|
|
475
475
|
|
|
476
476
|
/**
|
|
477
|
-
*
|
|
477
|
+
* Needs `webhooks.view` and `agents.view`, as the Security signals page in the portal does.
|
|
478
478
|
* @summary Read SSF stream configuration(s)
|
|
479
479
|
* @param {SsfApiGetStreamConfigRequest} requestParameters Request parameters.
|
|
480
480
|
* @param {*} [options] Override http request option.
|
|
@@ -486,7 +486,7 @@ export class SsfApi extends BaseAPI implements SsfApiInterface {
|
|
|
486
486
|
}
|
|
487
487
|
|
|
488
488
|
/**
|
|
489
|
-
*
|
|
489
|
+
* Needs `settings.manage`, as the portal does.
|
|
490
490
|
* @summary Request a stream verification event
|
|
491
491
|
* @param {SsfApiVerifyStreamRequest} requestParameters Request parameters.
|
|
492
492
|
* @param {*} [options] Override http request option.
|
|
@@ -91,10 +91,11 @@ export declare const AdminAbacApiAxiosParamCreator: (configuration?: Configurati
|
|
|
91
91
|
*
|
|
92
92
|
* @summary List ABAC policies
|
|
93
93
|
* @param {string} orgId
|
|
94
|
+
* @param {string} [action] Only policies that name this action, alone or in a comma-separated list. `*` lists the policies that name `*`.
|
|
94
95
|
* @param {*} [options] Override http request option.
|
|
95
96
|
* @throws {RequiredError}
|
|
96
97
|
*/
|
|
97
|
-
abacPoliciesList: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98
|
+
abacPoliciesList: (orgId: string, action?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
98
99
|
/**
|
|
99
100
|
*
|
|
100
101
|
* @summary Toggle a policy between active and inactive
|
|
@@ -210,10 +211,11 @@ export declare const AdminAbacApiFp: (configuration?: Configuration) => {
|
|
|
210
211
|
*
|
|
211
212
|
* @summary List ABAC policies
|
|
212
213
|
* @param {string} orgId
|
|
214
|
+
* @param {string} [action] Only policies that name this action, alone or in a comma-separated list. `*` lists the policies that name `*`.
|
|
213
215
|
* @param {*} [options] Override http request option.
|
|
214
216
|
* @throws {RequiredError}
|
|
215
217
|
*/
|
|
216
|
-
abacPoliciesList(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AbacPoliciesListResponse>>;
|
|
218
|
+
abacPoliciesList(orgId: string, action?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AbacPoliciesListResponse>>;
|
|
217
219
|
/**
|
|
218
220
|
*
|
|
219
221
|
* @summary Toggle a policy between active and inactive
|
|
@@ -621,6 +623,12 @@ export interface AdminAbacApiAbacPoliciesListRequest {
|
|
|
621
623
|
* @memberof AdminAbacApiAbacPoliciesList
|
|
622
624
|
*/
|
|
623
625
|
readonly orgId: string;
|
|
626
|
+
/**
|
|
627
|
+
* Only policies that name this action, alone or in a comma-separated list. `*` lists the policies that name `*`.
|
|
628
|
+
* @type {string}
|
|
629
|
+
* @memberof AdminAbacApiAbacPoliciesList
|
|
630
|
+
*/
|
|
631
|
+
readonly action?: string;
|
|
624
632
|
}
|
|
625
633
|
/**
|
|
626
634
|
* Request parameters for abacPoliciesToggle operation in AdminAbacApi.
|
|
@@ -293,10 +293,11 @@ const AdminAbacApiAxiosParamCreator = function (configuration) {
|
|
|
293
293
|
*
|
|
294
294
|
* @summary List ABAC policies
|
|
295
295
|
* @param {string} orgId
|
|
296
|
+
* @param {string} [action] Only policies that name this action, alone or in a comma-separated list. `*` lists the policies that name `*`.
|
|
296
297
|
* @param {*} [options] Override http request option.
|
|
297
298
|
* @throws {RequiredError}
|
|
298
299
|
*/
|
|
299
|
-
abacPoliciesList: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
|
|
300
|
+
abacPoliciesList: (orgId_1, action_1, ...args_1) => __awaiter(this, [orgId_1, action_1, ...args_1], void 0, function* (orgId, action, options = {}) {
|
|
300
301
|
// verify required parameter 'orgId' is not null or undefined
|
|
301
302
|
(0, common_1.assertParamExists)('abacPoliciesList', 'orgId', orgId);
|
|
302
303
|
const localVarPath = `/orgs/{orgId}/api/v1/abac/policies`
|
|
@@ -315,6 +316,9 @@ const AdminAbacApiAxiosParamCreator = function (configuration) {
|
|
|
315
316
|
// authentication BearerAuth required
|
|
316
317
|
// http bearer authentication required
|
|
317
318
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
319
|
+
if (action !== undefined) {
|
|
320
|
+
localVarQueryParameter['action'] = action;
|
|
321
|
+
}
|
|
318
322
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
319
323
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
320
324
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -643,13 +647,14 @@ const AdminAbacApiFp = function (configuration) {
|
|
|
643
647
|
*
|
|
644
648
|
* @summary List ABAC policies
|
|
645
649
|
* @param {string} orgId
|
|
650
|
+
* @param {string} [action] Only policies that name this action, alone or in a comma-separated list. `*` lists the policies that name `*`.
|
|
646
651
|
* @param {*} [options] Override http request option.
|
|
647
652
|
* @throws {RequiredError}
|
|
648
653
|
*/
|
|
649
|
-
abacPoliciesList(orgId, options) {
|
|
654
|
+
abacPoliciesList(orgId, action, options) {
|
|
650
655
|
return __awaiter(this, void 0, void 0, function* () {
|
|
651
656
|
var _a, _b, _c;
|
|
652
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.abacPoliciesList(orgId, options);
|
|
657
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.abacPoliciesList(orgId, action, options);
|
|
653
658
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
654
659
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminAbacApi.abacPoliciesList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
655
660
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -828,7 +833,7 @@ const AdminAbacApiFactory = function (configuration, basePath, axios) {
|
|
|
828
833
|
* @throws {RequiredError}
|
|
829
834
|
*/
|
|
830
835
|
abacPoliciesList(requestParameters, options) {
|
|
831
|
-
return localVarFp.abacPoliciesList(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
836
|
+
return localVarFp.abacPoliciesList(requestParameters.orgId, requestParameters.action, options).then((request) => request(axios, basePath));
|
|
832
837
|
},
|
|
833
838
|
/**
|
|
834
839
|
*
|
|
@@ -976,7 +981,7 @@ class AdminAbacApi extends base_1.BaseAPI {
|
|
|
976
981
|
* @memberof AdminAbacApi
|
|
977
982
|
*/
|
|
978
983
|
abacPoliciesList(requestParameters, options) {
|
|
979
|
-
return (0, exports.AdminAbacApiFp)(this.configuration).abacPoliciesList(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
984
|
+
return (0, exports.AdminAbacApiFp)(this.configuration).abacPoliciesList(requestParameters.orgId, requestParameters.action, options).then((request) => request(this.axios, this.basePath));
|
|
980
985
|
}
|
|
981
986
|
/**
|
|
982
987
|
*
|