@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
|
@@ -24,7 +24,7 @@ import type { MessageResponse } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
28
28
|
* @summary Add permission(s) to a role
|
|
29
29
|
* @param {string} orgId
|
|
30
30
|
* @param {string} roleId
|
|
@@ -42,7 +42,7 @@ export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
42
42
|
*/
|
|
43
43
|
adminRolesAddUser: (orgId: string, roleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
|
-
*
|
|
45
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
46
46
|
* @summary Create a new role
|
|
47
47
|
* @param {string} orgId
|
|
48
48
|
* @param {*} [options] Override http request option.
|
|
@@ -94,7 +94,7 @@ export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
94
94
|
*/
|
|
95
95
|
adminRolesList: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
96
96
|
/**
|
|
97
|
-
*
|
|
97
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
98
98
|
* @summary Remove a permission from a role
|
|
99
99
|
* @param {string} orgId
|
|
100
100
|
* @param {string} roleId
|
|
@@ -114,7 +114,7 @@ export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
114
114
|
*/
|
|
115
115
|
adminRolesRemoveUser: (orgId: string, roleId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
116
116
|
/**
|
|
117
|
-
*
|
|
117
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
118
118
|
* @summary Update role permissions (replaces all)
|
|
119
119
|
* @param {string} orgId
|
|
120
120
|
* @param {string} roleId
|
|
@@ -147,7 +147,7 @@ export declare const AdminRolesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
147
147
|
*/
|
|
148
148
|
export declare const AdminRolesApiFp: (configuration?: Configuration) => {
|
|
149
149
|
/**
|
|
150
|
-
*
|
|
150
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
151
151
|
* @summary Add permission(s) to a role
|
|
152
152
|
* @param {string} orgId
|
|
153
153
|
* @param {string} roleId
|
|
@@ -165,7 +165,7 @@ export declare const AdminRolesApiFp: (configuration?: Configuration) => {
|
|
|
165
165
|
*/
|
|
166
166
|
adminRolesAddUser(orgId: string, roleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
|
|
167
167
|
/**
|
|
168
|
-
*
|
|
168
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
169
169
|
* @summary Create a new role
|
|
170
170
|
* @param {string} orgId
|
|
171
171
|
* @param {*} [options] Override http request option.
|
|
@@ -217,7 +217,7 @@ export declare const AdminRolesApiFp: (configuration?: Configuration) => {
|
|
|
217
217
|
*/
|
|
218
218
|
adminRolesList(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminRolesListResponse>>;
|
|
219
219
|
/**
|
|
220
|
-
*
|
|
220
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
221
221
|
* @summary Remove a permission from a role
|
|
222
222
|
* @param {string} orgId
|
|
223
223
|
* @param {string} roleId
|
|
@@ -237,7 +237,7 @@ export declare const AdminRolesApiFp: (configuration?: Configuration) => {
|
|
|
237
237
|
*/
|
|
238
238
|
adminRolesRemoveUser(orgId: string, roleId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
|
|
239
239
|
/**
|
|
240
|
-
*
|
|
240
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
241
241
|
* @summary Update role permissions (replaces all)
|
|
242
242
|
* @param {string} orgId
|
|
243
243
|
* @param {string} roleId
|
|
@@ -270,7 +270,7 @@ export declare const AdminRolesApiFp: (configuration?: Configuration) => {
|
|
|
270
270
|
*/
|
|
271
271
|
export declare const AdminRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
272
272
|
/**
|
|
273
|
-
*
|
|
273
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
274
274
|
* @summary Add permission(s) to a role
|
|
275
275
|
* @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
|
|
276
276
|
* @param {*} [options] Override http request option.
|
|
@@ -286,7 +286,7 @@ export declare const AdminRolesApiFactory: (configuration?: Configuration, baseP
|
|
|
286
286
|
*/
|
|
287
287
|
adminRolesAddUser(requestParameters: AdminRolesApiAdminRolesAddUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
288
288
|
/**
|
|
289
|
-
*
|
|
289
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
290
290
|
* @summary Create a new role
|
|
291
291
|
* @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
|
|
292
292
|
* @param {*} [options] Override http request option.
|
|
@@ -334,7 +334,7 @@ export declare const AdminRolesApiFactory: (configuration?: Configuration, baseP
|
|
|
334
334
|
*/
|
|
335
335
|
adminRolesList(requestParameters: AdminRolesApiAdminRolesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminRolesListResponse>;
|
|
336
336
|
/**
|
|
337
|
-
*
|
|
337
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
338
338
|
* @summary Remove a permission from a role
|
|
339
339
|
* @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
|
|
340
340
|
* @param {*} [options] Override http request option.
|
|
@@ -350,7 +350,7 @@ export declare const AdminRolesApiFactory: (configuration?: Configuration, baseP
|
|
|
350
350
|
*/
|
|
351
351
|
adminRolesRemoveUser(requestParameters: AdminRolesApiAdminRolesRemoveUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
352
352
|
/**
|
|
353
|
-
*
|
|
353
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
354
354
|
* @summary Update role permissions (replaces all)
|
|
355
355
|
* @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
|
|
356
356
|
* @param {*} [options] Override http request option.
|
|
@@ -381,7 +381,7 @@ export declare const AdminRolesApiFactory: (configuration?: Configuration, baseP
|
|
|
381
381
|
*/
|
|
382
382
|
export interface AdminRolesApiInterface {
|
|
383
383
|
/**
|
|
384
|
-
*
|
|
384
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
385
385
|
* @summary Add permission(s) to a role
|
|
386
386
|
* @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
|
|
387
387
|
* @param {*} [options] Override http request option.
|
|
@@ -399,7 +399,7 @@ export interface AdminRolesApiInterface {
|
|
|
399
399
|
*/
|
|
400
400
|
adminRolesAddUser(requestParameters: AdminRolesApiAdminRolesAddUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
401
401
|
/**
|
|
402
|
-
*
|
|
402
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
403
403
|
* @summary Create a new role
|
|
404
404
|
* @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
|
|
405
405
|
* @param {*} [options] Override http request option.
|
|
@@ -453,7 +453,7 @@ export interface AdminRolesApiInterface {
|
|
|
453
453
|
*/
|
|
454
454
|
adminRolesList(requestParameters: AdminRolesApiAdminRolesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminRolesListResponse>;
|
|
455
455
|
/**
|
|
456
|
-
*
|
|
456
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
457
457
|
* @summary Remove a permission from a role
|
|
458
458
|
* @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
|
|
459
459
|
* @param {*} [options] Override http request option.
|
|
@@ -471,7 +471,7 @@ export interface AdminRolesApiInterface {
|
|
|
471
471
|
*/
|
|
472
472
|
adminRolesRemoveUser(requestParameters: AdminRolesApiAdminRolesRemoveUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
|
|
473
473
|
/**
|
|
474
|
-
*
|
|
474
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
475
475
|
* @summary Update role permissions (replaces all)
|
|
476
476
|
* @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
|
|
477
477
|
* @param {*} [options] Override http request option.
|
|
@@ -753,7 +753,7 @@ export interface AdminRolesApiPutAdminRolesUpdateRequest {
|
|
|
753
753
|
*/
|
|
754
754
|
export declare class AdminRolesApi extends BaseAPI implements AdminRolesApiInterface {
|
|
755
755
|
/**
|
|
756
|
-
*
|
|
756
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
757
757
|
* @summary Add permission(s) to a role
|
|
758
758
|
* @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
|
|
759
759
|
* @param {*} [options] Override http request option.
|
|
@@ -771,7 +771,7 @@ export declare class AdminRolesApi extends BaseAPI implements AdminRolesApiInter
|
|
|
771
771
|
*/
|
|
772
772
|
adminRolesAddUser(requestParameters: AdminRolesApiAdminRolesAddUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
|
|
773
773
|
/**
|
|
774
|
-
*
|
|
774
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
775
775
|
* @summary Create a new role
|
|
776
776
|
* @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
|
|
777
777
|
* @param {*} [options] Override http request option.
|
|
@@ -825,7 +825,7 @@ export declare class AdminRolesApi extends BaseAPI implements AdminRolesApiInter
|
|
|
825
825
|
*/
|
|
826
826
|
adminRolesList(requestParameters: AdminRolesApiAdminRolesListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminRolesListResponse, any, {}>>;
|
|
827
827
|
/**
|
|
828
|
-
*
|
|
828
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
829
829
|
* @summary Remove a permission from a role
|
|
830
830
|
* @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
|
|
831
831
|
* @param {*} [options] Override http request option.
|
|
@@ -843,7 +843,7 @@ export declare class AdminRolesApi extends BaseAPI implements AdminRolesApiInter
|
|
|
843
843
|
*/
|
|
844
844
|
adminRolesRemoveUser(requestParameters: AdminRolesApiAdminRolesRemoveUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
|
|
845
845
|
/**
|
|
846
|
-
*
|
|
846
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
847
847
|
* @summary Update role permissions (replaces all)
|
|
848
848
|
* @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
|
|
849
849
|
* @param {*} [options] Override http request option.
|
|
@@ -33,7 +33,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
|
33
33
|
export const AdminRolesApiAxiosParamCreator = function (configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
37
37
|
* @summary Add permission(s) to a role
|
|
38
38
|
* @param {string} orgId
|
|
39
39
|
* @param {string} roleId
|
|
@@ -109,7 +109,7 @@ export const AdminRolesApiAxiosParamCreator = function (configuration) {
|
|
|
109
109
|
};
|
|
110
110
|
}),
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
112
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
113
113
|
* @summary Create a new role
|
|
114
114
|
* @param {string} orgId
|
|
115
115
|
* @param {*} [options] Override http request option.
|
|
@@ -329,7 +329,7 @@ export const AdminRolesApiAxiosParamCreator = function (configuration) {
|
|
|
329
329
|
};
|
|
330
330
|
}),
|
|
331
331
|
/**
|
|
332
|
-
*
|
|
332
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
333
333
|
* @summary Remove a permission from a role
|
|
334
334
|
* @param {string} orgId
|
|
335
335
|
* @param {string} roleId
|
|
@@ -413,7 +413,7 @@ export const AdminRolesApiAxiosParamCreator = function (configuration) {
|
|
|
413
413
|
};
|
|
414
414
|
}),
|
|
415
415
|
/**
|
|
416
|
-
*
|
|
416
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
417
417
|
* @summary Update role permissions (replaces all)
|
|
418
418
|
* @param {string} orgId
|
|
419
419
|
* @param {string} roleId
|
|
@@ -536,7 +536,7 @@ export const AdminRolesApiFp = function (configuration) {
|
|
|
536
536
|
const localVarAxiosParamCreator = AdminRolesApiAxiosParamCreator(configuration);
|
|
537
537
|
return {
|
|
538
538
|
/**
|
|
539
|
-
*
|
|
539
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
540
540
|
* @summary Add permission(s) to a role
|
|
541
541
|
* @param {string} orgId
|
|
542
542
|
* @param {string} roleId
|
|
@@ -570,7 +570,7 @@ export const AdminRolesApiFp = function (configuration) {
|
|
|
570
570
|
});
|
|
571
571
|
},
|
|
572
572
|
/**
|
|
573
|
-
*
|
|
573
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
574
574
|
* @summary Create a new role
|
|
575
575
|
* @param {string} orgId
|
|
576
576
|
* @param {*} [options] Override http request option.
|
|
@@ -670,7 +670,7 @@ export const AdminRolesApiFp = function (configuration) {
|
|
|
670
670
|
});
|
|
671
671
|
},
|
|
672
672
|
/**
|
|
673
|
-
*
|
|
673
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
674
674
|
* @summary Remove a permission from a role
|
|
675
675
|
* @param {string} orgId
|
|
676
676
|
* @param {string} roleId
|
|
@@ -706,7 +706,7 @@ export const AdminRolesApiFp = function (configuration) {
|
|
|
706
706
|
});
|
|
707
707
|
},
|
|
708
708
|
/**
|
|
709
|
-
*
|
|
709
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
710
710
|
* @summary Update role permissions (replaces all)
|
|
711
711
|
* @param {string} orgId
|
|
712
712
|
* @param {string} roleId
|
|
@@ -766,7 +766,7 @@ export const AdminRolesApiFactory = function (configuration, basePath, axios) {
|
|
|
766
766
|
const localVarFp = AdminRolesApiFp(configuration);
|
|
767
767
|
return {
|
|
768
768
|
/**
|
|
769
|
-
*
|
|
769
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
770
770
|
* @summary Add permission(s) to a role
|
|
771
771
|
* @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
|
|
772
772
|
* @param {*} [options] Override http request option.
|
|
@@ -786,7 +786,7 @@ export const AdminRolesApiFactory = function (configuration, basePath, axios) {
|
|
|
786
786
|
return localVarFp.adminRolesAddUser(requestParameters.orgId, requestParameters.roleId, options).then((request) => request(axios, basePath));
|
|
787
787
|
},
|
|
788
788
|
/**
|
|
789
|
-
*
|
|
789
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
790
790
|
* @summary Create a new role
|
|
791
791
|
* @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
|
|
792
792
|
* @param {*} [options] Override http request option.
|
|
@@ -846,7 +846,7 @@ export const AdminRolesApiFactory = function (configuration, basePath, axios) {
|
|
|
846
846
|
return localVarFp.adminRolesList(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
847
847
|
},
|
|
848
848
|
/**
|
|
849
|
-
*
|
|
849
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
850
850
|
* @summary Remove a permission from a role
|
|
851
851
|
* @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
|
|
852
852
|
* @param {*} [options] Override http request option.
|
|
@@ -866,7 +866,7 @@ export const AdminRolesApiFactory = function (configuration, basePath, axios) {
|
|
|
866
866
|
return localVarFp.adminRolesRemoveUser(requestParameters.orgId, requestParameters.roleId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
867
867
|
},
|
|
868
868
|
/**
|
|
869
|
-
*
|
|
869
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
870
870
|
* @summary Update role permissions (replaces all)
|
|
871
871
|
* @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
|
|
872
872
|
* @param {*} [options] Override http request option.
|
|
@@ -905,7 +905,7 @@ export const AdminRolesApiFactory = function (configuration, basePath, axios) {
|
|
|
905
905
|
*/
|
|
906
906
|
export class AdminRolesApi extends BaseAPI {
|
|
907
907
|
/**
|
|
908
|
-
*
|
|
908
|
+
* Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
909
909
|
* @summary Add permission(s) to a role
|
|
910
910
|
* @param {AdminRolesApiAdminRolesAddPermissionsRequest} requestParameters Request parameters.
|
|
911
911
|
* @param {*} [options] Override http request option.
|
|
@@ -927,7 +927,7 @@ export class AdminRolesApi extends BaseAPI {
|
|
|
927
927
|
return AdminRolesApiFp(this.configuration).adminRolesAddUser(requestParameters.orgId, requestParameters.roleId, options).then((request) => request(this.axios, this.basePath));
|
|
928
928
|
}
|
|
929
929
|
/**
|
|
930
|
-
*
|
|
930
|
+
* Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
931
931
|
* @summary Create a new role
|
|
932
932
|
* @param {AdminRolesApiAdminRolesCreateRequest} requestParameters Request parameters.
|
|
933
933
|
* @param {*} [options] Override http request option.
|
|
@@ -993,7 +993,7 @@ export class AdminRolesApi extends BaseAPI {
|
|
|
993
993
|
return AdminRolesApiFp(this.configuration).adminRolesList(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
994
994
|
}
|
|
995
995
|
/**
|
|
996
|
-
*
|
|
996
|
+
* Needs `roles.assign-permissions` and `roles.edit`.
|
|
997
997
|
* @summary Remove a permission from a role
|
|
998
998
|
* @param {AdminRolesApiAdminRolesRemovePermissionRequest} requestParameters Request parameters.
|
|
999
999
|
* @param {*} [options] Override http request option.
|
|
@@ -1015,7 +1015,7 @@ export class AdminRolesApi extends BaseAPI {
|
|
|
1015
1015
|
return AdminRolesApiFp(this.configuration).adminRolesRemoveUser(requestParameters.orgId, requestParameters.roleId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
1016
1016
|
}
|
|
1017
1017
|
/**
|
|
1018
|
-
*
|
|
1018
|
+
* Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
1019
1019
|
* @summary Update role permissions (replaces all)
|
|
1020
1020
|
* @param {AdminRolesApiAdminRolesUpdatePermissionsRequest} requestParameters Request parameters.
|
|
1021
1021
|
* @param {*} [options] Override http request option.
|