@stack-spot/portal-network 0.84.0 → 0.85.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -33,6 +33,64 @@ export type UserScmInfoRequest = {
33
33
  /** Repository personal token */
34
34
  token: string;
35
35
  };
36
+ export type SecretResponse = {
37
+ /** Secret id */
38
+ id: string;
39
+ /** Secret name */
40
+ name: string;
41
+ /** Secret description */
42
+ description: string;
43
+ /** Secret type */
44
+ "type": "API_KEY" | "OAUTH" | "CERTIFICATE" | "KEY_VALUE" | "BEARER_TOKEN";
45
+ /** Secret version */
46
+ version: number;
47
+ /** Reference id for the secret */
48
+ refId?: string;
49
+ /** Secret provider */
50
+ provider: "AWS_SECRETS_MANAGER";
51
+ /** Secret scope */
52
+ scope: "USER" | "SCOPED" | "ACCOUNT";
53
+ /** Scoped to */
54
+ scopedTo?: "WORKSPACE";
55
+ /** Scoped to value */
56
+ scopedValue?: string;
57
+ /** Expiration date of the secret */
58
+ expirationDate?: string;
59
+ /** Who created the secret */
60
+ createdBy: string;
61
+ /** When the secret was created */
62
+ createdAt: string;
63
+ /** Who last updated the secret */
64
+ updatedBy?: string;
65
+ /** When the secret was last updated */
66
+ updatedAt?: string;
67
+ /** Secret status */
68
+ status: "ENABLED" | "DISABLED" | "REVOKED" | "EXPIRED";
69
+ /** Secret value */
70
+ value?: {
71
+ [key: string]: string;
72
+ };
73
+ };
74
+ export type UpdateSecretRequest = {
75
+ /** Secret name */
76
+ name?: string;
77
+ /** Secret description */
78
+ description?: string;
79
+ /** Secret type */
80
+ "type"?: "API_KEY" | "OAUTH" | "CERTIFICATE" | "KEY_VALUE" | "BEARER_TOKEN";
81
+ /** Secret scope */
82
+ scope?: "USER" | "SCOPED" | "ACCOUNT";
83
+ /** Scoped to */
84
+ scopedTo?: "WORKSPACE";
85
+ /** Scope value */
86
+ scopeValue?: string;
87
+ /** Expiration date of the secret */
88
+ expirationDate?: string;
89
+ /** Secret value */
90
+ value?: {
91
+ [key: string]: string;
92
+ };
93
+ };
36
94
  export type ScopeResponse = {
37
95
  /** Scope id */
38
96
  id: string;
@@ -50,14 +108,17 @@ export type ScopeResponse = {
50
108
  updatedAt?: string;
51
109
  };
52
110
  export type IamUpdateScopeRequest = {
111
+ /** Scope name */
53
112
  name: string;
113
+ /** Scope description */
54
114
  description?: string;
115
+ /** Scope claim mapper */
55
116
  claim_mapper: {
56
117
  [key: string]: string;
57
118
  };
58
119
  };
59
120
  export type AccountScmInfoResponse = {
60
- /** Secrets name */
121
+ /** Secret name */
61
122
  secretName?: string;
62
123
  /** SCM Workflow repository URL */
63
124
  workflowUrl?: string;
@@ -137,27 +198,43 @@ export type RoleResourceResponse = {
137
198
  actions?: ResourceActionResponse[];
138
199
  };
139
200
  export type IamCreateStatementRequest = {
201
+ /** A list of actions. */
140
202
  actions: string[];
203
+ /** The resource. */
141
204
  resource: string;
142
205
  };
143
206
  export type UpdateResourceActionsRequest = {
207
+ /** The updated list of actions. */
144
208
  actions: string[];
145
209
  };
146
210
  export type AccountMemberStackspotIamDto = {
211
+ /** Unique identifier of the account member. */
147
212
  id: string;
213
+ /** Username of the account member. */
148
214
  username: string;
215
+ /** Email address of the account member. */
149
216
  email?: string;
217
+ /** First name of the account member. */
150
218
  firstName?: string;
219
+ /** Last name of the account member. */
151
220
  lastName?: string;
221
+ /** Area code of the phone number. */
152
222
  ddd?: string;
223
+ /** International dialing code of the phone number. */
153
224
  ddi?: string;
225
+ /** Phone number of the account member. */
154
226
  phone?: string;
227
+ /** Company associated with the account member. */
155
228
  company?: string;
229
+ /** Indicates if the account member is active. */
156
230
  isActive: boolean;
231
+ /** Indicates if the email of the account member is verified. */
157
232
  isEmailVerified: boolean;
233
+ /** Additional properties related to the account member. */
158
234
  properties?: {
159
235
  [key: string]: object;
160
236
  };
237
+ /** URL of the avatar image of the account member. */
161
238
  avatarImage?: string;
162
239
  };
163
240
  export type UpdateUserRequest = {
@@ -185,16 +262,27 @@ export type UpdateUserRequest = {
185
262
  avatarImageBase64?: string;
186
263
  };
187
264
  export type UpdateUserResponse = {
265
+ /** Username of the updated user. */
188
266
  username?: string;
267
+ /** Email address of the updated user. */
189
268
  email?: string;
269
+ /** First name of the updated user. */
190
270
  firstName?: string;
271
+ /** Last name of the updated user. */
191
272
  lastName?: string;
273
+ /** International dialing code of the updated user's phone number. */
192
274
  ddi?: string;
275
+ /** Area code of the updated user's phone number. */
193
276
  ddd?: string;
277
+ /** Phone number of the updated user. */
194
278
  phone?: string;
279
+ /** Indicates if the updated user is active. */
195
280
  isActive?: boolean;
281
+ /** Company associated with the updated user. */
196
282
  company?: string;
283
+ /** Password of the updated user. */
197
284
  password?: string;
285
+ /** URL of the avatar image of the updated user. */
198
286
  avatarImage?: string;
199
287
  };
200
288
  export type UpdatePasswordRequest = {
@@ -205,16 +293,25 @@ export type InvitationUserResponse = {
205
293
  email: string;
206
294
  };
207
295
  export type UserInvitationResponse = {
296
+ /** Unique identifier of the invitation */
208
297
  id: string;
298
+ /** Identifier of the associated account */
209
299
  accountId: string;
210
300
  sender: InvitationUserResponse;
211
301
  invitedUser: InvitationUserResponse;
302
+ /** Timestamp when the invitation was created */
212
303
  createdAt: string;
304
+ /** Timestamp when the invitation was resent */
213
305
  resentAt: string;
306
+ /** Timestamp when the invitation will expire */
214
307
  expirationDate: string;
308
+ /** Role assigned to the invited user */
215
309
  roleName: string;
310
+ /** Indicates whether the account is assigned to the invited user */
216
311
  assignAccount: boolean;
312
+ /** Magic link associated with the invitation */
217
313
  magicLink: string;
314
+ /** Current status of the invitation */
218
315
  status: "ACCEPTED" | "PENDING" | "CANCELLED";
219
316
  };
220
317
  export type UpdateFeatureFlagRequest = {
@@ -458,6 +555,48 @@ export type ServiceCredentialExpirationNotifyRequest = {
458
555
  /** Information related to the Service Credential */
459
556
  credentials: ServiceCredentialInfoRequest[];
460
557
  };
558
+ export type PageResponseSecretResponse = {
559
+ /** Current page content */
560
+ items?: SecretResponse[];
561
+ /** Total elements found */
562
+ totalElements: number;
563
+ /** Current page number */
564
+ page: number;
565
+ /** Length of current page items */
566
+ size: number;
567
+ /** Total pages found */
568
+ totalPages: number;
569
+ };
570
+ export type CreateSecretRequest = {
571
+ /** Secret name */
572
+ name: string;
573
+ /** Secret description */
574
+ description: string;
575
+ /** Secret type */
576
+ "type": "API_KEY" | "OAUTH" | "CERTIFICATE" | "KEY_VALUE" | "BEARER_TOKEN";
577
+ /** Secret scope */
578
+ scope: "USER" | "SCOPED" | "ACCOUNT";
579
+ /** Scoped of */
580
+ scopedTo?: "WORKSPACE";
581
+ /** Bind to scope value */
582
+ scopeValue?: string;
583
+ /** Expiration date of the secret */
584
+ expirationDate?: string;
585
+ /** Secret value */
586
+ value: {
587
+ [key: string]: string;
588
+ };
589
+ };
590
+ export type CheckSecretAccessRequest = {
591
+ /** List of IDs to be checked */
592
+ ids: string[];
593
+ };
594
+ export type CheckSecretAccessResponse = {
595
+ /** Map of secret IDs to access status (true if the user has access, false otherwise) */
596
+ result: {
597
+ [key: string]: boolean;
598
+ };
599
+ };
461
600
  export type PagingRequest = {
462
601
  size?: number;
463
602
  page: number;
@@ -471,8 +610,11 @@ export type PagingRequest = {
471
610
  filterIn?: string;
472
611
  };
473
612
  export type IamCreateScopeRequest = {
613
+ /** Scope name */
474
614
  name: string;
615
+ /** Scope description */
475
616
  description?: string;
617
+ /** Scope claim mapper */
476
618
  claim_mapper?: {
477
619
  [key: string]: string;
478
620
  };
@@ -584,6 +726,7 @@ export type RoleGroupResponse = {
584
726
  createdAt: string;
585
727
  };
586
728
  export type RoleGroupIdsRequest = {
729
+ /** List of group IDs to be bound to the role. */
587
730
  ids: string[];
588
731
  };
589
732
  export type ResourceTypeDto = {
@@ -662,15 +805,25 @@ export type CreateUserRequest = {
662
805
  avatarImageBase64?: string;
663
806
  };
664
807
  export type CreateUserResponse = {
808
+ /** Username of the created user. */
665
809
  username: string;
810
+ /** Email address of the created user. */
666
811
  email: string;
812
+ /** Company associated with the created user. */
667
813
  company?: string;
814
+ /** First name of the created user. */
668
815
  firstName: string;
816
+ /** Last name of the created user. */
669
817
  lastName: string;
818
+ /** International dialing code of the created user's phone number. */
670
819
  ddi: string;
820
+ /** Area code of the created user's phone number. */
671
821
  ddd: string;
822
+ /** Phone number of the created user. */
672
823
  phone: string;
824
+ /** Indicates if the created user is active. */
673
825
  isActive: boolean;
826
+ /** Indicates if the email of the created user is verified. */
674
827
  isEmailVerified?: boolean;
675
828
  };
676
829
  export type ReadMemberRoleResponse = {
@@ -1150,6 +1303,38 @@ export type RotateServiceCredentialSecretRequest = {
1150
1303
  export type RotateServiceCredentialSecretResponse = {
1151
1304
  secret?: string;
1152
1305
  };
1306
+ export type DeleteMemberPermissionsRequest = {
1307
+ /** Permission Action */
1308
+ actionName: string;
1309
+ /** Slug from resource type */
1310
+ resourceTypeSlug: string;
1311
+ /** Slug from resource */
1312
+ resourceSlug: string;
1313
+ };
1314
+ export type UpdateMemberPermissionsRequest = {
1315
+ /** Permission Action */
1316
+ actionName: string;
1317
+ /** Slug from resource type */
1318
+ resourceTypeSlug: string;
1319
+ /** Slug from resource */
1320
+ resourceSlug: string;
1321
+ };
1322
+ export type DeleteGroupPermissionsRequest = {
1323
+ /** Permission Action */
1324
+ actionName: string;
1325
+ /** Slug from resource type */
1326
+ resourceTypeSlug: string;
1327
+ /** Slug from resource */
1328
+ resourceSlug: string;
1329
+ };
1330
+ export type UpdateGroupPermissionsRequest = {
1331
+ /** Permission Action */
1332
+ actionName: string;
1333
+ /** Slug from resource type */
1334
+ resourceTypeSlug: string;
1335
+ /** Slug from resource */
1336
+ resourceSlug: string;
1337
+ };
1153
1338
  export type ServiceCredentialAssociateGroupRequest = {
1154
1339
  /** Service credential groups ids */
1155
1340
  teams: string[];
@@ -1170,22 +1355,6 @@ export type UpdateMemberPreferencesRequest = {
1170
1355
  /** Theme preferences Key */
1171
1356
  theme?: "DARK" | "LIGHT";
1172
1357
  };
1173
- export type DeleteMemberPermissionsRequest = {
1174
- /** Permission Action */
1175
- actionName: string;
1176
- /** Slug from resource type */
1177
- resourceTypeSlug: string;
1178
- /** Slug from resource */
1179
- resourceSlug: string;
1180
- };
1181
- export type UpdateMemberPermissionsRequest = {
1182
- /** Permission Action */
1183
- actionName: string;
1184
- /** Slug from resource type */
1185
- resourceTypeSlug: string;
1186
- /** Slug from resource */
1187
- resourceSlug: string;
1188
- };
1189
1358
  export type MemberCredentialResponse = {
1190
1359
  /** Field to represents if credential is active */
1191
1360
  active: boolean;
@@ -1232,22 +1401,6 @@ export type UpdateGroupRequest = {
1232
1401
  /** Group image base64 */
1233
1402
  image?: string;
1234
1403
  };
1235
- export type DeleteGroupPermissionsRequest = {
1236
- /** Permission Action */
1237
- actionName: string;
1238
- /** Slug from resource type */
1239
- resourceTypeSlug: string;
1240
- /** Slug from resource */
1241
- resourceSlug: string;
1242
- };
1243
- export type UpdateGroupPermissionsRequest = {
1244
- /** Permission Action */
1245
- actionName: string;
1246
- /** Slug from resource type */
1247
- resourceTypeSlug: string;
1248
- /** Slug from resource */
1249
- resourceSlug: string;
1250
- };
1251
1404
  export type ExtensionUpdateRequest = {
1252
1405
  /** The Id from active extension version */
1253
1406
  activeVersionId?: string;
@@ -1578,9 +1731,13 @@ export type RolePermissionResponse = {
1578
1731
  statements: PermissionStatementResponse[];
1579
1732
  };
1580
1733
  export type ResourceDto = {
1734
+ /** Unique identifier of the resource. */
1581
1735
  id: string;
1736
+ /** Name of the resource. */
1582
1737
  name: string;
1738
+ /** Slug version of the resource name. */
1583
1739
  slug: string;
1740
+ /** Optional description of the resource. */
1584
1741
  description?: string;
1585
1742
  "type"?: ResourceTypeDto;
1586
1743
  };
@@ -1677,75 +1834,94 @@ export type AccountPartnerResponse = {
1677
1834
  isActive: boolean;
1678
1835
  };
1679
1836
  /**
1680
- * List User repository credential's.
1837
+ * Retrieves a list of SCM credentials associated with the current user's account, including secret names and provider details.
1681
1838
  */
1682
1839
  export declare function listScmCredentials(opts?: Oazapfts.RequestOpts): Promise<UserScmInfoResponse[]>;
1683
1840
  /**
1684
- * Update User repository credential's.
1841
+ * Updates the SCM credentials for a user by saving the new secret information and triggering an update event.
1685
1842
  */
1686
1843
  export declare function scmCredentialUpdate({ userScmInfoRequest }: {
1687
1844
  userScmInfoRequest: UserScmInfoRequest;
1688
1845
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1689
1846
  /**
1690
- * Save User repository credential's.
1847
+ * Saves user SCM credentials by validating the user, storing the credentials securely, and triggering a creation event.
1691
1848
  */
1692
1849
  export declare function scmCredentialSave({ userScmInfoRequest }: {
1693
1850
  userScmInfoRequest: UserScmInfoRequest;
1694
1851
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1695
1852
  /**
1696
- * Delete an user SCM credentials.
1853
+ * Deletes the SCM credentials of a user from the repository and secrets manager, and sends a deletion event if the credentials exist.
1697
1854
  */
1698
1855
  export declare function scmDelete(opts?: Oazapfts.RequestOpts): Promise<unknown>;
1699
1856
  /**
1700
- * Get scope by ID
1857
+ * Get secret by ID
1858
+ */
1859
+ export declare function getById({ secretId }: {
1860
+ secretId: string;
1861
+ }, opts?: Oazapfts.RequestOpts): Promise<SecretResponse>;
1862
+ /**
1863
+ * Update secret information
1864
+ */
1865
+ export declare function updateSecret({ secretId, updateSecretRequest }: {
1866
+ secretId: string;
1867
+ updateSecretRequest: UpdateSecretRequest;
1868
+ }, opts?: Oazapfts.RequestOpts): Promise<never>;
1869
+ /**
1870
+ * Delete secret by ID
1871
+ */
1872
+ export declare function deleteSecret({ secretId }: {
1873
+ secretId: string;
1874
+ }, opts?: Oazapfts.RequestOpts): Promise<never>;
1875
+ /**
1876
+ * Retrieves a specific scope by its ID for the current user's tenant and returns it.
1701
1877
  */
1702
- export declare function getById({ scopeId }: {
1878
+ export declare function getById1({ scopeId }: {
1703
1879
  scopeId: string;
1704
1880
  }, opts?: Oazapfts.RequestOpts): Promise<ScopeResponse>;
1705
1881
  /**
1706
- * Update scope information
1882
+ * Updates the details of a specific scope within the tenant using the provided scope ID and update request.
1707
1883
  */
1708
1884
  export declare function updateScope({ scopeId, iamUpdateScopeRequest }: {
1709
1885
  scopeId: string;
1710
1886
  iamUpdateScopeRequest: IamUpdateScopeRequest;
1711
- }, opts?: Oazapfts.RequestOpts): Promise<never>;
1887
+ }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1712
1888
  /**
1713
- * Delete scope by ID
1889
+ * Deletes a specific scope identified by its ID within the user's current tenant.
1714
1890
  */
1715
1891
  export declare function deleteScope({ scopeId }: {
1716
1892
  scopeId: string;
1717
- }, opts?: Oazapfts.RequestOpts): Promise<never>;
1893
+ }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1718
1894
  /**
1719
- * List repository credential's.
1895
+ * Retrieves a list of SCM credentials associated with the current user's account.
1720
1896
  */
1721
1897
  export declare function listScmCredentials1(opts?: Oazapfts.RequestOpts): Promise<AccountScmInfoResponse[]>;
1722
1898
  /**
1723
- * Update repository credential's.
1899
+ * Updates the SCM credentials for the current user's account, saving the changes and triggering an update event.
1724
1900
  */
1725
1901
  export declare function scmCredentialUpdate1({ accountScmInfoUpdateRequest }: {
1726
1902
  accountScmInfoUpdateRequest: AccountScmInfoUpdateRequest;
1727
1903
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1728
1904
  /**
1729
- * Save repository credential's.
1905
+ * Saves SCM credentials for a user's account.
1730
1906
  */
1731
1907
  export declare function scmCredentialSave1({ accountScmInfoSaveRequest }: {
1732
1908
  accountScmInfoSaveRequest: AccountScmInfoSaveRequest;
1733
1909
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1734
1910
  /**
1735
- * Update a new role for Account
1911
+ * Updates the role of an account.
1736
1912
  */
1737
1913
  export declare function updateAccountRole({ roleId, updateAccountRoleRequest }: {
1738
1914
  roleId: string;
1739
1915
  updateAccountRoleRequest: UpdateAccountRoleRequest;
1740
1916
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1741
1917
  /**
1742
- * Delete a role for Account
1918
+ * Deletes a specific account role by its ID.
1743
1919
  */
1744
1920
  export declare function deleteAccountRole({ roleId }: {
1745
1921
  roleId: string;
1746
1922
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1747
1923
  /**
1748
- * Get all Global Resources and Actions compared to role
1924
+ * Retrieves a of resources and their associated actions with their status compared to a specified role.
1749
1925
  */
1750
1926
  export declare function getResourcesAndActionsWithStatus1({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
1751
1927
  roleId: string;
@@ -1761,14 +1937,14 @@ export declare function getResourcesAndActionsWithStatus1({ roleId, size, page,
1761
1937
  filterIn?: any;
1762
1938
  }, opts?: Oazapfts.RequestOpts): Promise<RoleResourceResponse[]>;
1763
1939
  /**
1764
- * Update role with new resource and actions
1940
+ * Updates the role of an account with new resource-action statements.
1765
1941
  */
1766
1942
  export declare function updateRoleWithNewActions({ roleId, body }: {
1767
1943
  roleId: string;
1768
1944
  body: IamCreateStatementRequest[];
1769
1945
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1770
1946
  /**
1771
- * Updates actions from a resource
1947
+ * Updates the actions associated with a specific resource in a role.
1772
1948
  */
1773
1949
  export declare function updateResourceActions({ roleId, resourceId, updateResourceActionsRequest }: {
1774
1950
  roleId: string;
@@ -1776,27 +1952,27 @@ export declare function updateResourceActions({ roleId, resourceId, updateResour
1776
1952
  updateResourceActionsRequest: UpdateResourceActionsRequest;
1777
1953
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1778
1954
  /**
1779
- * Get user by id
1955
+ * Retrieves account member details by their unique identifier.
1780
1956
  */
1781
1957
  export declare function getMemberById({ memberId }: {
1782
1958
  memberId: string;
1783
1959
  }, opts?: Oazapfts.RequestOpts): Promise<AccountMemberStackspotIamDto>;
1784
1960
  /**
1785
- * Update user on current tenant
1961
+ * Updates the information of an existing user.
1786
1962
  */
1787
1963
  export declare function updateUser({ memberId, updateUserRequest }: {
1788
1964
  memberId: string;
1789
1965
  updateUserRequest: UpdateUserRequest;
1790
1966
  }, opts?: Oazapfts.RequestOpts): Promise<UpdateUserResponse>;
1791
1967
  /**
1792
- * Update user password on current tenant
1968
+ * Updates the password of a specified user.
1793
1969
  */
1794
1970
  export declare function updateUserPassword({ memberId, updatePasswordRequest }: {
1795
1971
  memberId: string;
1796
1972
  updatePasswordRequest: UpdatePasswordRequest;
1797
1973
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1798
1974
  /**
1799
- * Accept user invitation
1975
+ * Accepts an invitation for a user to collaborate on an account.
1800
1976
  */
1801
1977
  export declare function accept({ id }: {
1802
1978
  id: string;
@@ -1915,19 +2091,46 @@ export declare function notifyServiceCredentialExpiration({ serviceCredentialExp
1915
2091
  serviceCredentialExpirationRequest: ServiceCredentialExpirationNotifyRequest;
1916
2092
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1917
2093
  /**
1918
- * Find all the existing scopes
2094
+ * Find secrets with multiple filters and conditions
2095
+ */
2096
+ export declare function findSecrets1({ size, page, sort, direction, search, filterByScope, filterByType, filterByScopedBy, filterByScopedValue, authorizedOnly }: {
2097
+ size?: any;
2098
+ page?: any;
2099
+ sort?: string;
2100
+ direction?: "ASC" | "DESC";
2101
+ search?: string;
2102
+ filterByScope?: "USER" | "SCOPED" | "ACCOUNT";
2103
+ filterByType?: "API_KEY" | "OAUTH" | "CERTIFICATE" | "KEY_VALUE" | "BEARER_TOKEN";
2104
+ filterByScopedBy?: "WORKSPACE";
2105
+ filterByScopedValue?: string;
2106
+ authorizedOnly?: boolean;
2107
+ }, opts?: Oazapfts.RequestOpts): Promise<PageResponseSecretResponse>;
2108
+ /**
2109
+ * Create a new secret
2110
+ */
2111
+ export declare function createSecret({ createSecretRequest }: {
2112
+ createSecretRequest: CreateSecretRequest;
2113
+ }, opts?: Oazapfts.RequestOpts): Promise<SecretResponse>;
2114
+ /**
2115
+ * Check if user has access to secret
2116
+ */
2117
+ export declare function findSecrets({ checkSecretAccessRequest }: {
2118
+ checkSecretAccessRequest: CheckSecretAccessRequest;
2119
+ }, opts?: Oazapfts.RequestOpts): Promise<CheckSecretAccessResponse>;
2120
+ /**
2121
+ * Retrieves a paginated list of scope details for the current user's tenant.
1919
2122
  */
1920
2123
  export declare function findScopes({ page }: {
1921
2124
  page?: PagingRequest;
1922
2125
  }, opts?: Oazapfts.RequestOpts): Promise<ScopeResponse[]>;
1923
2126
  /**
1924
- * Create a new scope
2127
+ * Creates a new IAM scope for the current user's tenant using the provided request details.
1925
2128
  */
1926
2129
  export declare function createScope({ iamCreateScopeRequest }: {
1927
2130
  iamCreateScopeRequest: IamCreateScopeRequest;
1928
- }, opts?: Oazapfts.RequestOpts): Promise<never>;
2131
+ }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1929
2132
  /**
1930
- * Get Roles
2133
+ * Retrieves a list of roles available to the current account.
1931
2134
  */
1932
2135
  export declare function getRoles3({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
1933
2136
  size?: any;
@@ -1942,13 +2145,13 @@ export declare function getRoles3({ size, page, sort, direction, search, filterM
1942
2145
  filterIn?: any;
1943
2146
  }, opts?: Oazapfts.RequestOpts): Promise<RoleResponse[]>;
1944
2147
  /**
1945
- * Create a new role for Account
2148
+ * Creates a new account role.
1946
2149
  */
1947
2150
  export declare function createAccountRole({ createAccountRoleRequest }: {
1948
2151
  createAccountRoleRequest: CreateAccountRoleRequest;
1949
2152
  }, opts?: Oazapfts.RequestOpts): Promise<IdResponse>;
1950
2153
  /**
1951
- * Get role members
2154
+ * Retrieves a list of role members for a specified role.
1952
2155
  */
1953
2156
  export declare function getRoleMembers1({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
1954
2157
  roleId: string;
@@ -1964,14 +2167,14 @@ export declare function getRoleMembers1({ roleId, size, page, sort, direction, s
1964
2167
  filterIn?: any;
1965
2168
  }, opts?: Oazapfts.RequestOpts): Promise<RoleMemberResponse[]>;
1966
2169
  /**
1967
- * Add Role to Member
2170
+ * Assigns a specified role to a list of members.
1968
2171
  */
1969
2172
  export declare function addRoleToMember({ roleId, addRoleToMemberRequest }: {
1970
2173
  roleId: string;
1971
2174
  addRoleToMemberRequest: AddRoleToMemberRequest;
1972
2175
  }, opts?: Oazapfts.RequestOpts): Promise<AddUsersToRoleResponse>;
1973
2176
  /**
1974
- * Get Groups from role
2177
+ * Retrieves a list of role groups associated with a specific group ID.
1975
2178
  */
1976
2179
  export declare function getRoleGroups1({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
1977
2180
  roleId: string;
@@ -1987,7 +2190,7 @@ export declare function getRoleGroups1({ roleId, size, page, sort, direction, se
1987
2190
  filterIn?: any;
1988
2191
  }, opts?: Oazapfts.RequestOpts): Promise<RoleGroupResponse[]>;
1989
2192
  /**
1990
- * Bind roles groups
2193
+ * Bind a role to a group.
1991
2194
  */
1992
2195
  export declare function bindRoleGroups({ roleId, roleGroupIdsRequest }: {
1993
2196
  roleId: string;
@@ -2015,7 +2218,7 @@ export declare function createResource({ createResourceRequest }: {
2015
2218
  createResourceRequest: CreateResourceRequest;
2016
2219
  }, opts?: Oazapfts.RequestOpts): Promise<IdResponse>;
2017
2220
  /**
2018
- * Get Account Members
2221
+ * Retrieves a list of account members for a specified account.
2019
2222
  */
2020
2223
  export declare function getAccountMembers2({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
2021
2224
  size?: any;
@@ -2030,13 +2233,13 @@ export declare function getAccountMembers2({ size, page, sort, direction, search
2030
2233
  filterIn?: any;
2031
2234
  }, opts?: Oazapfts.RequestOpts): Promise<AccountMemberResponse[]>;
2032
2235
  /**
2033
- * Create user on current tenant
2236
+ * Creates a new user in the account.
2034
2237
  */
2035
2238
  export declare function createUser({ createUserRequest }: {
2036
2239
  createUserRequest: CreateUserRequest;
2037
2240
  }, opts?: Oazapfts.RequestOpts): Promise<CreateUserResponse>;
2038
2241
  /**
2039
- * Get member roles
2242
+ * Retrieves a paginated list of roles associated with a specific member.
2040
2243
  */
2041
2244
  export declare function getRoles4({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
2042
2245
  memberId: string;
@@ -2052,20 +2255,20 @@ export declare function getRoles4({ memberId, size, page, sort, direction, searc
2052
2255
  filterIn?: any;
2053
2256
  }, opts?: Oazapfts.RequestOpts): Promise<ReadMemberRoleResponse[]>;
2054
2257
  /**
2055
- * Bind users to roles
2258
+ * Binds a member to a list of roles.
2056
2259
  */
2057
2260
  export declare function bindToRoles({ memberId, memberIdsCommonRequest }: {
2058
2261
  memberId: string;
2059
2262
  memberIdsCommonRequest: MemberIdsCommonRequest;
2060
2263
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2061
2264
  /**
2062
- * Reset member OTP
2265
+ * Resets the OTP configuration for a specified member.
2063
2266
  */
2064
2267
  export declare function resetOtp({ memberId }: {
2065
2268
  memberId: string;
2066
2269
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2067
2270
  /**
2068
- * Get member Groups
2271
+ * Retrieves a list of groups associated with a specific member.
2069
2272
  */
2070
2273
  export declare function getMemberGroups1({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
2071
2274
  memberId: string;
@@ -2081,7 +2284,7 @@ export declare function getMemberGroups1({ memberId, size, page, sort, direction
2081
2284
  filterIn?: any;
2082
2285
  }, opts?: Oazapfts.RequestOpts): Promise<GroupReadResponse[]>;
2083
2286
  /**
2084
- * Bind users to groups
2287
+ * Binds a member to a list of groups.
2085
2288
  */
2086
2289
  export declare function bindToGroups({ memberId, memberIdsCommonRequest }: {
2087
2290
  memberId: string;
@@ -2101,19 +2304,19 @@ export declare function addAccountMemberFavorite({ memberId, createFavoriteResou
2101
2304
  createFavoriteResourceRequest: CreateFavoriteResourceRequest;
2102
2305
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2103
2306
  /**
2104
- * Send Email to reset password
2307
+ * Resets the password for a user by generating a magic link and sending it to their email.
2105
2308
  */
2106
2309
  export declare function resetPassword({ memberEmailRequest }: {
2107
2310
  memberEmailRequest: MemberEmailRequest;
2108
2311
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2109
2312
  /**
2110
- * Invite new members to account
2313
+ * Invites new members to an account and assigns them to the default group based on the account type.
2111
2314
  */
2112
2315
  export declare function inviteMembers({ body }: {
2113
2316
  body: InviteNewMemberRequest[];
2114
2317
  }, opts?: Oazapfts.RequestOpts): Promise<InviteMembersResponse>;
2115
2318
  /**
2116
- * List user invitations for account
2319
+ * Lists user invitations for account
2117
2320
  */
2118
2321
  export declare function listUserInvitations({ filterBy, filterValue, page, size }: {
2119
2322
  filterBy?: string;
@@ -2122,7 +2325,7 @@ export declare function listUserInvitations({ filterBy, filterValue, page, size
2122
2325
  size?: string;
2123
2326
  }, opts?: Oazapfts.RequestOpts): Promise<UserInvitationResponse[]>;
2124
2327
  /**
2125
- * Create user invitations for account
2328
+ * Creates and sends an invitation to a user to join an account.
2126
2329
  */
2127
2330
  export declare function createUserInvitation({ createUserInvitationRequest }: {
2128
2331
  createUserInvitationRequest: CreateUserInvitationRequest;
@@ -2426,6 +2629,34 @@ export declare function rotateServiceCredentialSecret({ id, rotateServiceCredent
2426
2629
  export declare function revokeServiceCredential({ id }: {
2427
2630
  id: string;
2428
2631
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2632
+ /**
2633
+ * Delete a member permissions
2634
+ */
2635
+ export declare function deleteMemberPermissions({ memberId, body }: {
2636
+ memberId: string;
2637
+ body: DeleteMemberPermissionsRequest[];
2638
+ }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2639
+ /**
2640
+ * Update a member's permissions by assigning resources and actions, creating a default role if necessary.
2641
+ */
2642
+ export declare function updateMemberPermissions({ memberId, body }: {
2643
+ memberId: string;
2644
+ body: UpdateMemberPermissionsRequest[];
2645
+ }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2646
+ /**
2647
+ * Delete Group permissions
2648
+ */
2649
+ export declare function deleteGroupPermissions({ groupId, body }: {
2650
+ groupId: string;
2651
+ body: DeleteGroupPermissionsRequest[];
2652
+ }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2653
+ /**
2654
+ * Update Group permissions
2655
+ */
2656
+ export declare function updateGroupPermissions({ groupId, body }: {
2657
+ groupId: string;
2658
+ body: UpdateGroupPermissionsRequest[];
2659
+ }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2429
2660
  /**
2430
2661
  * Associate Group to Service Credential
2431
2662
  */
@@ -2440,34 +2671,46 @@ export declare function revokeServiceCredential1({ id }: {
2440
2671
  id: string;
2441
2672
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2442
2673
  /**
2443
- * Update member preferences
2674
+ * Enable secret by ID
2675
+ */
2676
+ export declare function enableSecret({ secretId }: {
2677
+ secretId: string;
2678
+ }, opts?: Oazapfts.RequestOpts): Promise<never>;
2679
+ /**
2680
+ * Disable secret by ID
2681
+ */
2682
+ export declare function disableSecret({ secretId }: {
2683
+ secretId: string;
2684
+ }, opts?: Oazapfts.RequestOpts): Promise<never>;
2685
+ /**
2686
+ * Retrieves the preferences of a specific member.
2444
2687
  */
2445
2688
  export declare function getMemberPreferences({ memberId }: {
2446
2689
  memberId: string;
2447
2690
  }, opts?: Oazapfts.RequestOpts): Promise<ReadPreferencesResponse>;
2448
2691
  /**
2449
- * Update member preferences
2692
+ * Updates the preferences of a specific member.
2450
2693
  */
2451
2694
  export declare function updateMemberPreferences({ memberId, updateMemberPreferencesRequest }: {
2452
2695
  memberId: string;
2453
2696
  updateMemberPreferencesRequest: UpdateMemberPreferencesRequest;
2454
2697
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2455
2698
  /**
2456
- * Delete a member permissions
2699
+ * Deletes specific permissions from a member's role.
2457
2700
  */
2458
- export declare function deleteMemberPermissions({ memberId, deleteMemberPermissionsRequest }: {
2701
+ export declare function deleteMemberPermissions1({ memberId, deleteMemberPermissionsRequest }: {
2459
2702
  memberId: string;
2460
2703
  deleteMemberPermissionsRequest: DeleteMemberPermissionsRequest;
2461
2704
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2462
2705
  /**
2463
- * Update member permissions
2706
+ * Update a member's permissions by assigning resources and actions, creating a default role if necessary.
2464
2707
  */
2465
- export declare function updateMemberPermissions({ memberId, updateMemberPermissionsRequest }: {
2708
+ export declare function updateMemberPermissions1({ memberId, updateMemberPermissionsRequest }: {
2466
2709
  memberId: string;
2467
2710
  updateMemberPermissionsRequest: UpdateMemberPermissionsRequest;
2468
2711
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2469
2712
  /**
2470
- * Get All Fido credentials for given user
2713
+ * Retrieves a paginated list of Fido user credentials for a specific member.
2471
2714
  */
2472
2715
  export declare function getAllMemberFidoCredentials({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
2473
2716
  memberId: string;
@@ -2483,25 +2726,25 @@ export declare function getAllMemberFidoCredentials({ memberId, size, page, sort
2483
2726
  filterIn?: any;
2484
2727
  }, opts?: Oazapfts.RequestOpts): Promise<MemberCredentialsListResponse>;
2485
2728
  /**
2486
- * Disables Fido credentials for given user
2729
+ * Deactivates all Fido credentials associated with a specific member.
2487
2730
  */
2488
2731
  export declare function deactivateFidoCredentials({ memberId }: {
2489
2732
  memberId: string;
2490
2733
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2491
2734
  /**
2492
- * Enable Fido credentials for given user
2735
+ * Enables Fido credentials for a specified member.
2493
2736
  */
2494
2737
  export declare function enableFidoCredentials({ memberId }: {
2495
2738
  memberId: string;
2496
2739
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2497
2740
  /**
2498
- * Revoke user invitation
2741
+ * Cancel a user invitation.
2499
2742
  */
2500
2743
  export declare function cancelUserInvitation({ id }: {
2501
2744
  id: string;
2502
2745
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2503
2746
  /**
2504
- * Resend user invitation
2747
+ * Resends a user invitation for a specified account.
2505
2748
  */
2506
2749
  export declare function resendUserInvitation({ id }: {
2507
2750
  id: string;
@@ -2528,14 +2771,14 @@ export declare function update1({ groupId, updateGroupRequest }: {
2528
2771
  /**
2529
2772
  * Delete Group permissions
2530
2773
  */
2531
- export declare function deleteGroupPermissions({ groupId, deleteGroupPermissionsRequest }: {
2774
+ export declare function deleteGroupPermissions1({ groupId, deleteGroupPermissionsRequest }: {
2532
2775
  groupId: string;
2533
2776
  deleteGroupPermissionsRequest: DeleteGroupPermissionsRequest;
2534
2777
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
2535
2778
  /**
2536
2779
  * Update Group permissions
2537
2780
  */
2538
- export declare function updateGroupPermissions({ groupId, updateGroupPermissionsRequest }: {
2781
+ export declare function updateGroupPermissions1({ groupId, updateGroupPermissionsRequest }: {
2539
2782
  groupId: string;
2540
2783
  updateGroupPermissionsRequest: UpdateGroupPermissionsRequest;
2541
2784
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
@@ -2755,7 +2998,7 @@ export declare function getResourceTypes({ size, page, sort, direction, search,
2755
2998
  filterIn?: any;
2756
2999
  }, opts?: Oazapfts.RequestOpts): Promise<PageResponseResourceTypeResponse>;
2757
3000
  /**
2758
- * Get Account Members
3001
+ * Retrieves a list of account members.
2759
3002
  */
2760
3003
  export declare function getAccountMembers({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
2761
3004
  size?: any;
@@ -2770,7 +3013,7 @@ export declare function getAccountMembers({ size, page, sort, direction, search,
2770
3013
  filterIn?: any;
2771
3014
  }, opts?: Oazapfts.RequestOpts): Promise<PageResponseAccountMemberResponse>;
2772
3015
  /**
2773
- * Get member roles
3016
+ * Retrieves a list of roles associated with a specific member.
2774
3017
  */
2775
3018
  export declare function getRoles1({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
2776
3019
  memberId: string;
@@ -2786,7 +3029,7 @@ export declare function getRoles1({ memberId, size, page, sort, direction, searc
2786
3029
  filterIn?: any;
2787
3030
  }, opts?: Oazapfts.RequestOpts): Promise<PageResponseReadMemberRoleResponse>;
2788
3031
  /**
2789
- * Get member Groups
3032
+ * Retrieves a list of groups for a specified member.
2790
3033
  */
2791
3034
  export declare function getMemberGroups({ memberId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
2792
3035
  memberId: string;
@@ -2866,11 +3109,11 @@ export declare function getMembers({ groupId, size, page, sort, direction, searc
2866
3109
  filterIn?: any;
2867
3110
  }, opts?: Oazapfts.RequestOpts): Promise<PageResponseReadGroupMembersResponse>;
2868
3111
  /**
2869
- * Verify User repository credential configuration status.
3112
+ * Verifies if SCM credentials exist for the current user's account and email, throwing an error if not found.
2870
3113
  */
2871
3114
  export declare function isCreatedScmCredentials(opts?: Oazapfts.RequestOpts): Promise<unknown>;
2872
3115
  /**
2873
- * List Accounts of User can use and collaborate.
3116
+ * Retrieves a list of user accounts along with their collaboration roles for the current authenticated user.
2874
3117
  */
2875
3118
  export declare function getUserAccountWithRole(opts?: Oazapfts.RequestOpts): Promise<AccountCollaborationInfoResponse[]>;
2876
3119
  /**
@@ -2922,15 +3165,21 @@ export declare function getServiceCredentialGroups1({ id }: {
2922
3165
  id: string;
2923
3166
  }, opts?: Oazapfts.RequestOpts): Promise<GroupReadResponse[]>;
2924
3167
  /**
2925
- * Get SCM provider.
3168
+ * Retrieve secret value
3169
+ */
3170
+ export declare function getSecretValue({ secretId }: {
3171
+ secretId: string;
3172
+ }, opts?: Oazapfts.RequestOpts): Promise<SecretResponse>;
3173
+ /**
3174
+ * Retrieves the SCM provider information for the current user's account.
2926
3175
  */
2927
3176
  export declare function getScmProvider(opts?: Oazapfts.RequestOpts): Promise<AccountScmProviderResponse>;
2928
3177
  /**
2929
- * Verify repository credential configuration status.
3178
+ * Verifies the SCM credentials configuration for the current user's account and returns its status, indicating if the mandate or user-specific configuration exists.
2930
3179
  */
2931
3180
  export declare function isCreatedScmCredentials1(opts?: Oazapfts.RequestOpts): Promise<AccountScmStatusResponse>;
2932
3181
  /**
2933
- * Get Permissions from role
3182
+ * Retrieves a list of permissions with their status for a specified role.
2934
3183
  */
2935
3184
  export declare function getPermissionsWithStatus({ roleId, size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
2936
3185
  roleId: string;
@@ -3002,7 +3251,7 @@ export declare function getAccess({ resourceType, resource, action, attribute }:
3002
3251
  attribute?: string;
3003
3252
  }, opts?: Oazapfts.RequestOpts): Promise<boolean>;
3004
3253
  /**
3005
- * Get Resources Members
3254
+ * Retrieves a list of resources associated with the specified member.
3006
3255
  */
3007
3256
  export declare function getResources2({ memberId }: {
3008
3257
  memberId: string;
@@ -3015,7 +3264,7 @@ export declare function listMemberFavoritesByResource({ memberId, resourceType }
3015
3264
  resourceType: string;
3016
3265
  }, opts?: Oazapfts.RequestOpts): Promise<any>;
3017
3266
  /**
3018
- * Get Account Collaborators Members
3267
+ * Retrieves a list of account members and collaborators associated with the current user's account.
3019
3268
  */
3020
3269
  export declare function getAccountMembersToCollaborators({ size, page, sort, direction, search, filterMode, filterBy, filterValue, multiFilterMode, filterIn }: {
3021
3270
  size?: any;
@@ -3119,7 +3368,7 @@ export declare function disassociateGroupToServiceCredential({ id, groupId }: {
3119
3368
  groupId: string;
3120
3369
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
3121
3370
  /**
3122
- * Remove Role from Member
3371
+ * Removes a specified role from a member.
3123
3372
  */
3124
3373
  export declare function removeRoleFromMember({ roleId, memberId }: {
3125
3374
  roleId: string;
@@ -3132,7 +3381,7 @@ export declare function deleteResource({ resourceId }: {
3132
3381
  resourceId: string;
3133
3382
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
3134
3383
  /**
3135
- * Removes member profile image
3384
+ * Deletes the profile image of a member.
3136
3385
  */
3137
3386
  export declare function deleteProfileImage({ memberId }: {
3138
3387
  memberId: string;