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