@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/admin-users-api.ts
CHANGED
|
@@ -44,6 +44,8 @@ import type { AdminIdentitiesListResponse } from '../models';
|
|
|
44
44
|
// @ts-ignore
|
|
45
45
|
import type { AdminRolesGetPermissionsResponse } from '../models';
|
|
46
46
|
// @ts-ignore
|
|
47
|
+
import type { AdminUsersRestoreResponse } from '../models';
|
|
48
|
+
// @ts-ignore
|
|
47
49
|
import type { BlockUserResponse } from '../models';
|
|
48
50
|
// @ts-ignore
|
|
49
51
|
import type { CreateUserResponse } from '../models';
|
|
@@ -127,7 +129,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
127
129
|
};
|
|
128
130
|
},
|
|
129
131
|
/**
|
|
130
|
-
*
|
|
132
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
131
133
|
* @summary Assign a permission to a user
|
|
132
134
|
* @param {string} orgId
|
|
133
135
|
* @param {string} userId
|
|
@@ -217,7 +219,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
217
219
|
};
|
|
218
220
|
},
|
|
219
221
|
/**
|
|
220
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
222
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
221
223
|
* @summary Relink legacy SAML users to an IdP
|
|
222
224
|
* @param {string} orgId
|
|
223
225
|
* @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
|
|
@@ -445,6 +447,51 @@ export const AdminUsersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
445
447
|
|
|
446
448
|
|
|
447
449
|
|
|
450
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
451
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
452
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
453
|
+
|
|
454
|
+
return {
|
|
455
|
+
url: toPathString(localVarUrlObj),
|
|
456
|
+
options: localVarRequestOptions,
|
|
457
|
+
};
|
|
458
|
+
},
|
|
459
|
+
/**
|
|
460
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
461
|
+
* @summary Restore a deleted user
|
|
462
|
+
* @param {string} orgId
|
|
463
|
+
* @param {string} userId
|
|
464
|
+
* @param {*} [options] Override http request option.
|
|
465
|
+
* @throws {RequiredError}
|
|
466
|
+
*/
|
|
467
|
+
adminUsersRestore: async (orgId: string, userId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
468
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
469
|
+
assertParamExists('adminUsersRestore', 'orgId', orgId)
|
|
470
|
+
// verify required parameter 'userId' is not null or undefined
|
|
471
|
+
assertParamExists('adminUsersRestore', 'userId', userId)
|
|
472
|
+
const localVarPath = `/orgs/{orgId}/api/v1/admin/users/{userId}/restore`
|
|
473
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
474
|
+
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
475
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
476
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
477
|
+
let baseOptions;
|
|
478
|
+
if (configuration) {
|
|
479
|
+
baseOptions = configuration.baseOptions;
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
483
|
+
const localVarHeaderParameter = {} as any;
|
|
484
|
+
const localVarQueryParameter = {} as any;
|
|
485
|
+
|
|
486
|
+
// authentication ApiKeyAuth required
|
|
487
|
+
await setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration)
|
|
488
|
+
|
|
489
|
+
// authentication BearerAuth required
|
|
490
|
+
// http bearer authentication required
|
|
491
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
448
495
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
449
496
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
450
497
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -769,10 +816,22 @@ export const AdminUsersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
769
816
|
*
|
|
770
817
|
* @summary List users
|
|
771
818
|
* @param {string} orgId
|
|
772
|
-
* @param {
|
|
773
|
-
* @
|
|
774
|
-
|
|
775
|
-
|
|
819
|
+
* @param {number} [page] Page number.
|
|
820
|
+
* @param {number} [limit] Users per page (1 to 100).
|
|
821
|
+
* @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
822
|
+
* @param {boolean} [active] Only active (`true`) or inactive (`false`) users.
|
|
823
|
+
* @param {boolean} [blocked] Only blocked (`true`) or not blocked (`false`) users.
|
|
824
|
+
* @param {boolean} [deleted] `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
825
|
+
* @param {boolean} [emailVerified] Only users whose email address is verified (`true`) or not (`false`).
|
|
826
|
+
* @param {boolean} [mfaEnabled] Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
827
|
+
* @param {string} [role] Only users who hold the role with this slug.
|
|
828
|
+
* @param {string} [group] Only members of the group with this slug.
|
|
829
|
+
* @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
830
|
+
* @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
|
|
831
|
+
* @param {*} [options] Override http request option.
|
|
832
|
+
* @throws {RequiredError}
|
|
833
|
+
*/
|
|
834
|
+
listUsers: async (orgId: string, page?: number, limit?: number, search?: string, active?: boolean, blocked?: boolean, deleted?: boolean, emailVerified?: boolean, mfaEnabled?: boolean, role?: string, group?: string, sortBy?: ListUsersSortBy, sortDir?: ListUsersSortDir, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
776
835
|
// verify required parameter 'orgId' is not null or undefined
|
|
777
836
|
assertParamExists('listUsers', 'orgId', orgId)
|
|
778
837
|
const localVarPath = `/orgs/{orgId}/api/v1/admin/users`
|
|
@@ -795,6 +854,54 @@ export const AdminUsersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
795
854
|
// http bearer authentication required
|
|
796
855
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
797
856
|
|
|
857
|
+
if (page !== undefined) {
|
|
858
|
+
localVarQueryParameter['page'] = page;
|
|
859
|
+
}
|
|
860
|
+
|
|
861
|
+
if (limit !== undefined) {
|
|
862
|
+
localVarQueryParameter['limit'] = limit;
|
|
863
|
+
}
|
|
864
|
+
|
|
865
|
+
if (search !== undefined) {
|
|
866
|
+
localVarQueryParameter['search'] = search;
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
if (active !== undefined) {
|
|
870
|
+
localVarQueryParameter['active'] = active;
|
|
871
|
+
}
|
|
872
|
+
|
|
873
|
+
if (blocked !== undefined) {
|
|
874
|
+
localVarQueryParameter['blocked'] = blocked;
|
|
875
|
+
}
|
|
876
|
+
|
|
877
|
+
if (deleted !== undefined) {
|
|
878
|
+
localVarQueryParameter['deleted'] = deleted;
|
|
879
|
+
}
|
|
880
|
+
|
|
881
|
+
if (emailVerified !== undefined) {
|
|
882
|
+
localVarQueryParameter['emailVerified'] = emailVerified;
|
|
883
|
+
}
|
|
884
|
+
|
|
885
|
+
if (mfaEnabled !== undefined) {
|
|
886
|
+
localVarQueryParameter['mfaEnabled'] = mfaEnabled;
|
|
887
|
+
}
|
|
888
|
+
|
|
889
|
+
if (role !== undefined) {
|
|
890
|
+
localVarQueryParameter['role'] = role;
|
|
891
|
+
}
|
|
892
|
+
|
|
893
|
+
if (group !== undefined) {
|
|
894
|
+
localVarQueryParameter['group'] = group;
|
|
895
|
+
}
|
|
896
|
+
|
|
897
|
+
if (sortBy !== undefined) {
|
|
898
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
if (sortDir !== undefined) {
|
|
902
|
+
localVarQueryParameter['sortDir'] = sortDir;
|
|
903
|
+
}
|
|
904
|
+
|
|
798
905
|
|
|
799
906
|
|
|
800
907
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1135,7 +1242,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
1135
1242
|
};
|
|
1136
1243
|
},
|
|
1137
1244
|
/**
|
|
1138
|
-
*
|
|
1245
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
1139
1246
|
* @summary Set a user\'s password
|
|
1140
1247
|
* @param {string} orgId
|
|
1141
1248
|
* @param {string} userId
|
|
@@ -1180,7 +1287,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration?: Configur
|
|
|
1180
1287
|
};
|
|
1181
1288
|
},
|
|
1182
1289
|
/**
|
|
1183
|
-
*
|
|
1290
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
1184
1291
|
* @summary Set a user\'s password
|
|
1185
1292
|
* @param {string} orgId
|
|
1186
1293
|
* @param {string} userId
|
|
@@ -1474,7 +1581,7 @@ export const AdminUsersApiFp = function(configuration?: Configuration) {
|
|
|
1474
1581
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1475
1582
|
},
|
|
1476
1583
|
/**
|
|
1477
|
-
*
|
|
1584
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
1478
1585
|
* @summary Assign a permission to a user
|
|
1479
1586
|
* @param {string} orgId
|
|
1480
1587
|
* @param {string} userId
|
|
@@ -1502,7 +1609,7 @@ export const AdminUsersApiFp = function(configuration?: Configuration) {
|
|
|
1502
1609
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1503
1610
|
},
|
|
1504
1611
|
/**
|
|
1505
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
1612
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
1506
1613
|
* @summary Relink legacy SAML users to an IdP
|
|
1507
1614
|
* @param {string} orgId
|
|
1508
1615
|
* @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
|
|
@@ -1573,6 +1680,20 @@ export const AdminUsersApiFp = function(configuration?: Configuration) {
|
|
|
1573
1680
|
const localVarOperationServerBasePath = operationServerMap['AdminUsersApi.adminIdentitiesUnlink']?.[localVarOperationServerIndex]?.url;
|
|
1574
1681
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1575
1682
|
},
|
|
1683
|
+
/**
|
|
1684
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
1685
|
+
* @summary Restore a deleted user
|
|
1686
|
+
* @param {string} orgId
|
|
1687
|
+
* @param {string} userId
|
|
1688
|
+
* @param {*} [options] Override http request option.
|
|
1689
|
+
* @throws {RequiredError}
|
|
1690
|
+
*/
|
|
1691
|
+
async adminUsersRestore(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminUsersRestoreResponse>> {
|
|
1692
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminUsersRestore(orgId, userId, options);
|
|
1693
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1694
|
+
const localVarOperationServerBasePath = operationServerMap['AdminUsersApi.adminUsersRestore']?.[localVarOperationServerIndex]?.url;
|
|
1695
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1696
|
+
},
|
|
1576
1697
|
/**
|
|
1577
1698
|
*
|
|
1578
1699
|
* @summary Block a user
|
|
@@ -1674,11 +1795,23 @@ export const AdminUsersApiFp = function(configuration?: Configuration) {
|
|
|
1674
1795
|
*
|
|
1675
1796
|
* @summary List users
|
|
1676
1797
|
* @param {string} orgId
|
|
1677
|
-
* @param {
|
|
1678
|
-
* @
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1798
|
+
* @param {number} [page] Page number.
|
|
1799
|
+
* @param {number} [limit] Users per page (1 to 100).
|
|
1800
|
+
* @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
1801
|
+
* @param {boolean} [active] Only active (`true`) or inactive (`false`) users.
|
|
1802
|
+
* @param {boolean} [blocked] Only blocked (`true`) or not blocked (`false`) users.
|
|
1803
|
+
* @param {boolean} [deleted] `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
1804
|
+
* @param {boolean} [emailVerified] Only users whose email address is verified (`true`) or not (`false`).
|
|
1805
|
+
* @param {boolean} [mfaEnabled] Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
1806
|
+
* @param {string} [role] Only users who hold the role with this slug.
|
|
1807
|
+
* @param {string} [group] Only members of the group with this slug.
|
|
1808
|
+
* @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
1809
|
+
* @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
|
|
1810
|
+
* @param {*} [options] Override http request option.
|
|
1811
|
+
* @throws {RequiredError}
|
|
1812
|
+
*/
|
|
1813
|
+
async listUsers(orgId: string, page?: number, limit?: number, search?: string, active?: boolean, blocked?: boolean, deleted?: boolean, emailVerified?: boolean, mfaEnabled?: boolean, role?: string, group?: string, sortBy?: ListUsersSortBy, sortDir?: ListUsersSortDir, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>> {
|
|
1814
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listUsers(orgId, page, limit, search, active, blocked, deleted, emailVerified, mfaEnabled, role, group, sortBy, sortDir, options);
|
|
1682
1815
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1683
1816
|
const localVarOperationServerBasePath = operationServerMap['AdminUsersApi.listUsers']?.[localVarOperationServerIndex]?.url;
|
|
1684
1817
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1786,7 +1919,7 @@ export const AdminUsersApiFp = function(configuration?: Configuration) {
|
|
|
1786
1919
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1787
1920
|
},
|
|
1788
1921
|
/**
|
|
1789
|
-
*
|
|
1922
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
1790
1923
|
* @summary Set a user\'s password
|
|
1791
1924
|
* @param {string} orgId
|
|
1792
1925
|
* @param {string} userId
|
|
@@ -1800,7 +1933,7 @@ export const AdminUsersApiFp = function(configuration?: Configuration) {
|
|
|
1800
1933
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1801
1934
|
},
|
|
1802
1935
|
/**
|
|
1803
|
-
*
|
|
1936
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
1804
1937
|
* @summary Set a user\'s password
|
|
1805
1938
|
* @param {string} orgId
|
|
1806
1939
|
* @param {string} userId
|
|
@@ -1904,7 +2037,7 @@ export const AdminUsersApiFactory = function (configuration?: Configuration, bas
|
|
|
1904
2037
|
return localVarFp.addUserGroup(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1905
2038
|
},
|
|
1906
2039
|
/**
|
|
1907
|
-
*
|
|
2040
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
1908
2041
|
* @summary Assign a permission to a user
|
|
1909
2042
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
1910
2043
|
* @param {*} [options] Override http request option.
|
|
@@ -1924,7 +2057,7 @@ export const AdminUsersApiFactory = function (configuration?: Configuration, bas
|
|
|
1924
2057
|
return localVarFp.addUserRole(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1925
2058
|
},
|
|
1926
2059
|
/**
|
|
1927
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
2060
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
1928
2061
|
* @summary Relink legacy SAML users to an IdP
|
|
1929
2062
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
1930
2063
|
* @param {*} [options] Override http request option.
|
|
@@ -1973,6 +2106,16 @@ export const AdminUsersApiFactory = function (configuration?: Configuration, bas
|
|
|
1973
2106
|
adminIdentitiesUnlink(requestParameters: AdminUsersApiAdminIdentitiesUnlinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse> {
|
|
1974
2107
|
return localVarFp.adminIdentitiesUnlink(requestParameters.type, requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1975
2108
|
},
|
|
2109
|
+
/**
|
|
2110
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
2111
|
+
* @summary Restore a deleted user
|
|
2112
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
2113
|
+
* @param {*} [options] Override http request option.
|
|
2114
|
+
* @throws {RequiredError}
|
|
2115
|
+
*/
|
|
2116
|
+
adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminUsersRestoreResponse> {
|
|
2117
|
+
return localVarFp.adminUsersRestore(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
2118
|
+
},
|
|
1976
2119
|
/**
|
|
1977
2120
|
*
|
|
1978
2121
|
* @summary Block a user
|
|
@@ -2051,7 +2194,7 @@ export const AdminUsersApiFactory = function (configuration?: Configuration, bas
|
|
|
2051
2194
|
* @throws {RequiredError}
|
|
2052
2195
|
*/
|
|
2053
2196
|
listUsers(requestParameters: AdminUsersApiListUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListUsersResponse> {
|
|
2054
|
-
return localVarFp.listUsers(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
2197
|
+
return localVarFp.listUsers(requestParameters.orgId, requestParameters.page, requestParameters.limit, requestParameters.search, requestParameters.active, requestParameters.blocked, requestParameters.deleted, requestParameters.emailVerified, requestParameters.mfaEnabled, requestParameters.role, requestParameters.group, requestParameters.sortBy, requestParameters.sortDir, options).then((request) => request(axios, basePath));
|
|
2055
2198
|
},
|
|
2056
2199
|
/**
|
|
2057
2200
|
*
|
|
@@ -2125,7 +2268,7 @@ export const AdminUsersApiFactory = function (configuration?: Configuration, bas
|
|
|
2125
2268
|
return localVarFp.sendUserVerificationEmail(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
2126
2269
|
},
|
|
2127
2270
|
/**
|
|
2128
|
-
*
|
|
2271
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
2129
2272
|
* @summary Set a user\'s password
|
|
2130
2273
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
2131
2274
|
* @param {*} [options] Override http request option.
|
|
@@ -2135,7 +2278,7 @@ export const AdminUsersApiFactory = function (configuration?: Configuration, bas
|
|
|
2135
2278
|
return localVarFp.setUserPassword(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
2136
2279
|
},
|
|
2137
2280
|
/**
|
|
2138
|
-
*
|
|
2281
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
2139
2282
|
* @summary Set a user\'s password
|
|
2140
2283
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
2141
2284
|
* @param {*} [options] Override http request option.
|
|
@@ -2214,7 +2357,7 @@ export interface AdminUsersApiInterface {
|
|
|
2214
2357
|
addUserGroup(requestParameters: AdminUsersApiAddUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserGroupResponse>;
|
|
2215
2358
|
|
|
2216
2359
|
/**
|
|
2217
|
-
*
|
|
2360
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
2218
2361
|
* @summary Assign a permission to a user
|
|
2219
2362
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
2220
2363
|
* @param {*} [options] Override http request option.
|
|
@@ -2234,7 +2377,7 @@ export interface AdminUsersApiInterface {
|
|
|
2234
2377
|
addUserRole(requestParameters: AdminUsersApiAddUserRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserRoleResponse>;
|
|
2235
2378
|
|
|
2236
2379
|
/**
|
|
2237
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
2380
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
2238
2381
|
* @summary Relink legacy SAML users to an IdP
|
|
2239
2382
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
2240
2383
|
* @param {*} [options] Override http request option.
|
|
@@ -2283,6 +2426,16 @@ export interface AdminUsersApiInterface {
|
|
|
2283
2426
|
*/
|
|
2284
2427
|
adminIdentitiesUnlink(requestParameters: AdminUsersApiAdminIdentitiesUnlinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
|
|
2285
2428
|
|
|
2429
|
+
/**
|
|
2430
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
2431
|
+
* @summary Restore a deleted user
|
|
2432
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
2433
|
+
* @param {*} [options] Override http request option.
|
|
2434
|
+
* @throws {RequiredError}
|
|
2435
|
+
* @memberof AdminUsersApiInterface
|
|
2436
|
+
*/
|
|
2437
|
+
adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminUsersRestoreResponse>;
|
|
2438
|
+
|
|
2286
2439
|
/**
|
|
2287
2440
|
*
|
|
2288
2441
|
* @summary Block a user
|
|
@@ -2435,7 +2588,7 @@ export interface AdminUsersApiInterface {
|
|
|
2435
2588
|
sendUserVerificationEmail(requestParameters: AdminUsersApiSendUserVerificationEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<SendUserVerificationEmailResponse>;
|
|
2436
2589
|
|
|
2437
2590
|
/**
|
|
2438
|
-
*
|
|
2591
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
2439
2592
|
* @summary Set a user\'s password
|
|
2440
2593
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
2441
2594
|
* @param {*} [options] Override http request option.
|
|
@@ -2445,7 +2598,7 @@ export interface AdminUsersApiInterface {
|
|
|
2445
2598
|
setUserPassword(requestParameters: AdminUsersApiSetUserPasswordRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetUserPasswordPostResponse>;
|
|
2446
2599
|
|
|
2447
2600
|
/**
|
|
2448
|
-
*
|
|
2601
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
2449
2602
|
* @summary Set a user\'s password
|
|
2450
2603
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
2451
2604
|
* @param {*} [options] Override http request option.
|
|
@@ -2688,6 +2841,27 @@ export interface AdminUsersApiAdminIdentitiesUnlinkRequest {
|
|
|
2688
2841
|
readonly userId: string
|
|
2689
2842
|
}
|
|
2690
2843
|
|
|
2844
|
+
/**
|
|
2845
|
+
* Request parameters for adminUsersRestore operation in AdminUsersApi.
|
|
2846
|
+
* @export
|
|
2847
|
+
* @interface AdminUsersApiAdminUsersRestoreRequest
|
|
2848
|
+
*/
|
|
2849
|
+
export interface AdminUsersApiAdminUsersRestoreRequest {
|
|
2850
|
+
/**
|
|
2851
|
+
*
|
|
2852
|
+
* @type {string}
|
|
2853
|
+
* @memberof AdminUsersApiAdminUsersRestore
|
|
2854
|
+
*/
|
|
2855
|
+
readonly orgId: string
|
|
2856
|
+
|
|
2857
|
+
/**
|
|
2858
|
+
*
|
|
2859
|
+
* @type {string}
|
|
2860
|
+
* @memberof AdminUsersApiAdminUsersRestore
|
|
2861
|
+
*/
|
|
2862
|
+
readonly userId: string
|
|
2863
|
+
}
|
|
2864
|
+
|
|
2691
2865
|
/**
|
|
2692
2866
|
* Request parameters for blockUser operation in AdminUsersApi.
|
|
2693
2867
|
* @export
|
|
@@ -2840,6 +3014,90 @@ export interface AdminUsersApiListUsersRequest {
|
|
|
2840
3014
|
* @memberof AdminUsersApiListUsers
|
|
2841
3015
|
*/
|
|
2842
3016
|
readonly orgId: string
|
|
3017
|
+
|
|
3018
|
+
/**
|
|
3019
|
+
* Page number.
|
|
3020
|
+
* @type {number}
|
|
3021
|
+
* @memberof AdminUsersApiListUsers
|
|
3022
|
+
*/
|
|
3023
|
+
readonly page?: number
|
|
3024
|
+
|
|
3025
|
+
/**
|
|
3026
|
+
* Users per page (1 to 100).
|
|
3027
|
+
* @type {number}
|
|
3028
|
+
* @memberof AdminUsersApiListUsers
|
|
3029
|
+
*/
|
|
3030
|
+
readonly limit?: number
|
|
3031
|
+
|
|
3032
|
+
/**
|
|
3033
|
+
* Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
3034
|
+
* @type {string}
|
|
3035
|
+
* @memberof AdminUsersApiListUsers
|
|
3036
|
+
*/
|
|
3037
|
+
readonly search?: string
|
|
3038
|
+
|
|
3039
|
+
/**
|
|
3040
|
+
* Only active (`true`) or inactive (`false`) users.
|
|
3041
|
+
* @type {boolean}
|
|
3042
|
+
* @memberof AdminUsersApiListUsers
|
|
3043
|
+
*/
|
|
3044
|
+
readonly active?: boolean
|
|
3045
|
+
|
|
3046
|
+
/**
|
|
3047
|
+
* Only blocked (`true`) or not blocked (`false`) users.
|
|
3048
|
+
* @type {boolean}
|
|
3049
|
+
* @memberof AdminUsersApiListUsers
|
|
3050
|
+
*/
|
|
3051
|
+
readonly blocked?: boolean
|
|
3052
|
+
|
|
3053
|
+
/**
|
|
3054
|
+
* `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
3055
|
+
* @type {boolean}
|
|
3056
|
+
* @memberof AdminUsersApiListUsers
|
|
3057
|
+
*/
|
|
3058
|
+
readonly deleted?: boolean
|
|
3059
|
+
|
|
3060
|
+
/**
|
|
3061
|
+
* Only users whose email address is verified (`true`) or not (`false`).
|
|
3062
|
+
* @type {boolean}
|
|
3063
|
+
* @memberof AdminUsersApiListUsers
|
|
3064
|
+
*/
|
|
3065
|
+
readonly emailVerified?: boolean
|
|
3066
|
+
|
|
3067
|
+
/**
|
|
3068
|
+
* Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
3069
|
+
* @type {boolean}
|
|
3070
|
+
* @memberof AdminUsersApiListUsers
|
|
3071
|
+
*/
|
|
3072
|
+
readonly mfaEnabled?: boolean
|
|
3073
|
+
|
|
3074
|
+
/**
|
|
3075
|
+
* Only users who hold the role with this slug.
|
|
3076
|
+
* @type {string}
|
|
3077
|
+
* @memberof AdminUsersApiListUsers
|
|
3078
|
+
*/
|
|
3079
|
+
readonly role?: string
|
|
3080
|
+
|
|
3081
|
+
/**
|
|
3082
|
+
* Only members of the group with this slug.
|
|
3083
|
+
* @type {string}
|
|
3084
|
+
* @memberof AdminUsersApiListUsers
|
|
3085
|
+
*/
|
|
3086
|
+
readonly group?: string
|
|
3087
|
+
|
|
3088
|
+
/**
|
|
3089
|
+
* Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
3090
|
+
* @type {'email' | 'name' | 'username' | 'createdAt' | 'lastLoginAt'}
|
|
3091
|
+
* @memberof AdminUsersApiListUsers
|
|
3092
|
+
*/
|
|
3093
|
+
readonly sortBy?: ListUsersSortBy
|
|
3094
|
+
|
|
3095
|
+
/**
|
|
3096
|
+
* Sort direction. Used only together with sortBy.
|
|
3097
|
+
* @type {'ASC' | 'DESC'}
|
|
3098
|
+
* @memberof AdminUsersApiListUsers
|
|
3099
|
+
*/
|
|
3100
|
+
readonly sortDir?: ListUsersSortDir
|
|
2843
3101
|
}
|
|
2844
3102
|
|
|
2845
3103
|
/**
|
|
@@ -3177,7 +3435,7 @@ export class AdminUsersApi extends BaseAPI implements AdminUsersApiInterface {
|
|
|
3177
3435
|
}
|
|
3178
3436
|
|
|
3179
3437
|
/**
|
|
3180
|
-
*
|
|
3438
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
3181
3439
|
* @summary Assign a permission to a user
|
|
3182
3440
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
3183
3441
|
* @param {*} [options] Override http request option.
|
|
@@ -3201,7 +3459,7 @@ export class AdminUsersApi extends BaseAPI implements AdminUsersApiInterface {
|
|
|
3201
3459
|
}
|
|
3202
3460
|
|
|
3203
3461
|
/**
|
|
3204
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
3462
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
3205
3463
|
* @summary Relink legacy SAML users to an IdP
|
|
3206
3464
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
3207
3465
|
* @param {*} [options] Override http request option.
|
|
@@ -3260,6 +3518,18 @@ export class AdminUsersApi extends BaseAPI implements AdminUsersApiInterface {
|
|
|
3260
3518
|
return AdminUsersApiFp(this.configuration).adminIdentitiesUnlink(requestParameters.type, requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
3261
3519
|
}
|
|
3262
3520
|
|
|
3521
|
+
/**
|
|
3522
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
3523
|
+
* @summary Restore a deleted user
|
|
3524
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
3525
|
+
* @param {*} [options] Override http request option.
|
|
3526
|
+
* @throws {RequiredError}
|
|
3527
|
+
* @memberof AdminUsersApi
|
|
3528
|
+
*/
|
|
3529
|
+
public adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig) {
|
|
3530
|
+
return AdminUsersApiFp(this.configuration).adminUsersRestore(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
3531
|
+
}
|
|
3532
|
+
|
|
3263
3533
|
/**
|
|
3264
3534
|
*
|
|
3265
3535
|
* @summary Block a user
|
|
@@ -3353,7 +3623,7 @@ export class AdminUsersApi extends BaseAPI implements AdminUsersApiInterface {
|
|
|
3353
3623
|
* @memberof AdminUsersApi
|
|
3354
3624
|
*/
|
|
3355
3625
|
public listUsers(requestParameters: AdminUsersApiListUsersRequest, options?: RawAxiosRequestConfig) {
|
|
3356
|
-
return AdminUsersApiFp(this.configuration).listUsers(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
3626
|
+
return AdminUsersApiFp(this.configuration).listUsers(requestParameters.orgId, requestParameters.page, requestParameters.limit, requestParameters.search, requestParameters.active, requestParameters.blocked, requestParameters.deleted, requestParameters.emailVerified, requestParameters.mfaEnabled, requestParameters.role, requestParameters.group, requestParameters.sortBy, requestParameters.sortDir, options).then((request) => request(this.axios, this.basePath));
|
|
3357
3627
|
}
|
|
3358
3628
|
|
|
3359
3629
|
/**
|
|
@@ -3442,7 +3712,7 @@ export class AdminUsersApi extends BaseAPI implements AdminUsersApiInterface {
|
|
|
3442
3712
|
}
|
|
3443
3713
|
|
|
3444
3714
|
/**
|
|
3445
|
-
*
|
|
3715
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
3446
3716
|
* @summary Set a user\'s password
|
|
3447
3717
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
3448
3718
|
* @param {*} [options] Override http request option.
|
|
@@ -3454,7 +3724,7 @@ export class AdminUsersApi extends BaseAPI implements AdminUsersApiInterface {
|
|
|
3454
3724
|
}
|
|
3455
3725
|
|
|
3456
3726
|
/**
|
|
3457
|
-
*
|
|
3727
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
3458
3728
|
* @summary Set a user\'s password
|
|
3459
3729
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
3460
3730
|
* @param {*} [options] Override http request option.
|
|
@@ -3536,3 +3806,22 @@ export enum AdminIdentitiesUnlinkType {
|
|
|
3536
3806
|
LDAP = 'ldap',
|
|
3537
3807
|
SOCIAL = 'social'
|
|
3538
3808
|
}
|
|
3809
|
+
/**
|
|
3810
|
+
* @export
|
|
3811
|
+
* @enum {string}
|
|
3812
|
+
*/
|
|
3813
|
+
export enum ListUsersSortBy {
|
|
3814
|
+
EMAIL = 'email',
|
|
3815
|
+
NAME = 'name',
|
|
3816
|
+
USERNAME = 'username',
|
|
3817
|
+
CREATED_AT = 'createdAt',
|
|
3818
|
+
LAST_LOGIN_AT = 'lastLoginAt'
|
|
3819
|
+
}
|
|
3820
|
+
/**
|
|
3821
|
+
* @export
|
|
3822
|
+
* @enum {string}
|
|
3823
|
+
*/
|
|
3824
|
+
export enum ListUsersSortDir {
|
|
3825
|
+
ASC = 'ASC',
|
|
3826
|
+
DESC = 'DESC'
|
|
3827
|
+
}
|
package/api/agents-api.ts
CHANGED
|
@@ -60,7 +60,7 @@ import type { VerifyAgentCardResponse } from '../models';
|
|
|
60
60
|
export const AgentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
61
61
|
return {
|
|
62
62
|
/**
|
|
63
|
-
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document
|
|
63
|
+
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document:read\", \"context\": {\"id\": \"123\"} }
|
|
64
64
|
* @summary Agent-friendly permission check (Natural Language style)
|
|
65
65
|
* @param {string} orgId
|
|
66
66
|
* @param {AskRequest} askRequest
|
|
@@ -519,7 +519,7 @@ export const AgentsApiFp = function(configuration?: Configuration) {
|
|
|
519
519
|
const localVarAxiosParamCreator = AgentsApiAxiosParamCreator(configuration)
|
|
520
520
|
return {
|
|
521
521
|
/**
|
|
522
|
-
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document
|
|
522
|
+
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document:read\", \"context\": {\"id\": \"123\"} }
|
|
523
523
|
* @summary Agent-friendly permission check (Natural Language style)
|
|
524
524
|
* @param {string} orgId
|
|
525
525
|
* @param {AskRequest} askRequest
|
|
@@ -666,7 +666,7 @@ export const AgentsApiFactory = function (configuration?: Configuration, basePat
|
|
|
666
666
|
const localVarFp = AgentsApiFp(configuration)
|
|
667
667
|
return {
|
|
668
668
|
/**
|
|
669
|
-
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document
|
|
669
|
+
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document:read\", \"context\": {\"id\": \"123\"} }
|
|
670
670
|
* @summary Agent-friendly permission check (Natural Language style)
|
|
671
671
|
* @param {AgentsApiAskRequest} requestParameters Request parameters.
|
|
672
672
|
* @param {*} [options] Override http request option.
|
|
@@ -773,7 +773,7 @@ export const AgentsApiFactory = function (configuration?: Configuration, basePat
|
|
|
773
773
|
*/
|
|
774
774
|
export interface AgentsApiInterface {
|
|
775
775
|
/**
|
|
776
|
-
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document
|
|
776
|
+
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document:read\", \"context\": {\"id\": \"123\"} }
|
|
777
777
|
* @summary Agent-friendly permission check (Natural Language style)
|
|
778
778
|
* @param {AgentsApiAskRequest} requestParameters Request parameters.
|
|
779
779
|
* @param {*} [options] Override http request option.
|
|
@@ -1083,7 +1083,7 @@ export interface AgentsApiVerifyAgentCardRequest {
|
|
|
1083
1083
|
*/
|
|
1084
1084
|
export class AgentsApi extends BaseAPI implements AgentsApiInterface {
|
|
1085
1085
|
/**
|
|
1086
|
-
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document
|
|
1086
|
+
* POST /orgs/{orgId}/api/v1/agents/ask Body: { \"action\": \"document:read\", \"context\": {\"id\": \"123\"} }
|
|
1087
1087
|
* @summary Agent-friendly permission check (Natural Language style)
|
|
1088
1088
|
* @param {AgentsApiAskRequest} requestParameters Request parameters.
|
|
1089
1089
|
* @param {*} [options] Override http request option.
|