@orbis-systems/orbis-api-clients 0.8.6 → 0.8.7
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/dist/aesmidas/index.d.ts +20 -0
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +712 -712
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +67 -67
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +302 -191
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/package.json +154 -154
package/dist/uma/index.d.ts
CHANGED
|
@@ -79,6 +79,197 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
|
|
|
79
79
|
protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
|
|
80
80
|
protected renewTokens(): Promise<AuthData>;
|
|
81
81
|
}
|
|
82
|
+
export enum UmaUserDetailsGenerationType {
|
|
83
|
+
ClaimsOnlyGeneration = "claims_only",
|
|
84
|
+
FullUserDataGeneration = "full_user_data",
|
|
85
|
+
AllUserDataGeneration = "all_user_data"
|
|
86
|
+
}
|
|
87
|
+
export enum UmaTenantSettingLabel {
|
|
88
|
+
StorePasswordHistoryForDays = "store_password_history_for_days",
|
|
89
|
+
ResetPasswordIfUserInactiveForDays = "reset_password_if_user_inactive_for_days",
|
|
90
|
+
PeriodicallyResetPasswordAfterDays = "periodically_reset_password_after_days"
|
|
91
|
+
}
|
|
92
|
+
export enum UmaUserType {
|
|
93
|
+
B2BUserType = "b2b",
|
|
94
|
+
SystemUserType = "system",
|
|
95
|
+
B2CUserType = "b2c"
|
|
96
|
+
}
|
|
97
|
+
export enum UmaUserStatusChangeReasonType {
|
|
98
|
+
BlockUserStatusChangeReasonType = "block",
|
|
99
|
+
UnblockUserStatusChangeReasonType = "unblock",
|
|
100
|
+
RestoreUserStatusChangeReasonType = "restore",
|
|
101
|
+
DeleteUserStatusChangeReasonType = "delete"
|
|
102
|
+
}
|
|
103
|
+
export enum UmaUserStatus {
|
|
104
|
+
ActiveUserStatus = "active",
|
|
105
|
+
BlockedUserStatus = "blocked",
|
|
106
|
+
DeletedUserStatus = "deleted"
|
|
107
|
+
}
|
|
108
|
+
export enum UmaPermissionAG {
|
|
109
|
+
ChiefadminPermissionAG = "chiefadmin",
|
|
110
|
+
SuperadminPermissionAG = "superadmin",
|
|
111
|
+
B2BOnlyPermissionAG = "b2b_only",
|
|
112
|
+
RegularPermissionAG = "regular"
|
|
113
|
+
}
|
|
114
|
+
export enum UmaEntityName {
|
|
115
|
+
B2BUsersEntity = "b2b_users",
|
|
116
|
+
B2CUsersEntity = "b2c_users",
|
|
117
|
+
RolesEntity = "roles",
|
|
118
|
+
RoleTypesEntity = "role_types",
|
|
119
|
+
PermissionsEntity = "permissions",
|
|
120
|
+
MicroservicesEntity = "microservices",
|
|
121
|
+
IdentityProvidersEntity = "identity_providers",
|
|
122
|
+
FirmsEntity = "firms",
|
|
123
|
+
EndpointsEntity = "endpoints",
|
|
124
|
+
BranchesEntity = "branches",
|
|
125
|
+
APIKeysEntity = "api_keys"
|
|
126
|
+
}
|
|
127
|
+
export enum UmaEntityAccessType {
|
|
128
|
+
GranularEntityAccessType = "granular",
|
|
129
|
+
HighLevelEntityAccessType = "high-level"
|
|
130
|
+
}
|
|
131
|
+
export enum UmaEndpointType {
|
|
132
|
+
RegularEndpoint = "regular",
|
|
133
|
+
DisplayOnlyEndpoint = "display_only"
|
|
134
|
+
}
|
|
135
|
+
export enum UmaAuthProviderAppType {
|
|
136
|
+
GoogleOAuth2Provider = "google-oauth2",
|
|
137
|
+
AppleIDOAuth2Provider = "apple-id"
|
|
138
|
+
}
|
|
139
|
+
export enum UmaActionType {
|
|
140
|
+
CreateAction = "create",
|
|
141
|
+
UpdateAction = "update",
|
|
142
|
+
DeleteAction = "delete",
|
|
143
|
+
ResetPasswordAction = "reset_password",
|
|
144
|
+
RegistrationAction = "registration",
|
|
145
|
+
SettingsChangeAction = "settings_change",
|
|
146
|
+
AvatarChangeAction = "avatar_change",
|
|
147
|
+
RateLimitExceededAction = "rate_limit_exceeded",
|
|
148
|
+
UserExpiredAction = "user_expired"
|
|
149
|
+
}
|
|
150
|
+
export enum UmaActionTrigger {
|
|
151
|
+
B2BUserTrigger = "b2b_user",
|
|
152
|
+
OwnerUserTrigger = "owner_user",
|
|
153
|
+
RegularMigrationsTrigger = "regular_migrations",
|
|
154
|
+
DataMigrationsTrigger = "data_migrations",
|
|
155
|
+
RateLimitTrigger = "rate_limit",
|
|
156
|
+
CronTrigger = "cron"
|
|
157
|
+
}
|
|
158
|
+
export enum UmaOption {
|
|
159
|
+
SmsMfaOption = "sms",
|
|
160
|
+
EmailMfaOption = "email",
|
|
161
|
+
VoiceMfaOption = "voice",
|
|
162
|
+
WebAuthnMfaOption = "webauthn",
|
|
163
|
+
YubicoOTPMfaOption = "yubico_otp",
|
|
164
|
+
TOTPMfaOption = "totp"
|
|
165
|
+
}
|
|
166
|
+
export enum UmaErrorCode {
|
|
167
|
+
JSONValidationErr = 4000,
|
|
168
|
+
JSONReadErr = 4001,
|
|
169
|
+
JSONParseErr = 4002,
|
|
170
|
+
ForbiddenErr = 4003,
|
|
171
|
+
ForbiddenDueLimit = 4030,
|
|
172
|
+
RecordNotFoundErr = 4004,
|
|
173
|
+
RelationNotFoundErr = 4041,
|
|
174
|
+
RecordAlreadyExistsErr = 4005,
|
|
175
|
+
ImageValidationErr = 4006,
|
|
176
|
+
InappropriateImageErr = 4007,
|
|
177
|
+
FaceNotFoundOnImageErr = 4008,
|
|
178
|
+
UnauthorizedErr = 4010,
|
|
179
|
+
TokenRevokedErr = 4012,
|
|
180
|
+
TokenNotActiveErr = 4013,
|
|
181
|
+
EmailNotVerifiedErr = 4015,
|
|
182
|
+
TokenParsingErr = 4016,
|
|
183
|
+
PhoneNotVerifiedErr = 4017,
|
|
184
|
+
UUIDParseErr = 4026,
|
|
185
|
+
InvalidEmailOrPasswordOrTypeErr = 4028,
|
|
186
|
+
UserDeletedErr = 4029,
|
|
187
|
+
InvalidMfaCodeErr = 4128,
|
|
188
|
+
MfaRequiredErr = 4228,
|
|
189
|
+
TokenVerificationErr = 4328,
|
|
190
|
+
InvalidAPIKeyOrSecretErr = 4428,
|
|
191
|
+
MfaAddingNotAllowedErr = 4528,
|
|
192
|
+
BranchRequestNotAllowed = 4103,
|
|
193
|
+
ForbiddenForUserTypeErr = 4203,
|
|
194
|
+
SecondForbiddenErr = 4031,
|
|
195
|
+
ThirdForbiddenErr = 4032,
|
|
196
|
+
FourthForbiddenErr = 4033,
|
|
197
|
+
FifthForbiddenErr = 4034,
|
|
198
|
+
EntitiesChoiceNotAllowed = 4303,
|
|
199
|
+
BodyParsingErr = 4403,
|
|
200
|
+
UpdateOfOldEntityStateErr = 4503,
|
|
201
|
+
ChiefadminMutationErr = 4603,
|
|
202
|
+
ChildEntitiesExistErr = 4703,
|
|
203
|
+
TenantActionForbiddenErr = 4803,
|
|
204
|
+
RBACManipulationErr = 4903,
|
|
205
|
+
YubicoMaxKeysLimitReachedErr = 4113,
|
|
206
|
+
ConflictErr = 4090,
|
|
207
|
+
SecondFieldConflictErr = 4091,
|
|
208
|
+
ThirdFieldConflictErr = 4092,
|
|
209
|
+
FourthFieldConflictErr = 4093,
|
|
210
|
+
FifthFieldConflictErr = 4094,
|
|
211
|
+
SixthFieldConflictErr = 4095,
|
|
212
|
+
SeventhFieldConflictErr = 4096,
|
|
213
|
+
UpdateDeletedUserErr = 4097,
|
|
214
|
+
GoneErr = 4100,
|
|
215
|
+
SecondGoneErr = 4101,
|
|
216
|
+
UnprocessableEntity = 4222,
|
|
217
|
+
TooEarlyDuplicateRequest = 4250,
|
|
218
|
+
RateLimitErr = 4291,
|
|
219
|
+
ForbiddenByFirmsStatusErr = 4292,
|
|
220
|
+
NotAcceptableError = 4600,
|
|
221
|
+
InternalServerErr = 5000,
|
|
222
|
+
InvalidRequest = 6000
|
|
223
|
+
}
|
|
224
|
+
export enum UmaTokenType {
|
|
225
|
+
RefreshToken = "refresh",
|
|
226
|
+
AccessToken = "access"
|
|
227
|
+
}
|
|
228
|
+
export enum UmaTokenOrigin {
|
|
229
|
+
APIKeyTokenOrigin = "api_key",
|
|
230
|
+
UserTokenOrigin = "user"
|
|
231
|
+
}
|
|
232
|
+
export enum UmaTokenGenerationMode {
|
|
233
|
+
StandardTokenGenerationMode = "standard",
|
|
234
|
+
MinifiedTokenGenerationMode = "minified"
|
|
235
|
+
}
|
|
236
|
+
export enum UmaResetPasswordType {
|
|
237
|
+
PasswordResetByContactCode = "by_contact_code",
|
|
238
|
+
PasswordResetByEmailLink = "by_email_link"
|
|
239
|
+
}
|
|
240
|
+
export enum UmaFetchListMode {
|
|
241
|
+
FetchAllFetchListMode = "fetch_all",
|
|
242
|
+
OnlyCountFetchListMode = "only_count",
|
|
243
|
+
OnlyFetchRecordsFetchListMode = "only_fetch_records"
|
|
244
|
+
}
|
|
245
|
+
export enum UmaAuthUserType {
|
|
246
|
+
AllAuthUserType = "all",
|
|
247
|
+
B2BAuthUserType = "b2b",
|
|
248
|
+
B2CAuthUserType = "b2c"
|
|
249
|
+
}
|
|
250
|
+
export enum UmaAuthAppType {
|
|
251
|
+
EmailCodeAuthAppType = "email_code",
|
|
252
|
+
SmsCodeAuthAppType = "sms_code",
|
|
253
|
+
YubicoOTPAuthAppType = "yubico_otp",
|
|
254
|
+
WebAuthnAuthAppType = "webauthn",
|
|
255
|
+
TOTPAuthAppType = "totp"
|
|
256
|
+
}
|
|
257
|
+
export enum UmaAccessControlProhibitionReasonType {
|
|
258
|
+
OneOfGroupRoleCheckFailedProhibition = "one_of_group_role_check_failed",
|
|
259
|
+
TargetUserIsChiefadminProhibition = "target_user_is_chiefadmin",
|
|
260
|
+
CannotAssignNonRegularPermissionsToB2CUserProhibition = "cannot_assign_non_regular_permissions_to_b2c_user",
|
|
261
|
+
SuperadminMutationNotAllowedProhibition = "superadmin_mutation_not_allowed",
|
|
262
|
+
OnlyChiefadminCanMutationSuperadminEditorsProhibition = "only_chiefadmin_can_mutate_superadmin_editors",
|
|
263
|
+
UserLacksPermissionsProhibition = "user_lacks_permissions",
|
|
264
|
+
UserLacksAccessToTargetFirmsProhibition = "user_lacks_access_to_target_firms",
|
|
265
|
+
UserLacksAdminAccessToTargetFirmsProhibition = "user_lacks_admin_access_to_target_firms",
|
|
266
|
+
TargetLacksBranchesForNonAdminFirmsProhibition = "target_lacks_branches_for_non_admin_firms",
|
|
267
|
+
UserLacksAccessToTargetBranchesProhibition = "user_lacks_access_to_target_branches",
|
|
268
|
+
TargetHasAdminFirmBranchesProhibition = "target_has_admin_firm_branches",
|
|
269
|
+
TargetUserIsDeletedProhibition = "target_user_is_deleted",
|
|
270
|
+
UserLacksUpdatePermissionProhibition = "user_lacks_update_permission",
|
|
271
|
+
UserLacksDeletePermissionProhibition = "user_lacks_delete_permission"
|
|
272
|
+
}
|
|
82
273
|
export interface UmaGetActionLogsSerializer {
|
|
83
274
|
action_logs: UmaActionLogSerializer[];
|
|
84
275
|
current_page: number;
|
|
@@ -86,6 +277,15 @@ export interface UmaGetActionLogsSerializer {
|
|
|
86
277
|
status: number;
|
|
87
278
|
total_records: number;
|
|
88
279
|
}
|
|
280
|
+
export interface UmaAdminAPIKeysMutationSerializer {
|
|
281
|
+
api_keys: UmaAdminAPIKeySerializer;
|
|
282
|
+
status: number;
|
|
283
|
+
}
|
|
284
|
+
export interface UmaGetAdminAPIKeysSerializer {
|
|
285
|
+
api_keys: UmaAdminAPIKeySerializer[];
|
|
286
|
+
pagination: UmaPaginationSerializer;
|
|
287
|
+
status: number;
|
|
288
|
+
}
|
|
89
289
|
export interface UmaAllowedOriginMutationSerializer {
|
|
90
290
|
allowed_origin: UmaAllowedOriginSerializer;
|
|
91
291
|
status: number;
|
|
@@ -243,34 +443,6 @@ export interface UmaAccessControlProhibitionReason {
|
|
|
243
443
|
description?: string;
|
|
244
444
|
type?: UmaAccessControlProhibitionReasonType;
|
|
245
445
|
}
|
|
246
|
-
export enum UmaAccessControlProhibitionReasonType {
|
|
247
|
-
OneOfGroupRoleCheckFailedProhibition = "one_of_group_role_check_failed",
|
|
248
|
-
TargetUserIsChiefadminProhibition = "target_user_is_chiefadmin",
|
|
249
|
-
CannotAssignNonRegularPermissionsToB2CUserProhibition = "cannot_assign_non_regular_permissions_to_b2c_user",
|
|
250
|
-
SuperadminMutationNotAllowedProhibition = "superadmin_mutation_not_allowed",
|
|
251
|
-
OnlyChiefadminCanMutationSuperadminEditorsProhibition = "only_chiefadmin_can_mutate_superadmin_editors",
|
|
252
|
-
UserLacksPermissionsProhibition = "user_lacks_permissions",
|
|
253
|
-
UserLacksAccessToTargetFirmsProhibition = "user_lacks_access_to_target_firms",
|
|
254
|
-
UserLacksAdminAccessToTargetFirmsProhibition = "user_lacks_admin_access_to_target_firms",
|
|
255
|
-
TargetLacksBranchesForNonAdminFirmsProhibition = "target_lacks_branches_for_non_admin_firms",
|
|
256
|
-
UserLacksAccessToTargetBranchesProhibition = "user_lacks_access_to_target_branches",
|
|
257
|
-
TargetHasAdminFirmBranchesProhibition = "target_has_admin_firm_branches",
|
|
258
|
-
TargetUserIsDeletedProhibition = "target_user_is_deleted",
|
|
259
|
-
UserLacksUpdatePermissionProhibition = "user_lacks_update_permission",
|
|
260
|
-
UserLacksDeletePermissionProhibition = "user_lacks_delete_permission"
|
|
261
|
-
}
|
|
262
|
-
export enum UmaAuthAppType {
|
|
263
|
-
EmailCodeAuthAppType = "email_code",
|
|
264
|
-
SmsCodeAuthAppType = "sms_code",
|
|
265
|
-
YubicoOTPAuthAppType = "yubico_otp",
|
|
266
|
-
WebAuthnAuthAppType = "webauthn",
|
|
267
|
-
TOTPAuthAppType = "totp"
|
|
268
|
-
}
|
|
269
|
-
export enum UmaAuthUserType {
|
|
270
|
-
AllAuthUserType = "all",
|
|
271
|
-
B2BAuthUserType = "b2b",
|
|
272
|
-
B2CAuthUserType = "b2c"
|
|
273
|
-
}
|
|
274
446
|
export interface UmaClaims {
|
|
275
447
|
'2fa_on'?: boolean;
|
|
276
448
|
admin_of_firm_ids?: number[];
|
|
@@ -296,35 +468,14 @@ export interface UmaClaims {
|
|
|
296
468
|
t_type?: UmaTokenType;
|
|
297
469
|
u_type?: UmaAuthUserType;
|
|
298
470
|
}
|
|
299
|
-
export enum UmaFetchListMode {
|
|
300
|
-
FetchAllFetchListMode = "fetch_all",
|
|
301
|
-
OnlyCountFetchListMode = "only_count",
|
|
302
|
-
OnlyFetchRecordsFetchListMode = "only_fetch_records"
|
|
303
|
-
}
|
|
304
471
|
export interface UmaPaginationDto {
|
|
305
472
|
page?: number;
|
|
306
473
|
size?: number;
|
|
307
474
|
}
|
|
308
|
-
export enum UmaResetPasswordType {
|
|
309
|
-
PasswordResetByContactCode = "by_contact_code",
|
|
310
|
-
PasswordResetByEmailLink = "by_email_link"
|
|
311
|
-
}
|
|
312
475
|
export interface UmaSortDto {
|
|
313
476
|
direction?: string;
|
|
314
477
|
field?: string;
|
|
315
478
|
}
|
|
316
|
-
export enum UmaTokenGenerationMode {
|
|
317
|
-
StandardTokenGenerationMode = "standard",
|
|
318
|
-
MinifiedTokenGenerationMode = "minified"
|
|
319
|
-
}
|
|
320
|
-
export enum UmaTokenOrigin {
|
|
321
|
-
APIKeyTokenOrigin = "api_key",
|
|
322
|
-
UserTokenOrigin = "user"
|
|
323
|
-
}
|
|
324
|
-
export enum UmaTokenType {
|
|
325
|
-
RefreshToken = "refresh",
|
|
326
|
-
AccessToken = "access"
|
|
327
|
-
}
|
|
328
479
|
export interface UmaGetCountriesSerializer {
|
|
329
480
|
countries: UmaCountrySerializer[];
|
|
330
481
|
status: number;
|
|
@@ -371,64 +522,6 @@ export interface UmaError {
|
|
|
371
522
|
field?: string;
|
|
372
523
|
request_id?: string;
|
|
373
524
|
}
|
|
374
|
-
export enum UmaErrorCode {
|
|
375
|
-
JSONValidationErr = 4000,
|
|
376
|
-
JSONReadErr = 4001,
|
|
377
|
-
JSONParseErr = 4002,
|
|
378
|
-
ForbiddenErr = 4003,
|
|
379
|
-
ForbiddenDueLimit = 4030,
|
|
380
|
-
RecordNotFoundErr = 4004,
|
|
381
|
-
RelationNotFoundErr = 4041,
|
|
382
|
-
RecordAlreadyExistsErr = 4005,
|
|
383
|
-
ImageValidationErr = 4006,
|
|
384
|
-
InappropriateImageErr = 4007,
|
|
385
|
-
FaceNotFoundOnImageErr = 4008,
|
|
386
|
-
UnauthorizedErr = 4010,
|
|
387
|
-
TokenRevokedErr = 4012,
|
|
388
|
-
TokenNotActiveErr = 4013,
|
|
389
|
-
EmailNotVerifiedErr = 4015,
|
|
390
|
-
TokenParsingErr = 4016,
|
|
391
|
-
PhoneNotVerifiedErr = 4017,
|
|
392
|
-
UUIDParseErr = 4026,
|
|
393
|
-
InvalidEmailOrPasswordOrTypeErr = 4028,
|
|
394
|
-
UserDeletedErr = 4029,
|
|
395
|
-
InvalidMfaCodeErr = 4128,
|
|
396
|
-
MfaRequiredErr = 4228,
|
|
397
|
-
TokenVerificationErr = 4328,
|
|
398
|
-
InvalidAPIKeyOrSecretErr = 4428,
|
|
399
|
-
MfaAddingNotAllowedErr = 4528,
|
|
400
|
-
BranchRequestNotAllowed = 4103,
|
|
401
|
-
ForbiddenForUserTypeErr = 4203,
|
|
402
|
-
SecondForbiddenErr = 4031,
|
|
403
|
-
ThirdForbiddenErr = 4032,
|
|
404
|
-
FourthForbiddenErr = 4033,
|
|
405
|
-
FifthForbiddenErr = 4034,
|
|
406
|
-
EntitiesChoiceNotAllowed = 4303,
|
|
407
|
-
BodyParsingErr = 4403,
|
|
408
|
-
UpdateOfOldEntityStateErr = 4503,
|
|
409
|
-
ChiefadminMutationErr = 4603,
|
|
410
|
-
ChildEntitiesExistErr = 4703,
|
|
411
|
-
TenantActionForbiddenErr = 4803,
|
|
412
|
-
RBACManipulationErr = 4903,
|
|
413
|
-
YubicoMaxKeysLimitReachedErr = 4113,
|
|
414
|
-
ConflictErr = 4090,
|
|
415
|
-
SecondFieldConflictErr = 4091,
|
|
416
|
-
ThirdFieldConflictErr = 4092,
|
|
417
|
-
FourthFieldConflictErr = 4093,
|
|
418
|
-
FifthFieldConflictErr = 4094,
|
|
419
|
-
SixthFieldConflictErr = 4095,
|
|
420
|
-
SeventhFieldConflictErr = 4096,
|
|
421
|
-
UpdateDeletedUserErr = 4097,
|
|
422
|
-
GoneErr = 4100,
|
|
423
|
-
SecondGoneErr = 4101,
|
|
424
|
-
UnprocessableEntity = 4222,
|
|
425
|
-
TooEarlyDuplicateRequest = 4250,
|
|
426
|
-
RateLimitErr = 4291,
|
|
427
|
-
ForbiddenByFirmsStatusErr = 4292,
|
|
428
|
-
NotAcceptableError = 4600,
|
|
429
|
-
InternalServerErr = 5000,
|
|
430
|
-
InvalidRequest = 6000
|
|
431
|
-
}
|
|
432
525
|
export interface UmaErrorsSerializer {
|
|
433
526
|
errors: UmaError[];
|
|
434
527
|
}
|
|
@@ -451,14 +544,6 @@ export interface UmaLocaleSerializer {
|
|
|
451
544
|
/** @example "French" */
|
|
452
545
|
name: string;
|
|
453
546
|
}
|
|
454
|
-
export enum UmaOption {
|
|
455
|
-
SmsMfaOption = "sms",
|
|
456
|
-
EmailMfaOption = "email",
|
|
457
|
-
VoiceMfaOption = "voice",
|
|
458
|
-
WebAuthnMfaOption = "webauthn",
|
|
459
|
-
YubicoOTPMfaOption = "yubico_otp",
|
|
460
|
-
TOTPMfaOption = "totp"
|
|
461
|
-
}
|
|
462
547
|
export interface UmaGetMicroservicesListSerializer {
|
|
463
548
|
current_page: number;
|
|
464
549
|
microservices_list: UmaMicroserviceSerializer[];
|
|
@@ -481,76 +566,10 @@ export interface UmaPermissionMutationSerializer {
|
|
|
481
566
|
permission: UmaPermissionSerializer;
|
|
482
567
|
status: number;
|
|
483
568
|
}
|
|
484
|
-
export enum UmaActionTrigger {
|
|
485
|
-
B2BUserTrigger = "b2b_user",
|
|
486
|
-
OwnerUserTrigger = "owner_user",
|
|
487
|
-
RegularMigrationsTrigger = "regular_migrations",
|
|
488
|
-
DataMigrationsTrigger = "data_migrations",
|
|
489
|
-
RateLimitTrigger = "rate_limit",
|
|
490
|
-
CronTrigger = "cron"
|
|
491
|
-
}
|
|
492
|
-
export enum UmaActionType {
|
|
493
|
-
CreateAction = "create",
|
|
494
|
-
UpdateAction = "update",
|
|
495
|
-
DeleteAction = "delete",
|
|
496
|
-
ResetPasswordAction = "reset_password",
|
|
497
|
-
RegistrationAction = "registration",
|
|
498
|
-
SettingsChangeAction = "settings_change",
|
|
499
|
-
AvatarChangeAction = "avatar_change",
|
|
500
|
-
RateLimitExceededAction = "rate_limit_exceeded",
|
|
501
|
-
UserExpiredAction = "user_expired"
|
|
502
|
-
}
|
|
503
|
-
export enum UmaAuthProviderAppType {
|
|
504
|
-
GoogleOAuth2Provider = "google-oauth2",
|
|
505
|
-
AppleIDOAuth2Provider = "apple-id"
|
|
506
|
-
}
|
|
507
|
-
export enum UmaEndpointType {
|
|
508
|
-
RegularEndpoint = "regular",
|
|
509
|
-
DisplayOnlyEndpoint = "display_only"
|
|
510
|
-
}
|
|
511
|
-
export enum UmaEntityAccessType {
|
|
512
|
-
GranularEntityAccessType = "granular",
|
|
513
|
-
HighLevelEntityAccessType = "high-level"
|
|
514
|
-
}
|
|
515
569
|
export interface UmaEntityData {
|
|
516
570
|
name?: string;
|
|
517
571
|
value?: UmaEntityAccessType;
|
|
518
572
|
}
|
|
519
|
-
export enum UmaEntityName {
|
|
520
|
-
B2BUsersEntity = "b2b_users",
|
|
521
|
-
B2CUsersEntity = "b2c_users",
|
|
522
|
-
RolesEntity = "roles",
|
|
523
|
-
RoleTypesEntity = "role_types",
|
|
524
|
-
PermissionsEntity = "permissions",
|
|
525
|
-
MicroservicesEntity = "microservices",
|
|
526
|
-
IdentityProvidersEntity = "identity_providers",
|
|
527
|
-
FirmsEntity = "firms",
|
|
528
|
-
EndpointsEntity = "endpoints",
|
|
529
|
-
BranchesEntity = "branches",
|
|
530
|
-
APIKeysEntity = "api_keys"
|
|
531
|
-
}
|
|
532
|
-
export enum UmaPermissionAG {
|
|
533
|
-
ChiefadminPermissionAG = "chiefadmin",
|
|
534
|
-
SuperadminPermissionAG = "superadmin",
|
|
535
|
-
B2BOnlyPermissionAG = "b2b_only",
|
|
536
|
-
RegularPermissionAG = "regular"
|
|
537
|
-
}
|
|
538
|
-
export enum UmaUserStatus {
|
|
539
|
-
ActiveUserStatus = "active",
|
|
540
|
-
BlockedUserStatus = "blocked",
|
|
541
|
-
DeletedUserStatus = "deleted"
|
|
542
|
-
}
|
|
543
|
-
export enum UmaUserStatusChangeReasonType {
|
|
544
|
-
BlockUserStatusChangeReasonType = "block",
|
|
545
|
-
UnblockUserStatusChangeReasonType = "unblock",
|
|
546
|
-
RestoreUserStatusChangeReasonType = "restore",
|
|
547
|
-
DeleteUserStatusChangeReasonType = "delete"
|
|
548
|
-
}
|
|
549
|
-
export enum UmaUserType {
|
|
550
|
-
B2BUserType = "b2b",
|
|
551
|
-
SystemUserType = "system",
|
|
552
|
-
B2CUserType = "b2c"
|
|
553
|
-
}
|
|
554
573
|
export interface UmaPublicSettingsResponseSerializer {
|
|
555
574
|
settings: UmaPublicSettingsSerializer;
|
|
556
575
|
status: number;
|
|
@@ -664,6 +683,21 @@ export interface UmaActionLogsSettingsSerializer {
|
|
|
664
683
|
action_types: UmaActionType[];
|
|
665
684
|
entity_names: UmaEntityName[];
|
|
666
685
|
}
|
|
686
|
+
export interface UmaAdminAPIKeySerializer {
|
|
687
|
+
ac_same_as_for_user: boolean;
|
|
688
|
+
api_key: string;
|
|
689
|
+
api_secret: string;
|
|
690
|
+
branches: UmaBranchSerializer[];
|
|
691
|
+
created_at: string;
|
|
692
|
+
firms: UmaFirmAccessSerializer[];
|
|
693
|
+
id: number;
|
|
694
|
+
microservices: UmaMicroserviceSerializer[];
|
|
695
|
+
name: string;
|
|
696
|
+
permissions: UmaPermissionSerializer[];
|
|
697
|
+
roles: UmaRoleSerializer[];
|
|
698
|
+
updated_at: string;
|
|
699
|
+
user: UmaUserSerializer;
|
|
700
|
+
}
|
|
667
701
|
export interface UmaAdminB2BUserSerializer {
|
|
668
702
|
access_revoking_date: string;
|
|
669
703
|
allow_feedback: boolean;
|
|
@@ -777,6 +811,38 @@ export interface UmaAdminB2CUserSerializer {
|
|
|
777
811
|
username: string;
|
|
778
812
|
watchmen_user_links: UmaWatchmenUserLinkSerializer[];
|
|
779
813
|
}
|
|
814
|
+
export interface UmaAdminCreateAPIKeyDto {
|
|
815
|
+
ac_same_as_for_user?: boolean;
|
|
816
|
+
branches?: number[];
|
|
817
|
+
firms?: UmaFirmInfo[];
|
|
818
|
+
mfa_codes?: UmaMfaCodesDto;
|
|
819
|
+
name?: string;
|
|
820
|
+
permissions?: number[];
|
|
821
|
+
roles?: number[];
|
|
822
|
+
user_id?: number;
|
|
823
|
+
}
|
|
824
|
+
export interface UmaAdminDeleteAPIKeysDto {
|
|
825
|
+
ids?: number[];
|
|
826
|
+
mfa_codes?: UmaMfaCodesDto;
|
|
827
|
+
}
|
|
828
|
+
export interface UmaAdminGetAPIKeysListDto {
|
|
829
|
+
pagination?: UmaPaginationDto;
|
|
830
|
+
search?: string;
|
|
831
|
+
sorts?: UmaSortDto[];
|
|
832
|
+
/** Optional: filter by specific user IDs */
|
|
833
|
+
user_ids?: number[];
|
|
834
|
+
}
|
|
835
|
+
export interface UmaAdminUpdateAPIKeyDto {
|
|
836
|
+
ac_same_as_for_user?: boolean;
|
|
837
|
+
branches?: number[];
|
|
838
|
+
firms?: UmaFirmInfo[];
|
|
839
|
+
mfa_codes?: UmaMfaCodesDto;
|
|
840
|
+
name?: string;
|
|
841
|
+
permissions?: number[];
|
|
842
|
+
roles?: number[];
|
|
843
|
+
updated_at?: string;
|
|
844
|
+
user_id?: number;
|
|
845
|
+
}
|
|
780
846
|
export interface UmaAdminUserSerializer {
|
|
781
847
|
access_revoking_date: string;
|
|
782
848
|
allow_feedback: boolean;
|
|
@@ -1777,6 +1843,11 @@ export interface UmaOptionalPaginationDto {
|
|
|
1777
1843
|
page?: number;
|
|
1778
1844
|
size?: number;
|
|
1779
1845
|
}
|
|
1846
|
+
export interface UmaPaginationSerializer {
|
|
1847
|
+
current_page: number;
|
|
1848
|
+
pages_count: number;
|
|
1849
|
+
total_records: number;
|
|
1850
|
+
}
|
|
1780
1851
|
export interface UmaPartialUpdatePermissionDto {
|
|
1781
1852
|
metadata?: UmaPermissionMetadataDto;
|
|
1782
1853
|
microservice_id?: number;
|
|
@@ -1973,11 +2044,6 @@ export interface UmaTenantSettingDto {
|
|
|
1973
2044
|
label?: UmaTenantSettingDtoLabelEnum;
|
|
1974
2045
|
value?: string;
|
|
1975
2046
|
}
|
|
1976
|
-
export enum UmaTenantSettingLabel {
|
|
1977
|
-
StorePasswordHistoryForDays = "store_password_history_for_days",
|
|
1978
|
-
ResetPasswordIfUserInactiveForDays = "reset_password_if_user_inactive_for_days",
|
|
1979
|
-
PeriodicallyResetPasswordAfterDays = "periodically_reset_password_after_days"
|
|
1980
|
-
}
|
|
1981
2047
|
export interface UmaTokens {
|
|
1982
2048
|
access_expires_at?: number;
|
|
1983
2049
|
access_token?: string;
|
|
@@ -2170,11 +2236,6 @@ export interface UmaUpsertTablePresetDto {
|
|
|
2170
2236
|
presets?: object;
|
|
2171
2237
|
table_name?: string;
|
|
2172
2238
|
}
|
|
2173
|
-
export enum UmaUserDetailsGenerationType {
|
|
2174
|
-
ClaimsOnlyGeneration = "claims_only",
|
|
2175
|
-
FullUserDataGeneration = "full_user_data",
|
|
2176
|
-
AllUserDataGeneration = "all_user_data"
|
|
2177
|
-
}
|
|
2178
2239
|
export interface UmaUserSerializer {
|
|
2179
2240
|
allow_feedback: boolean;
|
|
2180
2241
|
big_avatar_url: string;
|
|
@@ -2530,6 +2591,55 @@ export class ActionLogs<HandleError extends boolean = boolean> {
|
|
|
2530
2591
|
*/
|
|
2531
2592
|
getActionLogs(getActionLogsDto: UmaGetActionLogsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetActionLogsSerializer, HandleError>>;
|
|
2532
2593
|
}
|
|
2594
|
+
export class AdminApiKeys<HandleError extends boolean = boolean> {
|
|
2595
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2596
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2597
|
+
/**
|
|
2598
|
+
* @description Create API Key & API Secret Pair for any B2B user. API Secret won't be accessible for read after that.
|
|
2599
|
+
* @tags admin_api_keys
|
|
2600
|
+
* @name Create
|
|
2601
|
+
* @summary Admin: Create API Key & API Secret Pair for any user
|
|
2602
|
+
* @request POST:/v1/admin/api-keys
|
|
2603
|
+
* @secure
|
|
2604
|
+
*/
|
|
2605
|
+
create(createApiKey: UmaAdminCreateAPIKeyDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError>>;
|
|
2606
|
+
/**
|
|
2607
|
+
* @description Delete any API Keys by IDs. Only accessible to chiefadmin.
|
|
2608
|
+
* @tags admin_api_keys
|
|
2609
|
+
* @name Delete
|
|
2610
|
+
* @summary Admin: Delete any API Keys
|
|
2611
|
+
* @request DELETE:/v1/admin/api-keys
|
|
2612
|
+
* @secure
|
|
2613
|
+
*/
|
|
2614
|
+
delete(deleteApiKeys: UmaAdminDeleteAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2615
|
+
/**
|
|
2616
|
+
* @description Get all API Keys info (would return API Keys without secrets). Only accessible to chiefadmin.
|
|
2617
|
+
* @tags admin_api_keys
|
|
2618
|
+
* @name Get
|
|
2619
|
+
* @summary Admin: Get all API Keys info
|
|
2620
|
+
* @request POST:/v1/admin/api-keys/list
|
|
2621
|
+
* @secure
|
|
2622
|
+
*/
|
|
2623
|
+
get(apiKeys: UmaAdminGetAPIKeysListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAdminAPIKeysSerializer, HandleError>>;
|
|
2624
|
+
/**
|
|
2625
|
+
* @description Get any API Key by id. Only accessible to chiefadmin.
|
|
2626
|
+
* @tags admin_api_keys
|
|
2627
|
+
* @name GetById
|
|
2628
|
+
* @summary Admin: Get API Key by id
|
|
2629
|
+
* @request GET:/v1/admin/api-keys/{id}
|
|
2630
|
+
* @secure
|
|
2631
|
+
*/
|
|
2632
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError>>;
|
|
2633
|
+
/**
|
|
2634
|
+
* @description Update any API Key Record. Only accessible to chiefadmin.
|
|
2635
|
+
* @tags admin_api_keys
|
|
2636
|
+
* @name Update
|
|
2637
|
+
* @summary Admin: Update any API Key Record
|
|
2638
|
+
* @request PUT:/v1/admin/api-keys/{id}
|
|
2639
|
+
* @secure
|
|
2640
|
+
*/
|
|
2641
|
+
update(id: number, apiKey: UmaAdminUpdateAPIKeyDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAdminAPIKeysMutationSerializer, HandleError>>;
|
|
2642
|
+
}
|
|
2533
2643
|
export class AllowedOrigins<HandleError extends boolean = boolean> {
|
|
2534
2644
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2535
2645
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4244,6 +4354,7 @@ declare class UmaClient<HandleError extends boolean = boolean> extends JwtClient
|
|
|
4244
4354
|
export class UmaApi<HandleError extends boolean = false> extends BaseApi<HandleError, UmaClient<HandleError>> {
|
|
4245
4355
|
readonly config: UmaClientConfig<HandleError>;
|
|
4246
4356
|
actionLog: ActionLogs<HandleError>;
|
|
4357
|
+
adminApiKeys: AdminApiKeys<HandleError>;
|
|
4247
4358
|
allowedOrigins: AllowedOrigins<HandleError>;
|
|
4248
4359
|
apiKeys: ApiKeys<HandleError>;
|
|
4249
4360
|
authApps: AuthApps<HandleError>;
|