@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 CHANGED
@@ -110,7 +110,7 @@ class CancelablePromise {
110
110
 
111
111
  const OpenAPI = {
112
112
  BASE: 'https://base.manager.iblai.app',
113
- VERSION: '4.118.3-core',
113
+ VERSION: '4.118.4-core',
114
114
  WITH_CREDENTIALS: false,
115
115
  CREDENTIALS: 'include',
116
116
  TOKEN: undefined,
@@ -15392,14 +15392,14 @@ class CredentialsService {
15392
15392
  */
15393
15393
  static credentialsOrgsUsersRetrieve({
15394
15394
  platformKey,
15395
- username
15395
+ userId
15396
15396
  }) {
15397
15397
  return request(OpenAPI, {
15398
15398
  method: 'GET',
15399
- url: '/api/credentials/orgs/{platform_key}/users/{username}/',
15399
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/',
15400
15400
  path: {
15401
15401
  'platform_key': platformKey,
15402
- 'username': username
15402
+ 'user_id': userId
15403
15403
  }
15404
15404
  });
15405
15405
  }
@@ -15485,15 +15485,15 @@ class CredentialsService {
15485
15485
  */
15486
15486
  static credentialsOrgsUsersCreate({
15487
15487
  platformKey,
15488
- username,
15488
+ userId,
15489
15489
  requestBody
15490
15490
  }) {
15491
15491
  return request(OpenAPI, {
15492
15492
  method: 'POST',
15493
- url: '/api/credentials/orgs/{platform_key}/users/{username}/',
15493
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/',
15494
15494
  path: {
15495
15495
  'platform_key': platformKey,
15496
- 'username': username
15496
+ 'user_id': userId
15497
15497
  },
15498
15498
  body: requestBody,
15499
15499
  mediaType: 'application/json'
@@ -15542,33 +15542,36 @@ class CredentialsService {
15542
15542
  * "result": {credential object}
15543
15543
  * }
15544
15544
  *
15545
- * DELETE: No content (204)
15546
- *
15547
- * Error Responses:
15548
- * 400 Bad Request: If the request data is invalid
15549
- * 401 Unauthorized: If the user is not authenticated
15550
- * 403 Forbidden: If the user does not have permission to access this resource
15551
- * 404 Not Found: If the credential doesn't exist
15552
- * 500 Internal Server Error: If an unexpected error occurs
15553
- *
15554
- * Access Control:
15555
- * - Requires CredentialAssignmentPermission
15556
- * - Users can only manage credentials they have permission to access
15557
- * @returns Credential
15558
- * @throws ApiError
15559
- */
15545
+ * DELETE: A JSON response indicating success:
15546
+ * {
15547
+ * "status": {"success": true, "description": "Deleted"}
15548
+ * }
15549
+ *
15550
+ * Error Responses:
15551
+ * 400 Bad Request: If the request data is invalid
15552
+ * 401 Unauthorized: If the user is not authenticated
15553
+ * 403 Forbidden: If the user does not have permission to access this resource
15554
+ * 404 Not Found: If the credential doesn't exist
15555
+ * 500 Internal Server Error: If an unexpected error occurs
15556
+ *
15557
+ * Access Control:
15558
+ * - Requires CredentialAssignmentPermission
15559
+ * - Users can only manage credentials they have permission to access
15560
+ * @returns Credential
15561
+ * @throws ApiError
15562
+ */
15560
15563
  static credentialsOrgsUsersRetrieve2({
15561
15564
  entityId,
15562
15565
  platformKey,
15563
- username
15566
+ userId
15564
15567
  }) {
15565
15568
  return request(OpenAPI, {
15566
15569
  method: 'GET',
15567
- url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}',
15570
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/{entity_id}',
15568
15571
  path: {
15569
15572
  'entity_id': entityId,
15570
15573
  'platform_key': platformKey,
15571
- 'username': username
15574
+ 'user_id': userId
15572
15575
  }
15573
15576
  });
15574
15577
  }
@@ -15615,34 +15618,37 @@ class CredentialsService {
15615
15618
  * "result": {credential object}
15616
15619
  * }
15617
15620
  *
15618
- * DELETE: No content (204)
15619
- *
15620
- * Error Responses:
15621
- * 400 Bad Request: If the request data is invalid
15622
- * 401 Unauthorized: If the user is not authenticated
15623
- * 403 Forbidden: If the user does not have permission to access this resource
15624
- * 404 Not Found: If the credential doesn't exist
15625
- * 500 Internal Server Error: If an unexpected error occurs
15626
- *
15627
- * Access Control:
15628
- * - Requires CredentialAssignmentPermission
15629
- * - Users can only manage credentials they have permission to access
15630
- * @returns Credential
15631
- * @throws ApiError
15632
- */
15621
+ * DELETE: A JSON response indicating success:
15622
+ * {
15623
+ * "status": {"success": true, "description": "Deleted"}
15624
+ * }
15625
+ *
15626
+ * Error Responses:
15627
+ * 400 Bad Request: If the request data is invalid
15628
+ * 401 Unauthorized: If the user is not authenticated
15629
+ * 403 Forbidden: If the user does not have permission to access this resource
15630
+ * 404 Not Found: If the credential doesn't exist
15631
+ * 500 Internal Server Error: If an unexpected error occurs
15632
+ *
15633
+ * Access Control:
15634
+ * - Requires CredentialAssignmentPermission
15635
+ * - Users can only manage credentials they have permission to access
15636
+ * @returns Credential
15637
+ * @throws ApiError
15638
+ */
15633
15639
  static credentialsOrgsUsersUpdate({
15634
15640
  entityId,
15635
15641
  platformKey,
15636
- username,
15642
+ userId,
15637
15643
  requestBody
15638
15644
  }) {
15639
15645
  return request(OpenAPI, {
15640
15646
  method: 'PUT',
15641
- url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}',
15647
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/{entity_id}',
15642
15648
  path: {
15643
15649
  'entity_id': entityId,
15644
15650
  'platform_key': platformKey,
15645
- 'username': username
15651
+ 'user_id': userId
15646
15652
  },
15647
15653
  body: requestBody,
15648
15654
  mediaType: 'application/json'
@@ -15691,212 +15697,110 @@ class CredentialsService {
15691
15697
  * "result": {credential object}
15692
15698
  * }
15693
15699
  *
15694
- * DELETE: No content (204)
15695
- *
15696
- * Error Responses:
15697
- * 400 Bad Request: If the request data is invalid
15698
- * 401 Unauthorized: If the user is not authenticated
15699
- * 403 Forbidden: If the user does not have permission to access this resource
15700
- * 404 Not Found: If the credential doesn't exist
15701
- * 500 Internal Server Error: If an unexpected error occurs
15702
- *
15703
- * Access Control:
15704
- * - Requires CredentialAssignmentPermission
15705
- * - Users can only manage credentials they have permission to access
15706
- * @returns void
15707
- * @throws ApiError
15708
- */
15700
+ * DELETE: A JSON response indicating success:
15701
+ * {
15702
+ * "status": {"success": true, "description": "Deleted"}
15703
+ * }
15704
+ *
15705
+ * Error Responses:
15706
+ * 400 Bad Request: If the request data is invalid
15707
+ * 401 Unauthorized: If the user is not authenticated
15708
+ * 403 Forbidden: If the user does not have permission to access this resource
15709
+ * 404 Not Found: If the credential doesn't exist
15710
+ * 500 Internal Server Error: If an unexpected error occurs
15711
+ *
15712
+ * Access Control:
15713
+ * - Requires CredentialAssignmentPermission
15714
+ * - Users can only manage credentials they have permission to access
15715
+ * @returns void
15716
+ * @throws ApiError
15717
+ */
15709
15718
  static credentialsOrgsUsersDestroy({
15710
15719
  entityId,
15711
15720
  platformKey,
15712
- username
15721
+ userId
15713
15722
  }) {
15714
15723
  return request(OpenAPI, {
15715
15724
  method: 'DELETE',
15716
- url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}',
15725
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/{entity_id}',
15717
15726
  path: {
15718
15727
  'entity_id': entityId,
15719
15728
  'platform_key': platformKey,
15720
- 'username': username
15729
+ 'user_id': userId
15721
15730
  }
15722
15731
  });
15723
15732
  }
15724
15733
  /**
15725
- * Endpoint to issue and retrieve credential assertions for a specific credential.
15726
- *
15727
- * This endpoint allows issuing new credential assertions and retrieving existing
15728
- * assertions for a specific credential.
15729
- *
15730
- * Path Parameters:
15731
- * org (str): The organization/tenant identifier
15732
- * user_id (str): The user ID making the request
15733
- * entity_id (str): The credential entity ID
15734
- *
15735
- * Methods:
15736
- * POST: Issue a new credential assertion
15737
- * GET: Retrieve assertions for a specific credential
15738
- *
15739
- * POST Request Body:
15740
- * A JSON object containing recipient information and any additional metadata
15741
- * required for issuing the credential.
15742
- *
15743
- * Returns:
15744
- * POST: A JSON response containing the created assertion using the AssertionSerializer format
15745
- * GET: A paginated list of assertions using the AssertionSerializer format
15746
- *
15747
- * Error Responses:
15748
- * 400 Bad Request: If the request data is invalid
15749
- * 401 Unauthorized: If the user is not authenticated
15750
- * 403 Forbidden: If the user does not have permission to access this resource
15751
- * 404 Not Found: If the credential doesn't exist
15752
- * 500 Internal Server Error: If an unexpected error occurs
15753
15734
  * @returns PaginatedAssertionsResponse
15754
15735
  * @throws ApiError
15755
15736
  */
15756
15737
  static credentialsOrgsUsersAssertionsRetrieve3({
15757
15738
  entityId,
15758
15739
  platformKey,
15759
- username
15740
+ userId
15760
15741
  }) {
15761
15742
  return request(OpenAPI, {
15762
15743
  method: 'GET',
15763
- url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}/assertions/',
15744
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/{entity_id}/assertions/',
15764
15745
  path: {
15765
15746
  'entity_id': entityId,
15766
15747
  'platform_key': platformKey,
15767
- 'username': username
15748
+ 'user_id': userId
15768
15749
  }
15769
15750
  });
15770
15751
  }
15771
15752
  /**
15772
- * Endpoint to issue and retrieve credential assertions for a specific credential.
15773
- *
15774
- * This endpoint allows issuing new credential assertions and retrieving existing
15775
- * assertions for a specific credential.
15776
- *
15777
- * Path Parameters:
15778
- * org (str): The organization/tenant identifier
15779
- * user_id (str): The user ID making the request
15780
- * entity_id (str): The credential entity ID
15781
- *
15782
- * Methods:
15783
- * POST: Issue a new credential assertion
15784
- * GET: Retrieve assertions for a specific credential
15785
- *
15786
- * POST Request Body:
15787
- * A JSON object containing recipient information and any additional metadata
15788
- * required for issuing the credential.
15789
- *
15790
- * Returns:
15791
- * POST: A JSON response containing the created assertion using the AssertionSerializer format
15792
- * GET: A paginated list of assertions using the AssertionSerializer format
15793
- *
15794
- * Error Responses:
15795
- * 400 Bad Request: If the request data is invalid
15796
- * 401 Unauthorized: If the user is not authenticated
15797
- * 403 Forbidden: If the user does not have permission to access this resource
15798
- * 404 Not Found: If the credential doesn't exist
15799
- * 500 Internal Server Error: If an unexpected error occurs
15800
15753
  * @returns Assertion
15801
15754
  * @throws ApiError
15802
15755
  */
15803
15756
  static credentialsOrgsUsersAssertionsCreate({
15804
15757
  entityId,
15805
15758
  platformKey,
15806
- username,
15759
+ userId,
15807
15760
  requestBody
15808
15761
  }) {
15809
15762
  return request(OpenAPI, {
15810
15763
  method: 'POST',
15811
- url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}/assertions/',
15764
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/{entity_id}/assertions/',
15812
15765
  path: {
15813
15766
  'entity_id': entityId,
15814
15767
  'platform_key': platformKey,
15815
- 'username': username
15768
+ 'user_id': userId
15816
15769
  },
15817
15770
  body: requestBody,
15818
15771
  mediaType: 'application/json'
15819
15772
  });
15820
15773
  }
15821
15774
  /**
15822
- * Endpoint to issue credential assertions in bulk for a specific credential.
15823
- *
15824
- * This endpoint allows issuing credential assertions to multiple users at once.
15825
- *
15826
- * Path Parameters:
15827
- * org (str): The organization/tenant identifier
15828
- * user_id (str): The user ID making the request
15829
- * entity_id (str): The credential entity ID
15830
- *
15831
- * POST Request Body:
15832
- * A JSON object containing:
15833
- * - users (list): List of usernames to issue the credential to
15834
- * - Additional metadata required for issuing the credential
15835
- *
15836
- * Returns:
15837
- * A JSON response containing:
15838
- * {
15839
- * "skipped": ["username1", "username3"], // Users that were skipped (e.g., already have the credential)
15840
- * "issued": ["username2", "username4"] // Users that were successfully issued the credential
15841
- * }
15842
- *
15843
- * Error Responses:
15844
- * 400 Bad Request: If the request data is invalid or missing required fields
15845
- * 401 Unauthorized: If the user is not authenticated
15846
- * 403 Forbidden: If the user does not have permission to access this resource
15847
- * 404 Not Found: If the credential doesn't exist
15848
- * 500 Internal Server Error: If an unexpected error occurs
15849
- * @returns BulkCreateAssertion
15850
- * @throws ApiError
15851
- */
15775
+ * @returns BulkCreateAssertion
15776
+ * @throws ApiError
15777
+ */
15852
15778
  static credentialsOrgsUsersAssertionsBulkCreate({
15853
15779
  entityId,
15854
15780
  platformKey,
15855
- username,
15781
+ userId,
15856
15782
  requestBody
15857
15783
  }) {
15858
15784
  return request(OpenAPI, {
15859
15785
  method: 'POST',
15860
- url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}/assertions/bulk/',
15786
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/{entity_id}/assertions/bulk/',
15861
15787
  path: {
15862
15788
  'entity_id': entityId,
15863
15789
  'platform_key': platformKey,
15864
- 'username': username
15790
+ 'user_id': userId
15865
15791
  },
15866
15792
  body: requestBody,
15867
15793
  mediaType: 'application/json'
15868
15794
  });
15869
15795
  }
15870
15796
  /**
15871
- * Endpoint to retrieve all credential assertions for a user within an organization.
15872
- *
15873
- * This endpoint provides access to all credential assertions (issued credentials)
15874
- * for a specific user within an organization, with support for filtering.
15875
- *
15876
- * Path Parameters:
15877
- * org (str): The organization/tenant identifier
15878
- * user_id (str): The user ID to retrieve assertions for
15879
- *
15880
- * Query Parameters:
15881
- * course (str, optional): Filter by course ID
15882
- * include_revoked (bool, optional): Include revoked assertions (default: false)
15883
- * include_expired (bool, optional): Include expired assertions (default: false)
15884
- * exclude_main_tenant_assertions (bool, optional): Exclude assertions from the main tenant (default: false)
15885
- *
15886
- * Returns:
15887
- * A paginated response using the AssertionSerializer format
15888
- *
15889
- * Error Responses:
15890
- * 401 Unauthorized: If the user is not authenticated
15891
- * 403 Forbidden: If the user does not have permission to access this resource
15892
- * 404 Not Found: If the user or organization doesn't exist
15893
- * 500 Internal Server Error: If an unexpected error occurs
15797
+ * A GET View that validates QueryParams and returns results to a serializer
15894
15798
  * @returns PaginatedAssertionsResponse
15895
15799
  * @throws ApiError
15896
15800
  */
15897
15801
  static credentialsOrgsUsersAssertionsRetrieve({
15898
15802
  platformKey,
15899
- username,
15803
+ userId,
15900
15804
  course,
15901
15805
  excludeMainTenantAssertions,
15902
15806
  includeExpired,
@@ -15906,10 +15810,10 @@ class CredentialsService {
15906
15810
  }) {
15907
15811
  return request(OpenAPI, {
15908
15812
  method: 'GET',
15909
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assertions/',
15813
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assertions/',
15910
15814
  path: {
15911
15815
  'platform_key': platformKey,
15912
- 'username': username
15816
+ 'user_id': userId
15913
15817
  },
15914
15818
  query: {
15915
15819
  'course': course,
@@ -15928,7 +15832,7 @@ class CredentialsService {
15928
15832
  */
15929
15833
  static credentialsOrgsUsersAssertionsOverTimeRetrieve({
15930
15834
  platformKey,
15931
- username,
15835
+ userId,
15932
15836
  departmentId,
15933
15837
  endDate,
15934
15838
  format = 'json',
@@ -15937,10 +15841,10 @@ class CredentialsService {
15937
15841
  }) {
15938
15842
  return request(OpenAPI, {
15939
15843
  method: 'GET',
15940
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assertions-over-time/',
15844
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assertions-over-time/',
15941
15845
  path: {
15942
15846
  'platform_key': platformKey,
15943
- 'username': username
15847
+ 'user_id': userId
15944
15848
  },
15945
15849
  query: {
15946
15850
  'department_id': departmentId,
@@ -15952,99 +15856,41 @@ class CredentialsService {
15952
15856
  });
15953
15857
  }
15954
15858
  /**
15955
- * Endpoint to retrieve and update a specific credential assertion.
15956
- *
15957
- * This endpoint allows retrieving details of a specific credential assertion
15958
- * and updating its status (e.g., revoking it).
15959
- *
15960
- * Path Parameters:
15961
- * org (str): The organization/tenant identifier
15962
- * user_id (str): The user ID making the request
15963
- * entity_id (str): The assertion entity ID
15964
- *
15965
- * Methods:
15966
- * GET: Retrieve assertion details
15967
- * PUT: Update assertion status (e.g., revoke)
15968
- *
15969
- * PUT Request Body:
15970
- * A JSON object containing:
15971
- * - revoked (bool): Set to true to revoke the assertion
15972
- * - revocationReason (str): Reason for revocation (required when revoking)
15973
- *
15974
- * Returns:
15975
- * GET: A JSON response containing the assertion details using the AssertionSerializer format
15976
- * PUT: A JSON response containing the updated assertion using the AssertionSerializer format
15977
- *
15978
- * Error Responses:
15979
- * 400 Bad Request: If the request data is invalid
15980
- * 401 Unauthorized: If the user is not authenticated
15981
- * 403 Forbidden: If the user does not have permission to access this resource
15982
- * 404 Not Found: If the assertion doesn't exist
15983
- * 500 Internal Server Error: If an unexpected error occurs
15984
15859
  * @returns Assertion
15985
15860
  * @throws ApiError
15986
15861
  */
15987
15862
  static credentialsOrgsUsersAssertionsRetrieve2({
15988
15863
  entityId,
15989
15864
  platformKey,
15990
- username
15865
+ userId
15991
15866
  }) {
15992
15867
  return request(OpenAPI, {
15993
15868
  method: 'GET',
15994
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assertions/{entity_id}',
15869
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assertions/{entity_id}',
15995
15870
  path: {
15996
15871
  'entity_id': entityId,
15997
15872
  'platform_key': platformKey,
15998
- 'username': username
15873
+ 'user_id': userId
15999
15874
  }
16000
15875
  });
16001
15876
  }
16002
15877
  /**
16003
- * Endpoint to retrieve and update a specific credential assertion.
16004
- *
16005
- * This endpoint allows retrieving details of a specific credential assertion
16006
- * and updating its status (e.g., revoking it).
16007
- *
16008
- * Path Parameters:
16009
- * org (str): The organization/tenant identifier
16010
- * user_id (str): The user ID making the request
16011
- * entity_id (str): The assertion entity ID
16012
- *
16013
- * Methods:
16014
- * GET: Retrieve assertion details
16015
- * PUT: Update assertion status (e.g., revoke)
16016
- *
16017
- * PUT Request Body:
16018
- * A JSON object containing:
16019
- * - revoked (bool): Set to true to revoke the assertion
16020
- * - revocationReason (str): Reason for revocation (required when revoking)
16021
- *
16022
- * Returns:
16023
- * GET: A JSON response containing the assertion details using the AssertionSerializer format
16024
- * PUT: A JSON response containing the updated assertion using the AssertionSerializer format
16025
- *
16026
- * Error Responses:
16027
- * 400 Bad Request: If the request data is invalid
16028
- * 401 Unauthorized: If the user is not authenticated
16029
- * 403 Forbidden: If the user does not have permission to access this resource
16030
- * 404 Not Found: If the assertion doesn't exist
16031
- * 500 Internal Server Error: If an unexpected error occurs
16032
15878
  * @returns Assertion
16033
15879
  * @throws ApiError
16034
15880
  */
16035
15881
  static credentialsOrgsUsersAssertionsUpdate({
16036
15882
  entityId,
16037
15883
  platformKey,
16038
- username,
15884
+ userId,
16039
15885
  requestBody
16040
15886
  }) {
16041
15887
  return request(OpenAPI, {
16042
15888
  method: 'PUT',
16043
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assertions/{entity_id}',
15889
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assertions/{entity_id}',
16044
15890
  path: {
16045
15891
  'entity_id': entityId,
16046
15892
  'platform_key': platformKey,
16047
- 'username': username
15893
+ 'user_id': userId
16048
15894
  },
16049
15895
  body: requestBody,
16050
15896
  mediaType: 'application/json'
@@ -16059,15 +15905,15 @@ class CredentialsService {
16059
15905
  static credentialsOrgsUsersAssignmentsDestroy({
16060
15906
  assignmentId,
16061
15907
  platformKey,
16062
- username
15908
+ userId
16063
15909
  }) {
16064
15910
  return request(OpenAPI, {
16065
15911
  method: 'DELETE',
16066
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/{assignment_id}',
15912
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assignments/{assignment_id}',
16067
15913
  path: {
16068
15914
  'assignment_id': assignmentId,
16069
15915
  'platform_key': platformKey,
16070
- 'username': username
15916
+ 'user_id': userId
16071
15917
  }
16072
15918
  });
16073
15919
  }
@@ -16078,14 +15924,14 @@ class CredentialsService {
16078
15924
  */
16079
15925
  static credentialsOrgsUsersAssignmentsGroupsRetrieve({
16080
15926
  platformKey,
16081
- username
15927
+ userId
16082
15928
  }) {
16083
15929
  return request(OpenAPI, {
16084
15930
  method: 'GET',
16085
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/groups/',
15931
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assignments/groups/',
16086
15932
  path: {
16087
15933
  'platform_key': platformKey,
16088
- 'username': username
15934
+ 'user_id': userId
16089
15935
  }
16090
15936
  });
16091
15937
  }
@@ -16096,14 +15942,14 @@ class CredentialsService {
16096
15942
  */
16097
15943
  static credentialsOrgsUsersAssignmentsGroupsCreate({
16098
15944
  platformKey,
16099
- username
15945
+ userId
16100
15946
  }) {
16101
15947
  return request(OpenAPI, {
16102
15948
  method: 'POST',
16103
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/groups/',
15949
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assignments/groups/',
16104
15950
  path: {
16105
15951
  'platform_key': platformKey,
16106
- 'username': username
15952
+ 'user_id': userId
16107
15953
  }
16108
15954
  });
16109
15955
  }
@@ -16117,14 +15963,14 @@ class CredentialsService {
16117
15963
  */
16118
15964
  static credentialsOrgsUsersAssignmentsUsersRetrieve({
16119
15965
  platformKey,
16120
- username
15966
+ userId
16121
15967
  }) {
16122
15968
  return request(OpenAPI, {
16123
15969
  method: 'GET',
16124
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/users/',
15970
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assignments/users/',
16125
15971
  path: {
16126
15972
  'platform_key': platformKey,
16127
- 'username': username
15973
+ 'user_id': userId
16128
15974
  }
16129
15975
  });
16130
15976
  }
@@ -16135,14 +15981,14 @@ class CredentialsService {
16135
15981
  */
16136
15982
  static credentialsOrgsUsersAssignmentsUsersCreate({
16137
15983
  platformKey,
16138
- username
15984
+ userId
16139
15985
  }) {
16140
15986
  return request(OpenAPI, {
16141
15987
  method: 'POST',
16142
- url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/users/',
15988
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/assignments/users/',
16143
15989
  path: {
16144
15990
  'platform_key': platformKey,
16145
- 'username': username
15991
+ 'user_id': userId
16146
15992
  }
16147
15993
  });
16148
15994
  }
@@ -16153,7 +15999,7 @@ class CredentialsService {
16153
15999
  */
16154
16000
  static credentialsOrgsUsersCourseAssertionsOverTimeRetrieve({
16155
16001
  platformKey,
16156
- username,
16002
+ userId,
16157
16003
  departmentId,
16158
16004
  endDate,
16159
16005
  format = 'json',
@@ -16162,10 +16008,10 @@ class CredentialsService {
16162
16008
  }) {
16163
16009
  return request(OpenAPI, {
16164
16010
  method: 'GET',
16165
- url: '/api/credentials/orgs/{platform_key}/users/{username}/course-assertions-over-time/',
16011
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/course-assertions-over-time/',
16166
16012
  path: {
16167
16013
  'platform_key': platformKey,
16168
- 'username': username
16014
+ 'user_id': userId
16169
16015
  },
16170
16016
  query: {
16171
16017
  'department_id': departmentId,
@@ -16177,42 +16023,21 @@ class CredentialsService {
16177
16023
  });
16178
16024
  }
16179
16025
  /**
16180
- * Endpoint to retrieve the credentials of a given tenant grouped by course.
16181
- *
16182
- * This endpoint provides access to credential data grouped by course for a specific
16183
- * organization/tenant, with support for pagination and filtering.
16184
- *
16185
- * Path Parameters:
16186
- * org (str): The organization/tenant identifier
16187
- *
16188
- * Query Parameters:
16189
- * limit (int, optional): Number of results per page (default: 10)
16190
- * offset (int, optional): Starting position for pagination
16191
- * search (str, optional): Search term e.g course_id
16192
- *
16193
- * Returns:
16194
- * A paginated response using the CourseCredentialSerializer format.
16195
- *
16196
- * Error Responses:
16197
- * 401 Unauthorized: If the user is not authenticated
16198
- * 403 Forbidden: If the user does not have permission to access this data
16199
- * 404 Not Found: If the organization doesn't exist
16200
- * 500 Internal Server Error: If an unexpected error occurs
16201
16026
  * @returns any No response body
16202
16027
  * @throws ApiError
16203
16028
  */
16204
16029
  static credentialsOrgsUsersCourseCredentialsList({
16205
16030
  platformKey,
16206
- username,
16031
+ userId,
16207
16032
  page,
16208
16033
  pageSize
16209
16034
  }) {
16210
16035
  return request(OpenAPI, {
16211
16036
  method: 'GET',
16212
- url: '/api/credentials/orgs/{platform_key}/users/{username}/course-credentials/',
16037
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/course-credentials/',
16213
16038
  path: {
16214
16039
  'platform_key': platformKey,
16215
- 'username': username
16040
+ 'user_id': userId
16216
16041
  },
16217
16042
  query: {
16218
16043
  'page': page,
@@ -16227,7 +16052,7 @@ class CredentialsService {
16227
16052
  */
16228
16053
  static credentialsOrgsUsersCredentialsOverTimeRetrieve({
16229
16054
  platformKey,
16230
- username,
16055
+ userId,
16231
16056
  departmentId,
16232
16057
  endDate,
16233
16058
  format = 'json',
@@ -16236,10 +16061,10 @@ class CredentialsService {
16236
16061
  }) {
16237
16062
  return request(OpenAPI, {
16238
16063
  method: 'GET',
16239
- url: '/api/credentials/orgs/{platform_key}/users/{username}/credentials-over-time/',
16064
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/credentials-over-time/',
16240
16065
  path: {
16241
16066
  'platform_key': platformKey,
16242
- 'username': username
16067
+ 'user_id': userId
16243
16068
  },
16244
16069
  query: {
16245
16070
  'department_id': departmentId,
@@ -16265,14 +16090,14 @@ class CredentialsService {
16265
16090
  */
16266
16091
  static credentialsOrgsUsersExternalMappingRetrieve({
16267
16092
  platformKey,
16268
- username
16093
+ userId
16269
16094
  }) {
16270
16095
  return request(OpenAPI, {
16271
16096
  method: 'GET',
16272
- url: '/api/credentials/orgs/{platform_key}/users/{username}/external-mapping/',
16097
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/external-mapping/',
16273
16098
  path: {
16274
16099
  'platform_key': platformKey,
16275
- 'username': username
16100
+ 'user_id': userId
16276
16101
  }
16277
16102
  });
16278
16103
  }
@@ -16298,12 +16123,1046 @@ class CredentialsService {
16298
16123
  */
16299
16124
  static credentialsOrgsUsersExternalMappingCreate({
16300
16125
  platformKey,
16301
- username,
16126
+ userId,
16302
16127
  requestBody
16303
16128
  }) {
16304
16129
  return request(OpenAPI, {
16305
16130
  method: 'POST',
16306
- url: '/api/credentials/orgs/{platform_key}/users/{username}/external-mapping/',
16131
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/external-mapping/',
16132
+ path: {
16133
+ 'platform_key': platformKey,
16134
+ 'user_id': userId
16135
+ },
16136
+ body: requestBody,
16137
+ mediaType: 'application/json'
16138
+ });
16139
+ }
16140
+ /**
16141
+ * Delete an external credential mapping.
16142
+ *
16143
+ * Request Body:
16144
+ * {
16145
+ * "credential_id": "credential-entity-id", // Required
16146
+ * "provider_name": "accredible" // Required
16147
+ * }
16148
+ *
16149
+ * Returns:
16150
+ * A JSON response confirming deletion
16151
+ * @returns void
16152
+ * @throws ApiError
16153
+ */
16154
+ static credentialsOrgsUsersExternalMappingDestroy({
16155
+ platformKey,
16156
+ userId
16157
+ }) {
16158
+ return request(OpenAPI, {
16159
+ method: 'DELETE',
16160
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/external-mapping/',
16161
+ path: {
16162
+ 'platform_key': platformKey,
16163
+ 'user_id': userId
16164
+ }
16165
+ });
16166
+ }
16167
+ /**
16168
+ * @returns UploadedImage
16169
+ * @throws ApiError
16170
+ */
16171
+ static credentialsOrgsUsersImagesRetrieve({
16172
+ platformKey,
16173
+ userId
16174
+ }) {
16175
+ return request(OpenAPI, {
16176
+ method: 'GET',
16177
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/images/',
16178
+ path: {
16179
+ 'platform_key': platformKey,
16180
+ 'user_id': userId
16181
+ }
16182
+ });
16183
+ }
16184
+ /**
16185
+ * @returns UploadedImage
16186
+ * @throws ApiError
16187
+ */
16188
+ static credentialsOrgsUsersImagesCreate({
16189
+ platformKey,
16190
+ userId,
16191
+ requestBody
16192
+ }) {
16193
+ return request(OpenAPI, {
16194
+ method: 'POST',
16195
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/images/',
16196
+ path: {
16197
+ 'platform_key': platformKey,
16198
+ 'user_id': userId
16199
+ },
16200
+ body: requestBody,
16201
+ mediaType: 'application/json'
16202
+ });
16203
+ }
16204
+ /**
16205
+ * A GET View that validates QueryParams and returns results to a serializer
16206
+ * @returns Issuer
16207
+ * @throws ApiError
16208
+ */
16209
+ static credentialsOrgsUsersIssuersRetrieve({
16210
+ platformKey,
16211
+ q,
16212
+ userId
16213
+ }) {
16214
+ return request(OpenAPI, {
16215
+ method: 'GET',
16216
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/issuers/',
16217
+ path: {
16218
+ 'platform_key': platformKey,
16219
+ 'user_id': userId
16220
+ },
16221
+ query: {
16222
+ 'q': q
16223
+ }
16224
+ });
16225
+ }
16226
+ /**
16227
+ * A GET View that validates QueryParams and returns results to a serializer
16228
+ * @returns Issuer
16229
+ * @throws ApiError
16230
+ */
16231
+ static credentialsOrgsUsersIssuersCreate({
16232
+ platformKey,
16233
+ q,
16234
+ userId,
16235
+ requestBody
16236
+ }) {
16237
+ return request(OpenAPI, {
16238
+ method: 'POST',
16239
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/issuers/',
16240
+ path: {
16241
+ 'platform_key': platformKey,
16242
+ 'user_id': userId
16243
+ },
16244
+ query: {
16245
+ 'q': q
16246
+ },
16247
+ body: requestBody,
16248
+ mediaType: 'application/json'
16249
+ });
16250
+ }
16251
+ /**
16252
+ * @returns Issuer
16253
+ * @throws ApiError
16254
+ */
16255
+ static credentialsOrgsUsersIssuersRetrieve2({
16256
+ entityId,
16257
+ platformKey,
16258
+ userId
16259
+ }) {
16260
+ return request(OpenAPI, {
16261
+ method: 'GET',
16262
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/issuers/{entity_id}',
16263
+ path: {
16264
+ 'entity_id': entityId,
16265
+ 'platform_key': platformKey,
16266
+ 'user_id': userId
16267
+ }
16268
+ });
16269
+ }
16270
+ /**
16271
+ * @returns Issuer
16272
+ * @throws ApiError
16273
+ */
16274
+ static credentialsOrgsUsersIssuersUpdate({
16275
+ entityId,
16276
+ platformKey,
16277
+ userId,
16278
+ requestBody
16279
+ }) {
16280
+ return request(OpenAPI, {
16281
+ method: 'PUT',
16282
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/issuers/{entity_id}',
16283
+ path: {
16284
+ 'entity_id': entityId,
16285
+ 'platform_key': platformKey,
16286
+ 'user_id': userId
16287
+ },
16288
+ body: requestBody,
16289
+ mediaType: 'application/json'
16290
+ });
16291
+ }
16292
+ /**
16293
+ * @returns void
16294
+ * @throws ApiError
16295
+ */
16296
+ static credentialsOrgsUsersIssuersDestroy({
16297
+ entityId,
16298
+ platformKey,
16299
+ userId
16300
+ }) {
16301
+ return request(OpenAPI, {
16302
+ method: 'DELETE',
16303
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/issuers/{entity_id}',
16304
+ path: {
16305
+ 'entity_id': entityId,
16306
+ 'platform_key': platformKey,
16307
+ 'user_id': userId
16308
+ }
16309
+ });
16310
+ }
16311
+ /**
16312
+ * @returns IssuerAuthority
16313
+ * @throws ApiError
16314
+ */
16315
+ static credentialsOrgsUsersIssuersAuthorityCreate({
16316
+ platformKey,
16317
+ userId,
16318
+ requestBody
16319
+ }) {
16320
+ return request(OpenAPI, {
16321
+ method: 'POST',
16322
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/issuers/authority/',
16323
+ path: {
16324
+ 'platform_key': platformKey,
16325
+ 'user_id': userId
16326
+ },
16327
+ body: requestBody,
16328
+ mediaType: 'application/json'
16329
+ });
16330
+ }
16331
+ /**
16332
+ * Retrieve provider configurations for the platform.
16333
+ *
16334
+ * Query Parameters:
16335
+ * provider_name (str, optional): Filter to a specific provider
16336
+ * page (int, optional): Page number
16337
+ * page_size (int, optional): Items per page
16338
+ *
16339
+ * Returns all configurations for the platform if the user is an admin.
16340
+ * @returns CredentialProviderConfig
16341
+ * @throws ApiError
16342
+ */
16343
+ static credentialsOrgsUsersProviderConfigRetrieve({
16344
+ platformKey,
16345
+ userId
16346
+ }) {
16347
+ return request(OpenAPI, {
16348
+ method: 'GET',
16349
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/provider-config/',
16350
+ path: {
16351
+ 'platform_key': platformKey,
16352
+ 'user_id': userId
16353
+ }
16354
+ });
16355
+ }
16356
+ /**
16357
+ * Create or update a provider configuration.
16358
+ *
16359
+ * If a configuration doesn't exist for the platform and provider, it will be created.
16360
+ * If it exists, it will be updated.
16361
+ *
16362
+ * Request Body:
16363
+ * {
16364
+ * "provider_name": "accredible", // Required
16365
+ * "config": {...}, // Optional
16366
+ * "enabled": true // Optional
16367
+ * }
16368
+ *
16369
+ * Returns:
16370
+ * - 201 Created: When creating a new configuration
16371
+ * - 200 OK: When updating an existing configuration
16372
+ * @returns CredentialProviderConfig
16373
+ * @throws ApiError
16374
+ */
16375
+ static credentialsOrgsUsersProviderConfigCreate({
16376
+ platformKey,
16377
+ userId,
16378
+ requestBody
16379
+ }) {
16380
+ return request(OpenAPI, {
16381
+ method: 'POST',
16382
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/provider-config/',
16383
+ path: {
16384
+ 'platform_key': platformKey,
16385
+ 'user_id': userId
16386
+ },
16387
+ body: requestBody,
16388
+ mediaType: 'application/json'
16389
+ });
16390
+ }
16391
+ /**
16392
+ * Deactivate a provider configuration (sets enabled=False).
16393
+ *
16394
+ * Request Body:
16395
+ * {
16396
+ * "provider_name": "accredible" // Required
16397
+ * }
16398
+ * @returns void
16399
+ * @throws ApiError
16400
+ */
16401
+ static credentialsOrgsUsersProviderConfigDestroy({
16402
+ platformKey,
16403
+ userId
16404
+ }) {
16405
+ return request(OpenAPI, {
16406
+ method: 'DELETE',
16407
+ url: '/api/credentials/orgs/{platform_key}/users/{user_id}/provider-config/',
16408
+ path: {
16409
+ 'platform_key': platformKey,
16410
+ 'user_id': userId
16411
+ }
16412
+ });
16413
+ }
16414
+ /**
16415
+ * Get all credentials for a platform with search and pagination support.
16416
+ *
16417
+ * Query Parameters:
16418
+ * - platform_org: Platform org ID (takes precedence over URL org)
16419
+ * - page: Page number (default: 1)
16420
+ * - page_size: Items per page (default: 10, max: 100)
16421
+ * - search: Search term to filter credentials
16422
+ * - course: Course ID to filter credentials
16423
+ * - program: Program ID to filter credentials
16424
+ * @returns Credential
16425
+ * @throws ApiError
16426
+ */
16427
+ static credentialsOrgsUsersRetrieve3({
16428
+ platformKey,
16429
+ username
16430
+ }) {
16431
+ return request(OpenAPI, {
16432
+ method: 'GET',
16433
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/',
16434
+ path: {
16435
+ 'platform_key': platformKey,
16436
+ 'username': username
16437
+ }
16438
+ });
16439
+ }
16440
+ /**
16441
+ * API View for managing credentials across a platform.
16442
+ *
16443
+ * This endpoint allows creating and retrieving credentials for a specific organization/tenant,
16444
+ * with support for filtering, searching, and pagination.
16445
+ *
16446
+ * Path Parameters:
16447
+ * org (str): The organization/tenant identifier
16448
+ * user_id (str): The user ID making the request
16449
+ *
16450
+ * Query Parameters:
16451
+ * # Platform identification
16452
+ * platform_org (str, optional): Alternative platform identifier (takes precedence over URL org)
16453
+ *
16454
+ * # Pagination
16455
+ * page (int, optional): Page number (default: 1)
16456
+ * page_size (int, optional): Items per page (default: 10, max: 100)
16457
+ *
16458
+ * # Filtering and search
16459
+ * search (str, optional): Search term to filter credentials by name or description
16460
+ * course (str, optional): Course ID to filter credentials associated with a specific course
16461
+ * program (str, optional): Program ID to filter credentials associated with a specific program
16462
+ *
16463
+ * Methods:
16464
+ * GET: Retrieve credentials with filtering and pagination
16465
+ * POST: Create a new credential
16466
+ *
16467
+ * POST Request Body:
16468
+ * A JSON object containing credential details:
16469
+ * - name (str): Credential name
16470
+ * - description (str, optional): Credential description
16471
+ * - issuer (str): Issuer entity ID
16472
+ * - credential_type (str, optional): Type of credential
16473
+ * - html_template (str, optional): HTML template for credential rendering
16474
+ * - css_template (str, optional): CSS template for credential styling
16475
+ * - icon_image (str, optional): URL to credential icon
16476
+ * - background_image (str, optional): URL to credential background
16477
+ * - thumbnail_image (str, optional): URL to credential thumbnail
16478
+ * - criteria_url (str, optional): URL to credential criteria
16479
+ * - criteria_text (str, optional): Text description of credential criteria
16480
+ * - issuing_signal (str, optional): Signal that triggers credential issuance
16481
+ *
16482
+ * Returns:
16483
+ * GET: A JSON response containing:
16484
+ * {
16485
+ * "status": {"success": true, "description": "Ok"},
16486
+ * "result": {
16487
+ * "next": "URL to next page",
16488
+ * "previous": "URL to previous page",
16489
+ * "count": 42,
16490
+ * "data": [
16491
+ * {credential object},
16492
+ * {credential object},
16493
+ * ...
16494
+ * ],
16495
+ * "num_pages": 5,
16496
+ * "page_number": 1,
16497
+ * "max_page_size": 100
16498
+ * }
16499
+ * }
16500
+ *
16501
+ * POST: A JSON response containing:
16502
+ * {
16503
+ * "status": {"success": true, "description": "Created"},
16504
+ * "result": {credential object}
16505
+ * }
16506
+ *
16507
+ * Error Responses:
16508
+ * 400 Bad Request: If the request data is invalid
16509
+ * 401 Unauthorized: If the user is not authenticated
16510
+ * 403 Forbidden: If the user does not have permission to access this resource
16511
+ * 404 Not Found: If the platform doesn't exist
16512
+ * 500 Internal Server Error: If an unexpected error occurs
16513
+ *
16514
+ * Access Control:
16515
+ * - Requires CredentialAssignmentPermission
16516
+ * - Only public credentials are returned by default
16517
+ * @returns Credential
16518
+ * @throws ApiError
16519
+ */
16520
+ static credentialsOrgsUsersCreate2({
16521
+ platformKey,
16522
+ username,
16523
+ requestBody
16524
+ }) {
16525
+ return request(OpenAPI, {
16526
+ method: 'POST',
16527
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/',
16528
+ path: {
16529
+ 'platform_key': platformKey,
16530
+ 'username': username
16531
+ },
16532
+ body: requestBody,
16533
+ mediaType: 'application/json'
16534
+ });
16535
+ }
16536
+ /**
16537
+ * API View for managing individual credentials.
16538
+ *
16539
+ * This endpoint allows retrieving, updating, and deleting specific credentials
16540
+ * identified by their entity_id.
16541
+ *
16542
+ * Path Parameters:
16543
+ * org (str): The organization/tenant identifier
16544
+ * user_id (str): The user ID making the request
16545
+ * entity_id (str): The credential entity ID
16546
+ *
16547
+ * Methods:
16548
+ * GET: Retrieve a specific credential
16549
+ * PUT: Update a specific credential
16550
+ * DELETE: Delete a specific credential
16551
+ *
16552
+ * PUT Request Body:
16553
+ * A JSON object containing credential details to update:
16554
+ * - name (str, optional): Credential name
16555
+ * - description (str, optional): Credential description
16556
+ * - credential_type (str, optional): Type of credential
16557
+ * - html_template (str, optional): HTML template for credential rendering
16558
+ * - css_template (str, optional): CSS template for credential styling
16559
+ * - icon_image (str, optional): URL to credential icon
16560
+ * - background_image (str, optional): URL to credential background
16561
+ * - thumbnail_image (str, optional): URL to credential thumbnail
16562
+ * - criteria_url (str, optional): URL to credential criteria
16563
+ * - criteria_text (str, optional): Text description of credential criteria
16564
+ * - issuing_signal (str, optional): Signal that triggers credential issuance
16565
+ *
16566
+ * Returns:
16567
+ * GET: A JSON response containing:
16568
+ * {
16569
+ * "status": {"success": true, "description": "Ok"},
16570
+ * "result": {credential object}
16571
+ * }
16572
+ *
16573
+ * PUT: A JSON response containing:
16574
+ * {
16575
+ * "status": {"success": true, "description": "Updated"},
16576
+ * "result": {credential object}
16577
+ * }
16578
+ *
16579
+ * DELETE: A JSON response indicating success:
16580
+ * {
16581
+ * "status": {"success": true, "description": "Deleted"}
16582
+ * }
16583
+ *
16584
+ * Error Responses:
16585
+ * 400 Bad Request: If the request data is invalid
16586
+ * 401 Unauthorized: If the user is not authenticated
16587
+ * 403 Forbidden: If the user does not have permission to access this resource
16588
+ * 404 Not Found: If the credential doesn't exist
16589
+ * 500 Internal Server Error: If an unexpected error occurs
16590
+ *
16591
+ * Access Control:
16592
+ * - Requires CredentialAssignmentPermission
16593
+ * - Users can only manage credentials they have permission to access
16594
+ * @returns Credential
16595
+ * @throws ApiError
16596
+ */
16597
+ static credentialsOrgsUsersRetrieve4({
16598
+ entityId,
16599
+ platformKey,
16600
+ username
16601
+ }) {
16602
+ return request(OpenAPI, {
16603
+ method: 'GET',
16604
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}',
16605
+ path: {
16606
+ 'entity_id': entityId,
16607
+ 'platform_key': platformKey,
16608
+ 'username': username
16609
+ }
16610
+ });
16611
+ }
16612
+ /**
16613
+ * API View for managing individual credentials.
16614
+ *
16615
+ * This endpoint allows retrieving, updating, and deleting specific credentials
16616
+ * identified by their entity_id.
16617
+ *
16618
+ * Path Parameters:
16619
+ * org (str): The organization/tenant identifier
16620
+ * user_id (str): The user ID making the request
16621
+ * entity_id (str): The credential entity ID
16622
+ *
16623
+ * Methods:
16624
+ * GET: Retrieve a specific credential
16625
+ * PUT: Update a specific credential
16626
+ * DELETE: Delete a specific credential
16627
+ *
16628
+ * PUT Request Body:
16629
+ * A JSON object containing credential details to update:
16630
+ * - name (str, optional): Credential name
16631
+ * - description (str, optional): Credential description
16632
+ * - credential_type (str, optional): Type of credential
16633
+ * - html_template (str, optional): HTML template for credential rendering
16634
+ * - css_template (str, optional): CSS template for credential styling
16635
+ * - icon_image (str, optional): URL to credential icon
16636
+ * - background_image (str, optional): URL to credential background
16637
+ * - thumbnail_image (str, optional): URL to credential thumbnail
16638
+ * - criteria_url (str, optional): URL to credential criteria
16639
+ * - criteria_text (str, optional): Text description of credential criteria
16640
+ * - issuing_signal (str, optional): Signal that triggers credential issuance
16641
+ *
16642
+ * Returns:
16643
+ * GET: A JSON response containing:
16644
+ * {
16645
+ * "status": {"success": true, "description": "Ok"},
16646
+ * "result": {credential object}
16647
+ * }
16648
+ *
16649
+ * PUT: A JSON response containing:
16650
+ * {
16651
+ * "status": {"success": true, "description": "Updated"},
16652
+ * "result": {credential object}
16653
+ * }
16654
+ *
16655
+ * DELETE: A JSON response indicating success:
16656
+ * {
16657
+ * "status": {"success": true, "description": "Deleted"}
16658
+ * }
16659
+ *
16660
+ * Error Responses:
16661
+ * 400 Bad Request: If the request data is invalid
16662
+ * 401 Unauthorized: If the user is not authenticated
16663
+ * 403 Forbidden: If the user does not have permission to access this resource
16664
+ * 404 Not Found: If the credential doesn't exist
16665
+ * 500 Internal Server Error: If an unexpected error occurs
16666
+ *
16667
+ * Access Control:
16668
+ * - Requires CredentialAssignmentPermission
16669
+ * - Users can only manage credentials they have permission to access
16670
+ * @returns Credential
16671
+ * @throws ApiError
16672
+ */
16673
+ static credentialsOrgsUsersUpdate2({
16674
+ entityId,
16675
+ platformKey,
16676
+ username,
16677
+ requestBody
16678
+ }) {
16679
+ return request(OpenAPI, {
16680
+ method: 'PUT',
16681
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}',
16682
+ path: {
16683
+ 'entity_id': entityId,
16684
+ 'platform_key': platformKey,
16685
+ 'username': username
16686
+ },
16687
+ body: requestBody,
16688
+ mediaType: 'application/json'
16689
+ });
16690
+ }
16691
+ /**
16692
+ * API View for managing individual credentials.
16693
+ *
16694
+ * This endpoint allows retrieving, updating, and deleting specific credentials
16695
+ * identified by their entity_id.
16696
+ *
16697
+ * Path Parameters:
16698
+ * org (str): The organization/tenant identifier
16699
+ * user_id (str): The user ID making the request
16700
+ * entity_id (str): The credential entity ID
16701
+ *
16702
+ * Methods:
16703
+ * GET: Retrieve a specific credential
16704
+ * PUT: Update a specific credential
16705
+ * DELETE: Delete a specific credential
16706
+ *
16707
+ * PUT Request Body:
16708
+ * A JSON object containing credential details to update:
16709
+ * - name (str, optional): Credential name
16710
+ * - description (str, optional): Credential description
16711
+ * - credential_type (str, optional): Type of credential
16712
+ * - html_template (str, optional): HTML template for credential rendering
16713
+ * - css_template (str, optional): CSS template for credential styling
16714
+ * - icon_image (str, optional): URL to credential icon
16715
+ * - background_image (str, optional): URL to credential background
16716
+ * - thumbnail_image (str, optional): URL to credential thumbnail
16717
+ * - criteria_url (str, optional): URL to credential criteria
16718
+ * - criteria_text (str, optional): Text description of credential criteria
16719
+ * - issuing_signal (str, optional): Signal that triggers credential issuance
16720
+ *
16721
+ * Returns:
16722
+ * GET: A JSON response containing:
16723
+ * {
16724
+ * "status": {"success": true, "description": "Ok"},
16725
+ * "result": {credential object}
16726
+ * }
16727
+ *
16728
+ * PUT: A JSON response containing:
16729
+ * {
16730
+ * "status": {"success": true, "description": "Updated"},
16731
+ * "result": {credential object}
16732
+ * }
16733
+ *
16734
+ * DELETE: A JSON response indicating success:
16735
+ * {
16736
+ * "status": {"success": true, "description": "Deleted"}
16737
+ * }
16738
+ *
16739
+ * Error Responses:
16740
+ * 400 Bad Request: If the request data is invalid
16741
+ * 401 Unauthorized: If the user is not authenticated
16742
+ * 403 Forbidden: If the user does not have permission to access this resource
16743
+ * 404 Not Found: If the credential doesn't exist
16744
+ * 500 Internal Server Error: If an unexpected error occurs
16745
+ *
16746
+ * Access Control:
16747
+ * - Requires CredentialAssignmentPermission
16748
+ * - Users can only manage credentials they have permission to access
16749
+ * @returns void
16750
+ * @throws ApiError
16751
+ */
16752
+ static credentialsOrgsUsersDestroy2({
16753
+ entityId,
16754
+ platformKey,
16755
+ username
16756
+ }) {
16757
+ return request(OpenAPI, {
16758
+ method: 'DELETE',
16759
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}',
16760
+ path: {
16761
+ 'entity_id': entityId,
16762
+ 'platform_key': platformKey,
16763
+ 'username': username
16764
+ }
16765
+ });
16766
+ }
16767
+ /**
16768
+ * @returns PaginatedAssertionsResponse
16769
+ * @throws ApiError
16770
+ */
16771
+ static credentialsOrgsUsersAssertionsRetrieve6({
16772
+ entityId,
16773
+ platformKey,
16774
+ username
16775
+ }) {
16776
+ return request(OpenAPI, {
16777
+ method: 'GET',
16778
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}/assertions/',
16779
+ path: {
16780
+ 'entity_id': entityId,
16781
+ 'platform_key': platformKey,
16782
+ 'username': username
16783
+ }
16784
+ });
16785
+ }
16786
+ /**
16787
+ * @returns Assertion
16788
+ * @throws ApiError
16789
+ */
16790
+ static credentialsOrgsUsersAssertionsCreate2({
16791
+ entityId,
16792
+ platformKey,
16793
+ username,
16794
+ requestBody
16795
+ }) {
16796
+ return request(OpenAPI, {
16797
+ method: 'POST',
16798
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}/assertions/',
16799
+ path: {
16800
+ 'entity_id': entityId,
16801
+ 'platform_key': platformKey,
16802
+ 'username': username
16803
+ },
16804
+ body: requestBody,
16805
+ mediaType: 'application/json'
16806
+ });
16807
+ }
16808
+ /**
16809
+ * @returns BulkCreateAssertion
16810
+ * @throws ApiError
16811
+ */
16812
+ static credentialsOrgsUsersAssertionsBulkCreate2({
16813
+ entityId,
16814
+ platformKey,
16815
+ username,
16816
+ requestBody
16817
+ }) {
16818
+ return request(OpenAPI, {
16819
+ method: 'POST',
16820
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/{entity_id}/assertions/bulk/',
16821
+ path: {
16822
+ 'entity_id': entityId,
16823
+ 'platform_key': platformKey,
16824
+ 'username': username
16825
+ },
16826
+ body: requestBody,
16827
+ mediaType: 'application/json'
16828
+ });
16829
+ }
16830
+ /**
16831
+ * A GET View that validates QueryParams and returns results to a serializer
16832
+ * @returns PaginatedAssertionsResponse
16833
+ * @throws ApiError
16834
+ */
16835
+ static credentialsOrgsUsersAssertionsRetrieve4({
16836
+ platformKey,
16837
+ username,
16838
+ course,
16839
+ excludeMainTenantAssertions,
16840
+ includeExpired,
16841
+ includeRevoked,
16842
+ page,
16843
+ pageSize
16844
+ }) {
16845
+ return request(OpenAPI, {
16846
+ method: 'GET',
16847
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assertions/',
16848
+ path: {
16849
+ 'platform_key': platformKey,
16850
+ 'username': username
16851
+ },
16852
+ query: {
16853
+ 'course': course,
16854
+ 'exclude_main_tenant_assertions': excludeMainTenantAssertions,
16855
+ 'include_expired': includeExpired,
16856
+ 'include_revoked': includeRevoked,
16857
+ 'page': page,
16858
+ 'page_size': pageSize
16859
+ }
16860
+ });
16861
+ }
16862
+ /**
16863
+ * Get all credentials of a given tenant
16864
+ * @returns OvertimeWithChangeInfo
16865
+ * @throws ApiError
16866
+ */
16867
+ static credentialsOrgsUsersAssertionsOverTimeRetrieve2({
16868
+ platformKey,
16869
+ username,
16870
+ departmentId,
16871
+ endDate,
16872
+ format = 'json',
16873
+ includeMainPlatform = true,
16874
+ startDate
16875
+ }) {
16876
+ return request(OpenAPI, {
16877
+ method: 'GET',
16878
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assertions-over-time/',
16879
+ path: {
16880
+ 'platform_key': platformKey,
16881
+ 'username': username
16882
+ },
16883
+ query: {
16884
+ 'department_id': departmentId,
16885
+ 'end_date': endDate,
16886
+ 'format': format,
16887
+ 'include_main_platform': includeMainPlatform,
16888
+ 'start_date': startDate
16889
+ }
16890
+ });
16891
+ }
16892
+ /**
16893
+ * @returns Assertion
16894
+ * @throws ApiError
16895
+ */
16896
+ static credentialsOrgsUsersAssertionsRetrieve5({
16897
+ entityId,
16898
+ platformKey,
16899
+ username
16900
+ }) {
16901
+ return request(OpenAPI, {
16902
+ method: 'GET',
16903
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assertions/{entity_id}',
16904
+ path: {
16905
+ 'entity_id': entityId,
16906
+ 'platform_key': platformKey,
16907
+ 'username': username
16908
+ }
16909
+ });
16910
+ }
16911
+ /**
16912
+ * @returns Assertion
16913
+ * @throws ApiError
16914
+ */
16915
+ static credentialsOrgsUsersAssertionsUpdate2({
16916
+ entityId,
16917
+ platformKey,
16918
+ username,
16919
+ requestBody
16920
+ }) {
16921
+ return request(OpenAPI, {
16922
+ method: 'PUT',
16923
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assertions/{entity_id}',
16924
+ path: {
16925
+ 'entity_id': entityId,
16926
+ 'platform_key': platformKey,
16927
+ 'username': username
16928
+ },
16929
+ body: requestBody,
16930
+ mediaType: 'application/json'
16931
+ });
16932
+ }
16933
+ /**
16934
+ * Delete a credential assignment using its entity_id.
16935
+ * Only platform admins and department admins can delete assignments.
16936
+ * @returns void
16937
+ * @throws ApiError
16938
+ */
16939
+ static credentialsOrgsUsersAssignmentsDestroy2({
16940
+ assignmentId,
16941
+ platformKey,
16942
+ username
16943
+ }) {
16944
+ return request(OpenAPI, {
16945
+ method: 'DELETE',
16946
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/{assignment_id}',
16947
+ path: {
16948
+ 'assignment_id': assignmentId,
16949
+ 'platform_key': platformKey,
16950
+ 'username': username
16951
+ }
16952
+ });
16953
+ }
16954
+ /**
16955
+ * Get group assignments with department-aware filtering
16956
+ * @returns any No response body
16957
+ * @throws ApiError
16958
+ */
16959
+ static credentialsOrgsUsersAssignmentsGroupsRetrieve2({
16960
+ platformKey,
16961
+ username
16962
+ }) {
16963
+ return request(OpenAPI, {
16964
+ method: 'GET',
16965
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/groups/',
16966
+ path: {
16967
+ 'platform_key': platformKey,
16968
+ 'username': username
16969
+ }
16970
+ });
16971
+ }
16972
+ /**
16973
+ * Create group assignment with department access validation
16974
+ * @returns any No response body
16975
+ * @throws ApiError
16976
+ */
16977
+ static credentialsOrgsUsersAssignmentsGroupsCreate2({
16978
+ platformKey,
16979
+ username
16980
+ }) {
16981
+ return request(OpenAPI, {
16982
+ method: 'POST',
16983
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/groups/',
16984
+ path: {
16985
+ 'platform_key': platformKey,
16986
+ 'username': username
16987
+ }
16988
+ });
16989
+ }
16990
+ /**
16991
+ * Get assignments and their corresponding assertions based on user role:
16992
+ * - Regular users: get only their own assignments
16993
+ * - Platform admins: get assignments for all users in their platform
16994
+ * - Department admins: get assignments for users in their department groups
16995
+ * @returns any No response body
16996
+ * @throws ApiError
16997
+ */
16998
+ static credentialsOrgsUsersAssignmentsUsersRetrieve2({
16999
+ platformKey,
17000
+ username
17001
+ }) {
17002
+ return request(OpenAPI, {
17003
+ method: 'GET',
17004
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/users/',
17005
+ path: {
17006
+ 'platform_key': platformKey,
17007
+ 'username': username
17008
+ }
17009
+ });
17010
+ }
17011
+ /**
17012
+ * Create assignments with department access validation
17013
+ * @returns any No response body
17014
+ * @throws ApiError
17015
+ */
17016
+ static credentialsOrgsUsersAssignmentsUsersCreate2({
17017
+ platformKey,
17018
+ username
17019
+ }) {
17020
+ return request(OpenAPI, {
17021
+ method: 'POST',
17022
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/assignments/users/',
17023
+ path: {
17024
+ 'platform_key': platformKey,
17025
+ 'username': username
17026
+ }
17027
+ });
17028
+ }
17029
+ /**
17030
+ * Get all credentials of a given tenant
17031
+ * @returns OverTime
17032
+ * @throws ApiError
17033
+ */
17034
+ static credentialsOrgsUsersCourseAssertionsOverTimeRetrieve2({
17035
+ platformKey,
17036
+ username,
17037
+ departmentId,
17038
+ endDate,
17039
+ format = 'json',
17040
+ includeMainPlatform = true,
17041
+ startDate
17042
+ }) {
17043
+ return request(OpenAPI, {
17044
+ method: 'GET',
17045
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/course-assertions-over-time/',
17046
+ path: {
17047
+ 'platform_key': platformKey,
17048
+ 'username': username
17049
+ },
17050
+ query: {
17051
+ 'department_id': departmentId,
17052
+ 'end_date': endDate,
17053
+ 'format': format,
17054
+ 'include_main_platform': includeMainPlatform,
17055
+ 'start_date': startDate
17056
+ }
17057
+ });
17058
+ }
17059
+ /**
17060
+ * @returns any No response body
17061
+ * @throws ApiError
17062
+ */
17063
+ static credentialsOrgsUsersCourseCredentialsList2({
17064
+ platformKey,
17065
+ username,
17066
+ page,
17067
+ pageSize
17068
+ }) {
17069
+ return request(OpenAPI, {
17070
+ method: 'GET',
17071
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/course-credentials/',
17072
+ path: {
17073
+ 'platform_key': platformKey,
17074
+ 'username': username
17075
+ },
17076
+ query: {
17077
+ 'page': page,
17078
+ 'page_size': pageSize
17079
+ }
17080
+ });
17081
+ }
17082
+ /**
17083
+ * Get all credentials of a given tenant
17084
+ * @returns OverTime
17085
+ * @throws ApiError
17086
+ */
17087
+ static credentialsOrgsUsersCredentialsOverTimeRetrieve2({
17088
+ platformKey,
17089
+ username,
17090
+ departmentId,
17091
+ endDate,
17092
+ format = 'json',
17093
+ includeMainPlatform = true,
17094
+ startDate
17095
+ }) {
17096
+ return request(OpenAPI, {
17097
+ method: 'GET',
17098
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/credentials-over-time/',
17099
+ path: {
17100
+ 'platform_key': platformKey,
17101
+ 'username': username
17102
+ },
17103
+ query: {
17104
+ 'department_id': departmentId,
17105
+ 'end_date': endDate,
17106
+ 'format': format,
17107
+ 'include_main_platform': includeMainPlatform,
17108
+ 'start_date': startDate
17109
+ }
17110
+ });
17111
+ }
17112
+ /**
17113
+ * Retrieve external credential mappings for the platform.
17114
+ *
17115
+ * Query Parameters:
17116
+ * credential_id (str, optional): Filter by credential entity_id
17117
+ * provider_name (str, optional): Filter by provider name
17118
+ * page (int, optional): Page number
17119
+ * page_size (int, optional): Items per page
17120
+ *
17121
+ * Returns all mappings for the platform if the user is an admin.
17122
+ * @returns ExternalCredentialMapping
17123
+ * @throws ApiError
17124
+ */
17125
+ static credentialsOrgsUsersExternalMappingRetrieve2({
17126
+ platformKey,
17127
+ username
17128
+ }) {
17129
+ return request(OpenAPI, {
17130
+ method: 'GET',
17131
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/external-mapping/',
17132
+ path: {
17133
+ 'platform_key': platformKey,
17134
+ 'username': username
17135
+ }
17136
+ });
17137
+ }
17138
+ /**
17139
+ * Create or update an external credential mapping.
17140
+ *
17141
+ * If a mapping doesn't exist for the credential + platform + provider combination,
17142
+ * it will be created. If it exists, it will be updated.
17143
+ *
17144
+ * Request Body:
17145
+ * {
17146
+ * "credential_id": "credential-entity-id", // Required
17147
+ * "provider_name": "accredible", // Required
17148
+ * "external_template_id": "123456", // Optional
17149
+ * "metadata": {} // Optional
17150
+ * }
17151
+ *
17152
+ * Returns:
17153
+ * - 201 Created: When creating a new mapping
17154
+ * - 200 OK: When updating an existing mapping
17155
+ * @returns ExternalCredentialMapping
17156
+ * @throws ApiError
17157
+ */
17158
+ static credentialsOrgsUsersExternalMappingCreate2({
17159
+ platformKey,
17160
+ username,
17161
+ requestBody
17162
+ }) {
17163
+ return request(OpenAPI, {
17164
+ method: 'POST',
17165
+ url: '/api/credentials/orgs/{platform_key}/users/{username}/external-mapping/',
16307
17166
  path: {
16308
17167
  'platform_key': platformKey,
16309
17168
  'username': username
@@ -16326,7 +17185,7 @@ class CredentialsService {
16326
17185
  * @returns void
16327
17186
  * @throws ApiError
16328
17187
  */
16329
- static credentialsOrgsUsersExternalMappingDestroy({
17188
+ static credentialsOrgsUsersExternalMappingDestroy2({
16330
17189
  platformKey,
16331
17190
  username
16332
17191
  }) {
@@ -16340,63 +17199,10 @@ class CredentialsService {
16340
17199
  });
16341
17200
  }
16342
17201
  /**
16343
- * API View for managing uploaded images for credentials.
16344
- *
16345
- * This endpoint allows uploading new images and retrieving existing images
16346
- * for use with credentials (icons, backgrounds, thumbnails, etc.).
16347
- *
16348
- * Path Parameters:
16349
- * org (str): The organization/tenant identifier
16350
- * user_id (str): The user ID making the request
16351
- *
16352
- * Query Parameters:
16353
- * query (str, required for GET): Search term to filter images by name
16354
- *
16355
- * Methods:
16356
- * GET: Retrieve images matching a search query
16357
- * POST: Upload a new image
16358
- *
16359
- * POST Request Body:
16360
- * Multipart form data containing:
16361
- * - image (file, required): The image file to upload
16362
- * - name (str, optional): A descriptive name for the image
16363
- *
16364
- * Returns:
16365
- * GET: A JSON array of image objects:
16366
- * [
16367
- * {
16368
- * "id": 123,
16369
- * "name": "Logo",
16370
- * "image": "https://example.com/media/uploaded_images/logo.png"
16371
- * },
16372
- * {
16373
- * "id": 124,
16374
- * "name": "Background",
16375
- * "image": "https://example.com/media/uploaded_images/background.jpg"
16376
- * },
16377
- * ...
16378
- * ]
16379
- *
16380
- * POST: A JSON object containing the uploaded image details:
16381
- * {
16382
- * "id": 125,
16383
- * "name": "Certificate Icon",
16384
- * "image": "https://example.com/media/uploaded_images/certificate-icon.png"
16385
- * }
16386
- *
16387
- * Error Responses:
16388
- * 400 Bad Request: If the request data is invalid or missing required parameters
16389
- * 401 Unauthorized: If the user is not authenticated
16390
- * 403 Forbidden: If the user does not have permission to access this resource
16391
- * 500 Internal Server Error: If an unexpected error occurs
16392
- *
16393
- * Access Control:
16394
- * - Requires IsAdminUserOrStudentDRFMixin
16395
- * - Only authenticated users with appropriate permissions can upload and retrieve images
16396
- * @returns UploadedImage
16397
- * @throws ApiError
16398
- */
16399
- static credentialsOrgsUsersImagesRetrieve({
17202
+ * @returns UploadedImage
17203
+ * @throws ApiError
17204
+ */
17205
+ static credentialsOrgsUsersImagesRetrieve2({
16400
17206
  platformKey,
16401
17207
  username
16402
17208
  }) {
@@ -16410,63 +17216,10 @@ class CredentialsService {
16410
17216
  });
16411
17217
  }
16412
17218
  /**
16413
- * API View for managing uploaded images for credentials.
16414
- *
16415
- * This endpoint allows uploading new images and retrieving existing images
16416
- * for use with credentials (icons, backgrounds, thumbnails, etc.).
16417
- *
16418
- * Path Parameters:
16419
- * org (str): The organization/tenant identifier
16420
- * user_id (str): The user ID making the request
16421
- *
16422
- * Query Parameters:
16423
- * query (str, required for GET): Search term to filter images by name
16424
- *
16425
- * Methods:
16426
- * GET: Retrieve images matching a search query
16427
- * POST: Upload a new image
16428
- *
16429
- * POST Request Body:
16430
- * Multipart form data containing:
16431
- * - image (file, required): The image file to upload
16432
- * - name (str, optional): A descriptive name for the image
16433
- *
16434
- * Returns:
16435
- * GET: A JSON array of image objects:
16436
- * [
16437
- * {
16438
- * "id": 123,
16439
- * "name": "Logo",
16440
- * "image": "https://example.com/media/uploaded_images/logo.png"
16441
- * },
16442
- * {
16443
- * "id": 124,
16444
- * "name": "Background",
16445
- * "image": "https://example.com/media/uploaded_images/background.jpg"
16446
- * },
16447
- * ...
16448
- * ]
16449
- *
16450
- * POST: A JSON object containing the uploaded image details:
16451
- * {
16452
- * "id": 125,
16453
- * "name": "Certificate Icon",
16454
- * "image": "https://example.com/media/uploaded_images/certificate-icon.png"
16455
- * }
16456
- *
16457
- * Error Responses:
16458
- * 400 Bad Request: If the request data is invalid or missing required parameters
16459
- * 401 Unauthorized: If the user is not authenticated
16460
- * 403 Forbidden: If the user does not have permission to access this resource
16461
- * 500 Internal Server Error: If an unexpected error occurs
16462
- *
16463
- * Access Control:
16464
- * - Requires IsAdminUserOrStudentDRFMixin
16465
- * - Only authenticated users with appropriate permissions can upload and retrieve images
16466
- * @returns UploadedImage
16467
- * @throws ApiError
16468
- */
16469
- static credentialsOrgsUsersImagesCreate({
17219
+ * @returns UploadedImage
17220
+ * @throws ApiError
17221
+ */
17222
+ static credentialsOrgsUsersImagesCreate2({
16470
17223
  platformKey,
16471
17224
  username,
16472
17225
  requestBody
@@ -16483,71 +17236,11 @@ class CredentialsService {
16483
17236
  });
16484
17237
  }
16485
17238
  /**
16486
- * API View for managing credential issuers.
16487
- *
16488
- * This endpoint allows creating and retrieving issuers for a specific organization/tenant,
16489
- * with support for filtering and pagination.
16490
- *
16491
- * Path Parameters:
16492
- * org (str): The organization/tenant identifier
16493
- * user_id (str): The user ID making the request
16494
- *
16495
- * Query Parameters:
16496
- * q (str, optional): Search term to filter issuers by name
16497
- * limit (int, optional): Number of results per page (default: 50)
16498
- * offset (int, optional): Starting position for pagination
16499
- *
16500
- * Methods:
16501
- * GET: Retrieve issuers with filtering and pagination
16502
- * POST: Create a new issuer
16503
- *
16504
- * POST Request Body:
16505
- * A JSON object containing issuer details:
16506
- * - name (str): Issuer name
16507
- * - iconImage (str, optional): URL to issuer icon
16508
- * - email (str, optional): Contact email for the issuer
16509
- * - url (str, optional): Website URL for the issuer
16510
- * - allowed_template_tags (array, optional): List of allowed template tags
16511
- *
16512
- * Returns:
16513
- * GET: A JSON response containing:
16514
- * {
16515
- * "status": {"success": true, "description": "Ok"},
16516
- * "result": {
16517
- * "next": "URL to next page",
16518
- * "previous": "URL to previous page",
16519
- * "count": 10,
16520
- * "data": [
16521
- * {issuer object},
16522
- * {issuer object},
16523
- * ...
16524
- * ],
16525
- * "num_pages": 1,
16526
- * "page_number": 1,
16527
- * "max_page_size": 1000
16528
- * }
16529
- * }
16530
- *
16531
- * POST: A JSON response containing:
16532
- * {
16533
- * "status": {"success": true, "description": "Created"},
16534
- * "result": {issuer object}
16535
- * }
16536
- *
16537
- * Error Responses:
16538
- * 400 Bad Request: If the request data is invalid
16539
- * 401 Unauthorized: If the user is not authenticated
16540
- * 403 Forbidden: If the user does not have permission to access this resource
16541
- * 404 Not Found: If the platform doesn't exist
16542
- * 500 Internal Server Error: If an unexpected error occurs
16543
- *
16544
- * Access Control:
16545
- * - Requires IsAdminUserOrStudentDRFMixin
16546
- * - Only authenticated users with appropriate permissions can manage issuers
16547
- * @returns Issuer
16548
- * @throws ApiError
16549
- */
16550
- static credentialsOrgsUsersIssuersRetrieve({
17239
+ * A GET View that validates QueryParams and returns results to a serializer
17240
+ * @returns Issuer
17241
+ * @throws ApiError
17242
+ */
17243
+ static credentialsOrgsUsersIssuersRetrieve3({
16551
17244
  platformKey,
16552
17245
  q,
16553
17246
  username
@@ -16565,71 +17258,11 @@ class CredentialsService {
16565
17258
  });
16566
17259
  }
16567
17260
  /**
16568
- * API View for managing credential issuers.
16569
- *
16570
- * This endpoint allows creating and retrieving issuers for a specific organization/tenant,
16571
- * with support for filtering and pagination.
16572
- *
16573
- * Path Parameters:
16574
- * org (str): The organization/tenant identifier
16575
- * user_id (str): The user ID making the request
16576
- *
16577
- * Query Parameters:
16578
- * q (str, optional): Search term to filter issuers by name
16579
- * limit (int, optional): Number of results per page (default: 50)
16580
- * offset (int, optional): Starting position for pagination
16581
- *
16582
- * Methods:
16583
- * GET: Retrieve issuers with filtering and pagination
16584
- * POST: Create a new issuer
16585
- *
16586
- * POST Request Body:
16587
- * A JSON object containing issuer details:
16588
- * - name (str): Issuer name
16589
- * - iconImage (str, optional): URL to issuer icon
16590
- * - email (str, optional): Contact email for the issuer
16591
- * - url (str, optional): Website URL for the issuer
16592
- * - allowed_template_tags (array, optional): List of allowed template tags
16593
- *
16594
- * Returns:
16595
- * GET: A JSON response containing:
16596
- * {
16597
- * "status": {"success": true, "description": "Ok"},
16598
- * "result": {
16599
- * "next": "URL to next page",
16600
- * "previous": "URL to previous page",
16601
- * "count": 10,
16602
- * "data": [
16603
- * {issuer object},
16604
- * {issuer object},
16605
- * ...
16606
- * ],
16607
- * "num_pages": 1,
16608
- * "page_number": 1,
16609
- * "max_page_size": 1000
16610
- * }
16611
- * }
16612
- *
16613
- * POST: A JSON response containing:
16614
- * {
16615
- * "status": {"success": true, "description": "Created"},
16616
- * "result": {issuer object}
16617
- * }
16618
- *
16619
- * Error Responses:
16620
- * 400 Bad Request: If the request data is invalid
16621
- * 401 Unauthorized: If the user is not authenticated
16622
- * 403 Forbidden: If the user does not have permission to access this resource
16623
- * 404 Not Found: If the platform doesn't exist
16624
- * 500 Internal Server Error: If an unexpected error occurs
16625
- *
16626
- * Access Control:
16627
- * - Requires IsAdminUserOrStudentDRFMixin
16628
- * - Only authenticated users with appropriate permissions can manage issuers
16629
- * @returns Issuer
16630
- * @throws ApiError
16631
- */
16632
- static credentialsOrgsUsersIssuersCreate({
17261
+ * A GET View that validates QueryParams and returns results to a serializer
17262
+ * @returns Issuer
17263
+ * @throws ApiError
17264
+ */
17265
+ static credentialsOrgsUsersIssuersCreate2({
16633
17266
  platformKey,
16634
17267
  q,
16635
17268
  username,
@@ -16650,75 +17283,10 @@ class CredentialsService {
16650
17283
  });
16651
17284
  }
16652
17285
  /**
16653
- * API View for managing individual issuers.
16654
- *
16655
- * This endpoint allows retrieving, updating, and deleting specific issuers
16656
- * identified by their entity_id or org identifier.
16657
- *
16658
- * Path Parameters:
16659
- * org (str): The organization/tenant identifier
16660
- * user_id (str): The user ID making the request
16661
- * entity_id (str): The issuer entity ID or org identifier
16662
- *
16663
- * Methods:
16664
- * GET: Retrieve a specific issuer
16665
- * PUT: Update a specific issuer
16666
- * DELETE: Delete a specific issuer
16667
- *
16668
- * PUT Request Body:
16669
- * A JSON object containing issuer details to update:
16670
- * - name (str, optional): Issuer name
16671
- * - iconImage (str, optional): URL to issuer icon
16672
- * - email (str, optional): Contact email for the issuer
16673
- * - url (str, optional): Website URL for the issuer
16674
- * - allowed_template_tags (array, optional): List of allowed template tags
16675
- *
16676
- * Returns:
16677
- * GET: A JSON response containing the issuer details:
16678
- * [
16679
- * {
16680
- * "name": "Example University",
16681
- * "org": "example-university",
16682
- * "entityId": "abc123",
16683
- * "signatories": [...],
16684
- * "url": "https://example.com",
16685
- * "iconImage": "https://example.com/logo.png",
16686
- * "allowed_template_tags": [...]
16687
- * }
16688
- * ]
16689
- *
16690
- * PUT: A JSON response containing the updated issuer details:
16691
- * [
16692
- * {
16693
- * "name": "Example University",
16694
- * "org": "example-university",
16695
- * "entityId": "abc123",
16696
- * "signatories": [...],
16697
- * "url": "https://example.com",
16698
- * "iconImage": "https://example.com/new-logo.png",
16699
- * "allowed_template_tags": [...]
16700
- * }
16701
- * ]
16702
- *
16703
- * DELETE: A JSON response indicating success:
16704
- * {
16705
- * "status": {"success": true, "description": "Deleted"}
16706
- * }
16707
- *
16708
- * Error Responses:
16709
- * 400 Bad Request: If the request data is invalid
16710
- * 401 Unauthorized: If the user is not authenticated
16711
- * 403 Forbidden: If the user does not have permission to access this resource
16712
- * 404 Not Found: If the issuer doesn't exist
16713
- * 500 Internal Server Error: If an unexpected error occurs
16714
- *
16715
- * Access Control:
16716
- * - Requires IsAdminUserOrStudentDRFMixin
16717
- * - Only authenticated users with appropriate permissions can manage issuers
16718
- * @returns Issuer
16719
- * @throws ApiError
16720
- */
16721
- static credentialsOrgsUsersIssuersRetrieve2({
17286
+ * @returns Issuer
17287
+ * @throws ApiError
17288
+ */
17289
+ static credentialsOrgsUsersIssuersRetrieve4({
16722
17290
  entityId,
16723
17291
  platformKey,
16724
17292
  username
@@ -16734,75 +17302,10 @@ class CredentialsService {
16734
17302
  });
16735
17303
  }
16736
17304
  /**
16737
- * API View for managing individual issuers.
16738
- *
16739
- * This endpoint allows retrieving, updating, and deleting specific issuers
16740
- * identified by their entity_id or org identifier.
16741
- *
16742
- * Path Parameters:
16743
- * org (str): The organization/tenant identifier
16744
- * user_id (str): The user ID making the request
16745
- * entity_id (str): The issuer entity ID or org identifier
16746
- *
16747
- * Methods:
16748
- * GET: Retrieve a specific issuer
16749
- * PUT: Update a specific issuer
16750
- * DELETE: Delete a specific issuer
16751
- *
16752
- * PUT Request Body:
16753
- * A JSON object containing issuer details to update:
16754
- * - name (str, optional): Issuer name
16755
- * - iconImage (str, optional): URL to issuer icon
16756
- * - email (str, optional): Contact email for the issuer
16757
- * - url (str, optional): Website URL for the issuer
16758
- * - allowed_template_tags (array, optional): List of allowed template tags
16759
- *
16760
- * Returns:
16761
- * GET: A JSON response containing the issuer details:
16762
- * [
16763
- * {
16764
- * "name": "Example University",
16765
- * "org": "example-university",
16766
- * "entityId": "abc123",
16767
- * "signatories": [...],
16768
- * "url": "https://example.com",
16769
- * "iconImage": "https://example.com/logo.png",
16770
- * "allowed_template_tags": [...]
16771
- * }
16772
- * ]
16773
- *
16774
- * PUT: A JSON response containing the updated issuer details:
16775
- * [
16776
- * {
16777
- * "name": "Example University",
16778
- * "org": "example-university",
16779
- * "entityId": "abc123",
16780
- * "signatories": [...],
16781
- * "url": "https://example.com",
16782
- * "iconImage": "https://example.com/new-logo.png",
16783
- * "allowed_template_tags": [...]
16784
- * }
16785
- * ]
16786
- *
16787
- * DELETE: A JSON response indicating success:
16788
- * {
16789
- * "status": {"success": true, "description": "Deleted"}
16790
- * }
16791
- *
16792
- * Error Responses:
16793
- * 400 Bad Request: If the request data is invalid
16794
- * 401 Unauthorized: If the user is not authenticated
16795
- * 403 Forbidden: If the user does not have permission to access this resource
16796
- * 404 Not Found: If the issuer doesn't exist
16797
- * 500 Internal Server Error: If an unexpected error occurs
16798
- *
16799
- * Access Control:
16800
- * - Requires IsAdminUserOrStudentDRFMixin
16801
- * - Only authenticated users with appropriate permissions can manage issuers
16802
- * @returns Issuer
16803
- * @throws ApiError
16804
- */
16805
- static credentialsOrgsUsersIssuersUpdate({
17305
+ * @returns Issuer
17306
+ * @throws ApiError
17307
+ */
17308
+ static credentialsOrgsUsersIssuersUpdate2({
16806
17309
  entityId,
16807
17310
  platformKey,
16808
17311
  username,
@@ -16821,75 +17324,10 @@ class CredentialsService {
16821
17324
  });
16822
17325
  }
16823
17326
  /**
16824
- * API View for managing individual issuers.
16825
- *
16826
- * This endpoint allows retrieving, updating, and deleting specific issuers
16827
- * identified by their entity_id or org identifier.
16828
- *
16829
- * Path Parameters:
16830
- * org (str): The organization/tenant identifier
16831
- * user_id (str): The user ID making the request
16832
- * entity_id (str): The issuer entity ID or org identifier
16833
- *
16834
- * Methods:
16835
- * GET: Retrieve a specific issuer
16836
- * PUT: Update a specific issuer
16837
- * DELETE: Delete a specific issuer
16838
- *
16839
- * PUT Request Body:
16840
- * A JSON object containing issuer details to update:
16841
- * - name (str, optional): Issuer name
16842
- * - iconImage (str, optional): URL to issuer icon
16843
- * - email (str, optional): Contact email for the issuer
16844
- * - url (str, optional): Website URL for the issuer
16845
- * - allowed_template_tags (array, optional): List of allowed template tags
16846
- *
16847
- * Returns:
16848
- * GET: A JSON response containing the issuer details:
16849
- * [
16850
- * {
16851
- * "name": "Example University",
16852
- * "org": "example-university",
16853
- * "entityId": "abc123",
16854
- * "signatories": [...],
16855
- * "url": "https://example.com",
16856
- * "iconImage": "https://example.com/logo.png",
16857
- * "allowed_template_tags": [...]
16858
- * }
16859
- * ]
16860
- *
16861
- * PUT: A JSON response containing the updated issuer details:
16862
- * [
16863
- * {
16864
- * "name": "Example University",
16865
- * "org": "example-university",
16866
- * "entityId": "abc123",
16867
- * "signatories": [...],
16868
- * "url": "https://example.com",
16869
- * "iconImage": "https://example.com/new-logo.png",
16870
- * "allowed_template_tags": [...]
16871
- * }
16872
- * ]
16873
- *
16874
- * DELETE: A JSON response indicating success:
16875
- * {
16876
- * "status": {"success": true, "description": "Deleted"}
16877
- * }
16878
- *
16879
- * Error Responses:
16880
- * 400 Bad Request: If the request data is invalid
16881
- * 401 Unauthorized: If the user is not authenticated
16882
- * 403 Forbidden: If the user does not have permission to access this resource
16883
- * 404 Not Found: If the issuer doesn't exist
16884
- * 500 Internal Server Error: If an unexpected error occurs
16885
- *
16886
- * Access Control:
16887
- * - Requires IsAdminUserOrStudentDRFMixin
16888
- * - Only authenticated users with appropriate permissions can manage issuers
16889
- * @returns void
16890
- * @throws ApiError
16891
- */
16892
- static credentialsOrgsUsersIssuersDestroy({
17327
+ * @returns void
17328
+ * @throws ApiError
17329
+ */
17330
+ static credentialsOrgsUsersIssuersDestroy2({
16893
17331
  entityId,
16894
17332
  platformKey,
16895
17333
  username
@@ -16905,51 +17343,10 @@ class CredentialsService {
16905
17343
  });
16906
17344
  }
16907
17345
  /**
16908
- * API View for managing issuer authorities (signatories).
16909
- *
16910
- * This endpoint allows creating authorities/signatories that can be associated
16911
- * with issuers or specific credentials.
16912
- *
16913
- * Path Parameters:
16914
- * org (str): The organization/tenant identifier
16915
- * user_id (str): The user ID making the request
16916
- *
16917
- * Methods:
16918
- * POST: Create a new issuer authority
16919
- *
16920
- * POST Request Body:
16921
- * A JSON object containing authority details:
16922
- * - name (str, required): Name of the signatory
16923
- * - title (str, required): Title of the signatory
16924
- * - signature (str, required): URL to the signature image
16925
- * - org (str, optional): Organization identifier to associate with an issuer
16926
- * - entityId (str, optional): Issuer entity ID to associate with
16927
- * - credential (str, optional): Credential entity ID to associate with
16928
- *
16929
- * Returns:
16930
- * POST: A JSON response containing the created authority:
16931
- * {
16932
- * "data": {
16933
- * "name": "John Smith",
16934
- * "title": "President",
16935
- * "signature": "https://example.com/signatures/john-smith.png"
16936
- * }
16937
- * }
16938
- *
16939
- * Error Responses:
16940
- * 400 Bad Request: If the request data is invalid or missing required fields
16941
- * 401 Unauthorized: If the user is not authenticated
16942
- * 403 Forbidden: If the user does not have permission to access this resource
16943
- * 404 Not Found: If the issuer or credential doesn't exist
16944
- * 500 Internal Server Error: If an unexpected error occurs
16945
- *
16946
- * Access Control:
16947
- * - Requires IsAdminUserOrStudentDRFMixin
16948
- * - Only authenticated users with appropriate permissions can manage authorities
16949
- * @returns IssuerAuthority
16950
- * @throws ApiError
16951
- */
16952
- static credentialsOrgsUsersIssuersAuthorityCreate({
17346
+ * @returns IssuerAuthority
17347
+ * @throws ApiError
17348
+ */
17349
+ static credentialsOrgsUsersIssuersAuthorityCreate2({
16953
17350
  platformKey,
16954
17351
  username,
16955
17352
  requestBody
@@ -16977,7 +17374,7 @@ class CredentialsService {
16977
17374
  * @returns CredentialProviderConfig
16978
17375
  * @throws ApiError
16979
17376
  */
16980
- static credentialsOrgsUsersProviderConfigRetrieve({
17377
+ static credentialsOrgsUsersProviderConfigRetrieve2({
16981
17378
  platformKey,
16982
17379
  username
16983
17380
  }) {
@@ -17009,7 +17406,7 @@ class CredentialsService {
17009
17406
  * @returns CredentialProviderConfig
17010
17407
  * @throws ApiError
17011
17408
  */
17012
- static credentialsOrgsUsersProviderConfigCreate({
17409
+ static credentialsOrgsUsersProviderConfigCreate2({
17013
17410
  platformKey,
17014
17411
  username,
17015
17412
  requestBody
@@ -17035,7 +17432,7 @@ class CredentialsService {
17035
17432
  * @returns void
17036
17433
  * @throws ApiError
17037
17434
  */
17038
- static credentialsOrgsUsersProviderConfigDestroy({
17435
+ static credentialsOrgsUsersProviderConfigDestroy2({
17039
17436
  platformKey,
17040
17437
  username
17041
17438
  }) {