sailpoint-api-client 1.8.2 → 1.8.4
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 +287 -65
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/api.d.ts +283 -64
- package/dist/beta/api.js +35 -36
- 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 +288 -69
- package/dist/v2024/api.js +49 -52
- package/dist/v2024/api.js.map +1 -1
- package/dist/v2024/common.js +2 -2
- package/dist/v2025/api.d.ts +292 -73
- package/dist/v2025/api.js +55 -58
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +2 -2
- package/dist/v2026/api.d.ts +691 -0
- package/dist/v2026/api.js +635 -2
- package/dist/v2026/api.js.map +1 -1
- package/dist/v2026/common.js +2 -2
- package/dist/v3/api.d.ts +47 -11
- package/dist/v3/api.js +22 -18
- 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 +299 -80
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +303 -84
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/api.ts +1010 -0
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/api.ts +50 -11
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/beta/api.d.ts
CHANGED
|
@@ -1064,11 +1064,11 @@ export interface AccessProfileBeta {
|
|
|
1064
1064
|
*/
|
|
1065
1065
|
'provisioningCriteria'?: ProvisioningCriteriaLevel1Beta | null;
|
|
1066
1066
|
/**
|
|
1067
|
-
*
|
|
1068
|
-
* @type {Array<
|
|
1067
|
+
* List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
|
|
1068
|
+
* @type {Array<AdditionalOwnerRefBeta>}
|
|
1069
1069
|
* @memberof AccessProfileBeta
|
|
1070
1070
|
*/
|
|
1071
|
-
'additionalOwners'?: Array<
|
|
1071
|
+
'additionalOwners'?: Array<AdditionalOwnerRefBeta> | null;
|
|
1072
1072
|
}
|
|
1073
1073
|
/**
|
|
1074
1074
|
*
|
|
@@ -4059,6 +4059,36 @@ export interface ActivateCampaignOptionsBeta {
|
|
|
4059
4059
|
*/
|
|
4060
4060
|
'timeZone'?: string;
|
|
4061
4061
|
}
|
|
4062
|
+
/**
|
|
4063
|
+
* Reference to an additional owner (identity or governance group).
|
|
4064
|
+
* @export
|
|
4065
|
+
* @interface AdditionalOwnerRefBeta
|
|
4066
|
+
*/
|
|
4067
|
+
export interface AdditionalOwnerRefBeta {
|
|
4068
|
+
/**
|
|
4069
|
+
* Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group.
|
|
4070
|
+
* @type {string}
|
|
4071
|
+
* @memberof AdditionalOwnerRefBeta
|
|
4072
|
+
*/
|
|
4073
|
+
'type'?: AdditionalOwnerRefBetaTypeBeta;
|
|
4074
|
+
/**
|
|
4075
|
+
* ID of the identity or governance group.
|
|
4076
|
+
* @type {string}
|
|
4077
|
+
* @memberof AdditionalOwnerRefBeta
|
|
4078
|
+
*/
|
|
4079
|
+
'id'?: string;
|
|
4080
|
+
/**
|
|
4081
|
+
* Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result.
|
|
4082
|
+
* @type {string}
|
|
4083
|
+
* @memberof AdditionalOwnerRefBeta
|
|
4084
|
+
*/
|
|
4085
|
+
'name'?: string | null;
|
|
4086
|
+
}
|
|
4087
|
+
export declare const AdditionalOwnerRefBetaTypeBeta: {
|
|
4088
|
+
readonly Identity: "IDENTITY";
|
|
4089
|
+
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
4090
|
+
};
|
|
4091
|
+
export type AdditionalOwnerRefBetaTypeBeta = typeof AdditionalOwnerRefBetaTypeBeta[keyof typeof AdditionalOwnerRefBetaTypeBeta];
|
|
4062
4092
|
/**
|
|
4063
4093
|
*
|
|
4064
4094
|
* @export
|
|
@@ -9345,11 +9375,17 @@ export interface DkimAttributesBeta {
|
|
|
9345
9375
|
*/
|
|
9346
9376
|
'dkimTokens'?: Array<string>;
|
|
9347
9377
|
/**
|
|
9348
|
-
* The current status if the domain /identity has been verified. Ie
|
|
9378
|
+
* The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING
|
|
9349
9379
|
* @type {string}
|
|
9350
9380
|
* @memberof DkimAttributesBeta
|
|
9351
9381
|
*/
|
|
9352
9382
|
'dkimVerificationStatus'?: string;
|
|
9383
|
+
/**
|
|
9384
|
+
* The AWS SES region the domain is associated with
|
|
9385
|
+
* @type {string}
|
|
9386
|
+
* @memberof DkimAttributesBeta
|
|
9387
|
+
*/
|
|
9388
|
+
'region'?: string;
|
|
9353
9389
|
}
|
|
9354
9390
|
/**
|
|
9355
9391
|
*
|
|
@@ -9384,10 +9420,10 @@ export interface DomainStatusDtoBeta {
|
|
|
9384
9420
|
'domain'?: string;
|
|
9385
9421
|
/**
|
|
9386
9422
|
* DKIM is enabled for this domain
|
|
9387
|
-
* @type {
|
|
9423
|
+
* @type {boolean}
|
|
9388
9424
|
* @memberof DomainStatusDtoBeta
|
|
9389
9425
|
*/
|
|
9390
|
-
'dkimEnabled'?:
|
|
9426
|
+
'dkimEnabled'?: boolean;
|
|
9391
9427
|
/**
|
|
9392
9428
|
* DKIM tokens required for authentication
|
|
9393
9429
|
* @type {Array<string>}
|
|
@@ -9400,6 +9436,12 @@ export interface DomainStatusDtoBeta {
|
|
|
9400
9436
|
* @memberof DomainStatusDtoBeta
|
|
9401
9437
|
*/
|
|
9402
9438
|
'dkimVerificationStatus'?: string;
|
|
9439
|
+
/**
|
|
9440
|
+
* The AWS SES region the domain is associated with
|
|
9441
|
+
* @type {string}
|
|
9442
|
+
* @memberof DomainStatusDtoBeta
|
|
9443
|
+
*/
|
|
9444
|
+
'region'?: string;
|
|
9403
9445
|
}
|
|
9404
9446
|
/**
|
|
9405
9447
|
* An enumeration of the types of DTOs supported within the IdentityNow infrastructure.
|
|
@@ -9522,34 +9564,41 @@ export interface EmailNotificationOptionBeta {
|
|
|
9522
9564
|
*/
|
|
9523
9565
|
export interface EmailStatusDtoBeta {
|
|
9524
9566
|
/**
|
|
9525
|
-
*
|
|
9567
|
+
* Unique identifier for the verified sender address
|
|
9526
9568
|
* @type {string}
|
|
9527
9569
|
* @memberof EmailStatusDtoBeta
|
|
9528
9570
|
*/
|
|
9529
9571
|
'id'?: string | null;
|
|
9530
9572
|
/**
|
|
9531
|
-
*
|
|
9573
|
+
* The verified sender email address
|
|
9532
9574
|
* @type {string}
|
|
9533
9575
|
* @memberof EmailStatusDtoBeta
|
|
9534
9576
|
*/
|
|
9535
9577
|
'email'?: string;
|
|
9536
9578
|
/**
|
|
9537
|
-
*
|
|
9579
|
+
* Whether the sender address is verified by domain
|
|
9538
9580
|
* @type {boolean}
|
|
9539
9581
|
* @memberof EmailStatusDtoBeta
|
|
9540
9582
|
*/
|
|
9541
9583
|
'isVerifiedByDomain'?: boolean;
|
|
9542
9584
|
/**
|
|
9543
|
-
*
|
|
9585
|
+
* The verification status of the sender address
|
|
9544
9586
|
* @type {string}
|
|
9545
9587
|
* @memberof EmailStatusDtoBeta
|
|
9546
9588
|
*/
|
|
9547
9589
|
'verificationStatus'?: EmailStatusDtoBetaVerificationStatusBeta;
|
|
9590
|
+
/**
|
|
9591
|
+
* The AWS SES region the sender address is associated with
|
|
9592
|
+
* @type {string}
|
|
9593
|
+
* @memberof EmailStatusDtoBeta
|
|
9594
|
+
*/
|
|
9595
|
+
'region'?: string;
|
|
9548
9596
|
}
|
|
9549
9597
|
export declare const EmailStatusDtoBetaVerificationStatusBeta: {
|
|
9550
9598
|
readonly Pending: "PENDING";
|
|
9551
9599
|
readonly Success: "SUCCESS";
|
|
9552
9600
|
readonly Failed: "FAILED";
|
|
9601
|
+
readonly Na: "NA";
|
|
9553
9602
|
};
|
|
9554
9603
|
export type EmailStatusDtoBetaVerificationStatusBeta = typeof EmailStatusDtoBetaVerificationStatusBeta[keyof typeof EmailStatusDtoBetaVerificationStatusBeta];
|
|
9555
9604
|
/**
|
|
@@ -17115,14 +17164,12 @@ export interface MatchTermBeta {
|
|
|
17115
17164
|
}> | null;
|
|
17116
17165
|
}
|
|
17117
17166
|
/**
|
|
17118
|
-
*
|
|
17167
|
+
* The notification medium (EMAIL, SLACK, or TEAMS)
|
|
17119
17168
|
* @export
|
|
17120
17169
|
* @enum {string}
|
|
17121
17170
|
*/
|
|
17122
17171
|
export declare const MediumBeta: {
|
|
17123
17172
|
readonly Email: "EMAIL";
|
|
17124
|
-
readonly Sms: "SMS";
|
|
17125
|
-
readonly Phone: "PHONE";
|
|
17126
17173
|
readonly Slack: "SLACK";
|
|
17127
17174
|
readonly Teams: "TEAMS";
|
|
17128
17175
|
};
|
|
@@ -23529,6 +23576,12 @@ export interface RoleBeta {
|
|
|
23529
23576
|
* @memberof RoleBeta
|
|
23530
23577
|
*/
|
|
23531
23578
|
'owner': OwnerReferenceBeta;
|
|
23579
|
+
/**
|
|
23580
|
+
* List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
|
|
23581
|
+
* @type {Array<AdditionalOwnerRefBeta>}
|
|
23582
|
+
* @memberof RoleBeta
|
|
23583
|
+
*/
|
|
23584
|
+
'additionalOwners'?: Array<AdditionalOwnerRefBeta> | null;
|
|
23532
23585
|
/**
|
|
23533
23586
|
*
|
|
23534
23587
|
* @type {Array<AccessProfileRefBeta>}
|
|
@@ -26615,12 +26668,36 @@ export interface SendTestNotificationRequestDtoBeta {
|
|
|
26615
26668
|
* @memberof SendTestNotificationRequestDtoBeta
|
|
26616
26669
|
*/
|
|
26617
26670
|
'medium'?: SendTestNotificationRequestDtoBetaMediumBeta;
|
|
26671
|
+
/**
|
|
26672
|
+
* The locale for the message text.
|
|
26673
|
+
* @type {string}
|
|
26674
|
+
* @memberof SendTestNotificationRequestDtoBeta
|
|
26675
|
+
*/
|
|
26676
|
+
'locale'?: string;
|
|
26618
26677
|
/**
|
|
26619
26678
|
* A Json object that denotes the context specific to the template.
|
|
26620
26679
|
* @type {object}
|
|
26621
26680
|
* @memberof SendTestNotificationRequestDtoBeta
|
|
26622
26681
|
*/
|
|
26623
26682
|
'context'?: object;
|
|
26683
|
+
/**
|
|
26684
|
+
* A list of override recipient email addresses for the test notification.
|
|
26685
|
+
* @type {Array<string>}
|
|
26686
|
+
* @memberof SendTestNotificationRequestDtoBeta
|
|
26687
|
+
*/
|
|
26688
|
+
'recipientEmailList'?: Array<string>;
|
|
26689
|
+
/**
|
|
26690
|
+
* A list of CC email addresses for the test notification.
|
|
26691
|
+
* @type {Array<string>}
|
|
26692
|
+
* @memberof SendTestNotificationRequestDtoBeta
|
|
26693
|
+
*/
|
|
26694
|
+
'carbonCopy'?: Array<string>;
|
|
26695
|
+
/**
|
|
26696
|
+
* A list of BCC email addresses for the test notification.
|
|
26697
|
+
* @type {Array<string>}
|
|
26698
|
+
* @memberof SendTestNotificationRequestDtoBeta
|
|
26699
|
+
*/
|
|
26700
|
+
'blindCarbonCopy'?: Array<string>;
|
|
26624
26701
|
}
|
|
26625
26702
|
export declare const SendTestNotificationRequestDtoBetaMediumBeta: {
|
|
26626
26703
|
readonly Email: "EMAIL";
|
|
@@ -30580,13 +30657,13 @@ export interface TaskStatusMessageParametersInnerBeta {
|
|
|
30580
30657
|
*/
|
|
30581
30658
|
export interface TemplateBulkDeleteDtoBeta {
|
|
30582
30659
|
/**
|
|
30583
|
-
*
|
|
30660
|
+
* The template key to delete
|
|
30584
30661
|
* @type {string}
|
|
30585
30662
|
* @memberof TemplateBulkDeleteDtoBeta
|
|
30586
30663
|
*/
|
|
30587
30664
|
'key': string;
|
|
30588
30665
|
/**
|
|
30589
|
-
*
|
|
30666
|
+
* The notification medium (EMAIL, SLACK, or TEAMS)
|
|
30590
30667
|
* @type {string}
|
|
30591
30668
|
* @memberof TemplateBulkDeleteDtoBeta
|
|
30592
30669
|
*/
|
|
@@ -30600,8 +30677,8 @@ export interface TemplateBulkDeleteDtoBeta {
|
|
|
30600
30677
|
}
|
|
30601
30678
|
export declare const TemplateBulkDeleteDtoBetaMediumBeta: {
|
|
30602
30679
|
readonly Email: "EMAIL";
|
|
30603
|
-
readonly
|
|
30604
|
-
readonly
|
|
30680
|
+
readonly Slack: "SLACK";
|
|
30681
|
+
readonly Teams: "TEAMS";
|
|
30605
30682
|
};
|
|
30606
30683
|
export type TemplateBulkDeleteDtoBetaMediumBeta = typeof TemplateBulkDeleteDtoBetaMediumBeta[keyof typeof TemplateBulkDeleteDtoBetaMediumBeta];
|
|
30607
30684
|
/**
|
|
@@ -30698,21 +30775,19 @@ export interface TemplateDtoBeta {
|
|
|
30698
30775
|
'modified'?: string;
|
|
30699
30776
|
/**
|
|
30700
30777
|
*
|
|
30701
|
-
* @type {
|
|
30778
|
+
* @type {TemplateDtoSlackTemplateBeta}
|
|
30702
30779
|
* @memberof TemplateDtoBeta
|
|
30703
30780
|
*/
|
|
30704
|
-
'slackTemplate'?:
|
|
30781
|
+
'slackTemplate'?: TemplateDtoSlackTemplateBeta;
|
|
30705
30782
|
/**
|
|
30706
30783
|
*
|
|
30707
|
-
* @type {
|
|
30784
|
+
* @type {TemplateDtoTeamsTemplateBeta}
|
|
30708
30785
|
* @memberof TemplateDtoBeta
|
|
30709
30786
|
*/
|
|
30710
|
-
'teamsTemplate'?:
|
|
30787
|
+
'teamsTemplate'?: TemplateDtoTeamsTemplateBeta;
|
|
30711
30788
|
}
|
|
30712
30789
|
export declare const TemplateDtoBetaMediumBeta: {
|
|
30713
30790
|
readonly Email: "EMAIL";
|
|
30714
|
-
readonly Phone: "PHONE";
|
|
30715
|
-
readonly Sms: "SMS";
|
|
30716
30791
|
readonly Slack: "SLACK";
|
|
30717
30792
|
readonly Teams: "TEAMS";
|
|
30718
30793
|
};
|
|
@@ -30806,12 +30881,156 @@ export interface TemplateDtoDefaultBeta {
|
|
|
30806
30881
|
}
|
|
30807
30882
|
export declare const TemplateDtoDefaultBetaMediumBeta: {
|
|
30808
30883
|
readonly Email: "EMAIL";
|
|
30809
|
-
readonly Phone: "PHONE";
|
|
30810
|
-
readonly Sms: "SMS";
|
|
30811
30884
|
readonly Slack: "SLACK";
|
|
30812
30885
|
readonly Teams: "TEAMS";
|
|
30813
30886
|
};
|
|
30814
30887
|
export type TemplateDtoDefaultBetaMediumBeta = typeof TemplateDtoDefaultBetaMediumBeta[keyof typeof TemplateDtoDefaultBetaMediumBeta];
|
|
30888
|
+
/**
|
|
30889
|
+
*
|
|
30890
|
+
* @export
|
|
30891
|
+
* @interface TemplateDtoSlackTemplateBeta
|
|
30892
|
+
*/
|
|
30893
|
+
export interface TemplateDtoSlackTemplateBeta {
|
|
30894
|
+
/**
|
|
30895
|
+
* The template key
|
|
30896
|
+
* @type {string}
|
|
30897
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30898
|
+
*/
|
|
30899
|
+
'key'?: string | null;
|
|
30900
|
+
/**
|
|
30901
|
+
* The main text content of the Slack message
|
|
30902
|
+
* @type {string}
|
|
30903
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30904
|
+
*/
|
|
30905
|
+
'text'?: string;
|
|
30906
|
+
/**
|
|
30907
|
+
* JSON string of Slack Block Kit blocks for rich formatting
|
|
30908
|
+
* @type {string}
|
|
30909
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30910
|
+
*/
|
|
30911
|
+
'blocks'?: string | null;
|
|
30912
|
+
/**
|
|
30913
|
+
* JSON string of Slack attachments
|
|
30914
|
+
* @type {string}
|
|
30915
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30916
|
+
*/
|
|
30917
|
+
'attachments'?: string;
|
|
30918
|
+
/**
|
|
30919
|
+
* The type of notification
|
|
30920
|
+
* @type {string}
|
|
30921
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30922
|
+
*/
|
|
30923
|
+
'notificationType'?: string | null;
|
|
30924
|
+
/**
|
|
30925
|
+
* The approval request ID
|
|
30926
|
+
* @type {string}
|
|
30927
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30928
|
+
*/
|
|
30929
|
+
'approvalId'?: string | null;
|
|
30930
|
+
/**
|
|
30931
|
+
* The request ID
|
|
30932
|
+
* @type {string}
|
|
30933
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30934
|
+
*/
|
|
30935
|
+
'requestId'?: string | null;
|
|
30936
|
+
/**
|
|
30937
|
+
* The ID of the user who made the request
|
|
30938
|
+
* @type {string}
|
|
30939
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30940
|
+
*/
|
|
30941
|
+
'requestedById'?: string | null;
|
|
30942
|
+
/**
|
|
30943
|
+
* Whether this is a subscription notification
|
|
30944
|
+
* @type {boolean}
|
|
30945
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30946
|
+
*/
|
|
30947
|
+
'isSubscription'?: boolean | null;
|
|
30948
|
+
/**
|
|
30949
|
+
*
|
|
30950
|
+
* @type {TemplateSlackAutoApprovalDataBeta}
|
|
30951
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30952
|
+
*/
|
|
30953
|
+
'autoApprovalData'?: TemplateSlackAutoApprovalDataBeta | null;
|
|
30954
|
+
/**
|
|
30955
|
+
*
|
|
30956
|
+
* @type {TemplateSlackCustomFieldsBeta}
|
|
30957
|
+
* @memberof TemplateDtoSlackTemplateBeta
|
|
30958
|
+
*/
|
|
30959
|
+
'customFields'?: TemplateSlackCustomFieldsBeta | null;
|
|
30960
|
+
}
|
|
30961
|
+
/**
|
|
30962
|
+
*
|
|
30963
|
+
* @export
|
|
30964
|
+
* @interface TemplateDtoTeamsTemplateBeta
|
|
30965
|
+
*/
|
|
30966
|
+
export interface TemplateDtoTeamsTemplateBeta {
|
|
30967
|
+
/**
|
|
30968
|
+
* The template key
|
|
30969
|
+
* @type {string}
|
|
30970
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
30971
|
+
*/
|
|
30972
|
+
'key'?: string | null;
|
|
30973
|
+
/**
|
|
30974
|
+
* The title of the Teams message
|
|
30975
|
+
* @type {string}
|
|
30976
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
30977
|
+
*/
|
|
30978
|
+
'title'?: string | null;
|
|
30979
|
+
/**
|
|
30980
|
+
* The main text content of the Teams message
|
|
30981
|
+
* @type {string}
|
|
30982
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
30983
|
+
*/
|
|
30984
|
+
'text'?: string;
|
|
30985
|
+
/**
|
|
30986
|
+
* JSON string of the Teams adaptive card
|
|
30987
|
+
* @type {string}
|
|
30988
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
30989
|
+
*/
|
|
30990
|
+
'messageJSON'?: string | null;
|
|
30991
|
+
/**
|
|
30992
|
+
* Whether this is a subscription notification
|
|
30993
|
+
* @type {boolean}
|
|
30994
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
30995
|
+
*/
|
|
30996
|
+
'isSubscription'?: boolean | null;
|
|
30997
|
+
/**
|
|
30998
|
+
* The approval request ID
|
|
30999
|
+
* @type {string}
|
|
31000
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
31001
|
+
*/
|
|
31002
|
+
'approvalId'?: string | null;
|
|
31003
|
+
/**
|
|
31004
|
+
* The request ID
|
|
31005
|
+
* @type {string}
|
|
31006
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
31007
|
+
*/
|
|
31008
|
+
'requestId'?: string | null;
|
|
31009
|
+
/**
|
|
31010
|
+
* The ID of the user who made the request
|
|
31011
|
+
* @type {string}
|
|
31012
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
31013
|
+
*/
|
|
31014
|
+
'requestedById'?: string | null;
|
|
31015
|
+
/**
|
|
31016
|
+
* The type of notification
|
|
31017
|
+
* @type {string}
|
|
31018
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
31019
|
+
*/
|
|
31020
|
+
'notificationType'?: string | null;
|
|
31021
|
+
/**
|
|
31022
|
+
*
|
|
31023
|
+
* @type {TemplateSlackAutoApprovalDataBeta}
|
|
31024
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
31025
|
+
*/
|
|
31026
|
+
'autoApprovalData'?: TemplateSlackAutoApprovalDataBeta | null;
|
|
31027
|
+
/**
|
|
31028
|
+
*
|
|
31029
|
+
* @type {TemplateSlackCustomFieldsBeta}
|
|
31030
|
+
* @memberof TemplateDtoTeamsTemplateBeta
|
|
31031
|
+
*/
|
|
31032
|
+
'customFields'?: TemplateSlackCustomFieldsBeta | null;
|
|
31033
|
+
}
|
|
30815
31034
|
/**
|
|
30816
31035
|
*
|
|
30817
31036
|
* @export
|
|
@@ -30819,31 +31038,31 @@ export type TemplateDtoDefaultBetaMediumBeta = typeof TemplateDtoDefaultBetaMedi
|
|
|
30819
31038
|
*/
|
|
30820
31039
|
export interface TemplateSlackAutoApprovalDataBeta {
|
|
30821
31040
|
/**
|
|
30822
|
-
*
|
|
31041
|
+
* Whether the request was auto-approved
|
|
30823
31042
|
* @type {string}
|
|
30824
31043
|
* @memberof TemplateSlackAutoApprovalDataBeta
|
|
30825
31044
|
*/
|
|
30826
31045
|
'isAutoApproved'?: string | null;
|
|
30827
31046
|
/**
|
|
30828
|
-
*
|
|
31047
|
+
* The item ID
|
|
30829
31048
|
* @type {string}
|
|
30830
31049
|
* @memberof TemplateSlackAutoApprovalDataBeta
|
|
30831
31050
|
*/
|
|
30832
31051
|
'itemId'?: string | null;
|
|
30833
31052
|
/**
|
|
30834
|
-
*
|
|
31053
|
+
* The item type
|
|
30835
31054
|
* @type {string}
|
|
30836
31055
|
* @memberof TemplateSlackAutoApprovalDataBeta
|
|
30837
31056
|
*/
|
|
30838
31057
|
'itemType'?: string | null;
|
|
30839
31058
|
/**
|
|
30840
|
-
*
|
|
31059
|
+
* JSON message for auto-approval
|
|
30841
31060
|
* @type {string}
|
|
30842
31061
|
* @memberof TemplateSlackAutoApprovalDataBeta
|
|
30843
31062
|
*/
|
|
30844
31063
|
'autoApprovalMessageJSON'?: string | null;
|
|
30845
31064
|
/**
|
|
30846
|
-
*
|
|
31065
|
+
* Title for auto-approval
|
|
30847
31066
|
* @type {string}
|
|
30848
31067
|
* @memberof TemplateSlackAutoApprovalDataBeta
|
|
30849
31068
|
*/
|
|
@@ -30856,55 +31075,55 @@ export interface TemplateSlackAutoApprovalDataBeta {
|
|
|
30856
31075
|
*/
|
|
30857
31076
|
export interface TemplateSlackBeta {
|
|
30858
31077
|
/**
|
|
30859
|
-
*
|
|
31078
|
+
* The template key
|
|
30860
31079
|
* @type {string}
|
|
30861
31080
|
* @memberof TemplateSlackBeta
|
|
30862
31081
|
*/
|
|
30863
31082
|
'key'?: string | null;
|
|
30864
31083
|
/**
|
|
30865
|
-
*
|
|
31084
|
+
* The main text content of the Slack message
|
|
30866
31085
|
* @type {string}
|
|
30867
31086
|
* @memberof TemplateSlackBeta
|
|
30868
31087
|
*/
|
|
30869
31088
|
'text'?: string;
|
|
30870
31089
|
/**
|
|
30871
|
-
*
|
|
31090
|
+
* JSON string of Slack Block Kit blocks for rich formatting
|
|
30872
31091
|
* @type {string}
|
|
30873
31092
|
* @memberof TemplateSlackBeta
|
|
30874
31093
|
*/
|
|
30875
31094
|
'blocks'?: string | null;
|
|
30876
31095
|
/**
|
|
30877
|
-
*
|
|
31096
|
+
* JSON string of Slack attachments
|
|
30878
31097
|
* @type {string}
|
|
30879
31098
|
* @memberof TemplateSlackBeta
|
|
30880
31099
|
*/
|
|
30881
31100
|
'attachments'?: string;
|
|
30882
31101
|
/**
|
|
30883
|
-
*
|
|
31102
|
+
* The type of notification
|
|
30884
31103
|
* @type {string}
|
|
30885
31104
|
* @memberof TemplateSlackBeta
|
|
30886
31105
|
*/
|
|
30887
31106
|
'notificationType'?: string | null;
|
|
30888
31107
|
/**
|
|
30889
|
-
*
|
|
31108
|
+
* The approval request ID
|
|
30890
31109
|
* @type {string}
|
|
30891
31110
|
* @memberof TemplateSlackBeta
|
|
30892
31111
|
*/
|
|
30893
31112
|
'approvalId'?: string | null;
|
|
30894
31113
|
/**
|
|
30895
|
-
*
|
|
31114
|
+
* The request ID
|
|
30896
31115
|
* @type {string}
|
|
30897
31116
|
* @memberof TemplateSlackBeta
|
|
30898
31117
|
*/
|
|
30899
31118
|
'requestId'?: string | null;
|
|
30900
31119
|
/**
|
|
30901
|
-
*
|
|
31120
|
+
* The ID of the user who made the request
|
|
30902
31121
|
* @type {string}
|
|
30903
31122
|
* @memberof TemplateSlackBeta
|
|
30904
31123
|
*/
|
|
30905
31124
|
'requestedById'?: string | null;
|
|
30906
31125
|
/**
|
|
30907
|
-
*
|
|
31126
|
+
* Whether this is a subscription notification
|
|
30908
31127
|
* @type {boolean}
|
|
30909
31128
|
* @memberof TemplateSlackBeta
|
|
30910
31129
|
*/
|
|
@@ -30929,25 +31148,25 @@ export interface TemplateSlackBeta {
|
|
|
30929
31148
|
*/
|
|
30930
31149
|
export interface TemplateSlackCustomFieldsBeta {
|
|
30931
31150
|
/**
|
|
30932
|
-
*
|
|
31151
|
+
* The type of request
|
|
30933
31152
|
* @type {string}
|
|
30934
31153
|
* @memberof TemplateSlackCustomFieldsBeta
|
|
30935
31154
|
*/
|
|
30936
31155
|
'requestType'?: string | null;
|
|
30937
31156
|
/**
|
|
30938
|
-
*
|
|
31157
|
+
* Whether the request contains a deny action
|
|
30939
31158
|
* @type {string}
|
|
30940
31159
|
* @memberof TemplateSlackCustomFieldsBeta
|
|
30941
31160
|
*/
|
|
30942
31161
|
'containsDeny'?: string | null;
|
|
30943
31162
|
/**
|
|
30944
|
-
*
|
|
31163
|
+
* The campaign ID
|
|
30945
31164
|
* @type {string}
|
|
30946
31165
|
* @memberof TemplateSlackCustomFieldsBeta
|
|
30947
31166
|
*/
|
|
30948
31167
|
'campaignId'?: string | null;
|
|
30949
31168
|
/**
|
|
30950
|
-
*
|
|
31169
|
+
* The campaign status
|
|
30951
31170
|
* @type {string}
|
|
30952
31171
|
* @memberof TemplateSlackCustomFieldsBeta
|
|
30953
31172
|
*/
|
|
@@ -30960,55 +31179,55 @@ export interface TemplateSlackCustomFieldsBeta {
|
|
|
30960
31179
|
*/
|
|
30961
31180
|
export interface TemplateTeamsBeta {
|
|
30962
31181
|
/**
|
|
30963
|
-
*
|
|
31182
|
+
* The template key
|
|
30964
31183
|
* @type {string}
|
|
30965
31184
|
* @memberof TemplateTeamsBeta
|
|
30966
31185
|
*/
|
|
30967
31186
|
'key'?: string | null;
|
|
30968
31187
|
/**
|
|
30969
|
-
*
|
|
31188
|
+
* The title of the Teams message
|
|
30970
31189
|
* @type {string}
|
|
30971
31190
|
* @memberof TemplateTeamsBeta
|
|
30972
31191
|
*/
|
|
30973
31192
|
'title'?: string | null;
|
|
30974
31193
|
/**
|
|
30975
|
-
*
|
|
31194
|
+
* The main text content of the Teams message
|
|
30976
31195
|
* @type {string}
|
|
30977
31196
|
* @memberof TemplateTeamsBeta
|
|
30978
31197
|
*/
|
|
30979
31198
|
'text'?: string;
|
|
30980
31199
|
/**
|
|
30981
|
-
*
|
|
31200
|
+
* JSON string of the Teams adaptive card
|
|
30982
31201
|
* @type {string}
|
|
30983
31202
|
* @memberof TemplateTeamsBeta
|
|
30984
31203
|
*/
|
|
30985
31204
|
'messageJSON'?: string | null;
|
|
30986
31205
|
/**
|
|
30987
|
-
*
|
|
31206
|
+
* Whether this is a subscription notification
|
|
30988
31207
|
* @type {boolean}
|
|
30989
31208
|
* @memberof TemplateTeamsBeta
|
|
30990
31209
|
*/
|
|
30991
31210
|
'isSubscription'?: boolean | null;
|
|
30992
31211
|
/**
|
|
30993
|
-
*
|
|
31212
|
+
* The approval request ID
|
|
30994
31213
|
* @type {string}
|
|
30995
31214
|
* @memberof TemplateTeamsBeta
|
|
30996
31215
|
*/
|
|
30997
31216
|
'approvalId'?: string | null;
|
|
30998
31217
|
/**
|
|
30999
|
-
*
|
|
31218
|
+
* The request ID
|
|
31000
31219
|
* @type {string}
|
|
31001
31220
|
* @memberof TemplateTeamsBeta
|
|
31002
31221
|
*/
|
|
31003
31222
|
'requestId'?: string | null;
|
|
31004
31223
|
/**
|
|
31005
|
-
*
|
|
31224
|
+
* The ID of the user who made the request
|
|
31006
31225
|
* @type {string}
|
|
31007
31226
|
* @memberof TemplateTeamsBeta
|
|
31008
31227
|
*/
|
|
31009
31228
|
'requestedById'?: string | null;
|
|
31010
31229
|
/**
|
|
31011
|
-
*
|
|
31230
|
+
* The type of notification
|
|
31012
31231
|
* @type {string}
|
|
31013
31232
|
* @memberof TemplateTeamsBeta
|
|
31014
31233
|
*/
|
|
@@ -34125,7 +34344,7 @@ export declare const AccessProfilesBetaApiAxiosParamCreator: (configuration?: Co
|
|
|
34125
34344
|
*/
|
|
34126
34345
|
listAccessProfiles: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34127
34346
|
/**
|
|
34128
|
-
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
34347
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **additionalOwners**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
34129
34348
|
* @summary Patch a specified access profile
|
|
34130
34349
|
* @param {string} id ID of the Access Profile to patch
|
|
34131
34350
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta
|
|
@@ -34208,7 +34427,7 @@ export declare const AccessProfilesBetaApiFp: (configuration?: Configuration) =>
|
|
|
34208
34427
|
*/
|
|
34209
34428
|
listAccessProfiles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfileBeta>>>;
|
|
34210
34429
|
/**
|
|
34211
|
-
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
34430
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **additionalOwners**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
34212
34431
|
* @summary Patch a specified access profile
|
|
34213
34432
|
* @param {string} id ID of the Access Profile to patch
|
|
34214
34433
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta
|
|
@@ -34279,7 +34498,7 @@ export declare const AccessProfilesBetaApiFactory: (configuration?: Configuratio
|
|
|
34279
34498
|
*/
|
|
34280
34499
|
listAccessProfiles(requestParameters?: AccessProfilesBetaApiListAccessProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AccessProfileBeta>>;
|
|
34281
34500
|
/**
|
|
34282
|
-
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
34501
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **additionalOwners**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
34283
34502
|
* @summary Patch a specified access profile
|
|
34284
34503
|
* @param {AccessProfilesBetaApiPatchAccessProfileRequest} requestParameters Request parameters.
|
|
34285
34504
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -34539,7 +34758,7 @@ export declare class AccessProfilesBetaApi extends BaseAPI {
|
|
|
34539
34758
|
*/
|
|
34540
34759
|
listAccessProfiles(requestParameters?: AccessProfilesBetaApiListAccessProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileBeta[], any>>;
|
|
34541
34760
|
/**
|
|
34542
|
-
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
34761
|
+
* This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **additionalOwners**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
34543
34762
|
* @summary Patch a specified access profile
|
|
34544
34763
|
* @param {AccessProfilesBetaApiPatchAccessProfileRequest} requestParameters Request parameters.
|
|
34545
34764
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -53239,7 +53458,7 @@ export declare const NotificationsBetaApiAxiosParamCreator: (configuration?: Con
|
|
|
53239
53458
|
*/
|
|
53240
53459
|
createVerifiedFromAddress: (emailStatusDtoBeta: EmailStatusDtoBeta, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53241
53460
|
/**
|
|
53242
|
-
* This lets you bulk delete templates that you previously created for your site.
|
|
53461
|
+
* This lets you bulk delete templates that you previously created for your site.
|
|
53243
53462
|
* @summary Bulk delete notification templates
|
|
53244
53463
|
* @param {Array<TemplateBulkDeleteDtoBeta>} templateBulkDeleteDtoBeta
|
|
53245
53464
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -53372,7 +53591,7 @@ export declare const NotificationsBetaApiFp: (configuration?: Configuration) =>
|
|
|
53372
53591
|
*/
|
|
53373
53592
|
createVerifiedFromAddress(emailStatusDtoBeta: EmailStatusDtoBeta, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailStatusDtoBeta>>;
|
|
53374
53593
|
/**
|
|
53375
|
-
* This lets you bulk delete templates that you previously created for your site.
|
|
53594
|
+
* This lets you bulk delete templates that you previously created for your site.
|
|
53376
53595
|
* @summary Bulk delete notification templates
|
|
53377
53596
|
* @param {Array<TemplateBulkDeleteDtoBeta>} templateBulkDeleteDtoBeta
|
|
53378
53597
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -53505,7 +53724,7 @@ export declare const NotificationsBetaApiFactory: (configuration?: Configuration
|
|
|
53505
53724
|
*/
|
|
53506
53725
|
createVerifiedFromAddress(requestParameters: NotificationsBetaApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EmailStatusDtoBeta>;
|
|
53507
53726
|
/**
|
|
53508
|
-
* This lets you bulk delete templates that you previously created for your site.
|
|
53727
|
+
* This lets you bulk delete templates that you previously created for your site.
|
|
53509
53728
|
* @summary Bulk delete notification templates
|
|
53510
53729
|
* @param {NotificationsBetaApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters.
|
|
53511
53730
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -53857,7 +54076,7 @@ export declare class NotificationsBetaApi extends BaseAPI {
|
|
|
53857
54076
|
*/
|
|
53858
54077
|
createVerifiedFromAddress(requestParameters: NotificationsBetaApiCreateVerifiedFromAddressRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EmailStatusDtoBeta, any>>;
|
|
53859
54078
|
/**
|
|
53860
|
-
* This lets you bulk delete templates that you previously created for your site.
|
|
54079
|
+
* This lets you bulk delete templates that you previously created for your site.
|
|
53861
54080
|
* @summary Bulk delete notification templates
|
|
53862
54081
|
* @param {NotificationsBetaApiDeleteNotificationTemplatesInBulkRequest} requestParameters Request parameters.
|
|
53863
54082
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56475,7 +56694,7 @@ export declare const RolesBetaApiAxiosParamCreator: (configuration?: Configurati
|
|
|
56475
56694
|
*/
|
|
56476
56695
|
listRoles: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56477
56696
|
/**
|
|
56478
|
-
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56697
|
+
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56479
56698
|
* @summary Patch a specified role
|
|
56480
56699
|
* @param {string} id ID of the Role to patch
|
|
56481
56700
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta
|
|
@@ -56563,7 +56782,7 @@ export declare const RolesBetaApiFp: (configuration?: Configuration) => {
|
|
|
56563
56782
|
*/
|
|
56564
56783
|
listRoles(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RoleBeta>>>;
|
|
56565
56784
|
/**
|
|
56566
|
-
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56785
|
+
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56567
56786
|
* @summary Patch a specified role
|
|
56568
56787
|
* @param {string} id ID of the Role to patch
|
|
56569
56788
|
* @param {Array<JsonPatchOperationBeta>} jsonPatchOperationBeta
|
|
@@ -56634,7 +56853,7 @@ export declare const RolesBetaApiFactory: (configuration?: Configuration, basePa
|
|
|
56634
56853
|
*/
|
|
56635
56854
|
listRoles(requestParameters?: RolesBetaApiListRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<RoleBeta>>;
|
|
56636
56855
|
/**
|
|
56637
|
-
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56856
|
+
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56638
56857
|
* @summary Patch a specified role
|
|
56639
56858
|
* @param {RolesBetaApiPatchRoleRequest} requestParameters Request parameters.
|
|
56640
56859
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -56925,7 +57144,7 @@ export declare class RolesBetaApi extends BaseAPI {
|
|
|
56925
57144
|
*/
|
|
56926
57145
|
listRoles(requestParameters?: RolesBetaApiListRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleBeta[], any>>;
|
|
56927
57146
|
/**
|
|
56928
|
-
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
57147
|
+
* This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description * enabled * owner * additionalOwners * accessProfiles * entitlements * membership * requestable * accessRequestConfig * revokeRequestConfig * segments * accessModelMetadata A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. When you use this API to modify a role\'s membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
|
56929
57148
|
* @summary Patch a specified role
|
|
56930
57149
|
* @param {RolesBetaApiPatchRoleRequest} requestParameters Request parameters.
|
|
56931
57150
|
* @param {*} [axiosOptions] Override http request option.
|