sailpoint-api-client 1.8.57 → 1.8.59
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/beta/README.md +2 -2
- package/beta/api.ts +71 -11
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +71 -11
- package/dist/beta/api.js +8 -8
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +2 -2
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/v2024/api.d.ts +68 -8
- package/dist/v2024/api.js +6 -6
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +2 -2
- package/dist/v2025/api.d.ts +92 -8
- package/dist/v2025/api.js +30 -6
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +2 -2
- package/dist/v2026/api.d.ts +475 -184
- package/dist/v2026/api.js +744 -441
- package/dist/v2026/api.js.map +1 -1
- package/dist/v2026/common.js +2 -2
- package/dist/v3/api.d.ts +62 -8
- package/dist/v3/api.js +6 -6
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +2 -2
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/api.ts +68 -8
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +92 -8
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/api.ts +822 -370
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +62 -8
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v2026/api.d.ts
CHANGED
|
@@ -2177,6 +2177,12 @@ export interface AccessRequestAdminItemStatusV2026 {
|
|
|
2177
2177
|
* @memberof AccessRequestAdminItemStatusV2026
|
|
2178
2178
|
*/
|
|
2179
2179
|
'description'?: string | null;
|
|
2180
|
+
/**
|
|
2181
|
+
* When the role access is scheduled for provisioning.
|
|
2182
|
+
* @type {string}
|
|
2183
|
+
* @memberof AccessRequestAdminItemStatusV2026
|
|
2184
|
+
*/
|
|
2185
|
+
'startDate'?: string | null;
|
|
2180
2186
|
/**
|
|
2181
2187
|
* When the role access is scheduled for removal.
|
|
2182
2188
|
* @type {string}
|
|
@@ -2510,6 +2516,12 @@ export interface AccessRequestItemV2026 {
|
|
|
2510
2516
|
'clientMetadata'?: {
|
|
2511
2517
|
[key: string]: string;
|
|
2512
2518
|
};
|
|
2519
|
+
/**
|
|
2520
|
+
* The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible.
|
|
2521
|
+
* @type {string}
|
|
2522
|
+
* @memberof AccessRequestItemV2026
|
|
2523
|
+
*/
|
|
2524
|
+
'startDate'?: string;
|
|
2513
2525
|
/**
|
|
2514
2526
|
* The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for.
|
|
2515
2527
|
* @type {string}
|
|
@@ -3180,7 +3192,7 @@ export interface AccessRequestV2026 {
|
|
|
3180
3192
|
[key: string]: string;
|
|
3181
3193
|
};
|
|
3182
3194
|
/**
|
|
3183
|
-
* Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests
|
|
3195
|
+
* Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different start dates * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests
|
|
3184
3196
|
* @type {Array<RequestedForDtoRefV2026>}
|
|
3185
3197
|
* @memberof AccessRequestV2026
|
|
3186
3198
|
*/
|
|
@@ -14416,6 +14428,24 @@ export interface CompletedApprovalV2026 {
|
|
|
14416
14428
|
* @memberof CompletedApprovalV2026
|
|
14417
14429
|
*/
|
|
14418
14430
|
'currentRemoveDate'?: string | null;
|
|
14431
|
+
/**
|
|
14432
|
+
* The date the role or access profile or entitlement is/will assigned to the specified identity.
|
|
14433
|
+
* @type {string}
|
|
14434
|
+
* @memberof CompletedApprovalV2026
|
|
14435
|
+
*/
|
|
14436
|
+
'startDate'?: string;
|
|
14437
|
+
/**
|
|
14438
|
+
* If true, then the request is to change the start date or sunrise date.
|
|
14439
|
+
* @type {boolean}
|
|
14440
|
+
* @memberof CompletedApprovalV2026
|
|
14441
|
+
*/
|
|
14442
|
+
'startUpdateRequested'?: boolean;
|
|
14443
|
+
/**
|
|
14444
|
+
* The start date or sunrise date that was assigned at the time of the request.
|
|
14445
|
+
* @type {string}
|
|
14446
|
+
* @memberof CompletedApprovalV2026
|
|
14447
|
+
*/
|
|
14448
|
+
'currentStartDate'?: string;
|
|
14419
14449
|
/**
|
|
14420
14450
|
*
|
|
14421
14451
|
* @type {SodViolationContextCheckCompletedV2026}
|
|
@@ -16535,6 +16565,43 @@ export interface CreateScheduledSearchRequestV2026 {
|
|
|
16535
16565
|
*/
|
|
16536
16566
|
'displayQueryDetails'?: boolean;
|
|
16537
16567
|
}
|
|
16568
|
+
/**
|
|
16569
|
+
*
|
|
16570
|
+
* @export
|
|
16571
|
+
* @interface CreateSourceSubtypeRequestV2026
|
|
16572
|
+
*/
|
|
16573
|
+
export interface CreateSourceSubtypeRequestV2026 {
|
|
16574
|
+
/**
|
|
16575
|
+
* ID of the source where subtype is created.
|
|
16576
|
+
* @type {string}
|
|
16577
|
+
* @memberof CreateSourceSubtypeRequestV2026
|
|
16578
|
+
*/
|
|
16579
|
+
'sourceId': string;
|
|
16580
|
+
/**
|
|
16581
|
+
* Technical name of the subtype.
|
|
16582
|
+
* @type {string}
|
|
16583
|
+
* @memberof CreateSourceSubtypeRequestV2026
|
|
16584
|
+
*/
|
|
16585
|
+
'technicalName': string;
|
|
16586
|
+
/**
|
|
16587
|
+
* Display name of the subtype.
|
|
16588
|
+
* @type {string}
|
|
16589
|
+
* @memberof CreateSourceSubtypeRequestV2026
|
|
16590
|
+
*/
|
|
16591
|
+
'displayName': string;
|
|
16592
|
+
/**
|
|
16593
|
+
* Description of the subtype.
|
|
16594
|
+
* @type {string}
|
|
16595
|
+
* @memberof CreateSourceSubtypeRequestV2026
|
|
16596
|
+
*/
|
|
16597
|
+
'description': string;
|
|
16598
|
+
/**
|
|
16599
|
+
* Type of the subtype.
|
|
16600
|
+
* @type {string}
|
|
16601
|
+
* @memberof CreateSourceSubtypeRequestV2026
|
|
16602
|
+
*/
|
|
16603
|
+
'type'?: string;
|
|
16604
|
+
}
|
|
16538
16605
|
/**
|
|
16539
16606
|
* Full delivery configuration. method and endpoint_url are required.
|
|
16540
16607
|
* @export
|
|
@@ -36042,6 +36109,24 @@ export interface PendingApprovalV2026 {
|
|
|
36042
36109
|
* @memberof PendingApprovalV2026
|
|
36043
36110
|
*/
|
|
36044
36111
|
'currentRemoveDate'?: string;
|
|
36112
|
+
/**
|
|
36113
|
+
* The date the role or access profile or entitlement is/will assigned to the specified identity.
|
|
36114
|
+
* @type {string}
|
|
36115
|
+
* @memberof PendingApprovalV2026
|
|
36116
|
+
*/
|
|
36117
|
+
'startDate'?: string;
|
|
36118
|
+
/**
|
|
36119
|
+
* If true, then the request is to change the start date or sunrise date.
|
|
36120
|
+
* @type {boolean}
|
|
36121
|
+
* @memberof PendingApprovalV2026
|
|
36122
|
+
*/
|
|
36123
|
+
'startUpdateRequested'?: boolean;
|
|
36124
|
+
/**
|
|
36125
|
+
* The start date or sunrise date that was assigned at the time of the request.
|
|
36126
|
+
* @type {string}
|
|
36127
|
+
* @memberof PendingApprovalV2026
|
|
36128
|
+
*/
|
|
36129
|
+
'currentStartDate'?: string;
|
|
36045
36130
|
/**
|
|
36046
36131
|
*
|
|
36047
36132
|
* @type {SodViolationContextCheckCompletedV2026}
|
|
@@ -38930,6 +39015,12 @@ export interface RequestedItemDtoRefV2026 {
|
|
|
38930
39015
|
'clientMetadata'?: {
|
|
38931
39016
|
[key: string]: string;
|
|
38932
39017
|
};
|
|
39018
|
+
/**
|
|
39019
|
+
* The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible.
|
|
39020
|
+
* @type {string}
|
|
39021
|
+
* @memberof RequestedItemDtoRefV2026
|
|
39022
|
+
*/
|
|
39023
|
+
'startDate'?: string;
|
|
38933
39024
|
/**
|
|
38934
39025
|
* The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for.
|
|
38935
39026
|
* @type {string}
|
|
@@ -39250,6 +39341,12 @@ export interface RequestedItemStatusV2026 {
|
|
|
39250
39341
|
* @memberof RequestedItemStatusV2026
|
|
39251
39342
|
*/
|
|
39252
39343
|
'description'?: string | null;
|
|
39344
|
+
/**
|
|
39345
|
+
* When the role access is scheduled for provisioning.
|
|
39346
|
+
* @type {string}
|
|
39347
|
+
* @memberof RequestedItemStatusV2026
|
|
39348
|
+
*/
|
|
39349
|
+
'startDate'?: string | null;
|
|
39253
39350
|
/**
|
|
39254
39351
|
* When the role access is scheduled for removal.
|
|
39255
39352
|
* @type {string}
|
|
@@ -48498,6 +48595,12 @@ export interface SourceSubtypeWithSourceV2026 {
|
|
|
48498
48595
|
* @memberof SourceSubtypeWithSourceV2026
|
|
48499
48596
|
*/
|
|
48500
48597
|
'source'?: SourceSubtypeWithSourceSourceV2026;
|
|
48598
|
+
/**
|
|
48599
|
+
* Indicates if the subtype is managed by the system.
|
|
48600
|
+
* @type {boolean}
|
|
48601
|
+
* @memberof SourceSubtypeWithSourceV2026
|
|
48602
|
+
*/
|
|
48603
|
+
'systemManaged'?: boolean;
|
|
48501
48604
|
}
|
|
48502
48605
|
/**
|
|
48503
48606
|
*
|
|
@@ -56445,7 +56548,7 @@ export declare const AccessRequestsV2026ApiAxiosParamCreator: (configuration?: C
|
|
|
56445
56548
|
*/
|
|
56446
56549
|
closeAccessRequest: (closeAccessRequestV2026: CloseAccessRequestV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56447
56550
|
/**
|
|
56448
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
56551
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
56449
56552
|
* @summary Submit access request
|
|
56450
56553
|
* @param {AccessRequestV2026} accessRequestV2026
|
|
56451
56554
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56496,7 +56599,7 @@ export declare const AccessRequestsV2026ApiAxiosParamCreator: (configuration?: C
|
|
|
56496
56599
|
* @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored.
|
|
56497
56600
|
* @param {number} [limit] Max number of results to return.
|
|
56498
56601
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
56499
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
56602
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
56500
56603
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId**
|
|
56501
56604
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
56502
56605
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56559,7 +56662,7 @@ export declare const AccessRequestsV2026ApiFp: (configuration?: Configuration) =
|
|
|
56559
56662
|
*/
|
|
56560
56663
|
closeAccessRequest(closeAccessRequestV2026: CloseAccessRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
56561
56664
|
/**
|
|
56562
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
56665
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
56563
56666
|
* @summary Submit access request
|
|
56564
56667
|
* @param {AccessRequestV2026} accessRequestV2026
|
|
56565
56668
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56610,7 +56713,7 @@ export declare const AccessRequestsV2026ApiFp: (configuration?: Configuration) =
|
|
|
56610
56713
|
* @param {boolean} [count] If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored.
|
|
56611
56714
|
* @param {number} [limit] Max number of results to return.
|
|
56612
56715
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
|
|
56613
|
-
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
56716
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
56614
56717
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId**
|
|
56615
56718
|
* @param {string} [requestState] Filter the results by the state of the request. The only valid value is *EXECUTING*.
|
|
56616
56719
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56673,7 +56776,7 @@ export declare const AccessRequestsV2026ApiFactory: (configuration?: Configurati
|
|
|
56673
56776
|
*/
|
|
56674
56777
|
closeAccessRequest(requestParameters: AccessRequestsV2026ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
56675
56778
|
/**
|
|
56676
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
56779
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
56677
56780
|
* @summary Submit access request
|
|
56678
56781
|
* @param {AccessRequestsV2026ApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
56679
56782
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56934,7 +57037,7 @@ export interface AccessRequestsV2026ApiListAdministratorsAccessRequestStatusRequ
|
|
|
56934
57037
|
*/
|
|
56935
57038
|
readonly offset?: number;
|
|
56936
57039
|
/**
|
|
56937
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
57040
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
|
|
56938
57041
|
* @type {string}
|
|
56939
57042
|
* @memberof AccessRequestsV2026ApiListAdministratorsAccessRequestStatus
|
|
56940
57043
|
*/
|
|
@@ -57028,7 +57131,7 @@ export declare class AccessRequestsV2026Api extends BaseAPI {
|
|
|
57028
57131
|
*/
|
|
57029
57132
|
closeAccessRequest(requestParameters: AccessRequestsV2026ApiCloseAccessRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
57030
57133
|
/**
|
|
57031
|
-
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
57134
|
+
* Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. >**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. :::info The ability to request access using this API is constrained by the Access Request Segments defined in the API token\'s user context. ::: Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting an access request to ensure that you aren\'t requesting access that is already granted. If you use this API to request access that an identity already has, without changing the account details or end date information from the existing assignment, the API will cancel the request as a duplicate. There are two types of access request: __GRANT_ACCESS__ * Can be requested for multiple identities in a single request. * Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. * If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. * You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Now supports an alternate field \'requestedForWithRequestedItems\' for users to specify account selections while requesting items where they have more than one account on the source. :::caution If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. ::: __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. * You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. * Does not support self request. Only manager can request to revoke access for their directly managed employees. * If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. * Roles, access profiles, and entitlements can be requested for revocation. * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You cannot specify a \'startDate\' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. * You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of \'assignmentId\' and \'nativeIdentity\' fields. These fields should be used within the \'requestedItems\' section for the revoke requests. * Usage of \'requestedForWithRequestedItems\' field is not supported for revoke requests.
|
|
57032
57135
|
* @summary Submit access request
|
|
57033
57136
|
* @param {AccessRequestsV2026ApiCreateAccessRequestRequest} requestParameters Request parameters.
|
|
57034
57137
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -81477,68 +81580,182 @@ export declare class MachineAccountMappingsV2026Api extends BaseAPI {
|
|
|
81477
81580
|
* @export
|
|
81478
81581
|
*/
|
|
81479
81582
|
export declare const MachineAccountSubtypesV2026ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
81583
|
+
/**
|
|
81584
|
+
* Create a new machine account subtype.
|
|
81585
|
+
* @summary Create subtype
|
|
81586
|
+
* @param {CreateSourceSubtypeRequestV2026} createSourceSubtypeRequestV2026
|
|
81587
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81588
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81589
|
+
* @throws {RequiredError}
|
|
81590
|
+
*/
|
|
81591
|
+
createSourceSubtype: (createSourceSubtypeRequestV2026: CreateSourceSubtypeRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81480
81592
|
/**
|
|
81481
81593
|
* Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted.
|
|
81482
81594
|
* @summary Delete subtype by ID
|
|
81483
81595
|
* @param {string} subtypeId The ID of the subtype.
|
|
81596
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81597
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81598
|
+
* @throws {RequiredError}
|
|
81599
|
+
*/
|
|
81600
|
+
deleteMachineAccountSubtype: (subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81601
|
+
/**
|
|
81602
|
+
* This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.
|
|
81603
|
+
* @summary Machine Subtype Approval Config
|
|
81604
|
+
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81605
|
+
* @param {string} subtypeId machine subtype id.
|
|
81484
81606
|
* @param {*} [axiosOptions] Override http request option.
|
|
81485
81607
|
* @throws {RequiredError}
|
|
81486
81608
|
*/
|
|
81487
|
-
|
|
81609
|
+
getMachineAccountSubtypeApprovalConfig: (xSailPointExperimental: string, subtypeId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81488
81610
|
/**
|
|
81489
81611
|
* Get a machine account subtype by subtype ID.
|
|
81490
81612
|
* @summary Get subtype by ID
|
|
81491
81613
|
* @param {string} subtypeId The ID of the subtype.
|
|
81614
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81492
81615
|
* @param {*} [axiosOptions] Override http request option.
|
|
81493
81616
|
* @throws {RequiredError}
|
|
81494
81617
|
*/
|
|
81495
|
-
getSourceSubtypeById: (subtypeId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81618
|
+
getSourceSubtypeById: (subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81619
|
+
/**
|
|
81620
|
+
* Get all machine account subtypes.
|
|
81621
|
+
* @summary Retrieve all subtypes
|
|
81622
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in*
|
|
81623
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName**
|
|
81624
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81625
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81626
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81627
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81628
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81629
|
+
* @throws {RequiredError}
|
|
81630
|
+
*/
|
|
81631
|
+
listSourceSubtypes: (filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81632
|
+
/**
|
|
81633
|
+
* This endpoint retrieves the subtypes for given subtypeIds.
|
|
81634
|
+
* @summary Bulk Retrieve of Source Subtypes
|
|
81635
|
+
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81636
|
+
* @param {Array<string>} requestBody
|
|
81637
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81638
|
+
* @throws {RequiredError}
|
|
81639
|
+
*/
|
|
81640
|
+
loadBulkSourceSubtypes: (xSailPointExperimental: string, requestBody: Array<string>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81496
81641
|
/**
|
|
81497
81642
|
* Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`.
|
|
81498
81643
|
* @summary Patch subtype by ID
|
|
81499
81644
|
* @param {string} subtypeId The ID of the subtype.
|
|
81500
81645
|
* @param {Array<object>} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
81646
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81501
81647
|
* @param {*} [axiosOptions] Override http request option.
|
|
81502
81648
|
* @throws {RequiredError}
|
|
81503
81649
|
*/
|
|
81504
|
-
patchMachineAccountSubtype: (subtypeId: string, requestBody: Array<object>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81650
|
+
patchMachineAccountSubtype: (subtypeId: string, requestBody: Array<object>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81651
|
+
/**
|
|
81652
|
+
* Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.
|
|
81653
|
+
* @summary Machine Subtype Approval Config
|
|
81654
|
+
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81655
|
+
* @param {string} subtypeId machine account subtype ID.
|
|
81656
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
81657
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81658
|
+
* @throws {RequiredError}
|
|
81659
|
+
*/
|
|
81660
|
+
updateMachineAccountSubtypeApprovalConfig: (xSailPointExperimental: string, subtypeId: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81505
81661
|
};
|
|
81506
81662
|
/**
|
|
81507
81663
|
* MachineAccountSubtypesV2026Api - functional programming interface
|
|
81508
81664
|
* @export
|
|
81509
81665
|
*/
|
|
81510
81666
|
export declare const MachineAccountSubtypesV2026ApiFp: (configuration?: Configuration) => {
|
|
81667
|
+
/**
|
|
81668
|
+
* Create a new machine account subtype.
|
|
81669
|
+
* @summary Create subtype
|
|
81670
|
+
* @param {CreateSourceSubtypeRequestV2026} createSourceSubtypeRequestV2026
|
|
81671
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81672
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81673
|
+
* @throws {RequiredError}
|
|
81674
|
+
*/
|
|
81675
|
+
createSourceSubtype(createSourceSubtypeRequestV2026: CreateSourceSubtypeRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceSubtypeWithSourceV2026>>;
|
|
81511
81676
|
/**
|
|
81512
81677
|
* Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted.
|
|
81513
81678
|
* @summary Delete subtype by ID
|
|
81514
81679
|
* @param {string} subtypeId The ID of the subtype.
|
|
81680
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81681
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81682
|
+
* @throws {RequiredError}
|
|
81683
|
+
*/
|
|
81684
|
+
deleteMachineAccountSubtype(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
81685
|
+
/**
|
|
81686
|
+
* This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.
|
|
81687
|
+
* @summary Machine Subtype Approval Config
|
|
81688
|
+
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81689
|
+
* @param {string} subtypeId machine subtype id.
|
|
81515
81690
|
* @param {*} [axiosOptions] Override http request option.
|
|
81516
81691
|
* @throws {RequiredError}
|
|
81517
81692
|
*/
|
|
81518
|
-
|
|
81693
|
+
getMachineAccountSubtypeApprovalConfig(xSailPointExperimental: string, subtypeId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MachineAccountSubtypeConfigDtoV2026>>;
|
|
81519
81694
|
/**
|
|
81520
81695
|
* Get a machine account subtype by subtype ID.
|
|
81521
81696
|
* @summary Get subtype by ID
|
|
81522
81697
|
* @param {string} subtypeId The ID of the subtype.
|
|
81698
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81699
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81700
|
+
* @throws {RequiredError}
|
|
81701
|
+
*/
|
|
81702
|
+
getSourceSubtypeById(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceSubtypeWithSourceV2026>>;
|
|
81703
|
+
/**
|
|
81704
|
+
* Get all machine account subtypes.
|
|
81705
|
+
* @summary Retrieve all subtypes
|
|
81706
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in*
|
|
81707
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName**
|
|
81708
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81709
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81710
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81711
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81523
81712
|
* @param {*} [axiosOptions] Override http request option.
|
|
81524
81713
|
* @throws {RequiredError}
|
|
81525
81714
|
*/
|
|
81526
|
-
|
|
81715
|
+
listSourceSubtypes(filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceSubtypeWithSourceV2026>>>;
|
|
81716
|
+
/**
|
|
81717
|
+
* This endpoint retrieves the subtypes for given subtypeIds.
|
|
81718
|
+
* @summary Bulk Retrieve of Source Subtypes
|
|
81719
|
+
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81720
|
+
* @param {Array<string>} requestBody
|
|
81721
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81722
|
+
* @throws {RequiredError}
|
|
81723
|
+
*/
|
|
81724
|
+
loadBulkSourceSubtypes(xSailPointExperimental: string, requestBody: Array<string>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceSubtypeWithSourceV2026>>>;
|
|
81527
81725
|
/**
|
|
81528
81726
|
* Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`.
|
|
81529
81727
|
* @summary Patch subtype by ID
|
|
81530
81728
|
* @param {string} subtypeId The ID of the subtype.
|
|
81531
81729
|
* @param {Array<object>} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
81730
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81731
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81732
|
+
* @throws {RequiredError}
|
|
81733
|
+
*/
|
|
81734
|
+
patchMachineAccountSubtype(subtypeId: string, requestBody: Array<object>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceSubtypeWithSourceV2026>>;
|
|
81735
|
+
/**
|
|
81736
|
+
* Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.
|
|
81737
|
+
* @summary Machine Subtype Approval Config
|
|
81738
|
+
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81739
|
+
* @param {string} subtypeId machine account subtype ID.
|
|
81740
|
+
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
81532
81741
|
* @param {*} [axiosOptions] Override http request option.
|
|
81533
81742
|
* @throws {RequiredError}
|
|
81534
81743
|
*/
|
|
81535
|
-
|
|
81744
|
+
updateMachineAccountSubtypeApprovalConfig(xSailPointExperimental: string, subtypeId: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MachineAccountSubtypeConfigDtoV2026>>;
|
|
81536
81745
|
};
|
|
81537
81746
|
/**
|
|
81538
81747
|
* MachineAccountSubtypesV2026Api - factory interface
|
|
81539
81748
|
* @export
|
|
81540
81749
|
*/
|
|
81541
81750
|
export declare const MachineAccountSubtypesV2026ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
81751
|
+
/**
|
|
81752
|
+
* Create a new machine account subtype.
|
|
81753
|
+
* @summary Create subtype
|
|
81754
|
+
* @param {MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest} requestParameters Request parameters.
|
|
81755
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81756
|
+
* @throws {RequiredError}
|
|
81757
|
+
*/
|
|
81758
|
+
createSourceSubtype(requestParameters: MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceSubtypeWithSourceV2026>;
|
|
81542
81759
|
/**
|
|
81543
81760
|
* Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted.
|
|
81544
81761
|
* @summary Delete subtype by ID
|
|
@@ -81547,6 +81764,14 @@ export declare const MachineAccountSubtypesV2026ApiFactory: (configuration?: Con
|
|
|
81547
81764
|
* @throws {RequiredError}
|
|
81548
81765
|
*/
|
|
81549
81766
|
deleteMachineAccountSubtype(requestParameters: MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
81767
|
+
/**
|
|
81768
|
+
* This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.
|
|
81769
|
+
* @summary Machine Subtype Approval Config
|
|
81770
|
+
* @param {MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters.
|
|
81771
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81772
|
+
* @throws {RequiredError}
|
|
81773
|
+
*/
|
|
81774
|
+
getMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<MachineAccountSubtypeConfigDtoV2026>;
|
|
81550
81775
|
/**
|
|
81551
81776
|
* Get a machine account subtype by subtype ID.
|
|
81552
81777
|
* @summary Get subtype by ID
|
|
@@ -81555,6 +81780,22 @@ export declare const MachineAccountSubtypesV2026ApiFactory: (configuration?: Con
|
|
|
81555
81780
|
* @throws {RequiredError}
|
|
81556
81781
|
*/
|
|
81557
81782
|
getSourceSubtypeById(requestParameters: MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceSubtypeWithSourceV2026>;
|
|
81783
|
+
/**
|
|
81784
|
+
* Get all machine account subtypes.
|
|
81785
|
+
* @summary Retrieve all subtypes
|
|
81786
|
+
* @param {MachineAccountSubtypesV2026ApiListSourceSubtypesRequest} requestParameters Request parameters.
|
|
81787
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81788
|
+
* @throws {RequiredError}
|
|
81789
|
+
*/
|
|
81790
|
+
listSourceSubtypes(requestParameters?: MachineAccountSubtypesV2026ApiListSourceSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SourceSubtypeWithSourceV2026>>;
|
|
81791
|
+
/**
|
|
81792
|
+
* This endpoint retrieves the subtypes for given subtypeIds.
|
|
81793
|
+
* @summary Bulk Retrieve of Source Subtypes
|
|
81794
|
+
* @param {MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest} requestParameters Request parameters.
|
|
81795
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81796
|
+
* @throws {RequiredError}
|
|
81797
|
+
*/
|
|
81798
|
+
loadBulkSourceSubtypes(requestParameters: MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SourceSubtypeWithSourceV2026>>;
|
|
81558
81799
|
/**
|
|
81559
81800
|
* Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`.
|
|
81560
81801
|
* @summary Patch subtype by ID
|
|
@@ -81563,7 +81804,34 @@ export declare const MachineAccountSubtypesV2026ApiFactory: (configuration?: Con
|
|
|
81563
81804
|
* @throws {RequiredError}
|
|
81564
81805
|
*/
|
|
81565
81806
|
patchMachineAccountSubtype(requestParameters: MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceSubtypeWithSourceV2026>;
|
|
81807
|
+
/**
|
|
81808
|
+
* Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.
|
|
81809
|
+
* @summary Machine Subtype Approval Config
|
|
81810
|
+
* @param {MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters.
|
|
81811
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
81812
|
+
* @throws {RequiredError}
|
|
81813
|
+
*/
|
|
81814
|
+
updateMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<MachineAccountSubtypeConfigDtoV2026>;
|
|
81566
81815
|
};
|
|
81816
|
+
/**
|
|
81817
|
+
* Request parameters for createSourceSubtype operation in MachineAccountSubtypesV2026Api.
|
|
81818
|
+
* @export
|
|
81819
|
+
* @interface MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest
|
|
81820
|
+
*/
|
|
81821
|
+
export interface MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest {
|
|
81822
|
+
/**
|
|
81823
|
+
*
|
|
81824
|
+
* @type {CreateSourceSubtypeRequestV2026}
|
|
81825
|
+
* @memberof MachineAccountSubtypesV2026ApiCreateSourceSubtype
|
|
81826
|
+
*/
|
|
81827
|
+
readonly createSourceSubtypeRequestV2026: CreateSourceSubtypeRequestV2026;
|
|
81828
|
+
/**
|
|
81829
|
+
* Use this header to enable this experimental API.
|
|
81830
|
+
* @type {string}
|
|
81831
|
+
* @memberof MachineAccountSubtypesV2026ApiCreateSourceSubtype
|
|
81832
|
+
*/
|
|
81833
|
+
readonly xSailPointExperimental?: string;
|
|
81834
|
+
}
|
|
81567
81835
|
/**
|
|
81568
81836
|
* Request parameters for deleteMachineAccountSubtype operation in MachineAccountSubtypesV2026Api.
|
|
81569
81837
|
* @export
|
|
@@ -81576,6 +81844,31 @@ export interface MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeReques
|
|
|
81576
81844
|
* @memberof MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtype
|
|
81577
81845
|
*/
|
|
81578
81846
|
readonly subtypeId: string;
|
|
81847
|
+
/**
|
|
81848
|
+
* Use this header to enable this experimental API.
|
|
81849
|
+
* @type {string}
|
|
81850
|
+
* @memberof MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtype
|
|
81851
|
+
*/
|
|
81852
|
+
readonly xSailPointExperimental?: string;
|
|
81853
|
+
}
|
|
81854
|
+
/**
|
|
81855
|
+
* Request parameters for getMachineAccountSubtypeApprovalConfig operation in MachineAccountSubtypesV2026Api.
|
|
81856
|
+
* @export
|
|
81857
|
+
* @interface MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest
|
|
81858
|
+
*/
|
|
81859
|
+
export interface MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest {
|
|
81860
|
+
/**
|
|
81861
|
+
* Use this header to enable this experimental API.
|
|
81862
|
+
* @type {string}
|
|
81863
|
+
* @memberof MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfig
|
|
81864
|
+
*/
|
|
81865
|
+
readonly xSailPointExperimental: string;
|
|
81866
|
+
/**
|
|
81867
|
+
* machine subtype id.
|
|
81868
|
+
* @type {string}
|
|
81869
|
+
* @memberof MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfig
|
|
81870
|
+
*/
|
|
81871
|
+
readonly subtypeId: string;
|
|
81579
81872
|
}
|
|
81580
81873
|
/**
|
|
81581
81874
|
* Request parameters for getSourceSubtypeById operation in MachineAccountSubtypesV2026Api.
|
|
@@ -81589,6 +81882,74 @@ export interface MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest {
|
|
|
81589
81882
|
* @memberof MachineAccountSubtypesV2026ApiGetSourceSubtypeById
|
|
81590
81883
|
*/
|
|
81591
81884
|
readonly subtypeId: string;
|
|
81885
|
+
/**
|
|
81886
|
+
* Use this header to enable this experimental API.
|
|
81887
|
+
* @type {string}
|
|
81888
|
+
* @memberof MachineAccountSubtypesV2026ApiGetSourceSubtypeById
|
|
81889
|
+
*/
|
|
81890
|
+
readonly xSailPointExperimental?: string;
|
|
81891
|
+
}
|
|
81892
|
+
/**
|
|
81893
|
+
* Request parameters for listSourceSubtypes operation in MachineAccountSubtypesV2026Api.
|
|
81894
|
+
* @export
|
|
81895
|
+
* @interface MachineAccountSubtypesV2026ApiListSourceSubtypesRequest
|
|
81896
|
+
*/
|
|
81897
|
+
export interface MachineAccountSubtypesV2026ApiListSourceSubtypesRequest {
|
|
81898
|
+
/**
|
|
81899
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in*
|
|
81900
|
+
* @type {string}
|
|
81901
|
+
* @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes
|
|
81902
|
+
*/
|
|
81903
|
+
readonly filters?: string;
|
|
81904
|
+
/**
|
|
81905
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName**
|
|
81906
|
+
* @type {string}
|
|
81907
|
+
* @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes
|
|
81908
|
+
*/
|
|
81909
|
+
readonly sorters?: string;
|
|
81910
|
+
/**
|
|
81911
|
+
* Use this header to enable this experimental API.
|
|
81912
|
+
* @type {string}
|
|
81913
|
+
* @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes
|
|
81914
|
+
*/
|
|
81915
|
+
readonly xSailPointExperimental?: string;
|
|
81916
|
+
/**
|
|
81917
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81918
|
+
* @type {boolean}
|
|
81919
|
+
* @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes
|
|
81920
|
+
*/
|
|
81921
|
+
readonly count?: boolean;
|
|
81922
|
+
/**
|
|
81923
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81924
|
+
* @type {number}
|
|
81925
|
+
* @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes
|
|
81926
|
+
*/
|
|
81927
|
+
readonly limit?: number;
|
|
81928
|
+
/**
|
|
81929
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81930
|
+
* @type {number}
|
|
81931
|
+
* @memberof MachineAccountSubtypesV2026ApiListSourceSubtypes
|
|
81932
|
+
*/
|
|
81933
|
+
readonly offset?: number;
|
|
81934
|
+
}
|
|
81935
|
+
/**
|
|
81936
|
+
* Request parameters for loadBulkSourceSubtypes operation in MachineAccountSubtypesV2026Api.
|
|
81937
|
+
* @export
|
|
81938
|
+
* @interface MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest
|
|
81939
|
+
*/
|
|
81940
|
+
export interface MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest {
|
|
81941
|
+
/**
|
|
81942
|
+
* Use this header to enable this experimental API.
|
|
81943
|
+
* @type {string}
|
|
81944
|
+
* @memberof MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypes
|
|
81945
|
+
*/
|
|
81946
|
+
readonly xSailPointExperimental: string;
|
|
81947
|
+
/**
|
|
81948
|
+
*
|
|
81949
|
+
* @type {Array<string>}
|
|
81950
|
+
* @memberof MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypes
|
|
81951
|
+
*/
|
|
81952
|
+
readonly requestBody: Array<string>;
|
|
81592
81953
|
}
|
|
81593
81954
|
/**
|
|
81594
81955
|
* Request parameters for patchMachineAccountSubtype operation in MachineAccountSubtypesV2026Api.
|
|
@@ -81608,6 +81969,37 @@ export interface MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest
|
|
|
81608
81969
|
* @memberof MachineAccountSubtypesV2026ApiPatchMachineAccountSubtype
|
|
81609
81970
|
*/
|
|
81610
81971
|
readonly requestBody: Array<object>;
|
|
81972
|
+
/**
|
|
81973
|
+
* Use this header to enable this experimental API.
|
|
81974
|
+
* @type {string}
|
|
81975
|
+
* @memberof MachineAccountSubtypesV2026ApiPatchMachineAccountSubtype
|
|
81976
|
+
*/
|
|
81977
|
+
readonly xSailPointExperimental?: string;
|
|
81978
|
+
}
|
|
81979
|
+
/**
|
|
81980
|
+
* Request parameters for updateMachineAccountSubtypeApprovalConfig operation in MachineAccountSubtypesV2026Api.
|
|
81981
|
+
* @export
|
|
81982
|
+
* @interface MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest
|
|
81983
|
+
*/
|
|
81984
|
+
export interface MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest {
|
|
81985
|
+
/**
|
|
81986
|
+
* Use this header to enable this experimental API.
|
|
81987
|
+
* @type {string}
|
|
81988
|
+
* @memberof MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfig
|
|
81989
|
+
*/
|
|
81990
|
+
readonly xSailPointExperimental: string;
|
|
81991
|
+
/**
|
|
81992
|
+
* machine account subtype ID.
|
|
81993
|
+
* @type {string}
|
|
81994
|
+
* @memberof MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfig
|
|
81995
|
+
*/
|
|
81996
|
+
readonly subtypeId: string;
|
|
81997
|
+
/**
|
|
81998
|
+
* The JSONPatch payload used to update the object.
|
|
81999
|
+
* @type {Array<JsonPatchOperationV2026>}
|
|
82000
|
+
* @memberof MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfig
|
|
82001
|
+
*/
|
|
82002
|
+
readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>;
|
|
81611
82003
|
}
|
|
81612
82004
|
/**
|
|
81613
82005
|
* MachineAccountSubtypesV2026Api - object-oriented interface
|
|
@@ -81616,6 +82008,15 @@ export interface MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest
|
|
|
81616
82008
|
* @extends {BaseAPI}
|
|
81617
82009
|
*/
|
|
81618
82010
|
export declare class MachineAccountSubtypesV2026Api extends BaseAPI {
|
|
82011
|
+
/**
|
|
82012
|
+
* Create a new machine account subtype.
|
|
82013
|
+
* @summary Create subtype
|
|
82014
|
+
* @param {MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest} requestParameters Request parameters.
|
|
82015
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82016
|
+
* @throws {RequiredError}
|
|
82017
|
+
* @memberof MachineAccountSubtypesV2026Api
|
|
82018
|
+
*/
|
|
82019
|
+
createSourceSubtype(requestParameters: MachineAccountSubtypesV2026ApiCreateSourceSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceSubtypeWithSourceV2026, any>>;
|
|
81619
82020
|
/**
|
|
81620
82021
|
* Delete a machine account subtype by subtype ID. Note: If subtype has approval settings or entitlement for machine account creation enablement then it\'ll be also deleted.
|
|
81621
82022
|
* @summary Delete subtype by ID
|
|
@@ -81625,6 +82026,15 @@ export declare class MachineAccountSubtypesV2026Api extends BaseAPI {
|
|
|
81625
82026
|
* @memberof MachineAccountSubtypesV2026Api
|
|
81626
82027
|
*/
|
|
81627
82028
|
deleteMachineAccountSubtype(requestParameters: MachineAccountSubtypesV2026ApiDeleteMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
82029
|
+
/**
|
|
82030
|
+
* This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.
|
|
82031
|
+
* @summary Machine Subtype Approval Config
|
|
82032
|
+
* @param {MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters.
|
|
82033
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82034
|
+
* @throws {RequiredError}
|
|
82035
|
+
* @memberof MachineAccountSubtypesV2026Api
|
|
82036
|
+
*/
|
|
82037
|
+
getMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountSubtypesV2026ApiGetMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MachineAccountSubtypeConfigDtoV2026, any>>;
|
|
81628
82038
|
/**
|
|
81629
82039
|
* Get a machine account subtype by subtype ID.
|
|
81630
82040
|
* @summary Get subtype by ID
|
|
@@ -81634,6 +82044,24 @@ export declare class MachineAccountSubtypesV2026Api extends BaseAPI {
|
|
|
81634
82044
|
* @memberof MachineAccountSubtypesV2026Api
|
|
81635
82045
|
*/
|
|
81636
82046
|
getSourceSubtypeById(requestParameters: MachineAccountSubtypesV2026ApiGetSourceSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceSubtypeWithSourceV2026, any>>;
|
|
82047
|
+
/**
|
|
82048
|
+
* Get all machine account subtypes.
|
|
82049
|
+
* @summary Retrieve all subtypes
|
|
82050
|
+
* @param {MachineAccountSubtypesV2026ApiListSourceSubtypesRequest} requestParameters Request parameters.
|
|
82051
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82052
|
+
* @throws {RequiredError}
|
|
82053
|
+
* @memberof MachineAccountSubtypesV2026Api
|
|
82054
|
+
*/
|
|
82055
|
+
listSourceSubtypes(requestParameters?: MachineAccountSubtypesV2026ApiListSourceSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceSubtypeWithSourceV2026[], any>>;
|
|
82056
|
+
/**
|
|
82057
|
+
* This endpoint retrieves the subtypes for given subtypeIds.
|
|
82058
|
+
* @summary Bulk Retrieve of Source Subtypes
|
|
82059
|
+
* @param {MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest} requestParameters Request parameters.
|
|
82060
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82061
|
+
* @throws {RequiredError}
|
|
82062
|
+
* @memberof MachineAccountSubtypesV2026Api
|
|
82063
|
+
*/
|
|
82064
|
+
loadBulkSourceSubtypes(requestParameters: MachineAccountSubtypesV2026ApiLoadBulkSourceSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceSubtypeWithSourceV2026[], any>>;
|
|
81637
82065
|
/**
|
|
81638
82066
|
* Update fields of a machine account subtype by subtype ID. Patchable fields only include: `displayName`, `description`.
|
|
81639
82067
|
* @summary Patch subtype by ID
|
|
@@ -81643,6 +82071,15 @@ export declare class MachineAccountSubtypesV2026Api extends BaseAPI {
|
|
|
81643
82071
|
* @memberof MachineAccountSubtypesV2026Api
|
|
81644
82072
|
*/
|
|
81645
82073
|
patchMachineAccountSubtype(requestParameters: MachineAccountSubtypesV2026ApiPatchMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceSubtypeWithSourceV2026, any>>;
|
|
82074
|
+
/**
|
|
82075
|
+
* Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.
|
|
82076
|
+
* @summary Machine Subtype Approval Config
|
|
82077
|
+
* @param {MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters.
|
|
82078
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
82079
|
+
* @throws {RequiredError}
|
|
82080
|
+
* @memberof MachineAccountSubtypesV2026Api
|
|
82081
|
+
*/
|
|
82082
|
+
updateMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountSubtypesV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MachineAccountSubtypeConfigDtoV2026, any>>;
|
|
81646
82083
|
}
|
|
81647
82084
|
/**
|
|
81648
82085
|
* MachineAccountsV2026Api - axios parameter creator
|
|
@@ -81656,6 +82093,7 @@ export declare const MachineAccountsV2026ApiAxiosParamCreator: (configuration?:
|
|
|
81656
82093
|
* @param {CreateMachineAccountSubtypeRequestV2026} createMachineAccountSubtypeRequestV2026
|
|
81657
82094
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81658
82095
|
* @param {*} [axiosOptions] Override http request option.
|
|
82096
|
+
* @deprecated
|
|
81659
82097
|
* @throws {RequiredError}
|
|
81660
82098
|
*/
|
|
81661
82099
|
createMachineAccountSubtype: (sourceId: string, createMachineAccountSubtypeRequestV2026: CreateMachineAccountSubtypeRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -81666,6 +82104,7 @@ export declare const MachineAccountsV2026ApiAxiosParamCreator: (configuration?:
|
|
|
81666
82104
|
* @param {string} technicalName The technical name of the subtype.
|
|
81667
82105
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81668
82106
|
* @param {*} [axiosOptions] Override http request option.
|
|
82107
|
+
* @deprecated
|
|
81669
82108
|
* @throws {RequiredError}
|
|
81670
82109
|
*/
|
|
81671
82110
|
deleteMachineAccountSubtypeByTechnicalName: (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -81678,21 +82117,13 @@ export declare const MachineAccountsV2026ApiAxiosParamCreator: (configuration?:
|
|
|
81678
82117
|
* @throws {RequiredError}
|
|
81679
82118
|
*/
|
|
81680
82119
|
getMachineAccount: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81681
|
-
/**
|
|
81682
|
-
* This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.
|
|
81683
|
-
* @summary Machine Subtype Approval Config
|
|
81684
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81685
|
-
* @param {string} subtypeId machine subtype id.
|
|
81686
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
81687
|
-
* @throws {RequiredError}
|
|
81688
|
-
*/
|
|
81689
|
-
getMachineAccountSubtypeApprovalConfig: (xSailPointExperimental: string, subtypeId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81690
82120
|
/**
|
|
81691
82121
|
* Get a machine account subtype by its unique ID.
|
|
81692
82122
|
* @summary Retrieve subtype by subtype id
|
|
81693
82123
|
* @param {string} subtypeId The ID of the machine account subtype.
|
|
81694
82124
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81695
82125
|
* @param {*} [axiosOptions] Override http request option.
|
|
82126
|
+
* @deprecated
|
|
81696
82127
|
* @throws {RequiredError}
|
|
81697
82128
|
*/
|
|
81698
82129
|
getMachineAccountSubtypeById: (subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -81703,6 +82134,7 @@ export declare const MachineAccountsV2026ApiAxiosParamCreator: (configuration?:
|
|
|
81703
82134
|
* @param {string} technicalName The technical name of the subtype.
|
|
81704
82135
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81705
82136
|
* @param {*} [axiosOptions] Override http request option.
|
|
82137
|
+
* @deprecated
|
|
81706
82138
|
* @throws {RequiredError}
|
|
81707
82139
|
*/
|
|
81708
82140
|
getMachineAccountSubtypeByTechnicalName: (sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -81717,6 +82149,7 @@ export declare const MachineAccountsV2026ApiAxiosParamCreator: (configuration?:
|
|
|
81717
82149
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81718
82150
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81719
82151
|
* @param {*} [axiosOptions] Override http request option.
|
|
82152
|
+
* @deprecated
|
|
81720
82153
|
* @throws {RequiredError}
|
|
81721
82154
|
*/
|
|
81722
82155
|
listMachineAccountSubtypes: (sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -81733,15 +82166,6 @@ export declare const MachineAccountsV2026ApiAxiosParamCreator: (configuration?:
|
|
|
81733
82166
|
* @throws {RequiredError}
|
|
81734
82167
|
*/
|
|
81735
82168
|
listMachineAccounts: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81736
|
-
/**
|
|
81737
|
-
* This endpoint retrieves the subtypes for given subtypeIds.
|
|
81738
|
-
* @summary Bulk Retrieve of Source Subtypes
|
|
81739
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81740
|
-
* @param {Array<string>} requestBody
|
|
81741
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
81742
|
-
* @throws {RequiredError}
|
|
81743
|
-
*/
|
|
81744
|
-
loadBulkSourceSubtypes: (xSailPointExperimental: string, requestBody: Array<string>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81745
82169
|
/**
|
|
81746
82170
|
* Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`.
|
|
81747
82171
|
* @summary Patch subtype
|
|
@@ -81750,6 +82174,7 @@ export declare const MachineAccountsV2026ApiAxiosParamCreator: (configuration?:
|
|
|
81750
82174
|
* @param {Array<object>} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
81751
82175
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81752
82176
|
* @param {*} [axiosOptions] Override http request option.
|
|
82177
|
+
* @deprecated
|
|
81753
82178
|
* @throws {RequiredError}
|
|
81754
82179
|
*/
|
|
81755
82180
|
patchMachineAccountSubtypeByTechnicalName: (sourceId: string, technicalName: string, requestBody: Array<object>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -81763,16 +82188,6 @@ export declare const MachineAccountsV2026ApiAxiosParamCreator: (configuration?:
|
|
|
81763
82188
|
* @throws {RequiredError}
|
|
81764
82189
|
*/
|
|
81765
82190
|
updateMachineAccount: (id: string, requestBody: Array<object>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81766
|
-
/**
|
|
81767
|
-
* Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.
|
|
81768
|
-
* @summary Machine Subtype Approval Config
|
|
81769
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81770
|
-
* @param {string} subtypeId machine account subtype ID.
|
|
81771
|
-
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
81772
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
81773
|
-
* @throws {RequiredError}
|
|
81774
|
-
*/
|
|
81775
|
-
updateMachineAccountSubtypeApprovalConfig: (xSailPointExperimental: string, subtypeId: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81776
82191
|
};
|
|
81777
82192
|
/**
|
|
81778
82193
|
* MachineAccountsV2026Api - functional programming interface
|
|
@@ -81786,6 +82201,7 @@ export declare const MachineAccountsV2026ApiFp: (configuration?: Configuration)
|
|
|
81786
82201
|
* @param {CreateMachineAccountSubtypeRequestV2026} createMachineAccountSubtypeRequestV2026
|
|
81787
82202
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81788
82203
|
* @param {*} [axiosOptions] Override http request option.
|
|
82204
|
+
* @deprecated
|
|
81789
82205
|
* @throws {RequiredError}
|
|
81790
82206
|
*/
|
|
81791
82207
|
createMachineAccountSubtype(sourceId: string, createMachineAccountSubtypeRequestV2026: CreateMachineAccountSubtypeRequestV2026, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceSubtypeV2026>>;
|
|
@@ -81796,6 +82212,7 @@ export declare const MachineAccountsV2026ApiFp: (configuration?: Configuration)
|
|
|
81796
82212
|
* @param {string} technicalName The technical name of the subtype.
|
|
81797
82213
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81798
82214
|
* @param {*} [axiosOptions] Override http request option.
|
|
82215
|
+
* @deprecated
|
|
81799
82216
|
* @throws {RequiredError}
|
|
81800
82217
|
*/
|
|
81801
82218
|
deleteMachineAccountSubtypeByTechnicalName(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
@@ -81808,21 +82225,13 @@ export declare const MachineAccountsV2026ApiFp: (configuration?: Configuration)
|
|
|
81808
82225
|
* @throws {RequiredError}
|
|
81809
82226
|
*/
|
|
81810
82227
|
getMachineAccount(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MachineAccountV2026>>;
|
|
81811
|
-
/**
|
|
81812
|
-
* This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.
|
|
81813
|
-
* @summary Machine Subtype Approval Config
|
|
81814
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81815
|
-
* @param {string} subtypeId machine subtype id.
|
|
81816
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
81817
|
-
* @throws {RequiredError}
|
|
81818
|
-
*/
|
|
81819
|
-
getMachineAccountSubtypeApprovalConfig(xSailPointExperimental: string, subtypeId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MachineAccountSubtypeConfigDtoV2026>>;
|
|
81820
82228
|
/**
|
|
81821
82229
|
* Get a machine account subtype by its unique ID.
|
|
81822
82230
|
* @summary Retrieve subtype by subtype id
|
|
81823
82231
|
* @param {string} subtypeId The ID of the machine account subtype.
|
|
81824
82232
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81825
82233
|
* @param {*} [axiosOptions] Override http request option.
|
|
82234
|
+
* @deprecated
|
|
81826
82235
|
* @throws {RequiredError}
|
|
81827
82236
|
*/
|
|
81828
82237
|
getMachineAccountSubtypeById(subtypeId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceSubtypeV2026>>;
|
|
@@ -81833,6 +82242,7 @@ export declare const MachineAccountsV2026ApiFp: (configuration?: Configuration)
|
|
|
81833
82242
|
* @param {string} technicalName The technical name of the subtype.
|
|
81834
82243
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81835
82244
|
* @param {*} [axiosOptions] Override http request option.
|
|
82245
|
+
* @deprecated
|
|
81836
82246
|
* @throws {RequiredError}
|
|
81837
82247
|
*/
|
|
81838
82248
|
getMachineAccountSubtypeByTechnicalName(sourceId: string, technicalName: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceSubtypeV2026>>;
|
|
@@ -81847,6 +82257,7 @@ export declare const MachineAccountsV2026ApiFp: (configuration?: Configuration)
|
|
|
81847
82257
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81848
82258
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
81849
82259
|
* @param {*} [axiosOptions] Override http request option.
|
|
82260
|
+
* @deprecated
|
|
81850
82261
|
* @throws {RequiredError}
|
|
81851
82262
|
*/
|
|
81852
82263
|
listMachineAccountSubtypes(sourceId: string, filters?: string, sorters?: string, xSailPointExperimental?: string, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceSubtypeV2026>>>;
|
|
@@ -81863,15 +82274,6 @@ export declare const MachineAccountsV2026ApiFp: (configuration?: Configuration)
|
|
|
81863
82274
|
* @throws {RequiredError}
|
|
81864
82275
|
*/
|
|
81865
82276
|
listMachineAccounts(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MachineAccountV2026>>>;
|
|
81866
|
-
/**
|
|
81867
|
-
* This endpoint retrieves the subtypes for given subtypeIds.
|
|
81868
|
-
* @summary Bulk Retrieve of Source Subtypes
|
|
81869
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81870
|
-
* @param {Array<string>} requestBody
|
|
81871
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
81872
|
-
* @throws {RequiredError}
|
|
81873
|
-
*/
|
|
81874
|
-
loadBulkSourceSubtypes(xSailPointExperimental: string, requestBody: Array<string>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SourceSubtypeWithSourceV2026>>>;
|
|
81875
82277
|
/**
|
|
81876
82278
|
* Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`.
|
|
81877
82279
|
* @summary Patch subtype
|
|
@@ -81880,6 +82282,7 @@ export declare const MachineAccountsV2026ApiFp: (configuration?: Configuration)
|
|
|
81880
82282
|
* @param {Array<object>} requestBody A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
81881
82283
|
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
81882
82284
|
* @param {*} [axiosOptions] Override http request option.
|
|
82285
|
+
* @deprecated
|
|
81883
82286
|
* @throws {RequiredError}
|
|
81884
82287
|
*/
|
|
81885
82288
|
patchMachineAccountSubtypeByTechnicalName(sourceId: string, technicalName: string, requestBody: Array<object>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SourceSubtypeV2026>>;
|
|
@@ -81893,16 +82296,6 @@ export declare const MachineAccountsV2026ApiFp: (configuration?: Configuration)
|
|
|
81893
82296
|
* @throws {RequiredError}
|
|
81894
82297
|
*/
|
|
81895
82298
|
updateMachineAccount(id: string, requestBody: Array<object>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MachineAccountV2026>>;
|
|
81896
|
-
/**
|
|
81897
|
-
* Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.
|
|
81898
|
-
* @summary Machine Subtype Approval Config
|
|
81899
|
-
* @param {string} xSailPointExperimental Use this header to enable this experimental API.
|
|
81900
|
-
* @param {string} subtypeId machine account subtype ID.
|
|
81901
|
-
* @param {Array<JsonPatchOperationV2026>} jsonPatchOperationV2026 The JSONPatch payload used to update the object.
|
|
81902
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
81903
|
-
* @throws {RequiredError}
|
|
81904
|
-
*/
|
|
81905
|
-
updateMachineAccountSubtypeApprovalConfig(xSailPointExperimental: string, subtypeId: string, jsonPatchOperationV2026: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MachineAccountSubtypeConfigDtoV2026>>;
|
|
81906
82299
|
};
|
|
81907
82300
|
/**
|
|
81908
82301
|
* MachineAccountsV2026Api - factory interface
|
|
@@ -81914,6 +82307,7 @@ export declare const MachineAccountsV2026ApiFactory: (configuration?: Configurat
|
|
|
81914
82307
|
* @summary Create subtype
|
|
81915
82308
|
* @param {MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest} requestParameters Request parameters.
|
|
81916
82309
|
* @param {*} [axiosOptions] Override http request option.
|
|
82310
|
+
* @deprecated
|
|
81917
82311
|
* @throws {RequiredError}
|
|
81918
82312
|
*/
|
|
81919
82313
|
createMachineAccountSubtype(requestParameters: MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceSubtypeV2026>;
|
|
@@ -81922,6 +82316,7 @@ export declare const MachineAccountsV2026ApiFactory: (configuration?: Configurat
|
|
|
81922
82316
|
* @summary Delete subtype
|
|
81923
82317
|
* @param {MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters.
|
|
81924
82318
|
* @param {*} [axiosOptions] Override http request option.
|
|
82319
|
+
* @deprecated
|
|
81925
82320
|
* @throws {RequiredError}
|
|
81926
82321
|
*/
|
|
81927
82322
|
deleteMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
@@ -81933,19 +82328,12 @@ export declare const MachineAccountsV2026ApiFactory: (configuration?: Configurat
|
|
|
81933
82328
|
* @throws {RequiredError}
|
|
81934
82329
|
*/
|
|
81935
82330
|
getMachineAccount(requestParameters: MachineAccountsV2026ApiGetMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<MachineAccountV2026>;
|
|
81936
|
-
/**
|
|
81937
|
-
* This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.
|
|
81938
|
-
* @summary Machine Subtype Approval Config
|
|
81939
|
-
* @param {MachineAccountsV2026ApiGetMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters.
|
|
81940
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
81941
|
-
* @throws {RequiredError}
|
|
81942
|
-
*/
|
|
81943
|
-
getMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountsV2026ApiGetMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<MachineAccountSubtypeConfigDtoV2026>;
|
|
81944
82331
|
/**
|
|
81945
82332
|
* Get a machine account subtype by its unique ID.
|
|
81946
82333
|
* @summary Retrieve subtype by subtype id
|
|
81947
82334
|
* @param {MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest} requestParameters Request parameters.
|
|
81948
82335
|
* @param {*} [axiosOptions] Override http request option.
|
|
82336
|
+
* @deprecated
|
|
81949
82337
|
* @throws {RequiredError}
|
|
81950
82338
|
*/
|
|
81951
82339
|
getMachineAccountSubtypeById(requestParameters: MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceSubtypeV2026>;
|
|
@@ -81954,6 +82342,7 @@ export declare const MachineAccountsV2026ApiFactory: (configuration?: Configurat
|
|
|
81954
82342
|
* @summary Retrieve subtype by source and technicalName
|
|
81955
82343
|
* @param {MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters.
|
|
81956
82344
|
* @param {*} [axiosOptions] Override http request option.
|
|
82345
|
+
* @deprecated
|
|
81957
82346
|
* @throws {RequiredError}
|
|
81958
82347
|
*/
|
|
81959
82348
|
getMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceSubtypeV2026>;
|
|
@@ -81962,6 +82351,7 @@ export declare const MachineAccountsV2026ApiFactory: (configuration?: Configurat
|
|
|
81962
82351
|
* @summary Retrieve all subtypes by source
|
|
81963
82352
|
* @param {MachineAccountsV2026ApiListMachineAccountSubtypesRequest} requestParameters Request parameters.
|
|
81964
82353
|
* @param {*} [axiosOptions] Override http request option.
|
|
82354
|
+
* @deprecated
|
|
81965
82355
|
* @throws {RequiredError}
|
|
81966
82356
|
*/
|
|
81967
82357
|
listMachineAccountSubtypes(requestParameters: MachineAccountsV2026ApiListMachineAccountSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SourceSubtypeV2026>>;
|
|
@@ -81973,19 +82363,12 @@ export declare const MachineAccountsV2026ApiFactory: (configuration?: Configurat
|
|
|
81973
82363
|
* @throws {RequiredError}
|
|
81974
82364
|
*/
|
|
81975
82365
|
listMachineAccounts(requestParameters?: MachineAccountsV2026ApiListMachineAccountsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<MachineAccountV2026>>;
|
|
81976
|
-
/**
|
|
81977
|
-
* This endpoint retrieves the subtypes for given subtypeIds.
|
|
81978
|
-
* @summary Bulk Retrieve of Source Subtypes
|
|
81979
|
-
* @param {MachineAccountsV2026ApiLoadBulkSourceSubtypesRequest} requestParameters Request parameters.
|
|
81980
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
81981
|
-
* @throws {RequiredError}
|
|
81982
|
-
*/
|
|
81983
|
-
loadBulkSourceSubtypes(requestParameters: MachineAccountsV2026ApiLoadBulkSourceSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<SourceSubtypeWithSourceV2026>>;
|
|
81984
82366
|
/**
|
|
81985
82367
|
* Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`.
|
|
81986
82368
|
* @summary Patch subtype
|
|
81987
82369
|
* @param {MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters.
|
|
81988
82370
|
* @param {*} [axiosOptions] Override http request option.
|
|
82371
|
+
* @deprecated
|
|
81989
82372
|
* @throws {RequiredError}
|
|
81990
82373
|
*/
|
|
81991
82374
|
patchMachineAccountSubtypeByTechnicalName(requestParameters: MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<SourceSubtypeV2026>;
|
|
@@ -81997,14 +82380,6 @@ export declare const MachineAccountsV2026ApiFactory: (configuration?: Configurat
|
|
|
81997
82380
|
* @throws {RequiredError}
|
|
81998
82381
|
*/
|
|
81999
82382
|
updateMachineAccount(requestParameters: MachineAccountsV2026ApiUpdateMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<MachineAccountV2026>;
|
|
82000
|
-
/**
|
|
82001
|
-
* Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.
|
|
82002
|
-
* @summary Machine Subtype Approval Config
|
|
82003
|
-
* @param {MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters.
|
|
82004
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
82005
|
-
* @throws {RequiredError}
|
|
82006
|
-
*/
|
|
82007
|
-
updateMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<MachineAccountSubtypeConfigDtoV2026>;
|
|
82008
82383
|
};
|
|
82009
82384
|
/**
|
|
82010
82385
|
* Request parameters for createMachineAccountSubtype operation in MachineAccountsV2026Api.
|
|
@@ -82075,25 +82450,6 @@ export interface MachineAccountsV2026ApiGetMachineAccountRequest {
|
|
|
82075
82450
|
*/
|
|
82076
82451
|
readonly xSailPointExperimental?: string;
|
|
82077
82452
|
}
|
|
82078
|
-
/**
|
|
82079
|
-
* Request parameters for getMachineAccountSubtypeApprovalConfig operation in MachineAccountsV2026Api.
|
|
82080
|
-
* @export
|
|
82081
|
-
* @interface MachineAccountsV2026ApiGetMachineAccountSubtypeApprovalConfigRequest
|
|
82082
|
-
*/
|
|
82083
|
-
export interface MachineAccountsV2026ApiGetMachineAccountSubtypeApprovalConfigRequest {
|
|
82084
|
-
/**
|
|
82085
|
-
* Use this header to enable this experimental API.
|
|
82086
|
-
* @type {string}
|
|
82087
|
-
* @memberof MachineAccountsV2026ApiGetMachineAccountSubtypeApprovalConfig
|
|
82088
|
-
*/
|
|
82089
|
-
readonly xSailPointExperimental: string;
|
|
82090
|
-
/**
|
|
82091
|
-
* machine subtype id.
|
|
82092
|
-
* @type {string}
|
|
82093
|
-
* @memberof MachineAccountsV2026ApiGetMachineAccountSubtypeApprovalConfig
|
|
82094
|
-
*/
|
|
82095
|
-
readonly subtypeId: string;
|
|
82096
|
-
}
|
|
82097
82453
|
/**
|
|
82098
82454
|
* Request parameters for getMachineAccountSubtypeById operation in MachineAccountsV2026Api.
|
|
82099
82455
|
* @export
|
|
@@ -82230,25 +82586,6 @@ export interface MachineAccountsV2026ApiListMachineAccountsRequest {
|
|
|
82230
82586
|
*/
|
|
82231
82587
|
readonly xSailPointExperimental?: string;
|
|
82232
82588
|
}
|
|
82233
|
-
/**
|
|
82234
|
-
* Request parameters for loadBulkSourceSubtypes operation in MachineAccountsV2026Api.
|
|
82235
|
-
* @export
|
|
82236
|
-
* @interface MachineAccountsV2026ApiLoadBulkSourceSubtypesRequest
|
|
82237
|
-
*/
|
|
82238
|
-
export interface MachineAccountsV2026ApiLoadBulkSourceSubtypesRequest {
|
|
82239
|
-
/**
|
|
82240
|
-
* Use this header to enable this experimental API.
|
|
82241
|
-
* @type {string}
|
|
82242
|
-
* @memberof MachineAccountsV2026ApiLoadBulkSourceSubtypes
|
|
82243
|
-
*/
|
|
82244
|
-
readonly xSailPointExperimental: string;
|
|
82245
|
-
/**
|
|
82246
|
-
*
|
|
82247
|
-
* @type {Array<string>}
|
|
82248
|
-
* @memberof MachineAccountsV2026ApiLoadBulkSourceSubtypes
|
|
82249
|
-
*/
|
|
82250
|
-
readonly requestBody: Array<string>;
|
|
82251
|
-
}
|
|
82252
82589
|
/**
|
|
82253
82590
|
* Request parameters for patchMachineAccountSubtypeByTechnicalName operation in MachineAccountsV2026Api.
|
|
82254
82591
|
* @export
|
|
@@ -82305,31 +82642,6 @@ export interface MachineAccountsV2026ApiUpdateMachineAccountRequest {
|
|
|
82305
82642
|
*/
|
|
82306
82643
|
readonly xSailPointExperimental?: string;
|
|
82307
82644
|
}
|
|
82308
|
-
/**
|
|
82309
|
-
* Request parameters for updateMachineAccountSubtypeApprovalConfig operation in MachineAccountsV2026Api.
|
|
82310
|
-
* @export
|
|
82311
|
-
* @interface MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest
|
|
82312
|
-
*/
|
|
82313
|
-
export interface MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest {
|
|
82314
|
-
/**
|
|
82315
|
-
* Use this header to enable this experimental API.
|
|
82316
|
-
* @type {string}
|
|
82317
|
-
* @memberof MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfig
|
|
82318
|
-
*/
|
|
82319
|
-
readonly xSailPointExperimental: string;
|
|
82320
|
-
/**
|
|
82321
|
-
* machine account subtype ID.
|
|
82322
|
-
* @type {string}
|
|
82323
|
-
* @memberof MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfig
|
|
82324
|
-
*/
|
|
82325
|
-
readonly subtypeId: string;
|
|
82326
|
-
/**
|
|
82327
|
-
* The JSONPatch payload used to update the object.
|
|
82328
|
-
* @type {Array<JsonPatchOperationV2026>}
|
|
82329
|
-
* @memberof MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfig
|
|
82330
|
-
*/
|
|
82331
|
-
readonly jsonPatchOperationV2026: Array<JsonPatchOperationV2026>;
|
|
82332
|
-
}
|
|
82333
82645
|
/**
|
|
82334
82646
|
* MachineAccountsV2026Api - object-oriented interface
|
|
82335
82647
|
* @export
|
|
@@ -82342,6 +82654,7 @@ export declare class MachineAccountsV2026Api extends BaseAPI {
|
|
|
82342
82654
|
* @summary Create subtype
|
|
82343
82655
|
* @param {MachineAccountsV2026ApiCreateMachineAccountSubtypeRequest} requestParameters Request parameters.
|
|
82344
82656
|
* @param {*} [axiosOptions] Override http request option.
|
|
82657
|
+
* @deprecated
|
|
82345
82658
|
* @throws {RequiredError}
|
|
82346
82659
|
* @memberof MachineAccountsV2026Api
|
|
82347
82660
|
*/
|
|
@@ -82351,6 +82664,7 @@ export declare class MachineAccountsV2026Api extends BaseAPI {
|
|
|
82351
82664
|
* @summary Delete subtype
|
|
82352
82665
|
* @param {MachineAccountsV2026ApiDeleteMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters.
|
|
82353
82666
|
* @param {*} [axiosOptions] Override http request option.
|
|
82667
|
+
* @deprecated
|
|
82354
82668
|
* @throws {RequiredError}
|
|
82355
82669
|
* @memberof MachineAccountsV2026Api
|
|
82356
82670
|
*/
|
|
@@ -82364,20 +82678,12 @@ export declare class MachineAccountsV2026Api extends BaseAPI {
|
|
|
82364
82678
|
* @memberof MachineAccountsV2026Api
|
|
82365
82679
|
*/
|
|
82366
82680
|
getMachineAccount(requestParameters: MachineAccountsV2026ApiGetMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MachineAccountV2026, any>>;
|
|
82367
|
-
/**
|
|
82368
|
-
* This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion.
|
|
82369
|
-
* @summary Machine Subtype Approval Config
|
|
82370
|
-
* @param {MachineAccountsV2026ApiGetMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters.
|
|
82371
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
82372
|
-
* @throws {RequiredError}
|
|
82373
|
-
* @memberof MachineAccountsV2026Api
|
|
82374
|
-
*/
|
|
82375
|
-
getMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountsV2026ApiGetMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MachineAccountSubtypeConfigDtoV2026, any>>;
|
|
82376
82681
|
/**
|
|
82377
82682
|
* Get a machine account subtype by its unique ID.
|
|
82378
82683
|
* @summary Retrieve subtype by subtype id
|
|
82379
82684
|
* @param {MachineAccountsV2026ApiGetMachineAccountSubtypeByIdRequest} requestParameters Request parameters.
|
|
82380
82685
|
* @param {*} [axiosOptions] Override http request option.
|
|
82686
|
+
* @deprecated
|
|
82381
82687
|
* @throws {RequiredError}
|
|
82382
82688
|
* @memberof MachineAccountsV2026Api
|
|
82383
82689
|
*/
|
|
@@ -82387,6 +82693,7 @@ export declare class MachineAccountsV2026Api extends BaseAPI {
|
|
|
82387
82693
|
* @summary Retrieve subtype by source and technicalName
|
|
82388
82694
|
* @param {MachineAccountsV2026ApiGetMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters.
|
|
82389
82695
|
* @param {*} [axiosOptions] Override http request option.
|
|
82696
|
+
* @deprecated
|
|
82390
82697
|
* @throws {RequiredError}
|
|
82391
82698
|
* @memberof MachineAccountsV2026Api
|
|
82392
82699
|
*/
|
|
@@ -82396,6 +82703,7 @@ export declare class MachineAccountsV2026Api extends BaseAPI {
|
|
|
82396
82703
|
* @summary Retrieve all subtypes by source
|
|
82397
82704
|
* @param {MachineAccountsV2026ApiListMachineAccountSubtypesRequest} requestParameters Request parameters.
|
|
82398
82705
|
* @param {*} [axiosOptions] Override http request option.
|
|
82706
|
+
* @deprecated
|
|
82399
82707
|
* @throws {RequiredError}
|
|
82400
82708
|
* @memberof MachineAccountsV2026Api
|
|
82401
82709
|
*/
|
|
@@ -82409,20 +82717,12 @@ export declare class MachineAccountsV2026Api extends BaseAPI {
|
|
|
82409
82717
|
* @memberof MachineAccountsV2026Api
|
|
82410
82718
|
*/
|
|
82411
82719
|
listMachineAccounts(requestParameters?: MachineAccountsV2026ApiListMachineAccountsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MachineAccountV2026[], any>>;
|
|
82412
|
-
/**
|
|
82413
|
-
* This endpoint retrieves the subtypes for given subtypeIds.
|
|
82414
|
-
* @summary Bulk Retrieve of Source Subtypes
|
|
82415
|
-
* @param {MachineAccountsV2026ApiLoadBulkSourceSubtypesRequest} requestParameters Request parameters.
|
|
82416
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
82417
|
-
* @throws {RequiredError}
|
|
82418
|
-
* @memberof MachineAccountsV2026Api
|
|
82419
|
-
*/
|
|
82420
|
-
loadBulkSourceSubtypes(requestParameters: MachineAccountsV2026ApiLoadBulkSourceSubtypesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SourceSubtypeWithSourceV2026[], any>>;
|
|
82421
82720
|
/**
|
|
82422
82721
|
* Update fields of a machine account subtype by source ID and technical name. Patchable fields include: `displayName`, `description`.
|
|
82423
82722
|
* @summary Patch subtype
|
|
82424
82723
|
* @param {MachineAccountsV2026ApiPatchMachineAccountSubtypeByTechnicalNameRequest} requestParameters Request parameters.
|
|
82425
82724
|
* @param {*} [axiosOptions] Override http request option.
|
|
82725
|
+
* @deprecated
|
|
82426
82726
|
* @throws {RequiredError}
|
|
82427
82727
|
* @memberof MachineAccountsV2026Api
|
|
82428
82728
|
*/
|
|
@@ -82436,15 +82736,6 @@ export declare class MachineAccountsV2026Api extends BaseAPI {
|
|
|
82436
82736
|
* @memberof MachineAccountsV2026Api
|
|
82437
82737
|
*/
|
|
82438
82738
|
updateMachineAccount(requestParameters: MachineAccountsV2026ApiUpdateMachineAccountRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MachineAccountV2026, any>>;
|
|
82439
|
-
/**
|
|
82440
|
-
* Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype.
|
|
82441
|
-
* @summary Machine Subtype Approval Config
|
|
82442
|
-
* @param {MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest} requestParameters Request parameters.
|
|
82443
|
-
* @param {*} [axiosOptions] Override http request option.
|
|
82444
|
-
* @throws {RequiredError}
|
|
82445
|
-
* @memberof MachineAccountsV2026Api
|
|
82446
|
-
*/
|
|
82447
|
-
updateMachineAccountSubtypeApprovalConfig(requestParameters: MachineAccountsV2026ApiUpdateMachineAccountSubtypeApprovalConfigRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MachineAccountSubtypeConfigDtoV2026, any>>;
|
|
82448
82739
|
}
|
|
82449
82740
|
/**
|
|
82450
82741
|
* MachineClassificationConfigV2026Api - axios parameter creator
|