@iblai/iblai-api 4.118.3-core → 4.118.4-core
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/index.cjs.js +1196 -799
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +1196 -799
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +1196 -799
- package/dist/index.umd.js.map +1 -1
- package/dist/types/services/CredentialsService.d.ts +762 -738
- package/package.json +1 -1
- package/sdk_schema.yml +1644 -730
- package/src/core/OpenAPI.ts +1 -1
- package/src/services/CredentialsService.ts +2166 -1562
|
@@ -54,9 +54,8 @@ export declare class CredentialsService {
|
|
|
54
54
|
* @returns Credential
|
|
55
55
|
* @throws ApiError
|
|
56
56
|
*/
|
|
57
|
-
static credentialsOrgsUsersRetrieve({ platformKey,
|
|
57
|
+
static credentialsOrgsUsersRetrieve({ platformKey, userId, }: {
|
|
58
58
|
platformKey: string;
|
|
59
|
-
username: string;
|
|
60
59
|
}): CancelablePromise<Credential>;
|
|
61
60
|
/**
|
|
62
61
|
* API View for managing credentials across a platform.
|
|
@@ -138,9 +137,8 @@ export declare class CredentialsService {
|
|
|
138
137
|
* @returns Credential
|
|
139
138
|
* @throws ApiError
|
|
140
139
|
*/
|
|
141
|
-
static credentialsOrgsUsersCreate({ platformKey,
|
|
140
|
+
static credentialsOrgsUsersCreate({ platformKey, userId, requestBody, }: {
|
|
142
141
|
platformKey: string;
|
|
143
|
-
username: string;
|
|
144
142
|
requestBody: Credential;
|
|
145
143
|
}): CancelablePromise<Credential>;
|
|
146
144
|
/**
|
|
@@ -186,25 +184,27 @@ export declare class CredentialsService {
|
|
|
186
184
|
* "result": {credential object}
|
|
187
185
|
* }
|
|
188
186
|
*
|
|
189
|
-
* DELETE:
|
|
190
|
-
*
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
187
|
+
* DELETE: A JSON response indicating success:
|
|
188
|
+
* {
|
|
189
|
+
* "status": {"success": true, "description": "Deleted"}
|
|
190
|
+
* }
|
|
191
|
+
*
|
|
192
|
+
* Error Responses:
|
|
193
|
+
* 400 Bad Request: If the request data is invalid
|
|
194
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
195
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
196
|
+
* 404 Not Found: If the credential doesn't exist
|
|
197
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
198
|
+
*
|
|
199
|
+
* Access Control:
|
|
200
|
+
* - Requires CredentialAssignmentPermission
|
|
201
|
+
* - Users can only manage credentials they have permission to access
|
|
202
|
+
* @returns Credential
|
|
203
|
+
* @throws ApiError
|
|
204
|
+
*/
|
|
205
|
+
static credentialsOrgsUsersRetrieve2({ entityId, platformKey, userId, }: {
|
|
205
206
|
entityId: string;
|
|
206
207
|
platformKey: string;
|
|
207
|
-
username: string;
|
|
208
208
|
}): CancelablePromise<Credential>;
|
|
209
209
|
/**
|
|
210
210
|
* API View for managing individual credentials.
|
|
@@ -249,25 +249,27 @@ export declare class CredentialsService {
|
|
|
249
249
|
* "result": {credential object}
|
|
250
250
|
* }
|
|
251
251
|
*
|
|
252
|
-
* DELETE:
|
|
253
|
-
*
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
252
|
+
* DELETE: A JSON response indicating success:
|
|
253
|
+
* {
|
|
254
|
+
* "status": {"success": true, "description": "Deleted"}
|
|
255
|
+
* }
|
|
256
|
+
*
|
|
257
|
+
* Error Responses:
|
|
258
|
+
* 400 Bad Request: If the request data is invalid
|
|
259
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
260
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
261
|
+
* 404 Not Found: If the credential doesn't exist
|
|
262
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
263
|
+
*
|
|
264
|
+
* Access Control:
|
|
265
|
+
* - Requires CredentialAssignmentPermission
|
|
266
|
+
* - Users can only manage credentials they have permission to access
|
|
267
|
+
* @returns Credential
|
|
268
|
+
* @throws ApiError
|
|
269
|
+
*/
|
|
270
|
+
static credentialsOrgsUsersUpdate({ entityId, platformKey, userId, requestBody, }: {
|
|
268
271
|
entityId: string;
|
|
269
272
|
platformKey: string;
|
|
270
|
-
username: string;
|
|
271
273
|
requestBody: Credential;
|
|
272
274
|
}): CancelablePromise<Credential>;
|
|
273
275
|
/**
|
|
@@ -313,168 +315,61 @@ export declare class CredentialsService {
|
|
|
313
315
|
* "result": {credential object}
|
|
314
316
|
* }
|
|
315
317
|
*
|
|
316
|
-
* DELETE:
|
|
317
|
-
*
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
318
|
+
* DELETE: A JSON response indicating success:
|
|
319
|
+
* {
|
|
320
|
+
* "status": {"success": true, "description": "Deleted"}
|
|
321
|
+
* }
|
|
322
|
+
*
|
|
323
|
+
* Error Responses:
|
|
324
|
+
* 400 Bad Request: If the request data is invalid
|
|
325
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
326
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
327
|
+
* 404 Not Found: If the credential doesn't exist
|
|
328
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
329
|
+
*
|
|
330
|
+
* Access Control:
|
|
331
|
+
* - Requires CredentialAssignmentPermission
|
|
332
|
+
* - Users can only manage credentials they have permission to access
|
|
333
|
+
* @returns void
|
|
334
|
+
* @throws ApiError
|
|
335
|
+
*/
|
|
336
|
+
static credentialsOrgsUsersDestroy({ entityId, platformKey, userId, }: {
|
|
332
337
|
entityId: string;
|
|
333
338
|
platformKey: string;
|
|
334
|
-
username: string;
|
|
335
339
|
}): CancelablePromise<void>;
|
|
336
340
|
/**
|
|
337
|
-
* Endpoint to issue and retrieve credential assertions for a specific credential.
|
|
338
|
-
*
|
|
339
|
-
* This endpoint allows issuing new credential assertions and retrieving existing
|
|
340
|
-
* assertions for a specific credential.
|
|
341
|
-
*
|
|
342
|
-
* Path Parameters:
|
|
343
|
-
* org (str): The organization/tenant identifier
|
|
344
|
-
* user_id (str): The user ID making the request
|
|
345
|
-
* entity_id (str): The credential entity ID
|
|
346
|
-
*
|
|
347
|
-
* Methods:
|
|
348
|
-
* POST: Issue a new credential assertion
|
|
349
|
-
* GET: Retrieve assertions for a specific credential
|
|
350
|
-
*
|
|
351
|
-
* POST Request Body:
|
|
352
|
-
* A JSON object containing recipient information and any additional metadata
|
|
353
|
-
* required for issuing the credential.
|
|
354
|
-
*
|
|
355
|
-
* Returns:
|
|
356
|
-
* POST: A JSON response containing the created assertion using the AssertionSerializer format
|
|
357
|
-
* GET: A paginated list of assertions using the AssertionSerializer format
|
|
358
|
-
*
|
|
359
|
-
* Error Responses:
|
|
360
|
-
* 400 Bad Request: If the request data is invalid
|
|
361
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
362
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
363
|
-
* 404 Not Found: If the credential doesn't exist
|
|
364
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
365
341
|
* @returns PaginatedAssertionsResponse
|
|
366
342
|
* @throws ApiError
|
|
367
343
|
*/
|
|
368
|
-
static credentialsOrgsUsersAssertionsRetrieve3({ entityId, platformKey,
|
|
344
|
+
static credentialsOrgsUsersAssertionsRetrieve3({ entityId, platformKey, userId, }: {
|
|
369
345
|
entityId: string;
|
|
370
346
|
platformKey: string;
|
|
371
|
-
username: string;
|
|
372
347
|
}): CancelablePromise<PaginatedAssertionsResponse>;
|
|
373
348
|
/**
|
|
374
|
-
* Endpoint to issue and retrieve credential assertions for a specific credential.
|
|
375
|
-
*
|
|
376
|
-
* This endpoint allows issuing new credential assertions and retrieving existing
|
|
377
|
-
* assertions for a specific credential.
|
|
378
|
-
*
|
|
379
|
-
* Path Parameters:
|
|
380
|
-
* org (str): The organization/tenant identifier
|
|
381
|
-
* user_id (str): The user ID making the request
|
|
382
|
-
* entity_id (str): The credential entity ID
|
|
383
|
-
*
|
|
384
|
-
* Methods:
|
|
385
|
-
* POST: Issue a new credential assertion
|
|
386
|
-
* GET: Retrieve assertions for a specific credential
|
|
387
|
-
*
|
|
388
|
-
* POST Request Body:
|
|
389
|
-
* A JSON object containing recipient information and any additional metadata
|
|
390
|
-
* required for issuing the credential.
|
|
391
|
-
*
|
|
392
|
-
* Returns:
|
|
393
|
-
* POST: A JSON response containing the created assertion using the AssertionSerializer format
|
|
394
|
-
* GET: A paginated list of assertions using the AssertionSerializer format
|
|
395
|
-
*
|
|
396
|
-
* Error Responses:
|
|
397
|
-
* 400 Bad Request: If the request data is invalid
|
|
398
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
399
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
400
|
-
* 404 Not Found: If the credential doesn't exist
|
|
401
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
402
349
|
* @returns Assertion
|
|
403
350
|
* @throws ApiError
|
|
404
351
|
*/
|
|
405
|
-
static credentialsOrgsUsersAssertionsCreate({ entityId, platformKey,
|
|
352
|
+
static credentialsOrgsUsersAssertionsCreate({ entityId, platformKey, userId, requestBody, }: {
|
|
406
353
|
entityId: string;
|
|
407
354
|
platformKey: string;
|
|
408
|
-
username: string;
|
|
409
355
|
requestBody: Assertion;
|
|
410
356
|
}): CancelablePromise<Assertion>;
|
|
411
357
|
/**
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
* Path Parameters:
|
|
417
|
-
* org (str): The organization/tenant identifier
|
|
418
|
-
* user_id (str): The user ID making the request
|
|
419
|
-
* entity_id (str): The credential entity ID
|
|
420
|
-
*
|
|
421
|
-
* POST Request Body:
|
|
422
|
-
* A JSON object containing:
|
|
423
|
-
* - users (list): List of usernames to issue the credential to
|
|
424
|
-
* - Additional metadata required for issuing the credential
|
|
425
|
-
*
|
|
426
|
-
* Returns:
|
|
427
|
-
* A JSON response containing:
|
|
428
|
-
* {
|
|
429
|
-
* "skipped": ["username1", "username3"], // Users that were skipped (e.g., already have the credential)
|
|
430
|
-
* "issued": ["username2", "username4"] // Users that were successfully issued the credential
|
|
431
|
-
* }
|
|
432
|
-
*
|
|
433
|
-
* Error Responses:
|
|
434
|
-
* 400 Bad Request: If the request data is invalid or missing required fields
|
|
435
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
436
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
437
|
-
* 404 Not Found: If the credential doesn't exist
|
|
438
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
439
|
-
* @returns BulkCreateAssertion
|
|
440
|
-
* @throws ApiError
|
|
441
|
-
*/
|
|
442
|
-
static credentialsOrgsUsersAssertionsBulkCreate({ entityId, platformKey, username, requestBody, }: {
|
|
358
|
+
* @returns BulkCreateAssertion
|
|
359
|
+
* @throws ApiError
|
|
360
|
+
*/
|
|
361
|
+
static credentialsOrgsUsersAssertionsBulkCreate({ entityId, platformKey, userId, requestBody, }: {
|
|
443
362
|
entityId: string;
|
|
444
363
|
platformKey: string;
|
|
445
|
-
username: string;
|
|
446
364
|
requestBody: BulkCreateAssertion;
|
|
447
365
|
}): CancelablePromise<BulkCreateAssertion>;
|
|
448
366
|
/**
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
* This endpoint provides access to all credential assertions (issued credentials)
|
|
452
|
-
* for a specific user within an organization, with support for filtering.
|
|
453
|
-
*
|
|
454
|
-
* Path Parameters:
|
|
455
|
-
* org (str): The organization/tenant identifier
|
|
456
|
-
* user_id (str): The user ID to retrieve assertions for
|
|
457
|
-
*
|
|
458
|
-
* Query Parameters:
|
|
459
|
-
* course (str, optional): Filter by course ID
|
|
460
|
-
* include_revoked (bool, optional): Include revoked assertions (default: false)
|
|
461
|
-
* include_expired (bool, optional): Include expired assertions (default: false)
|
|
462
|
-
* exclude_main_tenant_assertions (bool, optional): Exclude assertions from the main tenant (default: false)
|
|
463
|
-
*
|
|
464
|
-
* Returns:
|
|
465
|
-
* A paginated response using the AssertionSerializer format
|
|
466
|
-
*
|
|
467
|
-
* Error Responses:
|
|
468
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
469
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
470
|
-
* 404 Not Found: If the user or organization doesn't exist
|
|
471
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
367
|
+
* A GET View that validates QueryParams and returns results to a serializer
|
|
472
368
|
* @returns PaginatedAssertionsResponse
|
|
473
369
|
* @throws ApiError
|
|
474
370
|
*/
|
|
475
|
-
static credentialsOrgsUsersAssertionsRetrieve({ platformKey,
|
|
371
|
+
static credentialsOrgsUsersAssertionsRetrieve({ platformKey, userId, course, excludeMainTenantAssertions, includeExpired, includeRevoked, page, pageSize, }: {
|
|
476
372
|
platformKey: string;
|
|
477
|
-
username: string;
|
|
478
373
|
course?: string;
|
|
479
374
|
excludeMainTenantAssertions?: boolean;
|
|
480
375
|
includeExpired?: boolean;
|
|
@@ -487,107 +382,41 @@ export declare class CredentialsService {
|
|
|
487
382
|
* @returns OvertimeWithChangeInfo
|
|
488
383
|
* @throws ApiError
|
|
489
384
|
*/
|
|
490
|
-
static credentialsOrgsUsersAssertionsOverTimeRetrieve({ platformKey,
|
|
491
|
-
platformKey: string;
|
|
492
|
-
username: string;
|
|
493
|
-
/**
|
|
385
|
+
static credentialsOrgsUsersAssertionsOverTimeRetrieve({ platformKey, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
386
|
+
platformKey: string; /**
|
|
494
387
|
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
495
388
|
*/
|
|
496
|
-
departmentId?: number;
|
|
497
|
-
/**
|
|
389
|
+
departmentId?: number; /**
|
|
498
390
|
* end date. ISO 8601
|
|
499
391
|
*/
|
|
500
|
-
endDate?: string;
|
|
501
|
-
/**
|
|
392
|
+
endDate?: string; /**
|
|
502
393
|
* Format
|
|
503
394
|
*
|
|
504
395
|
* * `json` - json
|
|
505
396
|
*/
|
|
506
|
-
format?: 'json';
|
|
507
|
-
/**
|
|
397
|
+
format?: 'json'; /**
|
|
508
398
|
* Include main platform data
|
|
509
399
|
*/
|
|
510
|
-
includeMainPlatform?: boolean;
|
|
511
|
-
/**
|
|
400
|
+
includeMainPlatform?: boolean; /**
|
|
512
401
|
* start date. ISO 8601
|
|
513
402
|
*/
|
|
514
403
|
startDate?: string;
|
|
515
404
|
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
516
405
|
/**
|
|
517
|
-
* Endpoint to retrieve and update a specific credential assertion.
|
|
518
|
-
*
|
|
519
|
-
* This endpoint allows retrieving details of a specific credential assertion
|
|
520
|
-
* and updating its status (e.g., revoking it).
|
|
521
|
-
*
|
|
522
|
-
* Path Parameters:
|
|
523
|
-
* org (str): The organization/tenant identifier
|
|
524
|
-
* user_id (str): The user ID making the request
|
|
525
|
-
* entity_id (str): The assertion entity ID
|
|
526
|
-
*
|
|
527
|
-
* Methods:
|
|
528
|
-
* GET: Retrieve assertion details
|
|
529
|
-
* PUT: Update assertion status (e.g., revoke)
|
|
530
|
-
*
|
|
531
|
-
* PUT Request Body:
|
|
532
|
-
* A JSON object containing:
|
|
533
|
-
* - revoked (bool): Set to true to revoke the assertion
|
|
534
|
-
* - revocationReason (str): Reason for revocation (required when revoking)
|
|
535
|
-
*
|
|
536
|
-
* Returns:
|
|
537
|
-
* GET: A JSON response containing the assertion details using the AssertionSerializer format
|
|
538
|
-
* PUT: A JSON response containing the updated assertion using the AssertionSerializer format
|
|
539
|
-
*
|
|
540
|
-
* Error Responses:
|
|
541
|
-
* 400 Bad Request: If the request data is invalid
|
|
542
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
543
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
544
|
-
* 404 Not Found: If the assertion doesn't exist
|
|
545
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
546
406
|
* @returns Assertion
|
|
547
407
|
* @throws ApiError
|
|
548
408
|
*/
|
|
549
|
-
static credentialsOrgsUsersAssertionsRetrieve2({ entityId, platformKey,
|
|
409
|
+
static credentialsOrgsUsersAssertionsRetrieve2({ entityId, platformKey, userId, }: {
|
|
550
410
|
entityId: string;
|
|
551
411
|
platformKey: string;
|
|
552
|
-
username: string;
|
|
553
412
|
}): CancelablePromise<Assertion>;
|
|
554
413
|
/**
|
|
555
|
-
* Endpoint to retrieve and update a specific credential assertion.
|
|
556
|
-
*
|
|
557
|
-
* This endpoint allows retrieving details of a specific credential assertion
|
|
558
|
-
* and updating its status (e.g., revoking it).
|
|
559
|
-
*
|
|
560
|
-
* Path Parameters:
|
|
561
|
-
* org (str): The organization/tenant identifier
|
|
562
|
-
* user_id (str): The user ID making the request
|
|
563
|
-
* entity_id (str): The assertion entity ID
|
|
564
|
-
*
|
|
565
|
-
* Methods:
|
|
566
|
-
* GET: Retrieve assertion details
|
|
567
|
-
* PUT: Update assertion status (e.g., revoke)
|
|
568
|
-
*
|
|
569
|
-
* PUT Request Body:
|
|
570
|
-
* A JSON object containing:
|
|
571
|
-
* - revoked (bool): Set to true to revoke the assertion
|
|
572
|
-
* - revocationReason (str): Reason for revocation (required when revoking)
|
|
573
|
-
*
|
|
574
|
-
* Returns:
|
|
575
|
-
* GET: A JSON response containing the assertion details using the AssertionSerializer format
|
|
576
|
-
* PUT: A JSON response containing the updated assertion using the AssertionSerializer format
|
|
577
|
-
*
|
|
578
|
-
* Error Responses:
|
|
579
|
-
* 400 Bad Request: If the request data is invalid
|
|
580
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
581
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
582
|
-
* 404 Not Found: If the assertion doesn't exist
|
|
583
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
584
414
|
* @returns Assertion
|
|
585
415
|
* @throws ApiError
|
|
586
416
|
*/
|
|
587
|
-
static credentialsOrgsUsersAssertionsUpdate({ entityId, platformKey,
|
|
417
|
+
static credentialsOrgsUsersAssertionsUpdate({ entityId, platformKey, userId, requestBody, }: {
|
|
588
418
|
entityId: string;
|
|
589
419
|
platformKey: string;
|
|
590
|
-
username: string;
|
|
591
420
|
requestBody: Assertion;
|
|
592
421
|
}): CancelablePromise<Assertion>;
|
|
593
422
|
/**
|
|
@@ -596,28 +425,25 @@ export declare class CredentialsService {
|
|
|
596
425
|
* @returns void
|
|
597
426
|
* @throws ApiError
|
|
598
427
|
*/
|
|
599
|
-
static credentialsOrgsUsersAssignmentsDestroy({ assignmentId, platformKey,
|
|
428
|
+
static credentialsOrgsUsersAssignmentsDestroy({ assignmentId, platformKey, userId, }: {
|
|
600
429
|
assignmentId: string;
|
|
601
430
|
platformKey: string;
|
|
602
|
-
username: string;
|
|
603
431
|
}): CancelablePromise<void>;
|
|
604
432
|
/**
|
|
605
433
|
* Get group assignments with department-aware filtering
|
|
606
434
|
* @returns any No response body
|
|
607
435
|
* @throws ApiError
|
|
608
436
|
*/
|
|
609
|
-
static credentialsOrgsUsersAssignmentsGroupsRetrieve({ platformKey,
|
|
437
|
+
static credentialsOrgsUsersAssignmentsGroupsRetrieve({ platformKey, userId, }: {
|
|
610
438
|
platformKey: string;
|
|
611
|
-
username: string;
|
|
612
439
|
}): CancelablePromise<any>;
|
|
613
440
|
/**
|
|
614
441
|
* Create group assignment with department access validation
|
|
615
442
|
* @returns any No response body
|
|
616
443
|
* @throws ApiError
|
|
617
444
|
*/
|
|
618
|
-
static credentialsOrgsUsersAssignmentsGroupsCreate({ platformKey,
|
|
445
|
+
static credentialsOrgsUsersAssignmentsGroupsCreate({ platformKey, userId, }: {
|
|
619
446
|
platformKey: string;
|
|
620
|
-
username: string;
|
|
621
447
|
}): CancelablePromise<any>;
|
|
622
448
|
/**
|
|
623
449
|
* Get assignments and their corresponding assertions based on user role:
|
|
@@ -627,83 +453,51 @@ export declare class CredentialsService {
|
|
|
627
453
|
* @returns any No response body
|
|
628
454
|
* @throws ApiError
|
|
629
455
|
*/
|
|
630
|
-
static credentialsOrgsUsersAssignmentsUsersRetrieve({ platformKey,
|
|
456
|
+
static credentialsOrgsUsersAssignmentsUsersRetrieve({ platformKey, userId, }: {
|
|
631
457
|
platformKey: string;
|
|
632
|
-
username: string;
|
|
633
458
|
}): CancelablePromise<any>;
|
|
634
459
|
/**
|
|
635
460
|
* Create assignments with department access validation
|
|
636
461
|
* @returns any No response body
|
|
637
462
|
* @throws ApiError
|
|
638
463
|
*/
|
|
639
|
-
static credentialsOrgsUsersAssignmentsUsersCreate({ platformKey,
|
|
464
|
+
static credentialsOrgsUsersAssignmentsUsersCreate({ platformKey, userId, }: {
|
|
640
465
|
platformKey: string;
|
|
641
|
-
username: string;
|
|
642
466
|
}): CancelablePromise<any>;
|
|
643
467
|
/**
|
|
644
468
|
* Get all credentials of a given tenant
|
|
645
469
|
* @returns OverTime
|
|
646
470
|
* @throws ApiError
|
|
647
471
|
*/
|
|
648
|
-
static credentialsOrgsUsersCourseAssertionsOverTimeRetrieve({ platformKey,
|
|
649
|
-
platformKey: string;
|
|
650
|
-
username: string;
|
|
651
|
-
/**
|
|
472
|
+
static credentialsOrgsUsersCourseAssertionsOverTimeRetrieve({ platformKey, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
473
|
+
platformKey: string; /**
|
|
652
474
|
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
653
475
|
*/
|
|
654
|
-
departmentId?: number;
|
|
655
|
-
/**
|
|
476
|
+
departmentId?: number; /**
|
|
656
477
|
* end date. ISO 8601
|
|
657
478
|
*/
|
|
658
|
-
endDate?: string;
|
|
659
|
-
/**
|
|
479
|
+
endDate?: string; /**
|
|
660
480
|
* Format
|
|
661
481
|
*
|
|
662
482
|
* * `json` - json
|
|
663
483
|
*/
|
|
664
|
-
format?: 'json';
|
|
665
|
-
/**
|
|
484
|
+
format?: 'json'; /**
|
|
666
485
|
* Include main platform data
|
|
667
486
|
*/
|
|
668
|
-
includeMainPlatform?: boolean;
|
|
669
|
-
/**
|
|
487
|
+
includeMainPlatform?: boolean; /**
|
|
670
488
|
* start date. ISO 8601
|
|
671
489
|
*/
|
|
672
490
|
startDate?: string;
|
|
673
491
|
}): CancelablePromise<OverTime>;
|
|
674
492
|
/**
|
|
675
|
-
* Endpoint to retrieve the credentials of a given tenant grouped by course.
|
|
676
|
-
*
|
|
677
|
-
* This endpoint provides access to credential data grouped by course for a specific
|
|
678
|
-
* organization/tenant, with support for pagination and filtering.
|
|
679
|
-
*
|
|
680
|
-
* Path Parameters:
|
|
681
|
-
* org (str): The organization/tenant identifier
|
|
682
|
-
*
|
|
683
|
-
* Query Parameters:
|
|
684
|
-
* limit (int, optional): Number of results per page (default: 10)
|
|
685
|
-
* offset (int, optional): Starting position for pagination
|
|
686
|
-
* search (str, optional): Search term e.g course_id
|
|
687
|
-
*
|
|
688
|
-
* Returns:
|
|
689
|
-
* A paginated response using the CourseCredentialSerializer format.
|
|
690
|
-
*
|
|
691
|
-
* Error Responses:
|
|
692
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
693
|
-
* 403 Forbidden: If the user does not have permission to access this data
|
|
694
|
-
* 404 Not Found: If the organization doesn't exist
|
|
695
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
696
493
|
* @returns any No response body
|
|
697
494
|
* @throws ApiError
|
|
698
495
|
*/
|
|
699
|
-
static credentialsOrgsUsersCourseCredentialsList({ platformKey,
|
|
700
|
-
platformKey: string;
|
|
701
|
-
username: string;
|
|
702
|
-
/**
|
|
496
|
+
static credentialsOrgsUsersCourseCredentialsList({ platformKey, userId, page, pageSize, }: {
|
|
497
|
+
platformKey: string; /**
|
|
703
498
|
* A page number within the paginated result set.
|
|
704
499
|
*/
|
|
705
|
-
page?: number;
|
|
706
|
-
/**
|
|
500
|
+
page?: number; /**
|
|
707
501
|
* Number of results to return per page.
|
|
708
502
|
*/
|
|
709
503
|
pageSize?: number;
|
|
@@ -713,28 +507,22 @@ export declare class CredentialsService {
|
|
|
713
507
|
* @returns OverTime
|
|
714
508
|
* @throws ApiError
|
|
715
509
|
*/
|
|
716
|
-
static credentialsOrgsUsersCredentialsOverTimeRetrieve({ platformKey,
|
|
717
|
-
platformKey: string;
|
|
718
|
-
username: string;
|
|
719
|
-
/**
|
|
510
|
+
static credentialsOrgsUsersCredentialsOverTimeRetrieve({ platformKey, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
511
|
+
platformKey: string; /**
|
|
720
512
|
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
721
513
|
*/
|
|
722
|
-
departmentId?: number;
|
|
723
|
-
/**
|
|
514
|
+
departmentId?: number; /**
|
|
724
515
|
* end date. ISO 8601
|
|
725
516
|
*/
|
|
726
|
-
endDate?: string;
|
|
727
|
-
/**
|
|
517
|
+
endDate?: string; /**
|
|
728
518
|
* Format
|
|
729
519
|
*
|
|
730
520
|
* * `json` - json
|
|
731
521
|
*/
|
|
732
|
-
format?: 'json';
|
|
733
|
-
/**
|
|
522
|
+
format?: 'json'; /**
|
|
734
523
|
* Include main platform data
|
|
735
524
|
*/
|
|
736
|
-
includeMainPlatform?: boolean;
|
|
737
|
-
/**
|
|
525
|
+
includeMainPlatform?: boolean; /**
|
|
738
526
|
* start date. ISO 8601
|
|
739
527
|
*/
|
|
740
528
|
startDate?: string;
|
|
@@ -752,9 +540,8 @@ export declare class CredentialsService {
|
|
|
752
540
|
* @returns ExternalCredentialMapping
|
|
753
541
|
* @throws ApiError
|
|
754
542
|
*/
|
|
755
|
-
static credentialsOrgsUsersExternalMappingRetrieve({ platformKey,
|
|
543
|
+
static credentialsOrgsUsersExternalMappingRetrieve({ platformKey, userId, }: {
|
|
756
544
|
platformKey: string;
|
|
757
|
-
username: string;
|
|
758
545
|
}): CancelablePromise<ExternalCredentialMapping>;
|
|
759
546
|
/**
|
|
760
547
|
* Create or update an external credential mapping.
|
|
@@ -776,9 +563,8 @@ export declare class CredentialsService {
|
|
|
776
563
|
* @returns ExternalCredentialMapping
|
|
777
564
|
* @throws ApiError
|
|
778
565
|
*/
|
|
779
|
-
static credentialsOrgsUsersExternalMappingCreate({ platformKey,
|
|
566
|
+
static credentialsOrgsUsersExternalMappingCreate({ platformKey, userId, requestBody, }: {
|
|
780
567
|
platformKey: string;
|
|
781
|
-
username: string;
|
|
782
568
|
requestBody: ExternalCredentialMapping;
|
|
783
569
|
}): CancelablePromise<ExternalCredentialMapping>;
|
|
784
570
|
/**
|
|
@@ -795,229 +581,185 @@ export declare class CredentialsService {
|
|
|
795
581
|
* @returns void
|
|
796
582
|
* @throws ApiError
|
|
797
583
|
*/
|
|
798
|
-
static credentialsOrgsUsersExternalMappingDestroy({ platformKey,
|
|
584
|
+
static credentialsOrgsUsersExternalMappingDestroy({ platformKey, userId, }: {
|
|
799
585
|
platformKey: string;
|
|
800
|
-
username: string;
|
|
801
586
|
}): CancelablePromise<void>;
|
|
802
587
|
/**
|
|
803
|
-
*
|
|
804
|
-
*
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
*
|
|
808
|
-
* Path Parameters:
|
|
809
|
-
* org (str): The organization/tenant identifier
|
|
810
|
-
* user_id (str): The user ID making the request
|
|
811
|
-
*
|
|
812
|
-
* Query Parameters:
|
|
813
|
-
* query (str, required for GET): Search term to filter images by name
|
|
814
|
-
*
|
|
815
|
-
* Methods:
|
|
816
|
-
* GET: Retrieve images matching a search query
|
|
817
|
-
* POST: Upload a new image
|
|
818
|
-
*
|
|
819
|
-
* POST Request Body:
|
|
820
|
-
* Multipart form data containing:
|
|
821
|
-
* - image (file, required): The image file to upload
|
|
822
|
-
* - name (str, optional): A descriptive name for the image
|
|
823
|
-
*
|
|
824
|
-
* Returns:
|
|
825
|
-
* GET: A JSON array of image objects:
|
|
826
|
-
* [
|
|
827
|
-
* {
|
|
828
|
-
* "id": 123,
|
|
829
|
-
* "name": "Logo",
|
|
830
|
-
* "image": "https://example.com/media/uploaded_images/logo.png"
|
|
831
|
-
* },
|
|
832
|
-
* {
|
|
833
|
-
* "id": 124,
|
|
834
|
-
* "name": "Background",
|
|
835
|
-
* "image": "https://example.com/media/uploaded_images/background.jpg"
|
|
836
|
-
* },
|
|
837
|
-
* ...
|
|
838
|
-
* ]
|
|
839
|
-
*
|
|
840
|
-
* POST: A JSON object containing the uploaded image details:
|
|
841
|
-
* {
|
|
842
|
-
* "id": 125,
|
|
843
|
-
* "name": "Certificate Icon",
|
|
844
|
-
* "image": "https://example.com/media/uploaded_images/certificate-icon.png"
|
|
845
|
-
* }
|
|
846
|
-
*
|
|
847
|
-
* Error Responses:
|
|
848
|
-
* 400 Bad Request: If the request data is invalid or missing required parameters
|
|
849
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
850
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
851
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
852
|
-
*
|
|
853
|
-
* Access Control:
|
|
854
|
-
* - Requires IsAdminUserOrStudentDRFMixin
|
|
855
|
-
* - Only authenticated users with appropriate permissions can upload and retrieve images
|
|
856
|
-
* @returns UploadedImage
|
|
857
|
-
* @throws ApiError
|
|
858
|
-
*/
|
|
859
|
-
static credentialsOrgsUsersImagesRetrieve({ platformKey, username, }: {
|
|
588
|
+
* @returns UploadedImage
|
|
589
|
+
* @throws ApiError
|
|
590
|
+
*/
|
|
591
|
+
static credentialsOrgsUsersImagesRetrieve({ platformKey, userId, }: {
|
|
860
592
|
platformKey: string;
|
|
861
|
-
username: string;
|
|
862
593
|
}): CancelablePromise<UploadedImage>;
|
|
863
594
|
/**
|
|
864
|
-
*
|
|
865
|
-
*
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
*
|
|
869
|
-
* Path Parameters:
|
|
870
|
-
* org (str): The organization/tenant identifier
|
|
871
|
-
* user_id (str): The user ID making the request
|
|
872
|
-
*
|
|
873
|
-
* Query Parameters:
|
|
874
|
-
* query (str, required for GET): Search term to filter images by name
|
|
875
|
-
*
|
|
876
|
-
* Methods:
|
|
877
|
-
* GET: Retrieve images matching a search query
|
|
878
|
-
* POST: Upload a new image
|
|
879
|
-
*
|
|
880
|
-
* POST Request Body:
|
|
881
|
-
* Multipart form data containing:
|
|
882
|
-
* - image (file, required): The image file to upload
|
|
883
|
-
* - name (str, optional): A descriptive name for the image
|
|
884
|
-
*
|
|
885
|
-
* Returns:
|
|
886
|
-
* GET: A JSON array of image objects:
|
|
887
|
-
* [
|
|
888
|
-
* {
|
|
889
|
-
* "id": 123,
|
|
890
|
-
* "name": "Logo",
|
|
891
|
-
* "image": "https://example.com/media/uploaded_images/logo.png"
|
|
892
|
-
* },
|
|
893
|
-
* {
|
|
894
|
-
* "id": 124,
|
|
895
|
-
* "name": "Background",
|
|
896
|
-
* "image": "https://example.com/media/uploaded_images/background.jpg"
|
|
897
|
-
* },
|
|
898
|
-
* ...
|
|
899
|
-
* ]
|
|
900
|
-
*
|
|
901
|
-
* POST: A JSON object containing the uploaded image details:
|
|
902
|
-
* {
|
|
903
|
-
* "id": 125,
|
|
904
|
-
* "name": "Certificate Icon",
|
|
905
|
-
* "image": "https://example.com/media/uploaded_images/certificate-icon.png"
|
|
906
|
-
* }
|
|
907
|
-
*
|
|
908
|
-
* Error Responses:
|
|
909
|
-
* 400 Bad Request: If the request data is invalid or missing required parameters
|
|
910
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
911
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
912
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
913
|
-
*
|
|
914
|
-
* Access Control:
|
|
915
|
-
* - Requires IsAdminUserOrStudentDRFMixin
|
|
916
|
-
* - Only authenticated users with appropriate permissions can upload and retrieve images
|
|
917
|
-
* @returns UploadedImage
|
|
918
|
-
* @throws ApiError
|
|
919
|
-
*/
|
|
920
|
-
static credentialsOrgsUsersImagesCreate({ platformKey, username, requestBody, }: {
|
|
595
|
+
* @returns UploadedImage
|
|
596
|
+
* @throws ApiError
|
|
597
|
+
*/
|
|
598
|
+
static credentialsOrgsUsersImagesCreate({ platformKey, userId, requestBody, }: {
|
|
921
599
|
platformKey: string;
|
|
922
|
-
username: string;
|
|
923
600
|
requestBody?: UploadedImage;
|
|
924
601
|
}): CancelablePromise<UploadedImage>;
|
|
925
602
|
/**
|
|
926
|
-
*
|
|
927
|
-
*
|
|
928
|
-
*
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
* Path Parameters:
|
|
932
|
-
* org (str): The organization/tenant identifier
|
|
933
|
-
* user_id (str): The user ID making the request
|
|
934
|
-
*
|
|
935
|
-
* Query Parameters:
|
|
936
|
-
* q (str, optional): Search term to filter issuers by name
|
|
937
|
-
* limit (int, optional): Number of results per page (default: 50)
|
|
938
|
-
* offset (int, optional): Starting position for pagination
|
|
939
|
-
*
|
|
940
|
-
* Methods:
|
|
941
|
-
* GET: Retrieve issuers with filtering and pagination
|
|
942
|
-
* POST: Create a new issuer
|
|
943
|
-
*
|
|
944
|
-
* POST Request Body:
|
|
945
|
-
* A JSON object containing issuer details:
|
|
946
|
-
* - name (str): Issuer name
|
|
947
|
-
* - iconImage (str, optional): URL to issuer icon
|
|
948
|
-
* - email (str, optional): Contact email for the issuer
|
|
949
|
-
* - url (str, optional): Website URL for the issuer
|
|
950
|
-
* - allowed_template_tags (array, optional): List of allowed template tags
|
|
951
|
-
*
|
|
952
|
-
* Returns:
|
|
953
|
-
* GET: A JSON response containing:
|
|
954
|
-
* {
|
|
955
|
-
* "status": {"success": true, "description": "Ok"},
|
|
956
|
-
* "result": {
|
|
957
|
-
* "next": "URL to next page",
|
|
958
|
-
* "previous": "URL to previous page",
|
|
959
|
-
* "count": 10,
|
|
960
|
-
* "data": [
|
|
961
|
-
* {issuer object},
|
|
962
|
-
* {issuer object},
|
|
963
|
-
* ...
|
|
964
|
-
* ],
|
|
965
|
-
* "num_pages": 1,
|
|
966
|
-
* "page_number": 1,
|
|
967
|
-
* "max_page_size": 1000
|
|
968
|
-
* }
|
|
969
|
-
* }
|
|
970
|
-
*
|
|
971
|
-
* POST: A JSON response containing:
|
|
972
|
-
* {
|
|
973
|
-
* "status": {"success": true, "description": "Created"},
|
|
974
|
-
* "result": {issuer object}
|
|
975
|
-
* }
|
|
976
|
-
*
|
|
977
|
-
* Error Responses:
|
|
978
|
-
* 400 Bad Request: If the request data is invalid
|
|
979
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
980
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
981
|
-
* 404 Not Found: If the platform doesn't exist
|
|
982
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
983
|
-
*
|
|
984
|
-
* Access Control:
|
|
985
|
-
* - Requires IsAdminUserOrStudentDRFMixin
|
|
986
|
-
* - Only authenticated users with appropriate permissions can manage issuers
|
|
987
|
-
* @returns Issuer
|
|
988
|
-
* @throws ApiError
|
|
989
|
-
*/
|
|
990
|
-
static credentialsOrgsUsersIssuersRetrieve({ platformKey, q, username, }: {
|
|
603
|
+
* A GET View that validates QueryParams and returns results to a serializer
|
|
604
|
+
* @returns Issuer
|
|
605
|
+
* @throws ApiError
|
|
606
|
+
*/
|
|
607
|
+
static credentialsOrgsUsersIssuersRetrieve({ platformKey, q, userId, }: {
|
|
991
608
|
platformKey: string;
|
|
992
609
|
q: string;
|
|
993
|
-
username: string;
|
|
994
610
|
}): CancelablePromise<Issuer>;
|
|
995
611
|
/**
|
|
996
|
-
*
|
|
612
|
+
* A GET View that validates QueryParams and returns results to a serializer
|
|
613
|
+
* @returns Issuer
|
|
614
|
+
* @throws ApiError
|
|
615
|
+
*/
|
|
616
|
+
static credentialsOrgsUsersIssuersCreate({ platformKey, q, userId, requestBody, }: {
|
|
617
|
+
platformKey: string;
|
|
618
|
+
q: string;
|
|
619
|
+
requestBody: Issuer;
|
|
620
|
+
}): CancelablePromise<Issuer>;
|
|
621
|
+
/**
|
|
622
|
+
* @returns Issuer
|
|
623
|
+
* @throws ApiError
|
|
624
|
+
*/
|
|
625
|
+
static credentialsOrgsUsersIssuersRetrieve2({ entityId, platformKey, userId, }: {
|
|
626
|
+
entityId: string;
|
|
627
|
+
platformKey: string;
|
|
628
|
+
}): CancelablePromise<Issuer>;
|
|
629
|
+
/**
|
|
630
|
+
* @returns Issuer
|
|
631
|
+
* @throws ApiError
|
|
632
|
+
*/
|
|
633
|
+
static credentialsOrgsUsersIssuersUpdate({ entityId, platformKey, userId, requestBody, }: {
|
|
634
|
+
entityId: string;
|
|
635
|
+
platformKey: string;
|
|
636
|
+
requestBody: Issuer;
|
|
637
|
+
}): CancelablePromise<Issuer>;
|
|
638
|
+
/**
|
|
639
|
+
* @returns void
|
|
640
|
+
* @throws ApiError
|
|
641
|
+
*/
|
|
642
|
+
static credentialsOrgsUsersIssuersDestroy({ entityId, platformKey, userId, }: {
|
|
643
|
+
entityId: string;
|
|
644
|
+
platformKey: string;
|
|
645
|
+
}): CancelablePromise<void>;
|
|
646
|
+
/**
|
|
647
|
+
* @returns IssuerAuthority
|
|
648
|
+
* @throws ApiError
|
|
649
|
+
*/
|
|
650
|
+
static credentialsOrgsUsersIssuersAuthorityCreate({ platformKey, userId, requestBody, }: {
|
|
651
|
+
platformKey: string;
|
|
652
|
+
requestBody: IssuerAuthority;
|
|
653
|
+
}): CancelablePromise<IssuerAuthority>;
|
|
654
|
+
/**
|
|
655
|
+
* Retrieve provider configurations for the platform.
|
|
656
|
+
*
|
|
657
|
+
* Query Parameters:
|
|
658
|
+
* provider_name (str, optional): Filter to a specific provider
|
|
659
|
+
* page (int, optional): Page number
|
|
660
|
+
* page_size (int, optional): Items per page
|
|
661
|
+
*
|
|
662
|
+
* Returns all configurations for the platform if the user is an admin.
|
|
663
|
+
* @returns CredentialProviderConfig
|
|
664
|
+
* @throws ApiError
|
|
665
|
+
*/
|
|
666
|
+
static credentialsOrgsUsersProviderConfigRetrieve({ platformKey, userId, }: {
|
|
667
|
+
platformKey: string;
|
|
668
|
+
}): CancelablePromise<CredentialProviderConfig>;
|
|
669
|
+
/**
|
|
670
|
+
* Create or update a provider configuration.
|
|
671
|
+
*
|
|
672
|
+
* If a configuration doesn't exist for the platform and provider, it will be created.
|
|
673
|
+
* If it exists, it will be updated.
|
|
674
|
+
*
|
|
675
|
+
* Request Body:
|
|
676
|
+
* {
|
|
677
|
+
* "provider_name": "accredible", // Required
|
|
678
|
+
* "config": {...}, // Optional
|
|
679
|
+
* "enabled": true // Optional
|
|
680
|
+
* }
|
|
681
|
+
*
|
|
682
|
+
* Returns:
|
|
683
|
+
* - 201 Created: When creating a new configuration
|
|
684
|
+
* - 200 OK: When updating an existing configuration
|
|
685
|
+
* @returns CredentialProviderConfig
|
|
686
|
+
* @throws ApiError
|
|
687
|
+
*/
|
|
688
|
+
static credentialsOrgsUsersProviderConfigCreate({ platformKey, userId, requestBody, }: {
|
|
689
|
+
platformKey: string;
|
|
690
|
+
requestBody: CredentialProviderConfig;
|
|
691
|
+
}): CancelablePromise<CredentialProviderConfig>;
|
|
692
|
+
/**
|
|
693
|
+
* Deactivate a provider configuration (sets enabled=False).
|
|
694
|
+
*
|
|
695
|
+
* Request Body:
|
|
696
|
+
* {
|
|
697
|
+
* "provider_name": "accredible" // Required
|
|
698
|
+
* }
|
|
699
|
+
* @returns void
|
|
700
|
+
* @throws ApiError
|
|
701
|
+
*/
|
|
702
|
+
static credentialsOrgsUsersProviderConfigDestroy({ platformKey, userId, }: {
|
|
703
|
+
platformKey: string;
|
|
704
|
+
}): CancelablePromise<void>;
|
|
705
|
+
/**
|
|
706
|
+
* Get all credentials for a platform with search and pagination support.
|
|
707
|
+
*
|
|
708
|
+
* Query Parameters:
|
|
709
|
+
* - platform_org: Platform org ID (takes precedence over URL org)
|
|
710
|
+
* - page: Page number (default: 1)
|
|
711
|
+
* - page_size: Items per page (default: 10, max: 100)
|
|
712
|
+
* - search: Search term to filter credentials
|
|
713
|
+
* - course: Course ID to filter credentials
|
|
714
|
+
* - program: Program ID to filter credentials
|
|
715
|
+
* @returns Credential
|
|
716
|
+
* @throws ApiError
|
|
717
|
+
*/
|
|
718
|
+
static credentialsOrgsUsersRetrieve3({ platformKey, username, }: {
|
|
719
|
+
platformKey: string;
|
|
720
|
+
username: string;
|
|
721
|
+
}): CancelablePromise<Credential>;
|
|
722
|
+
/**
|
|
723
|
+
* API View for managing credentials across a platform.
|
|
997
724
|
*
|
|
998
|
-
* This endpoint allows creating and retrieving
|
|
999
|
-
* with support for filtering and pagination.
|
|
725
|
+
* This endpoint allows creating and retrieving credentials for a specific organization/tenant,
|
|
726
|
+
* with support for filtering, searching, and pagination.
|
|
1000
727
|
*
|
|
1001
728
|
* Path Parameters:
|
|
1002
729
|
* org (str): The organization/tenant identifier
|
|
1003
730
|
* user_id (str): The user ID making the request
|
|
1004
731
|
*
|
|
1005
732
|
* Query Parameters:
|
|
1006
|
-
*
|
|
1007
|
-
*
|
|
1008
|
-
*
|
|
733
|
+
* # Platform identification
|
|
734
|
+
* platform_org (str, optional): Alternative platform identifier (takes precedence over URL org)
|
|
735
|
+
*
|
|
736
|
+
* # Pagination
|
|
737
|
+
* page (int, optional): Page number (default: 1)
|
|
738
|
+
* page_size (int, optional): Items per page (default: 10, max: 100)
|
|
739
|
+
*
|
|
740
|
+
* # Filtering and search
|
|
741
|
+
* search (str, optional): Search term to filter credentials by name or description
|
|
742
|
+
* course (str, optional): Course ID to filter credentials associated with a specific course
|
|
743
|
+
* program (str, optional): Program ID to filter credentials associated with a specific program
|
|
1009
744
|
*
|
|
1010
745
|
* Methods:
|
|
1011
|
-
* GET: Retrieve
|
|
1012
|
-
* POST: Create a new
|
|
746
|
+
* GET: Retrieve credentials with filtering and pagination
|
|
747
|
+
* POST: Create a new credential
|
|
1013
748
|
*
|
|
1014
749
|
* POST Request Body:
|
|
1015
|
-
* A JSON object containing
|
|
1016
|
-
* - name (str):
|
|
1017
|
-
* -
|
|
1018
|
-
* -
|
|
1019
|
-
* -
|
|
1020
|
-
* -
|
|
750
|
+
* A JSON object containing credential details:
|
|
751
|
+
* - name (str): Credential name
|
|
752
|
+
* - description (str, optional): Credential description
|
|
753
|
+
* - issuer (str): Issuer entity ID
|
|
754
|
+
* - credential_type (str, optional): Type of credential
|
|
755
|
+
* - html_template (str, optional): HTML template for credential rendering
|
|
756
|
+
* - css_template (str, optional): CSS template for credential styling
|
|
757
|
+
* - icon_image (str, optional): URL to credential icon
|
|
758
|
+
* - background_image (str, optional): URL to credential background
|
|
759
|
+
* - thumbnail_image (str, optional): URL to credential thumbnail
|
|
760
|
+
* - criteria_url (str, optional): URL to credential criteria
|
|
761
|
+
* - criteria_text (str, optional): Text description of credential criteria
|
|
762
|
+
* - issuing_signal (str, optional): Signal that triggers credential issuance
|
|
1021
763
|
*
|
|
1022
764
|
* Returns:
|
|
1023
765
|
* GET: A JSON response containing:
|
|
@@ -1026,22 +768,22 @@ export declare class CredentialsService {
|
|
|
1026
768
|
* "result": {
|
|
1027
769
|
* "next": "URL to next page",
|
|
1028
770
|
* "previous": "URL to previous page",
|
|
1029
|
-
* "count":
|
|
771
|
+
* "count": 42,
|
|
1030
772
|
* "data": [
|
|
1031
|
-
* {
|
|
1032
|
-
* {
|
|
773
|
+
* {credential object},
|
|
774
|
+
* {credential object},
|
|
1033
775
|
* ...
|
|
1034
776
|
* ],
|
|
1035
|
-
* "num_pages":
|
|
777
|
+
* "num_pages": 5,
|
|
1036
778
|
* "page_number": 1,
|
|
1037
|
-
* "max_page_size":
|
|
779
|
+
* "max_page_size": 100
|
|
1038
780
|
* }
|
|
1039
781
|
* }
|
|
1040
782
|
*
|
|
1041
783
|
* POST: A JSON response containing:
|
|
1042
784
|
* {
|
|
1043
785
|
* "status": {"success": true, "description": "Created"},
|
|
1044
|
-
* "result": {
|
|
786
|
+
* "result": {credential object}
|
|
1045
787
|
* }
|
|
1046
788
|
*
|
|
1047
789
|
* Error Responses:
|
|
@@ -1052,286 +794,568 @@ export declare class CredentialsService {
|
|
|
1052
794
|
* 500 Internal Server Error: If an unexpected error occurs
|
|
1053
795
|
*
|
|
1054
796
|
* Access Control:
|
|
1055
|
-
* - Requires
|
|
1056
|
-
* - Only
|
|
1057
|
-
* @returns
|
|
797
|
+
* - Requires CredentialAssignmentPermission
|
|
798
|
+
* - Only public credentials are returned by default
|
|
799
|
+
* @returns Credential
|
|
1058
800
|
* @throws ApiError
|
|
1059
801
|
*/
|
|
1060
|
-
static
|
|
802
|
+
static credentialsOrgsUsersCreate2({ platformKey, username, requestBody, }: {
|
|
1061
803
|
platformKey: string;
|
|
1062
|
-
q: string;
|
|
1063
804
|
username: string;
|
|
1064
|
-
requestBody:
|
|
1065
|
-
}): CancelablePromise<
|
|
805
|
+
requestBody: Credential;
|
|
806
|
+
}): CancelablePromise<Credential>;
|
|
1066
807
|
/**
|
|
1067
|
-
* API View for managing individual
|
|
808
|
+
* API View for managing individual credentials.
|
|
1068
809
|
*
|
|
1069
|
-
* This endpoint allows retrieving, updating, and deleting specific
|
|
1070
|
-
* identified by their entity_id
|
|
810
|
+
* This endpoint allows retrieving, updating, and deleting specific credentials
|
|
811
|
+
* identified by their entity_id.
|
|
1071
812
|
*
|
|
1072
813
|
* Path Parameters:
|
|
1073
814
|
* org (str): The organization/tenant identifier
|
|
1074
815
|
* user_id (str): The user ID making the request
|
|
1075
|
-
* entity_id (str): The
|
|
816
|
+
* entity_id (str): The credential entity ID
|
|
1076
817
|
*
|
|
1077
818
|
* Methods:
|
|
1078
|
-
* GET: Retrieve a specific
|
|
1079
|
-
* PUT: Update a specific
|
|
1080
|
-
* DELETE: Delete a specific
|
|
819
|
+
* GET: Retrieve a specific credential
|
|
820
|
+
* PUT: Update a specific credential
|
|
821
|
+
* DELETE: Delete a specific credential
|
|
1081
822
|
*
|
|
1082
823
|
* PUT Request Body:
|
|
1083
|
-
* A JSON object containing
|
|
1084
|
-
* - name (str, optional):
|
|
1085
|
-
* -
|
|
1086
|
-
* -
|
|
1087
|
-
* -
|
|
1088
|
-
* -
|
|
824
|
+
* A JSON object containing credential details to update:
|
|
825
|
+
* - name (str, optional): Credential name
|
|
826
|
+
* - description (str, optional): Credential description
|
|
827
|
+
* - credential_type (str, optional): Type of credential
|
|
828
|
+
* - html_template (str, optional): HTML template for credential rendering
|
|
829
|
+
* - css_template (str, optional): CSS template for credential styling
|
|
830
|
+
* - icon_image (str, optional): URL to credential icon
|
|
831
|
+
* - background_image (str, optional): URL to credential background
|
|
832
|
+
* - thumbnail_image (str, optional): URL to credential thumbnail
|
|
833
|
+
* - criteria_url (str, optional): URL to credential criteria
|
|
834
|
+
* - criteria_text (str, optional): Text description of credential criteria
|
|
835
|
+
* - issuing_signal (str, optional): Signal that triggers credential issuance
|
|
1089
836
|
*
|
|
1090
837
|
* Returns:
|
|
1091
|
-
* GET: A JSON response containing
|
|
1092
|
-
*
|
|
838
|
+
* GET: A JSON response containing:
|
|
839
|
+
* {
|
|
840
|
+
* "status": {"success": true, "description": "Ok"},
|
|
841
|
+
* "result": {credential object}
|
|
842
|
+
* }
|
|
843
|
+
*
|
|
844
|
+
* PUT: A JSON response containing:
|
|
1093
845
|
* {
|
|
1094
|
-
* "
|
|
1095
|
-
* "
|
|
1096
|
-
* "entityId": "abc123",
|
|
1097
|
-
* "signatories": [...],
|
|
1098
|
-
* "url": "https://example.com",
|
|
1099
|
-
* "iconImage": "https://example.com/logo.png",
|
|
1100
|
-
* "allowed_template_tags": [...]
|
|
846
|
+
* "status": {"success": true, "description": "Updated"},
|
|
847
|
+
* "result": {credential object}
|
|
1101
848
|
* }
|
|
1102
|
-
* ]
|
|
1103
849
|
*
|
|
1104
|
-
*
|
|
1105
|
-
*
|
|
1106
|
-
* {
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
* 400 Bad Request: If the request data is invalid
|
|
1124
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
1125
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
1126
|
-
* 404 Not Found: If the issuer doesn't exist
|
|
1127
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
1128
|
-
*
|
|
1129
|
-
* Access Control:
|
|
1130
|
-
* - Requires IsAdminUserOrStudentDRFMixin
|
|
1131
|
-
* - Only authenticated users with appropriate permissions can manage issuers
|
|
1132
|
-
* @returns Issuer
|
|
1133
|
-
* @throws ApiError
|
|
1134
|
-
*/
|
|
1135
|
-
static credentialsOrgsUsersIssuersRetrieve2({ entityId, platformKey, username, }: {
|
|
850
|
+
* DELETE: A JSON response indicating success:
|
|
851
|
+
* {
|
|
852
|
+
* "status": {"success": true, "description": "Deleted"}
|
|
853
|
+
* }
|
|
854
|
+
*
|
|
855
|
+
* Error Responses:
|
|
856
|
+
* 400 Bad Request: If the request data is invalid
|
|
857
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
858
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
859
|
+
* 404 Not Found: If the credential doesn't exist
|
|
860
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
861
|
+
*
|
|
862
|
+
* Access Control:
|
|
863
|
+
* - Requires CredentialAssignmentPermission
|
|
864
|
+
* - Users can only manage credentials they have permission to access
|
|
865
|
+
* @returns Credential
|
|
866
|
+
* @throws ApiError
|
|
867
|
+
*/
|
|
868
|
+
static credentialsOrgsUsersRetrieve4({ entityId, platformKey, username, }: {
|
|
1136
869
|
entityId: string;
|
|
1137
870
|
platformKey: string;
|
|
1138
871
|
username: string;
|
|
1139
|
-
}): CancelablePromise<
|
|
872
|
+
}): CancelablePromise<Credential>;
|
|
1140
873
|
/**
|
|
1141
|
-
* API View for managing individual
|
|
874
|
+
* API View for managing individual credentials.
|
|
1142
875
|
*
|
|
1143
|
-
* This endpoint allows retrieving, updating, and deleting specific
|
|
1144
|
-
* identified by their entity_id
|
|
876
|
+
* This endpoint allows retrieving, updating, and deleting specific credentials
|
|
877
|
+
* identified by their entity_id.
|
|
1145
878
|
*
|
|
1146
879
|
* Path Parameters:
|
|
1147
880
|
* org (str): The organization/tenant identifier
|
|
1148
881
|
* user_id (str): The user ID making the request
|
|
1149
|
-
* entity_id (str): The
|
|
882
|
+
* entity_id (str): The credential entity ID
|
|
1150
883
|
*
|
|
1151
884
|
* Methods:
|
|
1152
|
-
* GET: Retrieve a specific
|
|
1153
|
-
* PUT: Update a specific
|
|
1154
|
-
* DELETE: Delete a specific
|
|
885
|
+
* GET: Retrieve a specific credential
|
|
886
|
+
* PUT: Update a specific credential
|
|
887
|
+
* DELETE: Delete a specific credential
|
|
1155
888
|
*
|
|
1156
889
|
* PUT Request Body:
|
|
1157
|
-
* A JSON object containing
|
|
1158
|
-
* - name (str, optional):
|
|
1159
|
-
* -
|
|
1160
|
-
* -
|
|
1161
|
-
* -
|
|
1162
|
-
* -
|
|
890
|
+
* A JSON object containing credential details to update:
|
|
891
|
+
* - name (str, optional): Credential name
|
|
892
|
+
* - description (str, optional): Credential description
|
|
893
|
+
* - credential_type (str, optional): Type of credential
|
|
894
|
+
* - html_template (str, optional): HTML template for credential rendering
|
|
895
|
+
* - css_template (str, optional): CSS template for credential styling
|
|
896
|
+
* - icon_image (str, optional): URL to credential icon
|
|
897
|
+
* - background_image (str, optional): URL to credential background
|
|
898
|
+
* - thumbnail_image (str, optional): URL to credential thumbnail
|
|
899
|
+
* - criteria_url (str, optional): URL to credential criteria
|
|
900
|
+
* - criteria_text (str, optional): Text description of credential criteria
|
|
901
|
+
* - issuing_signal (str, optional): Signal that triggers credential issuance
|
|
1163
902
|
*
|
|
1164
903
|
* Returns:
|
|
1165
|
-
* GET: A JSON response containing
|
|
1166
|
-
*
|
|
904
|
+
* GET: A JSON response containing:
|
|
905
|
+
* {
|
|
906
|
+
* "status": {"success": true, "description": "Ok"},
|
|
907
|
+
* "result": {credential object}
|
|
908
|
+
* }
|
|
909
|
+
*
|
|
910
|
+
* PUT: A JSON response containing:
|
|
1167
911
|
* {
|
|
1168
|
-
* "
|
|
1169
|
-
* "
|
|
1170
|
-
* "entityId": "abc123",
|
|
1171
|
-
* "signatories": [...],
|
|
1172
|
-
* "url": "https://example.com",
|
|
1173
|
-
* "iconImage": "https://example.com/logo.png",
|
|
1174
|
-
* "allowed_template_tags": [...]
|
|
912
|
+
* "status": {"success": true, "description": "Updated"},
|
|
913
|
+
* "result": {credential object}
|
|
1175
914
|
* }
|
|
1176
|
-
* ]
|
|
1177
915
|
*
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1180
|
-
* {
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
* 400 Bad Request: If the request data is invalid
|
|
1198
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
1199
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
1200
|
-
* 404 Not Found: If the issuer doesn't exist
|
|
1201
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
1202
|
-
*
|
|
1203
|
-
* Access Control:
|
|
1204
|
-
* - Requires IsAdminUserOrStudentDRFMixin
|
|
1205
|
-
* - Only authenticated users with appropriate permissions can manage issuers
|
|
1206
|
-
* @returns Issuer
|
|
1207
|
-
* @throws ApiError
|
|
1208
|
-
*/
|
|
1209
|
-
static credentialsOrgsUsersIssuersUpdate({ entityId, platformKey, username, requestBody, }: {
|
|
916
|
+
* DELETE: A JSON response indicating success:
|
|
917
|
+
* {
|
|
918
|
+
* "status": {"success": true, "description": "Deleted"}
|
|
919
|
+
* }
|
|
920
|
+
*
|
|
921
|
+
* Error Responses:
|
|
922
|
+
* 400 Bad Request: If the request data is invalid
|
|
923
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
924
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
925
|
+
* 404 Not Found: If the credential doesn't exist
|
|
926
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
927
|
+
*
|
|
928
|
+
* Access Control:
|
|
929
|
+
* - Requires CredentialAssignmentPermission
|
|
930
|
+
* - Users can only manage credentials they have permission to access
|
|
931
|
+
* @returns Credential
|
|
932
|
+
* @throws ApiError
|
|
933
|
+
*/
|
|
934
|
+
static credentialsOrgsUsersUpdate2({ entityId, platformKey, username, requestBody, }: {
|
|
1210
935
|
entityId: string;
|
|
1211
936
|
platformKey: string;
|
|
1212
937
|
username: string;
|
|
1213
|
-
requestBody:
|
|
1214
|
-
}): CancelablePromise<
|
|
938
|
+
requestBody: Credential;
|
|
939
|
+
}): CancelablePromise<Credential>;
|
|
1215
940
|
/**
|
|
1216
|
-
* API View for managing individual
|
|
941
|
+
* API View for managing individual credentials.
|
|
1217
942
|
*
|
|
1218
|
-
* This endpoint allows retrieving, updating, and deleting specific
|
|
1219
|
-
* identified by their entity_id
|
|
943
|
+
* This endpoint allows retrieving, updating, and deleting specific credentials
|
|
944
|
+
* identified by their entity_id.
|
|
1220
945
|
*
|
|
1221
946
|
* Path Parameters:
|
|
1222
947
|
* org (str): The organization/tenant identifier
|
|
1223
948
|
* user_id (str): The user ID making the request
|
|
1224
|
-
* entity_id (str): The
|
|
949
|
+
* entity_id (str): The credential entity ID
|
|
1225
950
|
*
|
|
1226
951
|
* Methods:
|
|
1227
|
-
* GET: Retrieve a specific
|
|
1228
|
-
* PUT: Update a specific
|
|
1229
|
-
* DELETE: Delete a specific
|
|
952
|
+
* GET: Retrieve a specific credential
|
|
953
|
+
* PUT: Update a specific credential
|
|
954
|
+
* DELETE: Delete a specific credential
|
|
1230
955
|
*
|
|
1231
956
|
* PUT Request Body:
|
|
1232
|
-
* A JSON object containing
|
|
1233
|
-
* - name (str, optional):
|
|
1234
|
-
* -
|
|
1235
|
-
* -
|
|
1236
|
-
* -
|
|
1237
|
-
* -
|
|
1238
|
-
*
|
|
1239
|
-
*
|
|
1240
|
-
*
|
|
1241
|
-
*
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
*
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
* Access Control:
|
|
1279
|
-
* - Requires IsAdminUserOrStudentDRFMixin
|
|
1280
|
-
* - Only authenticated users with appropriate permissions can manage issuers
|
|
1281
|
-
* @returns void
|
|
1282
|
-
* @throws ApiError
|
|
1283
|
-
*/
|
|
1284
|
-
static credentialsOrgsUsersIssuersDestroy({ entityId, platformKey, username, }: {
|
|
1285
|
-
entityId: string;
|
|
957
|
+
* A JSON object containing credential details to update:
|
|
958
|
+
* - name (str, optional): Credential name
|
|
959
|
+
* - description (str, optional): Credential description
|
|
960
|
+
* - credential_type (str, optional): Type of credential
|
|
961
|
+
* - html_template (str, optional): HTML template for credential rendering
|
|
962
|
+
* - css_template (str, optional): CSS template for credential styling
|
|
963
|
+
* - icon_image (str, optional): URL to credential icon
|
|
964
|
+
* - background_image (str, optional): URL to credential background
|
|
965
|
+
* - thumbnail_image (str, optional): URL to credential thumbnail
|
|
966
|
+
* - criteria_url (str, optional): URL to credential criteria
|
|
967
|
+
* - criteria_text (str, optional): Text description of credential criteria
|
|
968
|
+
* - issuing_signal (str, optional): Signal that triggers credential issuance
|
|
969
|
+
*
|
|
970
|
+
* Returns:
|
|
971
|
+
* GET: A JSON response containing:
|
|
972
|
+
* {
|
|
973
|
+
* "status": {"success": true, "description": "Ok"},
|
|
974
|
+
* "result": {credential object}
|
|
975
|
+
* }
|
|
976
|
+
*
|
|
977
|
+
* PUT: A JSON response containing:
|
|
978
|
+
* {
|
|
979
|
+
* "status": {"success": true, "description": "Updated"},
|
|
980
|
+
* "result": {credential object}
|
|
981
|
+
* }
|
|
982
|
+
*
|
|
983
|
+
* DELETE: A JSON response indicating success:
|
|
984
|
+
* {
|
|
985
|
+
* "status": {"success": true, "description": "Deleted"}
|
|
986
|
+
* }
|
|
987
|
+
*
|
|
988
|
+
* Error Responses:
|
|
989
|
+
* 400 Bad Request: If the request data is invalid
|
|
990
|
+
* 401 Unauthorized: If the user is not authenticated
|
|
991
|
+
* 403 Forbidden: If the user does not have permission to access this resource
|
|
992
|
+
* 404 Not Found: If the credential doesn't exist
|
|
993
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
994
|
+
*
|
|
995
|
+
* Access Control:
|
|
996
|
+
* - Requires CredentialAssignmentPermission
|
|
997
|
+
* - Users can only manage credentials they have permission to access
|
|
998
|
+
* @returns void
|
|
999
|
+
* @throws ApiError
|
|
1000
|
+
*/
|
|
1001
|
+
static credentialsOrgsUsersDestroy2({ entityId, platformKey, username, }: {
|
|
1002
|
+
entityId: string;
|
|
1286
1003
|
platformKey: string;
|
|
1287
1004
|
username: string;
|
|
1288
1005
|
}): CancelablePromise<void>;
|
|
1289
1006
|
/**
|
|
1290
|
-
*
|
|
1007
|
+
* @returns PaginatedAssertionsResponse
|
|
1008
|
+
* @throws ApiError
|
|
1009
|
+
*/
|
|
1010
|
+
static credentialsOrgsUsersAssertionsRetrieve6({ entityId, platformKey, username, }: {
|
|
1011
|
+
entityId: string;
|
|
1012
|
+
platformKey: string;
|
|
1013
|
+
username: string;
|
|
1014
|
+
}): CancelablePromise<PaginatedAssertionsResponse>;
|
|
1015
|
+
/**
|
|
1016
|
+
* @returns Assertion
|
|
1017
|
+
* @throws ApiError
|
|
1018
|
+
*/
|
|
1019
|
+
static credentialsOrgsUsersAssertionsCreate2({ entityId, platformKey, username, requestBody, }: {
|
|
1020
|
+
entityId: string;
|
|
1021
|
+
platformKey: string;
|
|
1022
|
+
username: string;
|
|
1023
|
+
requestBody: Assertion;
|
|
1024
|
+
}): CancelablePromise<Assertion>;
|
|
1025
|
+
/**
|
|
1026
|
+
* @returns BulkCreateAssertion
|
|
1027
|
+
* @throws ApiError
|
|
1028
|
+
*/
|
|
1029
|
+
static credentialsOrgsUsersAssertionsBulkCreate2({ entityId, platformKey, username, requestBody, }: {
|
|
1030
|
+
entityId: string;
|
|
1031
|
+
platformKey: string;
|
|
1032
|
+
username: string;
|
|
1033
|
+
requestBody: BulkCreateAssertion;
|
|
1034
|
+
}): CancelablePromise<BulkCreateAssertion>;
|
|
1035
|
+
/**
|
|
1036
|
+
* A GET View that validates QueryParams and returns results to a serializer
|
|
1037
|
+
* @returns PaginatedAssertionsResponse
|
|
1038
|
+
* @throws ApiError
|
|
1039
|
+
*/
|
|
1040
|
+
static credentialsOrgsUsersAssertionsRetrieve4({ platformKey, username, course, excludeMainTenantAssertions, includeExpired, includeRevoked, page, pageSize, }: {
|
|
1041
|
+
platformKey: string;
|
|
1042
|
+
username: string;
|
|
1043
|
+
course?: string;
|
|
1044
|
+
excludeMainTenantAssertions?: boolean;
|
|
1045
|
+
includeExpired?: boolean;
|
|
1046
|
+
includeRevoked?: boolean;
|
|
1047
|
+
page?: number;
|
|
1048
|
+
pageSize?: number;
|
|
1049
|
+
}): CancelablePromise<PaginatedAssertionsResponse>;
|
|
1050
|
+
/**
|
|
1051
|
+
* Get all credentials of a given tenant
|
|
1052
|
+
* @returns OvertimeWithChangeInfo
|
|
1053
|
+
* @throws ApiError
|
|
1054
|
+
*/
|
|
1055
|
+
static credentialsOrgsUsersAssertionsOverTimeRetrieve2({ platformKey, username, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1056
|
+
platformKey: string;
|
|
1057
|
+
username: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1060
|
+
*/
|
|
1061
|
+
departmentId?: number;
|
|
1062
|
+
/**
|
|
1063
|
+
* end date. ISO 8601
|
|
1064
|
+
*/
|
|
1065
|
+
endDate?: string;
|
|
1066
|
+
/**
|
|
1067
|
+
* Format
|
|
1068
|
+
*
|
|
1069
|
+
* * `json` - json
|
|
1070
|
+
*/
|
|
1071
|
+
format?: 'json';
|
|
1072
|
+
/**
|
|
1073
|
+
* Include main platform data
|
|
1074
|
+
*/
|
|
1075
|
+
includeMainPlatform?: boolean;
|
|
1076
|
+
/**
|
|
1077
|
+
* start date. ISO 8601
|
|
1078
|
+
*/
|
|
1079
|
+
startDate?: string;
|
|
1080
|
+
}): CancelablePromise<OvertimeWithChangeInfo>;
|
|
1081
|
+
/**
|
|
1082
|
+
* @returns Assertion
|
|
1083
|
+
* @throws ApiError
|
|
1084
|
+
*/
|
|
1085
|
+
static credentialsOrgsUsersAssertionsRetrieve5({ entityId, platformKey, username, }: {
|
|
1086
|
+
entityId: string;
|
|
1087
|
+
platformKey: string;
|
|
1088
|
+
username: string;
|
|
1089
|
+
}): CancelablePromise<Assertion>;
|
|
1090
|
+
/**
|
|
1091
|
+
* @returns Assertion
|
|
1092
|
+
* @throws ApiError
|
|
1093
|
+
*/
|
|
1094
|
+
static credentialsOrgsUsersAssertionsUpdate2({ entityId, platformKey, username, requestBody, }: {
|
|
1095
|
+
entityId: string;
|
|
1096
|
+
platformKey: string;
|
|
1097
|
+
username: string;
|
|
1098
|
+
requestBody: Assertion;
|
|
1099
|
+
}): CancelablePromise<Assertion>;
|
|
1100
|
+
/**
|
|
1101
|
+
* Delete a credential assignment using its entity_id.
|
|
1102
|
+
* Only platform admins and department admins can delete assignments.
|
|
1103
|
+
* @returns void
|
|
1104
|
+
* @throws ApiError
|
|
1105
|
+
*/
|
|
1106
|
+
static credentialsOrgsUsersAssignmentsDestroy2({ assignmentId, platformKey, username, }: {
|
|
1107
|
+
assignmentId: string;
|
|
1108
|
+
platformKey: string;
|
|
1109
|
+
username: string;
|
|
1110
|
+
}): CancelablePromise<void>;
|
|
1111
|
+
/**
|
|
1112
|
+
* Get group assignments with department-aware filtering
|
|
1113
|
+
* @returns any No response body
|
|
1114
|
+
* @throws ApiError
|
|
1115
|
+
*/
|
|
1116
|
+
static credentialsOrgsUsersAssignmentsGroupsRetrieve2({ platformKey, username, }: {
|
|
1117
|
+
platformKey: string;
|
|
1118
|
+
username: string;
|
|
1119
|
+
}): CancelablePromise<any>;
|
|
1120
|
+
/**
|
|
1121
|
+
* Create group assignment with department access validation
|
|
1122
|
+
* @returns any No response body
|
|
1123
|
+
* @throws ApiError
|
|
1124
|
+
*/
|
|
1125
|
+
static credentialsOrgsUsersAssignmentsGroupsCreate2({ platformKey, username, }: {
|
|
1126
|
+
platformKey: string;
|
|
1127
|
+
username: string;
|
|
1128
|
+
}): CancelablePromise<any>;
|
|
1129
|
+
/**
|
|
1130
|
+
* Get assignments and their corresponding assertions based on user role:
|
|
1131
|
+
* - Regular users: get only their own assignments
|
|
1132
|
+
* - Platform admins: get assignments for all users in their platform
|
|
1133
|
+
* - Department admins: get assignments for users in their department groups
|
|
1134
|
+
* @returns any No response body
|
|
1135
|
+
* @throws ApiError
|
|
1136
|
+
*/
|
|
1137
|
+
static credentialsOrgsUsersAssignmentsUsersRetrieve2({ platformKey, username, }: {
|
|
1138
|
+
platformKey: string;
|
|
1139
|
+
username: string;
|
|
1140
|
+
}): CancelablePromise<any>;
|
|
1141
|
+
/**
|
|
1142
|
+
* Create assignments with department access validation
|
|
1143
|
+
* @returns any No response body
|
|
1144
|
+
* @throws ApiError
|
|
1145
|
+
*/
|
|
1146
|
+
static credentialsOrgsUsersAssignmentsUsersCreate2({ platformKey, username, }: {
|
|
1147
|
+
platformKey: string;
|
|
1148
|
+
username: string;
|
|
1149
|
+
}): CancelablePromise<any>;
|
|
1150
|
+
/**
|
|
1151
|
+
* Get all credentials of a given tenant
|
|
1152
|
+
* @returns OverTime
|
|
1153
|
+
* @throws ApiError
|
|
1154
|
+
*/
|
|
1155
|
+
static credentialsOrgsUsersCourseAssertionsOverTimeRetrieve2({ platformKey, username, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1156
|
+
platformKey: string;
|
|
1157
|
+
username: string;
|
|
1158
|
+
/**
|
|
1159
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1160
|
+
*/
|
|
1161
|
+
departmentId?: number;
|
|
1162
|
+
/**
|
|
1163
|
+
* end date. ISO 8601
|
|
1164
|
+
*/
|
|
1165
|
+
endDate?: string;
|
|
1166
|
+
/**
|
|
1167
|
+
* Format
|
|
1168
|
+
*
|
|
1169
|
+
* * `json` - json
|
|
1170
|
+
*/
|
|
1171
|
+
format?: 'json';
|
|
1172
|
+
/**
|
|
1173
|
+
* Include main platform data
|
|
1174
|
+
*/
|
|
1175
|
+
includeMainPlatform?: boolean;
|
|
1176
|
+
/**
|
|
1177
|
+
* start date. ISO 8601
|
|
1178
|
+
*/
|
|
1179
|
+
startDate?: string;
|
|
1180
|
+
}): CancelablePromise<OverTime>;
|
|
1181
|
+
/**
|
|
1182
|
+
* @returns any No response body
|
|
1183
|
+
* @throws ApiError
|
|
1184
|
+
*/
|
|
1185
|
+
static credentialsOrgsUsersCourseCredentialsList2({ platformKey, username, page, pageSize, }: {
|
|
1186
|
+
platformKey: string;
|
|
1187
|
+
username: string;
|
|
1188
|
+
/**
|
|
1189
|
+
* A page number within the paginated result set.
|
|
1190
|
+
*/
|
|
1191
|
+
page?: number;
|
|
1192
|
+
/**
|
|
1193
|
+
* Number of results to return per page.
|
|
1194
|
+
*/
|
|
1195
|
+
pageSize?: number;
|
|
1196
|
+
}): CancelablePromise<any>;
|
|
1197
|
+
/**
|
|
1198
|
+
* Get all credentials of a given tenant
|
|
1199
|
+
* @returns OverTime
|
|
1200
|
+
* @throws ApiError
|
|
1201
|
+
*/
|
|
1202
|
+
static credentialsOrgsUsersCredentialsOverTimeRetrieve2({ platformKey, username, departmentId, endDate, format, includeMainPlatform, startDate, }: {
|
|
1203
|
+
platformKey: string;
|
|
1204
|
+
username: string;
|
|
1205
|
+
/**
|
|
1206
|
+
* When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
1207
|
+
*/
|
|
1208
|
+
departmentId?: number;
|
|
1209
|
+
/**
|
|
1210
|
+
* end date. ISO 8601
|
|
1211
|
+
*/
|
|
1212
|
+
endDate?: string;
|
|
1213
|
+
/**
|
|
1214
|
+
* Format
|
|
1215
|
+
*
|
|
1216
|
+
* * `json` - json
|
|
1217
|
+
*/
|
|
1218
|
+
format?: 'json';
|
|
1219
|
+
/**
|
|
1220
|
+
* Include main platform data
|
|
1221
|
+
*/
|
|
1222
|
+
includeMainPlatform?: boolean;
|
|
1223
|
+
/**
|
|
1224
|
+
* start date. ISO 8601
|
|
1225
|
+
*/
|
|
1226
|
+
startDate?: string;
|
|
1227
|
+
}): CancelablePromise<OverTime>;
|
|
1228
|
+
/**
|
|
1229
|
+
* Retrieve external credential mappings for the platform.
|
|
1291
1230
|
*
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
1231
|
+
* Query Parameters:
|
|
1232
|
+
* credential_id (str, optional): Filter by credential entity_id
|
|
1233
|
+
* provider_name (str, optional): Filter by provider name
|
|
1234
|
+
* page (int, optional): Page number
|
|
1235
|
+
* page_size (int, optional): Items per page
|
|
1294
1236
|
*
|
|
1295
|
-
*
|
|
1296
|
-
*
|
|
1297
|
-
*
|
|
1237
|
+
* Returns all mappings for the platform if the user is an admin.
|
|
1238
|
+
* @returns ExternalCredentialMapping
|
|
1239
|
+
* @throws ApiError
|
|
1240
|
+
*/
|
|
1241
|
+
static credentialsOrgsUsersExternalMappingRetrieve2({ platformKey, username, }: {
|
|
1242
|
+
platformKey: string;
|
|
1243
|
+
username: string;
|
|
1244
|
+
}): CancelablePromise<ExternalCredentialMapping>;
|
|
1245
|
+
/**
|
|
1246
|
+
* Create or update an external credential mapping.
|
|
1298
1247
|
*
|
|
1299
|
-
*
|
|
1300
|
-
*
|
|
1248
|
+
* If a mapping doesn't exist for the credential + platform + provider combination,
|
|
1249
|
+
* it will be created. If it exists, it will be updated.
|
|
1301
1250
|
*
|
|
1302
|
-
*
|
|
1303
|
-
*
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1251
|
+
* Request Body:
|
|
1252
|
+
* {
|
|
1253
|
+
* "credential_id": "credential-entity-id", // Required
|
|
1254
|
+
* "provider_name": "accredible", // Required
|
|
1255
|
+
* "external_template_id": "123456", // Optional
|
|
1256
|
+
* "metadata": {} // Optional
|
|
1257
|
+
* }
|
|
1258
|
+
*
|
|
1259
|
+
* Returns:
|
|
1260
|
+
* - 201 Created: When creating a new mapping
|
|
1261
|
+
* - 200 OK: When updating an existing mapping
|
|
1262
|
+
* @returns ExternalCredentialMapping
|
|
1263
|
+
* @throws ApiError
|
|
1264
|
+
*/
|
|
1265
|
+
static credentialsOrgsUsersExternalMappingCreate2({ platformKey, username, requestBody, }: {
|
|
1266
|
+
platformKey: string;
|
|
1267
|
+
username: string;
|
|
1268
|
+
requestBody: ExternalCredentialMapping;
|
|
1269
|
+
}): CancelablePromise<ExternalCredentialMapping>;
|
|
1270
|
+
/**
|
|
1271
|
+
* Delete an external credential mapping.
|
|
1310
1272
|
*
|
|
1311
|
-
*
|
|
1312
|
-
* POST: A JSON response containing the created authority:
|
|
1273
|
+
* Request Body:
|
|
1313
1274
|
* {
|
|
1314
|
-
* "
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1275
|
+
* "credential_id": "credential-entity-id", // Required
|
|
1276
|
+
* "provider_name": "accredible" // Required
|
|
1277
|
+
* }
|
|
1278
|
+
*
|
|
1279
|
+
* Returns:
|
|
1280
|
+
* A JSON response confirming deletion
|
|
1281
|
+
* @returns void
|
|
1282
|
+
* @throws ApiError
|
|
1283
|
+
*/
|
|
1284
|
+
static credentialsOrgsUsersExternalMappingDestroy2({ platformKey, username, }: {
|
|
1285
|
+
platformKey: string;
|
|
1286
|
+
username: string;
|
|
1287
|
+
}): CancelablePromise<void>;
|
|
1288
|
+
/**
|
|
1289
|
+
* @returns UploadedImage
|
|
1290
|
+
* @throws ApiError
|
|
1291
|
+
*/
|
|
1292
|
+
static credentialsOrgsUsersImagesRetrieve2({ platformKey, username, }: {
|
|
1293
|
+
platformKey: string;
|
|
1294
|
+
username: string;
|
|
1295
|
+
}): CancelablePromise<UploadedImage>;
|
|
1296
|
+
/**
|
|
1297
|
+
* @returns UploadedImage
|
|
1298
|
+
* @throws ApiError
|
|
1299
|
+
*/
|
|
1300
|
+
static credentialsOrgsUsersImagesCreate2({ platformKey, username, requestBody, }: {
|
|
1301
|
+
platformKey: string;
|
|
1302
|
+
username: string;
|
|
1303
|
+
requestBody?: UploadedImage;
|
|
1304
|
+
}): CancelablePromise<UploadedImage>;
|
|
1305
|
+
/**
|
|
1306
|
+
* A GET View that validates QueryParams and returns results to a serializer
|
|
1307
|
+
* @returns Issuer
|
|
1308
|
+
* @throws ApiError
|
|
1309
|
+
*/
|
|
1310
|
+
static credentialsOrgsUsersIssuersRetrieve3({ platformKey, q, username, }: {
|
|
1311
|
+
platformKey: string;
|
|
1312
|
+
q: string;
|
|
1313
|
+
username: string;
|
|
1314
|
+
}): CancelablePromise<Issuer>;
|
|
1315
|
+
/**
|
|
1316
|
+
* A GET View that validates QueryParams and returns results to a serializer
|
|
1317
|
+
* @returns Issuer
|
|
1318
|
+
* @throws ApiError
|
|
1319
|
+
*/
|
|
1320
|
+
static credentialsOrgsUsersIssuersCreate2({ platformKey, q, username, requestBody, }: {
|
|
1321
|
+
platformKey: string;
|
|
1322
|
+
q: string;
|
|
1323
|
+
username: string;
|
|
1324
|
+
requestBody: Issuer;
|
|
1325
|
+
}): CancelablePromise<Issuer>;
|
|
1326
|
+
/**
|
|
1327
|
+
* @returns Issuer
|
|
1328
|
+
* @throws ApiError
|
|
1329
|
+
*/
|
|
1330
|
+
static credentialsOrgsUsersIssuersRetrieve4({ entityId, platformKey, username, }: {
|
|
1331
|
+
entityId: string;
|
|
1332
|
+
platformKey: string;
|
|
1333
|
+
username: string;
|
|
1334
|
+
}): CancelablePromise<Issuer>;
|
|
1335
|
+
/**
|
|
1336
|
+
* @returns Issuer
|
|
1337
|
+
* @throws ApiError
|
|
1338
|
+
*/
|
|
1339
|
+
static credentialsOrgsUsersIssuersUpdate2({ entityId, platformKey, username, requestBody, }: {
|
|
1340
|
+
entityId: string;
|
|
1341
|
+
platformKey: string;
|
|
1342
|
+
username: string;
|
|
1343
|
+
requestBody: Issuer;
|
|
1344
|
+
}): CancelablePromise<Issuer>;
|
|
1345
|
+
/**
|
|
1346
|
+
* @returns void
|
|
1347
|
+
* @throws ApiError
|
|
1348
|
+
*/
|
|
1349
|
+
static credentialsOrgsUsersIssuersDestroy2({ entityId, platformKey, username, }: {
|
|
1350
|
+
entityId: string;
|
|
1351
|
+
platformKey: string;
|
|
1352
|
+
username: string;
|
|
1353
|
+
}): CancelablePromise<void>;
|
|
1354
|
+
/**
|
|
1355
|
+
* @returns IssuerAuthority
|
|
1356
|
+
* @throws ApiError
|
|
1357
|
+
*/
|
|
1358
|
+
static credentialsOrgsUsersIssuersAuthorityCreate2({ platformKey, username, requestBody, }: {
|
|
1335
1359
|
platformKey: string;
|
|
1336
1360
|
username: string;
|
|
1337
1361
|
requestBody: IssuerAuthority;
|
|
@@ -1348,7 +1372,7 @@ export declare class CredentialsService {
|
|
|
1348
1372
|
* @returns CredentialProviderConfig
|
|
1349
1373
|
* @throws ApiError
|
|
1350
1374
|
*/
|
|
1351
|
-
static
|
|
1375
|
+
static credentialsOrgsUsersProviderConfigRetrieve2({ platformKey, username, }: {
|
|
1352
1376
|
platformKey: string;
|
|
1353
1377
|
username: string;
|
|
1354
1378
|
}): CancelablePromise<CredentialProviderConfig>;
|
|
@@ -1371,7 +1395,7 @@ export declare class CredentialsService {
|
|
|
1371
1395
|
* @returns CredentialProviderConfig
|
|
1372
1396
|
* @throws ApiError
|
|
1373
1397
|
*/
|
|
1374
|
-
static
|
|
1398
|
+
static credentialsOrgsUsersProviderConfigCreate2({ platformKey, username, requestBody, }: {
|
|
1375
1399
|
platformKey: string;
|
|
1376
1400
|
username: string;
|
|
1377
1401
|
requestBody: CredentialProviderConfig;
|
|
@@ -1386,7 +1410,7 @@ export declare class CredentialsService {
|
|
|
1386
1410
|
* @returns void
|
|
1387
1411
|
* @throws ApiError
|
|
1388
1412
|
*/
|
|
1389
|
-
static
|
|
1413
|
+
static credentialsOrgsUsersProviderConfigDestroy2({ platformKey, username, }: {
|
|
1390
1414
|
platformKey: string;
|
|
1391
1415
|
username: string;
|
|
1392
1416
|
}): CancelablePromise<void>;
|