@aws-sdk/client-pca-connector-ad 3.529.1 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/PcaConnectorAd.d.ts +3 -1
- package/dist-types/PcaConnectorAdClient.d.ts +1 -1
- package/dist-types/commands/CreateConnectorCommand.d.ts +2 -1
- package/dist-types/commands/CreateDirectoryRegistrationCommand.d.ts +2 -1
- package/dist-types/commands/CreateServicePrincipalNameCommand.d.ts +2 -1
- package/dist-types/commands/CreateTemplateCommand.d.ts +2 -1
- package/dist-types/commands/CreateTemplateGroupAccessControlEntryCommand.d.ts +2 -1
- package/dist-types/commands/DeleteConnectorCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDirectoryRegistrationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteServicePrincipalNameCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTemplateCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTemplateGroupAccessControlEntryCommand.d.ts +2 -1
- package/dist-types/commands/GetConnectorCommand.d.ts +2 -1
- package/dist-types/commands/GetDirectoryRegistrationCommand.d.ts +2 -1
- package/dist-types/commands/GetServicePrincipalNameCommand.d.ts +2 -1
- package/dist-types/commands/GetTemplateCommand.d.ts +2 -1
- package/dist-types/commands/GetTemplateGroupAccessControlEntryCommand.d.ts +2 -1
- package/dist-types/commands/ListConnectorsCommand.d.ts +2 -1
- package/dist-types/commands/ListDirectoryRegistrationsCommand.d.ts +2 -1
- package/dist-types/commands/ListServicePrincipalNamesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTemplateGroupAccessControlEntriesCommand.d.ts +2 -1
- package/dist-types/commands/ListTemplatesCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTemplateCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTemplateGroupAccessControlEntryCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +351 -351
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/PcaConnectorAd.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreateConnectorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDirectoryRegistrationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateServicePrincipalNameCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateTemplateGroupAccessControlEntryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteConnectorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDirectoryRegistrationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteServicePrincipalNameCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTemplateGroupAccessControlEntryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetConnectorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDirectoryRegistrationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetServicePrincipalNameCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTemplateGroupAccessControlEntryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListConnectorsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDirectoryRegistrationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListServicePrincipalNamesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTemplateGroupAccessControlEntriesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateTemplateGroupAccessControlEntryCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -13,109 +13,109 @@ export declare const AccessRight: {
|
|
|
13
13
|
*/
|
|
14
14
|
export type AccessRight = (typeof AccessRight)[keyof typeof AccessRight];
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p> Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a
|
|
18
17
|
* template.</p>
|
|
18
|
+
* @public
|
|
19
19
|
*/
|
|
20
20
|
export interface AccessRights {
|
|
21
21
|
/**
|
|
22
|
-
* @public
|
|
23
22
|
* <p>Allow or deny an Active Directory group from enrolling certificates issued against a
|
|
24
23
|
* template.</p>
|
|
24
|
+
* @public
|
|
25
25
|
*/
|
|
26
26
|
Enroll?: AccessRight;
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>Allow or deny an Active Directory group from autoenrolling certificates issued against a template.
|
|
30
29
|
* The Active Directory group must be allowed to enroll to allow autoenrollment</p>
|
|
30
|
+
* @public
|
|
31
31
|
*/
|
|
32
32
|
AutoEnroll?: AccessRight;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
|
-
* @public
|
|
36
35
|
* <p> An access control entry allows or denies Active Directory groups based on their security
|
|
37
36
|
* identifiers (SIDs) from enrolling and/or autoenrolling with the template.</p>
|
|
37
|
+
* @public
|
|
38
38
|
*/
|
|
39
39
|
export interface AccessControlEntry {
|
|
40
40
|
/**
|
|
41
|
-
* @public
|
|
42
41
|
* <p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>
|
|
42
|
+
* @public
|
|
43
43
|
*/
|
|
44
44
|
GroupDisplayName?: string;
|
|
45
45
|
/**
|
|
46
|
-
* @public
|
|
47
46
|
* <p>Security identifier (SID) of the group object from Active Directory. The SID starts with
|
|
48
47
|
* "S-".</p>
|
|
48
|
+
* @public
|
|
49
49
|
*/
|
|
50
50
|
GroupSecurityIdentifier?: string;
|
|
51
51
|
/**
|
|
52
|
-
* @public
|
|
53
52
|
* <p>Permissions to allow or deny an Active Directory group to enroll or autoenroll certificates issued
|
|
54
53
|
* against a template.</p>
|
|
54
|
+
* @public
|
|
55
55
|
*/
|
|
56
56
|
AccessRights?: AccessRights;
|
|
57
57
|
/**
|
|
58
|
-
* @public
|
|
59
58
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
TemplateArn?: string;
|
|
62
62
|
/**
|
|
63
|
-
* @public
|
|
64
63
|
* <p>The date and time that the Access Control Entry was created.</p>
|
|
64
|
+
* @public
|
|
65
65
|
*/
|
|
66
66
|
CreatedAt?: Date;
|
|
67
67
|
/**
|
|
68
|
-
* @public
|
|
69
68
|
* <p>The date and time that the Access Control Entry was updated.</p>
|
|
69
|
+
* @public
|
|
70
70
|
*/
|
|
71
71
|
UpdatedAt?: Date;
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
|
-
* @public
|
|
75
74
|
* <p>Summary of group access control entries that allow or deny Active Directory groups based on their
|
|
76
75
|
* security identifiers (SIDs) from enrolling and/or autofenrolling with the template.</p>
|
|
76
|
+
* @public
|
|
77
77
|
*/
|
|
78
78
|
export interface AccessControlEntrySummary {
|
|
79
79
|
/**
|
|
80
|
-
* @public
|
|
81
80
|
* <p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>
|
|
81
|
+
* @public
|
|
82
82
|
*/
|
|
83
83
|
GroupDisplayName?: string;
|
|
84
84
|
/**
|
|
85
|
-
* @public
|
|
86
85
|
* <p>Security identifier (SID) of the group object from Active Directory. The SID starts with
|
|
87
86
|
* "S-".</p>
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
GroupSecurityIdentifier?: string;
|
|
90
90
|
/**
|
|
91
|
-
* @public
|
|
92
91
|
* <p>Allow or deny an Active Directory group from enrolling and autoenrolling certificates issued against
|
|
93
92
|
* a template.</p>
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
AccessRights?: AccessRights;
|
|
96
96
|
/**
|
|
97
|
-
* @public
|
|
98
97
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>. </p>
|
|
98
|
+
* @public
|
|
99
99
|
*/
|
|
100
100
|
TemplateArn?: string;
|
|
101
101
|
/**
|
|
102
|
-
* @public
|
|
103
102
|
* <p>The date and time that the Access Control Entry was created.</p>
|
|
103
|
+
* @public
|
|
104
104
|
*/
|
|
105
105
|
CreatedAt?: Date;
|
|
106
106
|
/**
|
|
107
|
-
* @public
|
|
108
107
|
* <p>The date and time that the Access Control Entry was updated.</p>
|
|
108
|
+
* @public
|
|
109
109
|
*/
|
|
110
110
|
UpdatedAt?: Date;
|
|
111
111
|
}
|
|
112
112
|
/**
|
|
113
|
-
* @public
|
|
114
113
|
* <p>You can receive this error if you attempt to create a resource share when you don't have
|
|
115
114
|
* the required permissions. This can be caused by insufficient permissions in policies
|
|
116
115
|
* attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen
|
|
117
116
|
* because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP)
|
|
118
117
|
* that affects your Amazon Web Services account. </p>
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
export declare class AccessDeniedException extends __BaseException {
|
|
121
121
|
readonly name: "AccessDeniedException";
|
|
@@ -204,8 +204,8 @@ export declare const ApplicationPolicyType: {
|
|
|
204
204
|
*/
|
|
205
205
|
export type ApplicationPolicyType = (typeof ApplicationPolicyType)[keyof typeof ApplicationPolicyType];
|
|
206
206
|
/**
|
|
207
|
-
* @public
|
|
208
207
|
* <p>Application policies describe what the certificate can be used for.</p>
|
|
208
|
+
* @public
|
|
209
209
|
*/
|
|
210
210
|
export type ApplicationPolicy = ApplicationPolicy.PolicyObjectIdentifierMember | ApplicationPolicy.PolicyTypeMember | ApplicationPolicy.$UnknownMember;
|
|
211
211
|
/**
|
|
@@ -213,8 +213,8 @@ export type ApplicationPolicy = ApplicationPolicy.PolicyObjectIdentifierMember |
|
|
|
213
213
|
*/
|
|
214
214
|
export declare namespace ApplicationPolicy {
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>The type of application policy</p>
|
|
217
|
+
* @public
|
|
218
218
|
*/
|
|
219
219
|
interface PolicyTypeMember {
|
|
220
220
|
PolicyType: ApplicationPolicyType;
|
|
@@ -222,8 +222,8 @@ export declare namespace ApplicationPolicy {
|
|
|
222
222
|
$unknown?: never;
|
|
223
223
|
}
|
|
224
224
|
/**
|
|
225
|
-
* @public
|
|
226
225
|
* <p>The object identifier (OID) of an application policy.</p>
|
|
226
|
+
* @public
|
|
227
227
|
*/
|
|
228
228
|
interface PolicyObjectIdentifierMember {
|
|
229
229
|
PolicyType?: never;
|
|
@@ -246,18 +246,18 @@ export declare namespace ApplicationPolicy {
|
|
|
246
246
|
const visit: <T>(value: ApplicationPolicy, visitor: Visitor<T>) => T;
|
|
247
247
|
}
|
|
248
248
|
/**
|
|
249
|
-
* @public
|
|
250
249
|
* <p>Application policies describe what the certificate can be used for.</p>
|
|
250
|
+
* @public
|
|
251
251
|
*/
|
|
252
252
|
export interface ApplicationPolicies {
|
|
253
253
|
/**
|
|
254
|
-
* @public
|
|
255
254
|
* <p>Marks the application policy extension as critical.</p>
|
|
255
|
+
* @public
|
|
256
256
|
*/
|
|
257
257
|
Critical?: boolean;
|
|
258
258
|
/**
|
|
259
|
-
* @public
|
|
260
259
|
* <p>Application policies describe what the certificate can be used for.</p>
|
|
260
|
+
* @public
|
|
261
261
|
*/
|
|
262
262
|
Policies: ApplicationPolicy[] | undefined;
|
|
263
263
|
}
|
|
@@ -277,7 +277,6 @@ export declare const ValidityPeriodType: {
|
|
|
277
277
|
*/
|
|
278
278
|
export type ValidityPeriodType = (typeof ValidityPeriodType)[keyof typeof ValidityPeriodType];
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>Information describing the end of the validity period of the certificate. This parameter
|
|
282
281
|
* sets the “Not After” date for the certificate. Certificate validity is the period of time
|
|
283
282
|
* during which a certificate is valid. Validity can be expressed as an explicit date and time
|
|
@@ -286,21 +285,21 @@ export type ValidityPeriodType = (typeof ValidityPeriodType)[keyof typeof Validi
|
|
|
286
285
|
* when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the
|
|
287
286
|
* future, the certificate will expire 20 days from issuance time regardless of the
|
|
288
287
|
* ValidityNotBefore value. </p>
|
|
288
|
+
* @public
|
|
289
289
|
*/
|
|
290
290
|
export interface ValidityPeriod {
|
|
291
291
|
/**
|
|
292
|
-
* @public
|
|
293
292
|
* <p>The unit of time. You can select hours, days, weeks, months, and years.</p>
|
|
293
|
+
* @public
|
|
294
294
|
*/
|
|
295
295
|
PeriodType: ValidityPeriodType | undefined;
|
|
296
296
|
/**
|
|
297
|
-
* @public
|
|
298
297
|
* <p>The numeric value for the validity period.</p>
|
|
298
|
+
* @public
|
|
299
299
|
*/
|
|
300
300
|
Period: number | undefined;
|
|
301
301
|
}
|
|
302
302
|
/**
|
|
303
|
-
* @public
|
|
304
303
|
* <p>Information describing the end of the validity period of the certificate. This parameter
|
|
305
304
|
* sets the “Not After” date for the certificate. Certificate validity is the period of time
|
|
306
305
|
* during which a certificate is valid. Validity can be expressed as an explicit date and time
|
|
@@ -309,10 +308,10 @@ export interface ValidityPeriod {
|
|
|
309
308
|
* ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the
|
|
310
309
|
* future, the certificate will expire 20 days from issuance time regardless of the
|
|
311
310
|
* ValidityNotBefore value.</p>
|
|
311
|
+
* @public
|
|
312
312
|
*/
|
|
313
313
|
export interface CertificateValidity {
|
|
314
314
|
/**
|
|
315
|
-
* @public
|
|
316
315
|
* <p>Information describing the end of the validity period of the certificate. This parameter
|
|
317
316
|
* sets the “Not After” date for the certificate. Certificate validity is the period of time
|
|
318
317
|
* during which a certificate is valid. Validity can be expressed as an explicit date and time
|
|
@@ -321,12 +320,13 @@ export interface CertificateValidity {
|
|
|
321
320
|
* ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the
|
|
322
321
|
* future, the certificate will expire 20 days from issuance time regardless of the
|
|
323
322
|
* ValidityNotBefore value.</p>
|
|
323
|
+
* @public
|
|
324
324
|
*/
|
|
325
325
|
ValidityPeriod: ValidityPeriod | undefined;
|
|
326
326
|
/**
|
|
327
|
-
* @public
|
|
328
327
|
* <p>Renewal period is the period of time before certificate expiration when a new
|
|
329
328
|
* certificate will be requested.</p>
|
|
329
|
+
* @public
|
|
330
330
|
*/
|
|
331
331
|
RenewalPeriod: ValidityPeriod | undefined;
|
|
332
332
|
}
|
|
@@ -375,22 +375,22 @@ export declare const ClientCompatibilityV4: {
|
|
|
375
375
|
*/
|
|
376
376
|
export type ClientCompatibilityV4 = (typeof ClientCompatibilityV4)[keyof typeof ClientCompatibilityV4];
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>This request cannot be completed for one of the following reasons because the requested
|
|
380
379
|
* resource was being concurrently modified by another request.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
export declare class ConflictException extends __BaseException {
|
|
383
383
|
readonly name: "ConflictException";
|
|
384
384
|
readonly $fault: "client";
|
|
385
385
|
Message: string | undefined;
|
|
386
386
|
/**
|
|
387
|
-
* @public
|
|
388
387
|
* <p>The identifier of the Amazon Web Services resource.</p>
|
|
388
|
+
* @public
|
|
389
389
|
*/
|
|
390
390
|
ResourceId: string | undefined;
|
|
391
391
|
/**
|
|
392
|
-
* @public
|
|
393
392
|
* <p>The resource type, which can be one of <code>Connector</code>, <code>Template</code>, <code>TemplateGroupAccessControlEntry</code>, <code>ServicePrincipalName</code>, or <code>DirectoryRegistration</code>.</p>
|
|
393
|
+
* @public
|
|
394
394
|
*/
|
|
395
395
|
ResourceType: string | undefined;
|
|
396
396
|
/**
|
|
@@ -431,121 +431,121 @@ export declare const ConnectorStatusReason: {
|
|
|
431
431
|
*/
|
|
432
432
|
export type ConnectorStatusReason = (typeof ConnectorStatusReason)[keyof typeof ConnectorStatusReason];
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>Information about your VPC and security groups used with the connector.</p>
|
|
435
|
+
* @public
|
|
436
436
|
*/
|
|
437
437
|
export interface VpcInformation {
|
|
438
438
|
/**
|
|
439
|
-
* @public
|
|
440
439
|
* <p>The security groups used with the connector. You can use a maximum of 4 security groups
|
|
441
440
|
* with a connector.</p>
|
|
441
|
+
* @public
|
|
442
442
|
*/
|
|
443
443
|
SecurityGroupIds: string[] | undefined;
|
|
444
444
|
}
|
|
445
445
|
/**
|
|
446
|
-
* @public
|
|
447
446
|
* <p>Amazon Web Services Private CA Connector for Active Directory is a service that links your Active Directory with Amazon Web Services Private CA. The connector brokers the
|
|
448
447
|
* exchange of certificates from Amazon Web Services Private CA to domain-joined users and machines managed with
|
|
449
448
|
* Active Directory.</p>
|
|
449
|
+
* @public
|
|
450
450
|
*/
|
|
451
451
|
export interface Connector {
|
|
452
452
|
/**
|
|
453
|
-
* @public
|
|
454
453
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>. </p>
|
|
454
|
+
* @public
|
|
455
455
|
*/
|
|
456
456
|
Arn?: string;
|
|
457
457
|
/**
|
|
458
|
-
* @public
|
|
459
458
|
* <p>The Amazon Resource Name (ARN) of the certificate authority being used. </p>
|
|
459
|
+
* @public
|
|
460
460
|
*/
|
|
461
461
|
CertificateAuthorityArn?: string;
|
|
462
462
|
/**
|
|
463
|
-
* @public
|
|
464
463
|
* <p>Certificate enrollment endpoint for Active Directory domain-joined objects reach out to when
|
|
465
464
|
* requesting certificates.</p>
|
|
465
|
+
* @public
|
|
466
466
|
*/
|
|
467
467
|
CertificateEnrollmentPolicyServerEndpoint?: string;
|
|
468
468
|
/**
|
|
469
|
-
* @public
|
|
470
469
|
* <p>The identifier of the Active Directory.</p>
|
|
470
|
+
* @public
|
|
471
471
|
*/
|
|
472
472
|
DirectoryId?: string;
|
|
473
473
|
/**
|
|
474
|
-
* @public
|
|
475
474
|
* <p>Information of the VPC and security group(s) used with the connector.</p>
|
|
475
|
+
* @public
|
|
476
476
|
*/
|
|
477
477
|
VpcInformation?: VpcInformation;
|
|
478
478
|
/**
|
|
479
|
-
* @public
|
|
480
479
|
* <p>Status of the connector. Status can be creating, active, deleting, or failed.</p>
|
|
480
|
+
* @public
|
|
481
481
|
*/
|
|
482
482
|
Status?: ConnectorStatus;
|
|
483
483
|
/**
|
|
484
|
-
* @public
|
|
485
484
|
* <p>Additional information about the connector status if the status is failed.</p>
|
|
485
|
+
* @public
|
|
486
486
|
*/
|
|
487
487
|
StatusReason?: ConnectorStatusReason;
|
|
488
488
|
/**
|
|
489
|
-
* @public
|
|
490
489
|
* <p>The date and time that the connector was created.</p>
|
|
490
|
+
* @public
|
|
491
491
|
*/
|
|
492
492
|
CreatedAt?: Date;
|
|
493
493
|
/**
|
|
494
|
-
* @public
|
|
495
494
|
* <p>The date and time that the connector was updated.</p>
|
|
495
|
+
* @public
|
|
496
496
|
*/
|
|
497
497
|
UpdatedAt?: Date;
|
|
498
498
|
}
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>Summary description of the Amazon Web Services Private CA AD connectors belonging to an Amazon Web Services
|
|
502
501
|
* account.</p>
|
|
502
|
+
* @public
|
|
503
503
|
*/
|
|
504
504
|
export interface ConnectorSummary {
|
|
505
505
|
/**
|
|
506
|
-
* @public
|
|
507
506
|
* <p> The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
507
|
+
* @public
|
|
508
508
|
*/
|
|
509
509
|
Arn?: string;
|
|
510
510
|
/**
|
|
511
|
-
* @public
|
|
512
511
|
* <p>The Amazon Resource Name (ARN) of the certificate authority being used.</p>
|
|
512
|
+
* @public
|
|
513
513
|
*/
|
|
514
514
|
CertificateAuthorityArn?: string;
|
|
515
515
|
/**
|
|
516
|
-
* @public
|
|
517
516
|
* <p>Certificate enrollment endpoint for Active Directory domain-joined objects to request
|
|
518
517
|
* certificates.</p>
|
|
518
|
+
* @public
|
|
519
519
|
*/
|
|
520
520
|
CertificateEnrollmentPolicyServerEndpoint?: string;
|
|
521
521
|
/**
|
|
522
|
-
* @public
|
|
523
522
|
* <p>The identifier of the Active Directory.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
DirectoryId?: string;
|
|
526
526
|
/**
|
|
527
|
-
* @public
|
|
528
527
|
* <p>Information of the VPC and security group(s) used with the connector.</p>
|
|
528
|
+
* @public
|
|
529
529
|
*/
|
|
530
530
|
VpcInformation?: VpcInformation;
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>Status of the connector. Status can be creating, active, deleting, or failed.</p>
|
|
533
|
+
* @public
|
|
534
534
|
*/
|
|
535
535
|
Status?: ConnectorStatus;
|
|
536
536
|
/**
|
|
537
|
-
* @public
|
|
538
537
|
* <p>Additional information about the connector status if the status is failed.</p>
|
|
538
|
+
* @public
|
|
539
539
|
*/
|
|
540
540
|
StatusReason?: ConnectorStatusReason;
|
|
541
541
|
/**
|
|
542
|
-
* @public
|
|
543
542
|
* <p>The date and time that the connector was created.</p>
|
|
543
|
+
* @public
|
|
544
544
|
*/
|
|
545
545
|
CreatedAt?: Date;
|
|
546
546
|
/**
|
|
547
|
-
* @public
|
|
548
547
|
* <p>The date and time that the connector was updated.</p>
|
|
548
|
+
* @public
|
|
549
549
|
*/
|
|
550
550
|
UpdatedAt?: Date;
|
|
551
551
|
}
|
|
@@ -554,28 +554,28 @@ export interface ConnectorSummary {
|
|
|
554
554
|
*/
|
|
555
555
|
export interface CreateConnectorRequest {
|
|
556
556
|
/**
|
|
557
|
-
* @public
|
|
558
557
|
* <p>The identifier of the Active Directory.</p>
|
|
558
|
+
* @public
|
|
559
559
|
*/
|
|
560
560
|
DirectoryId: string | undefined;
|
|
561
561
|
/**
|
|
562
|
-
* @public
|
|
563
562
|
* <p> The Amazon Resource Name (ARN) of the certificate authority being used.</p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
CertificateAuthorityArn: string | undefined;
|
|
566
566
|
/**
|
|
567
|
-
* @public
|
|
568
567
|
* <p>Security group IDs that describe the inbound and outbound rules.</p>
|
|
568
|
+
* @public
|
|
569
569
|
*/
|
|
570
570
|
VpcInformation: VpcInformation | undefined;
|
|
571
571
|
/**
|
|
572
|
-
* @public
|
|
573
572
|
* <p>Idempotency token.</p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
ClientToken?: string;
|
|
576
576
|
/**
|
|
577
|
-
* @public
|
|
578
577
|
* <p>Metadata assigned to a connector consisting of a key-value pair.</p>
|
|
578
|
+
* @public
|
|
579
579
|
*/
|
|
580
580
|
Tags?: Record<string, string>;
|
|
581
581
|
}
|
|
@@ -584,15 +584,15 @@ export interface CreateConnectorRequest {
|
|
|
584
584
|
*/
|
|
585
585
|
export interface CreateConnectorResponse {
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>If successful, the Amazon Resource Name (ARN) of the connector for Active Directory.</p>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
ConnectorArn?: string;
|
|
591
591
|
}
|
|
592
592
|
/**
|
|
593
|
-
* @public
|
|
594
593
|
* <p>The request processing has failed because of an unknown error, exception or failure with
|
|
595
594
|
* an internal server. </p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
export declare class InternalServerException extends __BaseException {
|
|
598
598
|
readonly name: "InternalServerException";
|
|
@@ -605,22 +605,22 @@ export declare class InternalServerException extends __BaseException {
|
|
|
605
605
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
606
606
|
}
|
|
607
607
|
/**
|
|
608
|
-
* @public
|
|
609
608
|
* <p>The operation tried to access a nonexistent resource. The resource might not be
|
|
610
609
|
* specified correctly, or its status might not be ACTIVE.</p>
|
|
610
|
+
* @public
|
|
611
611
|
*/
|
|
612
612
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
613
613
|
readonly name: "ResourceNotFoundException";
|
|
614
614
|
readonly $fault: "client";
|
|
615
615
|
Message: string | undefined;
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* <p>The identifier of the Amazon Web Services resource.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
ResourceId: string | undefined;
|
|
621
621
|
/**
|
|
622
|
-
* @public
|
|
623
622
|
* <p>The resource type, which can be one of <code>Connector</code>, <code>Template</code>, <code>TemplateGroupAccessControlEntry</code>, <code>ServicePrincipalName</code>, or <code>DirectoryRegistration</code>.</p>
|
|
623
|
+
* @public
|
|
624
624
|
*/
|
|
625
625
|
ResourceType: string | undefined;
|
|
626
626
|
/**
|
|
@@ -629,31 +629,31 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
629
629
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
630
630
|
}
|
|
631
631
|
/**
|
|
632
|
-
* @public
|
|
633
632
|
* <p>Request would cause a service quota to be exceeded.</p>
|
|
633
|
+
* @public
|
|
634
634
|
*/
|
|
635
635
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
636
636
|
readonly name: "ServiceQuotaExceededException";
|
|
637
637
|
readonly $fault: "client";
|
|
638
638
|
Message: string | undefined;
|
|
639
639
|
/**
|
|
640
|
-
* @public
|
|
641
640
|
* <p>The identifier of the Amazon Web Services resource.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
ResourceId: string | undefined;
|
|
644
644
|
/**
|
|
645
|
-
* @public
|
|
646
645
|
* <p>The resource type, which can be one of <code>Connector</code>, <code>Template</code>, <code>TemplateGroupAccessControlEntry</code>, <code>ServicePrincipalName</code>, or <code>DirectoryRegistration</code>.</p>
|
|
646
|
+
* @public
|
|
647
647
|
*/
|
|
648
648
|
ResourceType: string | undefined;
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>Identifies the originating service.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
ServiceCode: string | undefined;
|
|
654
654
|
/**
|
|
655
|
-
* @public
|
|
656
655
|
* <p>The code associated with the service quota.</p>
|
|
656
|
+
* @public
|
|
657
657
|
*/
|
|
658
658
|
QuotaCode: string | undefined;
|
|
659
659
|
/**
|
|
@@ -662,8 +662,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
662
662
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
663
663
|
}
|
|
664
664
|
/**
|
|
665
|
-
* @public
|
|
666
665
|
* <p>The limit on the number of requests per second was exceeded. </p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
export declare class ThrottlingException extends __BaseException {
|
|
669
669
|
readonly name: "ThrottlingException";
|
|
@@ -673,13 +673,13 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
673
673
|
};
|
|
674
674
|
Message: string | undefined;
|
|
675
675
|
/**
|
|
676
|
-
* @public
|
|
677
676
|
* <p>Identifies the originating service.</p>
|
|
677
|
+
* @public
|
|
678
678
|
*/
|
|
679
679
|
ServiceCode?: string;
|
|
680
680
|
/**
|
|
681
|
-
* @public
|
|
682
681
|
* <p>The code associated with the quota.</p>
|
|
682
|
+
* @public
|
|
683
683
|
*/
|
|
684
684
|
QuotaCode?: string;
|
|
685
685
|
/**
|
|
@@ -706,18 +706,18 @@ export declare const ValidationExceptionReason: {
|
|
|
706
706
|
*/
|
|
707
707
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
708
708
|
/**
|
|
709
|
-
* @public
|
|
710
709
|
* <p>An input validation error occurred. For example, invalid characters in a template name,
|
|
711
710
|
* or if a pagination token is invalid. </p>
|
|
711
|
+
* @public
|
|
712
712
|
*/
|
|
713
713
|
export declare class ValidationException extends __BaseException {
|
|
714
714
|
readonly name: "ValidationException";
|
|
715
715
|
readonly $fault: "client";
|
|
716
716
|
Message: string | undefined;
|
|
717
717
|
/**
|
|
718
|
-
* @public
|
|
719
718
|
* <p>The reason for the validation error. This won't be return for every
|
|
720
719
|
* validation exception.</p>
|
|
720
|
+
* @public
|
|
721
721
|
*/
|
|
722
722
|
Reason?: ValidationExceptionReason;
|
|
723
723
|
/**
|
|
@@ -730,8 +730,8 @@ export declare class ValidationException extends __BaseException {
|
|
|
730
730
|
*/
|
|
731
731
|
export interface DeleteConnectorRequest {
|
|
732
732
|
/**
|
|
733
|
-
* @public
|
|
734
733
|
* <p> The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
734
|
+
* @public
|
|
735
735
|
*/
|
|
736
736
|
ConnectorArn: string | undefined;
|
|
737
737
|
}
|
|
@@ -740,8 +740,8 @@ export interface DeleteConnectorRequest {
|
|
|
740
740
|
*/
|
|
741
741
|
export interface GetConnectorRequest {
|
|
742
742
|
/**
|
|
743
|
-
* @public
|
|
744
743
|
* <p> The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
744
|
+
* @public
|
|
745
745
|
*/
|
|
746
746
|
ConnectorArn: string | undefined;
|
|
747
747
|
}
|
|
@@ -750,8 +750,8 @@ export interface GetConnectorRequest {
|
|
|
750
750
|
*/
|
|
751
751
|
export interface GetConnectorResponse {
|
|
752
752
|
/**
|
|
753
|
-
* @public
|
|
754
753
|
* <p>A structure that contains information about your connector.</p>
|
|
754
|
+
* @public
|
|
755
755
|
*/
|
|
756
756
|
Connector?: Connector;
|
|
757
757
|
}
|
|
@@ -760,19 +760,19 @@ export interface GetConnectorResponse {
|
|
|
760
760
|
*/
|
|
761
761
|
export interface ListConnectorsRequest {
|
|
762
762
|
/**
|
|
763
|
-
* @public
|
|
764
763
|
* <p>Use this parameter when paginating results to specify the maximum number of items to
|
|
765
764
|
* return in the response on each page. If additional items exist beyond the number you
|
|
766
765
|
* specify, the <code>NextToken</code> element is sent in the response. Use this
|
|
767
766
|
* <code>NextToken</code> value in a subsequent request to retrieve additional
|
|
768
767
|
* items.</p>
|
|
768
|
+
* @public
|
|
769
769
|
*/
|
|
770
770
|
MaxResults?: number;
|
|
771
771
|
/**
|
|
772
|
-
* @public
|
|
773
772
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
774
773
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
775
774
|
* parameter from the response you just received.</p>
|
|
775
|
+
* @public
|
|
776
776
|
*/
|
|
777
777
|
NextToken?: string;
|
|
778
778
|
}
|
|
@@ -781,15 +781,15 @@ export interface ListConnectorsRequest {
|
|
|
781
781
|
*/
|
|
782
782
|
export interface ListConnectorsResponse {
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>Summary information about each connector you have created.</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
Connectors?: ConnectorSummary[];
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
791
790
|
* response with truncated results. Set it to the value of the NextToken parameter from the
|
|
792
791
|
* response you just received.</p>
|
|
792
|
+
* @public
|
|
793
793
|
*/
|
|
794
794
|
NextToken?: string;
|
|
795
795
|
}
|
|
@@ -798,18 +798,18 @@ export interface ListConnectorsResponse {
|
|
|
798
798
|
*/
|
|
799
799
|
export interface CreateDirectoryRegistrationRequest {
|
|
800
800
|
/**
|
|
801
|
-
* @public
|
|
802
801
|
* <p> The identifier of the Active Directory.</p>
|
|
802
|
+
* @public
|
|
803
803
|
*/
|
|
804
804
|
DirectoryId: string | undefined;
|
|
805
805
|
/**
|
|
806
|
-
* @public
|
|
807
806
|
* <p>Idempotency token.</p>
|
|
807
|
+
* @public
|
|
808
808
|
*/
|
|
809
809
|
ClientToken?: string;
|
|
810
810
|
/**
|
|
811
|
-
* @public
|
|
812
811
|
* <p>Metadata assigned to a directory registration consisting of a key-value pair.</p>
|
|
812
|
+
* @public
|
|
813
813
|
*/
|
|
814
814
|
Tags?: Record<string, string>;
|
|
815
815
|
}
|
|
@@ -818,8 +818,8 @@ export interface CreateDirectoryRegistrationRequest {
|
|
|
818
818
|
*/
|
|
819
819
|
export interface CreateDirectoryRegistrationResponse {
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
822
|
+
* @public
|
|
823
823
|
*/
|
|
824
824
|
DirectoryRegistrationArn?: string;
|
|
825
825
|
}
|
|
@@ -828,143 +828,143 @@ export interface CreateDirectoryRegistrationResponse {
|
|
|
828
828
|
*/
|
|
829
829
|
export interface CreateServicePrincipalNameRequest {
|
|
830
830
|
/**
|
|
831
|
-
* @public
|
|
832
831
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
832
|
+
* @public
|
|
833
833
|
*/
|
|
834
834
|
DirectoryRegistrationArn: string | undefined;
|
|
835
835
|
/**
|
|
836
|
-
* @public
|
|
837
836
|
* <p> The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
837
|
+
* @public
|
|
838
838
|
*/
|
|
839
839
|
ConnectorArn: string | undefined;
|
|
840
840
|
/**
|
|
841
|
-
* @public
|
|
842
841
|
* <p>Idempotency token.</p>
|
|
842
|
+
* @public
|
|
843
843
|
*/
|
|
844
844
|
ClientToken?: string;
|
|
845
845
|
}
|
|
846
846
|
/**
|
|
847
|
-
* @public
|
|
848
847
|
* <p>Template configurations for v2 template schema.</p>
|
|
848
|
+
* @public
|
|
849
849
|
*/
|
|
850
850
|
export interface EnrollmentFlagsV2 {
|
|
851
851
|
/**
|
|
852
|
-
* @public
|
|
853
852
|
* <p>Include symmetric algorithms allowed by the subject.</p>
|
|
853
|
+
* @public
|
|
854
854
|
*/
|
|
855
855
|
IncludeSymmetricAlgorithms?: boolean;
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>Require user interaction when the subject is enrolled and the private key associated
|
|
859
858
|
* with the certificate is used.</p>
|
|
859
|
+
* @public
|
|
860
860
|
*/
|
|
861
861
|
UserInteractionRequired?: boolean;
|
|
862
862
|
/**
|
|
863
|
-
* @public
|
|
864
863
|
* <p>Delete expired or revoked certificates instead of archiving them.</p>
|
|
864
|
+
* @public
|
|
865
865
|
*/
|
|
866
866
|
RemoveInvalidCertificateFromPersonalStore?: boolean;
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>This flag instructs the CA to not include the security extension
|
|
870
869
|
* szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections
|
|
871
870
|
* 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows
|
|
872
871
|
* Kerberos elevation-of-privilege vulnerability.</p>
|
|
872
|
+
* @public
|
|
873
873
|
*/
|
|
874
874
|
NoSecurityExtension?: boolean;
|
|
875
875
|
/**
|
|
876
|
-
* @public
|
|
877
876
|
* <p>Allow renewal using the same key.</p>
|
|
877
|
+
* @public
|
|
878
878
|
*/
|
|
879
879
|
EnableKeyReuseOnNtTokenKeysetStorageFull?: boolean;
|
|
880
880
|
}
|
|
881
881
|
/**
|
|
882
|
-
* @public
|
|
883
882
|
* <p>The key usage flags represent the purpose (e.g., encipherment, signature) of the key
|
|
884
883
|
* contained in the certificate.</p>
|
|
884
|
+
* @public
|
|
885
885
|
*/
|
|
886
886
|
export interface KeyUsageFlags {
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* <p>The digitalSignature is asserted when the subject public key is used for verifying
|
|
890
889
|
* digital signatures.</p>
|
|
890
|
+
* @public
|
|
891
891
|
*/
|
|
892
892
|
DigitalSignature?: boolean;
|
|
893
893
|
/**
|
|
894
|
-
* @public
|
|
895
894
|
* <p>NonRepudiation is asserted when the subject public key is used to verify digital
|
|
896
895
|
* signatures.</p>
|
|
896
|
+
* @public
|
|
897
897
|
*/
|
|
898
898
|
NonRepudiation?: boolean;
|
|
899
899
|
/**
|
|
900
|
-
* @public
|
|
901
900
|
* <p>KeyEncipherment is asserted when the subject public key is used for enciphering private
|
|
902
901
|
* or secret keys, i.e., for key transport.</p>
|
|
902
|
+
* @public
|
|
903
903
|
*/
|
|
904
904
|
KeyEncipherment?: boolean;
|
|
905
905
|
/**
|
|
906
|
-
* @public
|
|
907
906
|
* <p>DataEncipherment is asserted when the subject public key is used for directly
|
|
908
907
|
* enciphering raw user data without the use of an intermediate symmetric cipher.</p>
|
|
908
|
+
* @public
|
|
909
909
|
*/
|
|
910
910
|
DataEncipherment?: boolean;
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>KeyAgreement is asserted when the subject public key is used for key agreement.</p>
|
|
913
|
+
* @public
|
|
914
914
|
*/
|
|
915
915
|
KeyAgreement?: boolean;
|
|
916
916
|
}
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>The key usage extension defines the purpose (e.g., encipherment, signature) of the key
|
|
920
919
|
* contained in the certificate.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
export interface KeyUsage {
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>Sets the key usage extension to critical.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
Critical?: boolean;
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>The key usage flags represent the purpose (e.g., encipherment, signature) of the key
|
|
931
930
|
* contained in the certificate.</p>
|
|
931
|
+
* @public
|
|
932
932
|
*/
|
|
933
933
|
UsageFlags: KeyUsageFlags | undefined;
|
|
934
934
|
}
|
|
935
935
|
/**
|
|
936
|
-
* @public
|
|
937
936
|
* <p>Certificate extensions for v2 template schema</p>
|
|
937
|
+
* @public
|
|
938
938
|
*/
|
|
939
939
|
export interface ExtensionsV2 {
|
|
940
940
|
/**
|
|
941
|
-
* @public
|
|
942
941
|
* <p>The key usage extension defines the purpose (e.g., encipherment, signature, certificate
|
|
943
942
|
* signing) of the key contained in the certificate.</p>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
KeyUsage: KeyUsage | undefined;
|
|
946
946
|
/**
|
|
947
|
-
* @public
|
|
948
947
|
* <p>Application policies specify what the certificate is used for and its purpose. </p>
|
|
948
|
+
* @public
|
|
949
949
|
*/
|
|
950
950
|
ApplicationPolicies?: ApplicationPolicies;
|
|
951
951
|
}
|
|
952
952
|
/**
|
|
953
|
-
* @public
|
|
954
953
|
* <p>General flags for v2 template schema that defines if the template is for a machine or a
|
|
955
954
|
* user and if the template can be issued using autoenrollment.</p>
|
|
955
|
+
* @public
|
|
956
956
|
*/
|
|
957
957
|
export interface GeneralFlagsV2 {
|
|
958
958
|
/**
|
|
959
|
-
* @public
|
|
960
959
|
* <p>Allows certificate issuance using autoenrollment. Set to TRUE to allow
|
|
961
960
|
* autoenrollment.</p>
|
|
961
|
+
* @public
|
|
962
962
|
*/
|
|
963
963
|
AutoEnrollment?: boolean;
|
|
964
964
|
/**
|
|
965
|
-
* @public
|
|
966
965
|
* <p>Defines if the template is for machines or users. Set to TRUE if the template is for
|
|
967
966
|
* machines. Set to FALSE if the template is for users.</p>
|
|
967
|
+
* @public
|
|
968
968
|
*/
|
|
969
969
|
MachineType?: boolean;
|
|
970
970
|
}
|
|
@@ -981,51 +981,50 @@ export declare const KeySpec: {
|
|
|
981
981
|
*/
|
|
982
982
|
export type KeySpec = (typeof KeySpec)[keyof typeof KeySpec];
|
|
983
983
|
/**
|
|
984
|
-
* @public
|
|
985
984
|
* <p>Defines the attributes of the private key.</p>
|
|
985
|
+
* @public
|
|
986
986
|
*/
|
|
987
987
|
export interface PrivateKeyAttributesV2 {
|
|
988
988
|
/**
|
|
989
|
-
* @public
|
|
990
989
|
* <p>Set the minimum key length of the private key.</p>
|
|
990
|
+
* @public
|
|
991
991
|
*/
|
|
992
992
|
MinimalKeyLength: number | undefined;
|
|
993
993
|
/**
|
|
994
|
-
* @public
|
|
995
994
|
* <p>Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE"
|
|
996
995
|
* value.</p>
|
|
996
|
+
* @public
|
|
997
997
|
*/
|
|
998
998
|
KeySpec: KeySpec | undefined;
|
|
999
999
|
/**
|
|
1000
|
-
* @public
|
|
1001
1000
|
* <p>Defines the cryptographic providers used to generate the private key.</p>
|
|
1001
|
+
* @public
|
|
1002
1002
|
*/
|
|
1003
1003
|
CryptoProviders?: string[];
|
|
1004
1004
|
}
|
|
1005
1005
|
/**
|
|
1006
|
-
* @public
|
|
1007
1006
|
* <p>Private key flags for v2 templates specify the client compatibility, if the private key
|
|
1008
1007
|
* can be exported, and if user input is required when using a private key.</p>
|
|
1008
|
+
* @public
|
|
1009
1009
|
*/
|
|
1010
1010
|
export interface PrivateKeyFlagsV2 {
|
|
1011
1011
|
/**
|
|
1012
|
-
* @public
|
|
1013
1012
|
* <p>Allows the private key to be exported.</p>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
ExportableKey?: boolean;
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>Require user input when using the private key for enrollment.</p>
|
|
1018
|
+
* @public
|
|
1019
1019
|
*/
|
|
1020
1020
|
StrongKeyProtectionRequired?: boolean;
|
|
1021
1021
|
/**
|
|
1022
|
-
* @public
|
|
1023
1022
|
* <p>Defines the minimum client compatibility.</p>
|
|
1023
|
+
* @public
|
|
1024
1024
|
*/
|
|
1025
1025
|
ClientVersion: ClientCompatibilityV2 | undefined;
|
|
1026
1026
|
}
|
|
1027
1027
|
/**
|
|
1028
|
-
* @public
|
|
1029
1028
|
* <p>Information to include in the subject name and alternate subject name of the
|
|
1030
1029
|
* certificate. The subject name can be common name, directory path, DNS as common name, or
|
|
1031
1030
|
* left blank. You can optionally include email to the subject name for user templates. If you
|
|
@@ -1033,180 +1032,181 @@ export interface PrivateKeyFlagsV2 {
|
|
|
1033
1032
|
* alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,
|
|
1034
1033
|
* service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.
|
|
1035
1034
|
* If you leave the SAN blank, then you must set a subject name.</p>
|
|
1035
|
+
* @public
|
|
1036
1036
|
*/
|
|
1037
1037
|
export interface SubjectNameFlagsV2 {
|
|
1038
1038
|
/**
|
|
1039
|
-
* @public
|
|
1040
1039
|
* <p>Include the domain DNS in the subject alternate name.</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
SanRequireDomainDns?: boolean;
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>Include the service principal name (SPN) in the subject alternate name.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
SanRequireSpn?: boolean;
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>Include the globally unique identifier (GUID) in the subject alternate name.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
SanRequireDirectoryGuid?: boolean;
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>Include the user principal name (UPN) in the subject alternate name.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
SanRequireUpn?: boolean;
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>Include the subject's email in the subject alternate name.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
SanRequireEmail?: boolean;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>Include the DNS in the subject alternate name.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
SanRequireDns?: boolean;
|
|
1068
1068
|
/**
|
|
1069
|
-
* @public
|
|
1070
1069
|
* <p>Include the DNS as common name in the subject name.</p>
|
|
1070
|
+
* @public
|
|
1071
1071
|
*/
|
|
1072
1072
|
RequireDnsAsCn?: boolean;
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>Include the subject's email in the subject name.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
RequireEmail?: boolean;
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>Include the common name in the subject name.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
RequireCommonName?: boolean;
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>Include the directory path in the subject name.</p>
|
|
1085
|
+
* @public
|
|
1086
1086
|
*/
|
|
1087
1087
|
RequireDirectoryPath?: boolean;
|
|
1088
1088
|
}
|
|
1089
1089
|
/**
|
|
1090
|
-
* @public
|
|
1091
1090
|
* <p>v2 template schema that uses Legacy Cryptographic Providers.</p>
|
|
1091
|
+
* @public
|
|
1092
1092
|
*/
|
|
1093
1093
|
export interface TemplateV2 {
|
|
1094
1094
|
/**
|
|
1095
|
-
* @public
|
|
1096
1095
|
* <p>Certificate validity describes the validity and renewal periods of a certificate.</p>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
CertificateValidity: CertificateValidity | undefined;
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>List of templates in Active Directory that are superseded by this template.</p>
|
|
1101
|
+
* @public
|
|
1102
1102
|
*/
|
|
1103
1103
|
SupersededTemplates?: string[];
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>Private key attributes allow you to specify the minimal key length, key spec, and
|
|
1107
1106
|
* cryptographic providers for the private key of a certificate for v2 templates. V2 templates
|
|
1108
1107
|
* allow you to use Legacy Cryptographic Service Providers.</p>
|
|
1108
|
+
* @public
|
|
1109
1109
|
*/
|
|
1110
1110
|
PrivateKeyAttributes: PrivateKeyAttributesV2 | undefined;
|
|
1111
1111
|
/**
|
|
1112
|
-
* @public
|
|
1113
1112
|
* <p>Private key flags for v2 templates specify the client compatibility, if the private key
|
|
1114
1113
|
* can be exported, and if user input is required when using a private key. </p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
PrivateKeyFlags: PrivateKeyFlagsV2 | undefined;
|
|
1117
1117
|
/**
|
|
1118
|
-
* @public
|
|
1119
1118
|
* <p>Enrollment flags describe the enrollment settings for certificates such as using the
|
|
1120
1119
|
* existing private key and deleting expired or revoked certificates.</p>
|
|
1120
|
+
* @public
|
|
1121
1121
|
*/
|
|
1122
1122
|
EnrollmentFlags: EnrollmentFlagsV2 | undefined;
|
|
1123
1123
|
/**
|
|
1124
|
-
* @public
|
|
1125
1124
|
* <p>Subject name flags describe the subject name and subject alternate name that is included
|
|
1126
1125
|
* in a certificate.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
SubjectNameFlags: SubjectNameFlagsV2 | undefined;
|
|
1129
1129
|
/**
|
|
1130
|
-
* @public
|
|
1131
1130
|
* <p>General flags describe whether the template is used for computers or users and if the
|
|
1132
1131
|
* template can be used with autoenrollment.</p>
|
|
1132
|
+
* @public
|
|
1133
1133
|
*/
|
|
1134
1134
|
GeneralFlags: GeneralFlagsV2 | undefined;
|
|
1135
1135
|
/**
|
|
1136
|
-
* @public
|
|
1137
1136
|
* <p>Extensions describe the key usage extensions and application policies for a
|
|
1138
1137
|
* template.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
Extensions: ExtensionsV2 | undefined;
|
|
1141
1141
|
}
|
|
1142
1142
|
/**
|
|
1143
|
-
* @public
|
|
1144
1143
|
* <p>Template configurations for v3 template schema.</p>
|
|
1144
|
+
* @public
|
|
1145
1145
|
*/
|
|
1146
1146
|
export interface EnrollmentFlagsV3 {
|
|
1147
1147
|
/**
|
|
1148
|
-
* @public
|
|
1149
1148
|
* <p>Include symmetric algorithms allowed by the subject.</p>
|
|
1149
|
+
* @public
|
|
1150
1150
|
*/
|
|
1151
1151
|
IncludeSymmetricAlgorithms?: boolean;
|
|
1152
1152
|
/**
|
|
1153
|
-
* @public
|
|
1154
1153
|
* <p>Require user interaction when the subject is enrolled and the private key associated
|
|
1155
1154
|
* with the certificate is used.</p>
|
|
1155
|
+
* @public
|
|
1156
1156
|
*/
|
|
1157
1157
|
UserInteractionRequired?: boolean;
|
|
1158
1158
|
/**
|
|
1159
|
-
* @public
|
|
1160
1159
|
* <p>Delete expired or revoked certificates instead of archiving them.</p>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
RemoveInvalidCertificateFromPersonalStore?: boolean;
|
|
1163
1163
|
/**
|
|
1164
|
-
* @public
|
|
1165
1164
|
* <p>This flag instructs the CA to not include the security extension
|
|
1166
1165
|
* szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections
|
|
1167
1166
|
* 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows
|
|
1168
1167
|
* Kerberos elevation-of-privilege vulnerability.</p>
|
|
1168
|
+
* @public
|
|
1169
1169
|
*/
|
|
1170
1170
|
NoSecurityExtension?: boolean;
|
|
1171
1171
|
/**
|
|
1172
|
-
* @public
|
|
1173
1172
|
* <p>Allow renewal using the same key.</p>
|
|
1173
|
+
* @public
|
|
1174
1174
|
*/
|
|
1175
1175
|
EnableKeyReuseOnNtTokenKeysetStorageFull?: boolean;
|
|
1176
1176
|
}
|
|
1177
1177
|
/**
|
|
1178
|
-
* @public
|
|
1179
1178
|
* <p>Certificate extensions for v3 template schema</p>
|
|
1179
|
+
* @public
|
|
1180
1180
|
*/
|
|
1181
1181
|
export interface ExtensionsV3 {
|
|
1182
1182
|
/**
|
|
1183
|
-
* @public
|
|
1184
1183
|
* <p>The key usage extension defines the purpose (e.g., encipherment, signature, certificate
|
|
1185
1184
|
* signing) of the key contained in the certificate.</p>
|
|
1185
|
+
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
KeyUsage: KeyUsage | undefined;
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>Application policies specify what the certificate is used for and its purpose.</p>
|
|
1190
|
+
* @public
|
|
1191
1191
|
*/
|
|
1192
1192
|
ApplicationPolicies?: ApplicationPolicies;
|
|
1193
1193
|
}
|
|
1194
1194
|
/**
|
|
1195
|
-
* @public
|
|
1196
1195
|
* <p>General flags for v3 template schema that defines if the template is for a machine or a
|
|
1197
1196
|
* user and if the template can be issued using autoenrollment.</p>
|
|
1197
|
+
* @public
|
|
1198
1198
|
*/
|
|
1199
1199
|
export interface GeneralFlagsV3 {
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>Allows certificate issuance using autoenrollment. Set to TRUE to allow
|
|
1203
1202
|
* autoenrollment.</p>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
AutoEnrollment?: boolean;
|
|
1206
1206
|
/**
|
|
1207
|
-
* @public
|
|
1208
1207
|
* <p>Defines if the template is for machines or users. Set to TRUE if the template is for
|
|
1209
1208
|
* machines. Set to FALSE if the template is for users</p>
|
|
1209
|
+
* @public
|
|
1210
1210
|
*/
|
|
1211
1211
|
MachineType?: boolean;
|
|
1212
1212
|
}
|
|
@@ -1238,23 +1238,23 @@ export declare const PrivateKeyAlgorithm: {
|
|
|
1238
1238
|
*/
|
|
1239
1239
|
export type PrivateKeyAlgorithm = (typeof PrivateKeyAlgorithm)[keyof typeof PrivateKeyAlgorithm];
|
|
1240
1240
|
/**
|
|
1241
|
-
* @public
|
|
1242
1241
|
* <p>Specifies key usage.</p>
|
|
1242
|
+
* @public
|
|
1243
1243
|
*/
|
|
1244
1244
|
export interface KeyUsagePropertyFlags {
|
|
1245
1245
|
/**
|
|
1246
|
-
* @public
|
|
1247
1246
|
* <p>Allows key for encryption and decryption.</p>
|
|
1247
|
+
* @public
|
|
1248
1248
|
*/
|
|
1249
1249
|
Decrypt?: boolean;
|
|
1250
1250
|
/**
|
|
1251
|
-
* @public
|
|
1252
1251
|
* <p>Allows key exchange without encryption.</p>
|
|
1252
|
+
* @public
|
|
1253
1253
|
*/
|
|
1254
1254
|
KeyAgreement?: boolean;
|
|
1255
1255
|
/**
|
|
1256
|
-
* @public
|
|
1257
1256
|
* <p>Allow key use for digital signature.</p>
|
|
1257
|
+
* @public
|
|
1258
1258
|
*/
|
|
1259
1259
|
Sign?: boolean;
|
|
1260
1260
|
}
|
|
@@ -1270,10 +1270,10 @@ export declare const KeyUsagePropertyType: {
|
|
|
1270
1270
|
*/
|
|
1271
1271
|
export type KeyUsagePropertyType = (typeof KeyUsagePropertyType)[keyof typeof KeyUsagePropertyType];
|
|
1272
1272
|
/**
|
|
1273
|
-
* @public
|
|
1274
1273
|
* <p>The key usage property defines the purpose of the private key contained in the
|
|
1275
1274
|
* certificate. You can specify specific purposes using property flags or all by using
|
|
1276
1275
|
* property type ALL.</p>
|
|
1276
|
+
* @public
|
|
1277
1277
|
*/
|
|
1278
1278
|
export type KeyUsageProperty = KeyUsageProperty.PropertyFlagsMember | KeyUsageProperty.PropertyTypeMember | KeyUsageProperty.$UnknownMember;
|
|
1279
1279
|
/**
|
|
@@ -1281,9 +1281,9 @@ export type KeyUsageProperty = KeyUsageProperty.PropertyFlagsMember | KeyUsagePr
|
|
|
1281
1281
|
*/
|
|
1282
1282
|
export declare namespace KeyUsageProperty {
|
|
1283
1283
|
/**
|
|
1284
|
-
* @public
|
|
1285
1284
|
* <p>You can specify all key usages using property type ALL. You can use property type or
|
|
1286
1285
|
* property flags but not both. </p>
|
|
1286
|
+
* @public
|
|
1287
1287
|
*/
|
|
1288
1288
|
interface PropertyTypeMember {
|
|
1289
1289
|
PropertyType: KeyUsagePropertyType;
|
|
@@ -1291,9 +1291,9 @@ export declare namespace KeyUsageProperty {
|
|
|
1291
1291
|
$unknown?: never;
|
|
1292
1292
|
}
|
|
1293
1293
|
/**
|
|
1294
|
-
* @public
|
|
1295
1294
|
* <p>You can specify key usage for encryption, key agreement, and signature. You can use
|
|
1296
1295
|
* property flags or property type but not both. </p>
|
|
1296
|
+
* @public
|
|
1297
1297
|
*/
|
|
1298
1298
|
interface PropertyFlagsMember {
|
|
1299
1299
|
PropertyType?: never;
|
|
@@ -1316,70 +1316,69 @@ export declare namespace KeyUsageProperty {
|
|
|
1316
1316
|
const visit: <T>(value: KeyUsageProperty, visitor: Visitor<T>) => T;
|
|
1317
1317
|
}
|
|
1318
1318
|
/**
|
|
1319
|
-
* @public
|
|
1320
1319
|
* <p>Defines the attributes of the private key.</p>
|
|
1320
|
+
* @public
|
|
1321
1321
|
*/
|
|
1322
1322
|
export interface PrivateKeyAttributesV3 {
|
|
1323
1323
|
/**
|
|
1324
|
-
* @public
|
|
1325
1324
|
* <p>Set the minimum key length of the private key.</p>
|
|
1325
|
+
* @public
|
|
1326
1326
|
*/
|
|
1327
1327
|
MinimalKeyLength: number | undefined;
|
|
1328
1328
|
/**
|
|
1329
|
-
* @public
|
|
1330
1329
|
* <p>Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE"
|
|
1331
1330
|
* value.</p>
|
|
1331
|
+
* @public
|
|
1332
1332
|
*/
|
|
1333
1333
|
KeySpec: KeySpec | undefined;
|
|
1334
1334
|
/**
|
|
1335
|
-
* @public
|
|
1336
1335
|
* <p>Defines the cryptographic providers used to generate the private key.</p>
|
|
1336
|
+
* @public
|
|
1337
1337
|
*/
|
|
1338
1338
|
CryptoProviders?: string[];
|
|
1339
1339
|
/**
|
|
1340
|
-
* @public
|
|
1341
1340
|
* <p>The key usage property defines the purpose of the private key contained in the
|
|
1342
1341
|
* certificate. You can specify specific purposes using property flags or all by using
|
|
1343
1342
|
* property type ALL.</p>
|
|
1343
|
+
* @public
|
|
1344
1344
|
*/
|
|
1345
1345
|
KeyUsageProperty: KeyUsageProperty | undefined;
|
|
1346
1346
|
/**
|
|
1347
|
-
* @public
|
|
1348
1347
|
* <p>Defines the algorithm used to generate the private key.</p>
|
|
1348
|
+
* @public
|
|
1349
1349
|
*/
|
|
1350
1350
|
Algorithm: PrivateKeyAlgorithm | undefined;
|
|
1351
1351
|
}
|
|
1352
1352
|
/**
|
|
1353
|
-
* @public
|
|
1354
1353
|
* <p>Private key flags for v3 templates specify the client compatibility, if the private key
|
|
1355
1354
|
* can be exported, if user input is required when using a private key, and if an alternate
|
|
1356
1355
|
* signature algorithm should be used.</p>
|
|
1356
|
+
* @public
|
|
1357
1357
|
*/
|
|
1358
1358
|
export interface PrivateKeyFlagsV3 {
|
|
1359
1359
|
/**
|
|
1360
|
-
* @public
|
|
1361
1360
|
* <p>Allows the private key to be exported.</p>
|
|
1361
|
+
* @public
|
|
1362
1362
|
*/
|
|
1363
1363
|
ExportableKey?: boolean;
|
|
1364
1364
|
/**
|
|
1365
|
-
* @public
|
|
1366
1365
|
* <p>Requirer user input when using the private key for enrollment.</p>
|
|
1366
|
+
* @public
|
|
1367
1367
|
*/
|
|
1368
1368
|
StrongKeyProtectionRequired?: boolean;
|
|
1369
1369
|
/**
|
|
1370
|
-
* @public
|
|
1371
1370
|
* <p>Reguires the PKCS #1 v2.1 signature format for certificates. You should verify that your
|
|
1372
1371
|
* CA, objects, and applications can accept this signature format.</p>
|
|
1372
|
+
* @public
|
|
1373
1373
|
*/
|
|
1374
1374
|
RequireAlternateSignatureAlgorithm?: boolean;
|
|
1375
1375
|
/**
|
|
1376
|
-
* @public
|
|
1377
1376
|
* <p>Defines the minimum client compatibility.</p>
|
|
1377
|
+
* @public
|
|
1378
1378
|
*/
|
|
1379
1379
|
ClientVersion: ClientCompatibilityV3 | undefined;
|
|
1380
1380
|
}
|
|
1381
1381
|
/**
|
|
1382
|
-
* @public
|
|
1383
1382
|
* <p>Information to include in the subject name and alternate subject name of the
|
|
1384
1383
|
* certificate. The subject name can be common name, directory path, DNS as common name, or
|
|
1385
1384
|
* left blank. You can optionally include email to the subject name for user templates. If you
|
|
@@ -1387,267 +1386,267 @@ export interface PrivateKeyFlagsV3 {
|
|
|
1387
1386
|
* alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,
|
|
1388
1387
|
* service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.
|
|
1389
1388
|
* If you leave the SAN blank, then you must set a subject name.</p>
|
|
1389
|
+
* @public
|
|
1390
1390
|
*/
|
|
1391
1391
|
export interface SubjectNameFlagsV3 {
|
|
1392
1392
|
/**
|
|
1393
|
-
* @public
|
|
1394
1393
|
* <p>Include the domain DNS in the subject alternate name.</p>
|
|
1394
|
+
* @public
|
|
1395
1395
|
*/
|
|
1396
1396
|
SanRequireDomainDns?: boolean;
|
|
1397
1397
|
/**
|
|
1398
|
-
* @public
|
|
1399
1398
|
* <p>Include the service principal name (SPN) in the subject alternate name.</p>
|
|
1399
|
+
* @public
|
|
1400
1400
|
*/
|
|
1401
1401
|
SanRequireSpn?: boolean;
|
|
1402
1402
|
/**
|
|
1403
|
-
* @public
|
|
1404
1403
|
* <p>Include the globally unique identifier (GUID) in the subject alternate name.</p>
|
|
1404
|
+
* @public
|
|
1405
1405
|
*/
|
|
1406
1406
|
SanRequireDirectoryGuid?: boolean;
|
|
1407
1407
|
/**
|
|
1408
|
-
* @public
|
|
1409
1408
|
* <p>Include the user principal name (UPN) in the subject alternate name.</p>
|
|
1409
|
+
* @public
|
|
1410
1410
|
*/
|
|
1411
1411
|
SanRequireUpn?: boolean;
|
|
1412
1412
|
/**
|
|
1413
|
-
* @public
|
|
1414
1413
|
* <p>Include the subject's email in the subject alternate name.</p>
|
|
1414
|
+
* @public
|
|
1415
1415
|
*/
|
|
1416
1416
|
SanRequireEmail?: boolean;
|
|
1417
1417
|
/**
|
|
1418
|
-
* @public
|
|
1419
1418
|
* <p>Include the DNS in the subject alternate name.</p>
|
|
1419
|
+
* @public
|
|
1420
1420
|
*/
|
|
1421
1421
|
SanRequireDns?: boolean;
|
|
1422
1422
|
/**
|
|
1423
|
-
* @public
|
|
1424
1423
|
* <p>Include the DNS as common name in the subject name.</p>
|
|
1424
|
+
* @public
|
|
1425
1425
|
*/
|
|
1426
1426
|
RequireDnsAsCn?: boolean;
|
|
1427
1427
|
/**
|
|
1428
|
-
* @public
|
|
1429
1428
|
* <p>Include the subject's email in the subject name.</p>
|
|
1429
|
+
* @public
|
|
1430
1430
|
*/
|
|
1431
1431
|
RequireEmail?: boolean;
|
|
1432
1432
|
/**
|
|
1433
|
-
* @public
|
|
1434
1433
|
* <p>Include the common name in the subject name. </p>
|
|
1434
|
+
* @public
|
|
1435
1435
|
*/
|
|
1436
1436
|
RequireCommonName?: boolean;
|
|
1437
1437
|
/**
|
|
1438
|
-
* @public
|
|
1439
1438
|
* <p>Include the directory path in the subject name.</p>
|
|
1439
|
+
* @public
|
|
1440
1440
|
*/
|
|
1441
1441
|
RequireDirectoryPath?: boolean;
|
|
1442
1442
|
}
|
|
1443
1443
|
/**
|
|
1444
|
-
* @public
|
|
1445
1444
|
* <p>v3 template schema that uses Key Storage Providers.</p>
|
|
1445
|
+
* @public
|
|
1446
1446
|
*/
|
|
1447
1447
|
export interface TemplateV3 {
|
|
1448
1448
|
/**
|
|
1449
|
-
* @public
|
|
1450
1449
|
* <p>Certificate validity describes the validity and renewal periods of a certificate.</p>
|
|
1450
|
+
* @public
|
|
1451
1451
|
*/
|
|
1452
1452
|
CertificateValidity: CertificateValidity | undefined;
|
|
1453
1453
|
/**
|
|
1454
|
-
* @public
|
|
1455
1454
|
* <p>List of templates in Active Directory that are superseded by this template.</p>
|
|
1455
|
+
* @public
|
|
1456
1456
|
*/
|
|
1457
1457
|
SupersededTemplates?: string[];
|
|
1458
1458
|
/**
|
|
1459
|
-
* @public
|
|
1460
1459
|
* <p>Private key attributes allow you to specify the algorithm, minimal key length, key spec,
|
|
1461
1460
|
* key usage, and cryptographic providers for the private key of a certificate for v3
|
|
1462
1461
|
* templates. V3 templates allow you to use Key Storage Providers.</p>
|
|
1462
|
+
* @public
|
|
1463
1463
|
*/
|
|
1464
1464
|
PrivateKeyAttributes: PrivateKeyAttributesV3 | undefined;
|
|
1465
1465
|
/**
|
|
1466
|
-
* @public
|
|
1467
1466
|
* <p>Private key flags for v3 templates specify the client compatibility, if the private key
|
|
1468
1467
|
* can be exported, if user input is required when using a private key, and if an alternate
|
|
1469
1468
|
* signature algorithm should be used.</p>
|
|
1469
|
+
* @public
|
|
1470
1470
|
*/
|
|
1471
1471
|
PrivateKeyFlags: PrivateKeyFlagsV3 | undefined;
|
|
1472
1472
|
/**
|
|
1473
|
-
* @public
|
|
1474
1473
|
* <p>Enrollment flags describe the enrollment settings for certificates such as using the
|
|
1475
1474
|
* existing private key and deleting expired or revoked certificates.</p>
|
|
1475
|
+
* @public
|
|
1476
1476
|
*/
|
|
1477
1477
|
EnrollmentFlags: EnrollmentFlagsV3 | undefined;
|
|
1478
1478
|
/**
|
|
1479
|
-
* @public
|
|
1480
1479
|
* <p>Subject name flags describe the subject name and subject alternate name that is included
|
|
1481
1480
|
* in a certificate.</p>
|
|
1481
|
+
* @public
|
|
1482
1482
|
*/
|
|
1483
1483
|
SubjectNameFlags: SubjectNameFlagsV3 | undefined;
|
|
1484
1484
|
/**
|
|
1485
|
-
* @public
|
|
1486
1485
|
* <p>General flags describe whether the template is used for computers or users and if the
|
|
1487
1486
|
* template can be used with autoenrollment.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
GeneralFlags: GeneralFlagsV3 | undefined;
|
|
1490
1490
|
/**
|
|
1491
|
-
* @public
|
|
1492
1491
|
* <p>Specifies the hash algorithm used to hash the private key.</p>
|
|
1492
|
+
* @public
|
|
1493
1493
|
*/
|
|
1494
1494
|
HashAlgorithm: HashAlgorithm | undefined;
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <p>Extensions describe the key usage extensions and application policies for a
|
|
1498
1497
|
* template.</p>
|
|
1498
|
+
* @public
|
|
1499
1499
|
*/
|
|
1500
1500
|
Extensions: ExtensionsV3 | undefined;
|
|
1501
1501
|
}
|
|
1502
1502
|
/**
|
|
1503
|
-
* @public
|
|
1504
1503
|
* <p>Template configurations for v4 template schema.</p>
|
|
1504
|
+
* @public
|
|
1505
1505
|
*/
|
|
1506
1506
|
export interface EnrollmentFlagsV4 {
|
|
1507
1507
|
/**
|
|
1508
|
-
* @public
|
|
1509
1508
|
* <p>Include symmetric algorithms allowed by the subject.</p>
|
|
1509
|
+
* @public
|
|
1510
1510
|
*/
|
|
1511
1511
|
IncludeSymmetricAlgorithms?: boolean;
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>Require user interaction when the subject is enrolled and the private key associated
|
|
1515
1514
|
* with the certificate is used.</p>
|
|
1515
|
+
* @public
|
|
1516
1516
|
*/
|
|
1517
1517
|
UserInteractionRequired?: boolean;
|
|
1518
1518
|
/**
|
|
1519
|
-
* @public
|
|
1520
1519
|
* <p>Delete expired or revoked certificates instead of archiving them.</p>
|
|
1520
|
+
* @public
|
|
1521
1521
|
*/
|
|
1522
1522
|
RemoveInvalidCertificateFromPersonalStore?: boolean;
|
|
1523
1523
|
/**
|
|
1524
|
-
* @public
|
|
1525
1524
|
* <p>This flag instructs the CA to not include the security extension
|
|
1526
1525
|
* szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections
|
|
1527
1526
|
* 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows
|
|
1528
1527
|
* Kerberos elevation-of-privilege vulnerability.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
NoSecurityExtension?: boolean;
|
|
1531
1531
|
/**
|
|
1532
|
-
* @public
|
|
1533
1532
|
* <p>Allow renewal using the same key.</p>
|
|
1533
|
+
* @public
|
|
1534
1534
|
*/
|
|
1535
1535
|
EnableKeyReuseOnNtTokenKeysetStorageFull?: boolean;
|
|
1536
1536
|
}
|
|
1537
1537
|
/**
|
|
1538
|
-
* @public
|
|
1539
1538
|
* <p>Certificate extensions for v4 template schema</p>
|
|
1539
|
+
* @public
|
|
1540
1540
|
*/
|
|
1541
1541
|
export interface ExtensionsV4 {
|
|
1542
1542
|
/**
|
|
1543
|
-
* @public
|
|
1544
1543
|
* <p>The key usage extension defines the purpose (e.g., encipherment, signature) of the key
|
|
1545
1544
|
* contained in the certificate.</p>
|
|
1545
|
+
* @public
|
|
1546
1546
|
*/
|
|
1547
1547
|
KeyUsage: KeyUsage | undefined;
|
|
1548
1548
|
/**
|
|
1549
|
-
* @public
|
|
1550
1549
|
* <p>Application policies specify what the certificate is used for and its purpose.</p>
|
|
1550
|
+
* @public
|
|
1551
1551
|
*/
|
|
1552
1552
|
ApplicationPolicies?: ApplicationPolicies;
|
|
1553
1553
|
}
|
|
1554
1554
|
/**
|
|
1555
|
-
* @public
|
|
1556
1555
|
* <p>General flags for v4 template schema that defines if the template is for a machine or a
|
|
1557
1556
|
* user and if the template can be issued using autoenrollment.</p>
|
|
1557
|
+
* @public
|
|
1558
1558
|
*/
|
|
1559
1559
|
export interface GeneralFlagsV4 {
|
|
1560
1560
|
/**
|
|
1561
|
-
* @public
|
|
1562
1561
|
* <p>Allows certificate issuance using autoenrollment. Set to TRUE to allow
|
|
1563
1562
|
* autoenrollment.</p>
|
|
1563
|
+
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
AutoEnrollment?: boolean;
|
|
1566
1566
|
/**
|
|
1567
|
-
* @public
|
|
1568
1567
|
* <p>Defines if the template is for machines or users. Set to TRUE if the template is for
|
|
1569
1568
|
* machines. Set to FALSE if the template is for users</p>
|
|
1569
|
+
* @public
|
|
1570
1570
|
*/
|
|
1571
1571
|
MachineType?: boolean;
|
|
1572
1572
|
}
|
|
1573
1573
|
/**
|
|
1574
|
-
* @public
|
|
1575
1574
|
* <p>Defines the attributes of the private key.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
export interface PrivateKeyAttributesV4 {
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>Set the minimum key length of the private key.</p>
|
|
1580
|
+
* @public
|
|
1581
1581
|
*/
|
|
1582
1582
|
MinimalKeyLength: number | undefined;
|
|
1583
1583
|
/**
|
|
1584
|
-
* @public
|
|
1585
1584
|
* <p>Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE"
|
|
1586
1585
|
* value.</p>
|
|
1586
|
+
* @public
|
|
1587
1587
|
*/
|
|
1588
1588
|
KeySpec: KeySpec | undefined;
|
|
1589
1589
|
/**
|
|
1590
|
-
* @public
|
|
1591
1590
|
* <p>Defines the cryptographic providers used to generate the private key.</p>
|
|
1591
|
+
* @public
|
|
1592
1592
|
*/
|
|
1593
1593
|
CryptoProviders?: string[];
|
|
1594
1594
|
/**
|
|
1595
|
-
* @public
|
|
1596
1595
|
* <p>The key usage property defines the purpose of the private key contained in the
|
|
1597
1596
|
* certificate. You can specify specific purposes using property flags or all by using
|
|
1598
1597
|
* property type ALL.</p>
|
|
1598
|
+
* @public
|
|
1599
1599
|
*/
|
|
1600
1600
|
KeyUsageProperty?: KeyUsageProperty;
|
|
1601
1601
|
/**
|
|
1602
|
-
* @public
|
|
1603
1602
|
* <p>Defines the algorithm used to generate the private key.</p>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
Algorithm?: PrivateKeyAlgorithm;
|
|
1606
1606
|
}
|
|
1607
1607
|
/**
|
|
1608
|
-
* @public
|
|
1609
1608
|
* <p>Private key flags for v4 templates specify the client compatibility, if the private key
|
|
1610
1609
|
* can be exported, if user input is required when using a private key, if an alternate
|
|
1611
1610
|
* signature algorithm should be used, and if certificates are renewed using the same private
|
|
1612
1611
|
* key.</p>
|
|
1612
|
+
* @public
|
|
1613
1613
|
*/
|
|
1614
1614
|
export interface PrivateKeyFlagsV4 {
|
|
1615
1615
|
/**
|
|
1616
|
-
* @public
|
|
1617
1616
|
* <p>Allows the private key to be exported.</p>
|
|
1617
|
+
* @public
|
|
1618
1618
|
*/
|
|
1619
1619
|
ExportableKey?: boolean;
|
|
1620
1620
|
/**
|
|
1621
|
-
* @public
|
|
1622
1621
|
* <p>Require user input when using the private key for enrollment.</p>
|
|
1622
|
+
* @public
|
|
1623
1623
|
*/
|
|
1624
1624
|
StrongKeyProtectionRequired?: boolean;
|
|
1625
1625
|
/**
|
|
1626
|
-
* @public
|
|
1627
1626
|
* <p>Requires the PKCS #1 v2.1 signature format for certificates. You should verify that your
|
|
1628
1627
|
* CA, objects, and applications can accept this signature format.</p>
|
|
1628
|
+
* @public
|
|
1629
1629
|
*/
|
|
1630
1630
|
RequireAlternateSignatureAlgorithm?: boolean;
|
|
1631
1631
|
/**
|
|
1632
|
-
* @public
|
|
1633
1632
|
* <p>Renew certificate using the same private key.</p>
|
|
1633
|
+
* @public
|
|
1634
1634
|
*/
|
|
1635
1635
|
RequireSameKeyRenewal?: boolean;
|
|
1636
1636
|
/**
|
|
1637
|
-
* @public
|
|
1638
1637
|
* <p>Specifies the cryptographic service provider category used to generate private keys. Set
|
|
1639
1638
|
* to TRUE to use Legacy Cryptographic Service Providers and FALSE to use Key Storage
|
|
1640
1639
|
* Providers.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
UseLegacyProvider?: boolean;
|
|
1643
1643
|
/**
|
|
1644
|
-
* @public
|
|
1645
1644
|
* <p>Defines the minimum client compatibility.</p>
|
|
1645
|
+
* @public
|
|
1646
1646
|
*/
|
|
1647
1647
|
ClientVersion: ClientCompatibilityV4 | undefined;
|
|
1648
1648
|
}
|
|
1649
1649
|
/**
|
|
1650
|
-
* @public
|
|
1651
1650
|
* <p>Information to include in the subject name and alternate subject name of the
|
|
1652
1651
|
* certificate. The subject name can be common name, directory path, DNS as common name, or
|
|
1653
1652
|
* left blank. You can optionally include email to the subject name for user templates. If you
|
|
@@ -1655,127 +1654,128 @@ export interface PrivateKeyFlagsV4 {
|
|
|
1655
1654
|
* alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,
|
|
1656
1655
|
* service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.
|
|
1657
1656
|
* If you leave the SAN blank, then you must set a subject name.</p>
|
|
1657
|
+
* @public
|
|
1658
1658
|
*/
|
|
1659
1659
|
export interface SubjectNameFlagsV4 {
|
|
1660
1660
|
/**
|
|
1661
|
-
* @public
|
|
1662
1661
|
* <p>Include the domain DNS in the subject alternate name.</p>
|
|
1662
|
+
* @public
|
|
1663
1663
|
*/
|
|
1664
1664
|
SanRequireDomainDns?: boolean;
|
|
1665
1665
|
/**
|
|
1666
|
-
* @public
|
|
1667
1666
|
* <p>Include the service principal name (SPN) in the subject alternate name.</p>
|
|
1667
|
+
* @public
|
|
1668
1668
|
*/
|
|
1669
1669
|
SanRequireSpn?: boolean;
|
|
1670
1670
|
/**
|
|
1671
|
-
* @public
|
|
1672
1671
|
* <p>Include the globally unique identifier (GUID) in the subject alternate name.</p>
|
|
1672
|
+
* @public
|
|
1673
1673
|
*/
|
|
1674
1674
|
SanRequireDirectoryGuid?: boolean;
|
|
1675
1675
|
/**
|
|
1676
|
-
* @public
|
|
1677
1676
|
* <p>Include the user principal name (UPN) in the subject alternate name.</p>
|
|
1677
|
+
* @public
|
|
1678
1678
|
*/
|
|
1679
1679
|
SanRequireUpn?: boolean;
|
|
1680
1680
|
/**
|
|
1681
|
-
* @public
|
|
1682
1681
|
* <p>Include the subject's email in the subject alternate name.</p>
|
|
1682
|
+
* @public
|
|
1683
1683
|
*/
|
|
1684
1684
|
SanRequireEmail?: boolean;
|
|
1685
1685
|
/**
|
|
1686
|
-
* @public
|
|
1687
1686
|
* <p>Include the DNS in the subject alternate name.</p>
|
|
1687
|
+
* @public
|
|
1688
1688
|
*/
|
|
1689
1689
|
SanRequireDns?: boolean;
|
|
1690
1690
|
/**
|
|
1691
|
-
* @public
|
|
1692
1691
|
* <p>Include the DNS as common name in the subject name.</p>
|
|
1692
|
+
* @public
|
|
1693
1693
|
*/
|
|
1694
1694
|
RequireDnsAsCn?: boolean;
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>Include the subject's email in the subject name.</p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
RequireEmail?: boolean;
|
|
1700
1700
|
/**
|
|
1701
|
-
* @public
|
|
1702
1701
|
* <p>Include the common name in the subject name.</p>
|
|
1702
|
+
* @public
|
|
1703
1703
|
*/
|
|
1704
1704
|
RequireCommonName?: boolean;
|
|
1705
1705
|
/**
|
|
1706
|
-
* @public
|
|
1707
1706
|
* <p>Include the directory path in the subject name.</p>
|
|
1707
|
+
* @public
|
|
1708
1708
|
*/
|
|
1709
1709
|
RequireDirectoryPath?: boolean;
|
|
1710
1710
|
}
|
|
1711
1711
|
/**
|
|
1712
|
-
* @public
|
|
1713
1712
|
* <p>v4 template schema that can use either Legacy Cryptographic Providers or Key Storage
|
|
1714
1713
|
* Providers.</p>
|
|
1714
|
+
* @public
|
|
1715
1715
|
*/
|
|
1716
1716
|
export interface TemplateV4 {
|
|
1717
1717
|
/**
|
|
1718
|
-
* @public
|
|
1719
1718
|
* <p>Certificate validity describes the validity and renewal periods of a certificate.</p>
|
|
1719
|
+
* @public
|
|
1720
1720
|
*/
|
|
1721
1721
|
CertificateValidity: CertificateValidity | undefined;
|
|
1722
1722
|
/**
|
|
1723
|
-
* @public
|
|
1724
1723
|
* <p>List of templates in Active Directory that are superseded by this template.</p>
|
|
1724
|
+
* @public
|
|
1725
1725
|
*/
|
|
1726
1726
|
SupersededTemplates?: string[];
|
|
1727
1727
|
/**
|
|
1728
|
-
* @public
|
|
1729
1728
|
* <p>Private key attributes allow you to specify the minimal key length, key spec, key usage,
|
|
1730
1729
|
* and cryptographic providers for the private key of a certificate for v4 templates. V4
|
|
1731
1730
|
* templates allow you to use either Key Storage Providers or Legacy Cryptographic Service
|
|
1732
1731
|
* Providers. You specify the cryptography provider category in private key flags.</p>
|
|
1732
|
+
* @public
|
|
1733
1733
|
*/
|
|
1734
1734
|
PrivateKeyAttributes: PrivateKeyAttributesV4 | undefined;
|
|
1735
1735
|
/**
|
|
1736
|
-
* @public
|
|
1737
1736
|
* <p>Private key flags for v4 templates specify the client compatibility, if the private key
|
|
1738
1737
|
* can be exported, if user input is required when using a private key, if an alternate
|
|
1739
1738
|
* signature algorithm should be used, and if certificates are renewed using the same private
|
|
1740
1739
|
* key.</p>
|
|
1740
|
+
* @public
|
|
1741
1741
|
*/
|
|
1742
1742
|
PrivateKeyFlags: PrivateKeyFlagsV4 | undefined;
|
|
1743
1743
|
/**
|
|
1744
|
-
* @public
|
|
1745
1744
|
* <p>Enrollment flags describe the enrollment settings for certificates using the existing
|
|
1746
1745
|
* private key and deleting expired or revoked certificates.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
EnrollmentFlags: EnrollmentFlagsV4 | undefined;
|
|
1749
1749
|
/**
|
|
1750
|
-
* @public
|
|
1751
1750
|
* <p>Subject name flags describe the subject name and subject alternate name that is included
|
|
1752
1751
|
* in a certificate.</p>
|
|
1752
|
+
* @public
|
|
1753
1753
|
*/
|
|
1754
1754
|
SubjectNameFlags: SubjectNameFlagsV4 | undefined;
|
|
1755
1755
|
/**
|
|
1756
|
-
* @public
|
|
1757
1756
|
* <p>General flags describe whether the template is used for computers or users and if the
|
|
1758
1757
|
* template can be used with autoenrollment.</p>
|
|
1758
|
+
* @public
|
|
1759
1759
|
*/
|
|
1760
1760
|
GeneralFlags: GeneralFlagsV4 | undefined;
|
|
1761
1761
|
/**
|
|
1762
|
-
* @public
|
|
1763
1762
|
* <p>Specifies the hash algorithm used to hash the private key. Hash algorithm can only be
|
|
1764
1763
|
* specified when using Key Storage Providers.</p>
|
|
1764
|
+
* @public
|
|
1765
1765
|
*/
|
|
1766
1766
|
HashAlgorithm?: HashAlgorithm;
|
|
1767
1767
|
/**
|
|
1768
|
-
* @public
|
|
1769
1768
|
* <p>Extensions describe the key usage extensions and application policies for a
|
|
1770
1769
|
* template.</p>
|
|
1770
|
+
* @public
|
|
1771
1771
|
*/
|
|
1772
1772
|
Extensions: ExtensionsV4 | undefined;
|
|
1773
1773
|
}
|
|
1774
1774
|
/**
|
|
1775
|
-
* @public
|
|
1776
1775
|
* <p>Template configuration to define the information included in certificates. Define
|
|
1777
1776
|
* certificate validity and renewal periods, certificate request handling and enrollment
|
|
1778
1777
|
* options, key usage extensions, application policies, and cryptography settings.</p>
|
|
1778
|
+
* @public
|
|
1779
1779
|
*/
|
|
1780
1780
|
export type TemplateDefinition = TemplateDefinition.TemplateV2Member | TemplateDefinition.TemplateV3Member | TemplateDefinition.TemplateV4Member | TemplateDefinition.$UnknownMember;
|
|
1781
1781
|
/**
|
|
@@ -1783,10 +1783,10 @@ export type TemplateDefinition = TemplateDefinition.TemplateV2Member | TemplateD
|
|
|
1783
1783
|
*/
|
|
1784
1784
|
export declare namespace TemplateDefinition {
|
|
1785
1785
|
/**
|
|
1786
|
-
* @public
|
|
1787
1786
|
* <p>Template configuration to define the information included in certificates. Define
|
|
1788
1787
|
* certificate validity and renewal periods, certificate request handling and enrollment
|
|
1789
1788
|
* options, key usage extensions, application policies, and cryptography settings.</p>
|
|
1789
|
+
* @public
|
|
1790
1790
|
*/
|
|
1791
1791
|
interface TemplateV2Member {
|
|
1792
1792
|
TemplateV2: TemplateV2;
|
|
@@ -1795,10 +1795,10 @@ export declare namespace TemplateDefinition {
|
|
|
1795
1795
|
$unknown?: never;
|
|
1796
1796
|
}
|
|
1797
1797
|
/**
|
|
1798
|
-
* @public
|
|
1799
1798
|
* <p>Template configuration to define the information included in certificates. Define
|
|
1800
1799
|
* certificate validity and renewal periods, certificate request handling and enrollment
|
|
1801
1800
|
* options, key usage extensions, application policies, and cryptography settings.</p>
|
|
1801
|
+
* @public
|
|
1802
1802
|
*/
|
|
1803
1803
|
interface TemplateV3Member {
|
|
1804
1804
|
TemplateV2?: never;
|
|
@@ -1807,10 +1807,10 @@ export declare namespace TemplateDefinition {
|
|
|
1807
1807
|
$unknown?: never;
|
|
1808
1808
|
}
|
|
1809
1809
|
/**
|
|
1810
|
-
* @public
|
|
1811
1810
|
* <p>Template configuration to define the information included in certificates. Define
|
|
1812
1811
|
* certificate validity and renewal periods, certificate request handling and enrollment
|
|
1813
1812
|
* options, key usage extensions, application policies, and cryptography settings.</p>
|
|
1813
|
+
* @public
|
|
1814
1814
|
*/
|
|
1815
1815
|
interface TemplateV4Member {
|
|
1816
1816
|
TemplateV2?: never;
|
|
@@ -1840,30 +1840,30 @@ export declare namespace TemplateDefinition {
|
|
|
1840
1840
|
*/
|
|
1841
1841
|
export interface CreateTemplateRequest {
|
|
1842
1842
|
/**
|
|
1843
|
-
* @public
|
|
1844
1843
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
1844
|
+
* @public
|
|
1845
1845
|
*/
|
|
1846
1846
|
ConnectorArn: string | undefined;
|
|
1847
1847
|
/**
|
|
1848
|
-
* @public
|
|
1849
1848
|
* <p>Name of the template. The template name must be unique.</p>
|
|
1849
|
+
* @public
|
|
1850
1850
|
*/
|
|
1851
1851
|
Name: string | undefined;
|
|
1852
1852
|
/**
|
|
1853
|
-
* @public
|
|
1854
1853
|
* <p>Template configuration to define the information included in certificates. Define
|
|
1855
1854
|
* certificate validity and renewal periods, certificate request handling and enrollment
|
|
1856
1855
|
* options, key usage extensions, application policies, and cryptography settings.</p>
|
|
1856
|
+
* @public
|
|
1857
1857
|
*/
|
|
1858
1858
|
Definition: TemplateDefinition | undefined;
|
|
1859
1859
|
/**
|
|
1860
|
-
* @public
|
|
1861
1860
|
* <p>Idempotency token.</p>
|
|
1861
|
+
* @public
|
|
1862
1862
|
*/
|
|
1863
1863
|
ClientToken?: string;
|
|
1864
1864
|
/**
|
|
1865
|
-
* @public
|
|
1866
1865
|
* <p>Metadata assigned to a template consisting of a key-value pair.</p>
|
|
1866
|
+
* @public
|
|
1867
1867
|
*/
|
|
1868
1868
|
Tags?: Record<string, string>;
|
|
1869
1869
|
}
|
|
@@ -1872,8 +1872,8 @@ export interface CreateTemplateRequest {
|
|
|
1872
1872
|
*/
|
|
1873
1873
|
export interface CreateTemplateResponse {
|
|
1874
1874
|
/**
|
|
1875
|
-
* @public
|
|
1876
1875
|
* <p>If successful, the Amazon Resource Name (ARN) of the template.</p>
|
|
1876
|
+
* @public
|
|
1877
1877
|
*/
|
|
1878
1878
|
TemplateArn?: string;
|
|
1879
1879
|
}
|
|
@@ -1882,30 +1882,30 @@ export interface CreateTemplateResponse {
|
|
|
1882
1882
|
*/
|
|
1883
1883
|
export interface CreateTemplateGroupAccessControlEntryRequest {
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
1886
|
+
* @public
|
|
1887
1887
|
*/
|
|
1888
1888
|
TemplateArn: string | undefined;
|
|
1889
1889
|
/**
|
|
1890
|
-
* @public
|
|
1891
1890
|
* <p>Security identifier (SID) of the group object from Active Directory. The SID starts with
|
|
1892
1891
|
* "S-".</p>
|
|
1892
|
+
* @public
|
|
1893
1893
|
*/
|
|
1894
1894
|
GroupSecurityIdentifier: string | undefined;
|
|
1895
1895
|
/**
|
|
1896
|
-
* @public
|
|
1897
1896
|
* <p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>
|
|
1897
|
+
* @public
|
|
1898
1898
|
*/
|
|
1899
1899
|
GroupDisplayName: string | undefined;
|
|
1900
1900
|
/**
|
|
1901
|
-
* @public
|
|
1902
1901
|
* <p> Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a
|
|
1903
1902
|
* template.</p>
|
|
1903
|
+
* @public
|
|
1904
1904
|
*/
|
|
1905
1905
|
AccessRights: AccessRights | undefined;
|
|
1906
1906
|
/**
|
|
1907
|
-
* @public
|
|
1908
1907
|
* <p>Idempotency token.</p>
|
|
1908
|
+
* @public
|
|
1909
1909
|
*/
|
|
1910
1910
|
ClientToken?: string;
|
|
1911
1911
|
}
|
|
@@ -1914,8 +1914,8 @@ export interface CreateTemplateGroupAccessControlEntryRequest {
|
|
|
1914
1914
|
*/
|
|
1915
1915
|
export interface DeleteDirectoryRegistrationRequest {
|
|
1916
1916
|
/**
|
|
1917
|
-
* @public
|
|
1918
1917
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
1918
|
+
* @public
|
|
1919
1919
|
*/
|
|
1920
1920
|
DirectoryRegistrationArn: string | undefined;
|
|
1921
1921
|
}
|
|
@@ -1924,13 +1924,13 @@ export interface DeleteDirectoryRegistrationRequest {
|
|
|
1924
1924
|
*/
|
|
1925
1925
|
export interface DeleteServicePrincipalNameRequest {
|
|
1926
1926
|
/**
|
|
1927
|
-
* @public
|
|
1928
1927
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
1928
|
+
* @public
|
|
1929
1929
|
*/
|
|
1930
1930
|
DirectoryRegistrationArn: string | undefined;
|
|
1931
1931
|
/**
|
|
1932
|
-
* @public
|
|
1933
1932
|
* <p> The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
1933
|
+
* @public
|
|
1934
1934
|
*/
|
|
1935
1935
|
ConnectorArn: string | undefined;
|
|
1936
1936
|
}
|
|
@@ -1939,8 +1939,8 @@ export interface DeleteServicePrincipalNameRequest {
|
|
|
1939
1939
|
*/
|
|
1940
1940
|
export interface DeleteTemplateRequest {
|
|
1941
1941
|
/**
|
|
1942
|
-
* @public
|
|
1943
1942
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
1943
|
+
* @public
|
|
1944
1944
|
*/
|
|
1945
1945
|
TemplateArn: string | undefined;
|
|
1946
1946
|
}
|
|
@@ -1949,14 +1949,14 @@ export interface DeleteTemplateRequest {
|
|
|
1949
1949
|
*/
|
|
1950
1950
|
export interface DeleteTemplateGroupAccessControlEntryRequest {
|
|
1951
1951
|
/**
|
|
1952
|
-
* @public
|
|
1953
1952
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
1953
|
+
* @public
|
|
1954
1954
|
*/
|
|
1955
1955
|
TemplateArn: string | undefined;
|
|
1956
1956
|
/**
|
|
1957
|
-
* @public
|
|
1958
1957
|
* <p>Security identifier (SID) of the group object from Active Directory. The SID starts with
|
|
1959
1958
|
* "S-".</p>
|
|
1959
|
+
* @public
|
|
1960
1960
|
*/
|
|
1961
1961
|
GroupSecurityIdentifier: string | undefined;
|
|
1962
1962
|
}
|
|
@@ -1991,79 +1991,79 @@ export declare const DirectoryRegistrationStatusReason: {
|
|
|
1991
1991
|
*/
|
|
1992
1992
|
export type DirectoryRegistrationStatusReason = (typeof DirectoryRegistrationStatusReason)[keyof typeof DirectoryRegistrationStatusReason];
|
|
1993
1993
|
/**
|
|
1994
|
-
* @public
|
|
1995
1994
|
* <p>The directory registration represents the authorization of the connector service with a
|
|
1996
1995
|
* directory.</p>
|
|
1996
|
+
* @public
|
|
1997
1997
|
*/
|
|
1998
1998
|
export interface DirectoryRegistration {
|
|
1999
1999
|
/**
|
|
2000
|
-
* @public
|
|
2001
2000
|
* <p>The Amazon Resource Name (ARN) that was returned when you called
|
|
2002
2001
|
* CreateDirectoryRegistration. </p>
|
|
2002
|
+
* @public
|
|
2003
2003
|
*/
|
|
2004
2004
|
Arn?: string;
|
|
2005
2005
|
/**
|
|
2006
|
-
* @public
|
|
2007
2006
|
* <p>The identifier of the Active Directory.</p>
|
|
2007
|
+
* @public
|
|
2008
2008
|
*/
|
|
2009
2009
|
DirectoryId?: string;
|
|
2010
2010
|
/**
|
|
2011
|
-
* @public
|
|
2012
2011
|
* <p>Status of the directory registration.</p>
|
|
2012
|
+
* @public
|
|
2013
2013
|
*/
|
|
2014
2014
|
Status?: DirectoryRegistrationStatus;
|
|
2015
2015
|
/**
|
|
2016
|
-
* @public
|
|
2017
2016
|
* <p>Additional information about the directory registration status if the status is
|
|
2018
2017
|
* failed.</p>
|
|
2018
|
+
* @public
|
|
2019
2019
|
*/
|
|
2020
2020
|
StatusReason?: DirectoryRegistrationStatusReason;
|
|
2021
2021
|
/**
|
|
2022
|
-
* @public
|
|
2023
2022
|
* <p>The date and time that the directory registration was created.</p>
|
|
2023
|
+
* @public
|
|
2024
2024
|
*/
|
|
2025
2025
|
CreatedAt?: Date;
|
|
2026
2026
|
/**
|
|
2027
|
-
* @public
|
|
2028
2027
|
* <p>The date and time that the directory registration was updated.</p>
|
|
2028
|
+
* @public
|
|
2029
2029
|
*/
|
|
2030
2030
|
UpdatedAt?: Date;
|
|
2031
2031
|
}
|
|
2032
2032
|
/**
|
|
2033
|
-
* @public
|
|
2034
2033
|
* <p>The directory registration represents the authorization of the connector service with
|
|
2035
2034
|
* the Active Directory.</p>
|
|
2035
|
+
* @public
|
|
2036
2036
|
*/
|
|
2037
2037
|
export interface DirectoryRegistrationSummary {
|
|
2038
2038
|
/**
|
|
2039
|
-
* @public
|
|
2040
2039
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
2040
|
+
* @public
|
|
2041
2041
|
*/
|
|
2042
2042
|
Arn?: string;
|
|
2043
2043
|
/**
|
|
2044
|
-
* @public
|
|
2045
2044
|
* <p>The identifier of the Active Directory.</p>
|
|
2045
|
+
* @public
|
|
2046
2046
|
*/
|
|
2047
2047
|
DirectoryId?: string;
|
|
2048
2048
|
/**
|
|
2049
|
-
* @public
|
|
2050
2049
|
* <p>Status of the directory registration.</p>
|
|
2050
|
+
* @public
|
|
2051
2051
|
*/
|
|
2052
2052
|
Status?: DirectoryRegistrationStatus;
|
|
2053
2053
|
/**
|
|
2054
|
-
* @public
|
|
2055
2054
|
* <p>Additional information about the directory registration status if the status is
|
|
2056
2055
|
* failed.</p>
|
|
2056
|
+
* @public
|
|
2057
2057
|
*/
|
|
2058
2058
|
StatusReason?: DirectoryRegistrationStatusReason;
|
|
2059
2059
|
/**
|
|
2060
|
-
* @public
|
|
2061
2060
|
* <p>The date and time that the directory registration was created.</p>
|
|
2061
|
+
* @public
|
|
2062
2062
|
*/
|
|
2063
2063
|
CreatedAt?: Date;
|
|
2064
2064
|
/**
|
|
2065
|
-
* @public
|
|
2066
2065
|
* <p>The date and time that the directory registration was updated.</p>
|
|
2066
|
+
* @public
|
|
2067
2067
|
*/
|
|
2068
2068
|
UpdatedAt?: Date;
|
|
2069
2069
|
}
|
|
@@ -2072,8 +2072,8 @@ export interface DirectoryRegistrationSummary {
|
|
|
2072
2072
|
*/
|
|
2073
2073
|
export interface GetDirectoryRegistrationRequest {
|
|
2074
2074
|
/**
|
|
2075
|
-
* @public
|
|
2076
2075
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
2076
|
+
* @public
|
|
2077
2077
|
*/
|
|
2078
2078
|
DirectoryRegistrationArn: string | undefined;
|
|
2079
2079
|
}
|
|
@@ -2082,9 +2082,9 @@ export interface GetDirectoryRegistrationRequest {
|
|
|
2082
2082
|
*/
|
|
2083
2083
|
export interface GetDirectoryRegistrationResponse {
|
|
2084
2084
|
/**
|
|
2085
|
-
* @public
|
|
2086
2085
|
* <p>The directory registration represents the authorization of the connector service with a
|
|
2087
2086
|
* directory.</p>
|
|
2087
|
+
* @public
|
|
2088
2088
|
*/
|
|
2089
2089
|
DirectoryRegistration?: DirectoryRegistration;
|
|
2090
2090
|
}
|
|
@@ -2093,19 +2093,19 @@ export interface GetDirectoryRegistrationResponse {
|
|
|
2093
2093
|
*/
|
|
2094
2094
|
export interface ListDirectoryRegistrationsRequest {
|
|
2095
2095
|
/**
|
|
2096
|
-
* @public
|
|
2097
2096
|
* <p>Use this parameter when paginating results to specify the maximum number of items to
|
|
2098
2097
|
* return in the response on each page. If additional items exist beyond the number you
|
|
2099
2098
|
* specify, the <code>NextToken</code> element is sent in the response. Use this
|
|
2100
2099
|
* <code>NextToken</code> value in a subsequent request to retrieve additional
|
|
2101
2100
|
* items.</p>
|
|
2101
|
+
* @public
|
|
2102
2102
|
*/
|
|
2103
2103
|
MaxResults?: number;
|
|
2104
2104
|
/**
|
|
2105
|
-
* @public
|
|
2106
2105
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2107
2106
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2108
2107
|
* parameter from the response you just received.</p>
|
|
2108
|
+
* @public
|
|
2109
2109
|
*/
|
|
2110
2110
|
NextToken?: string;
|
|
2111
2111
|
}
|
|
@@ -2114,15 +2114,15 @@ export interface ListDirectoryRegistrationsRequest {
|
|
|
2114
2114
|
*/
|
|
2115
2115
|
export interface ListDirectoryRegistrationsResponse {
|
|
2116
2116
|
/**
|
|
2117
|
-
* @public
|
|
2118
2117
|
* <p>Summary information about each directory registration you have created.</p>
|
|
2118
|
+
* @public
|
|
2119
2119
|
*/
|
|
2120
2120
|
DirectoryRegistrations?: DirectoryRegistrationSummary[];
|
|
2121
2121
|
/**
|
|
2122
|
-
* @public
|
|
2123
2122
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2124
2123
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2125
2124
|
* parameter from the response you just received.</p>
|
|
2125
|
+
* @public
|
|
2126
2126
|
*/
|
|
2127
2127
|
NextToken?: string;
|
|
2128
2128
|
}
|
|
@@ -2131,13 +2131,13 @@ export interface ListDirectoryRegistrationsResponse {
|
|
|
2131
2131
|
*/
|
|
2132
2132
|
export interface GetServicePrincipalNameRequest {
|
|
2133
2133
|
/**
|
|
2134
|
-
* @public
|
|
2135
2134
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
DirectoryRegistrationArn: string | undefined;
|
|
2138
2138
|
/**
|
|
2139
|
-
* @public
|
|
2140
2139
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
2140
|
+
* @public
|
|
2141
2141
|
*/
|
|
2142
2142
|
ConnectorArn: string | undefined;
|
|
2143
2143
|
}
|
|
@@ -2171,39 +2171,39 @@ export declare const ServicePrincipalNameStatusReason: {
|
|
|
2171
2171
|
*/
|
|
2172
2172
|
export type ServicePrincipalNameStatusReason = (typeof ServicePrincipalNameStatusReason)[keyof typeof ServicePrincipalNameStatusReason];
|
|
2173
2173
|
/**
|
|
2174
|
-
* @public
|
|
2175
2174
|
* <p>The service principal name that the connector uses to authenticate with Active Directory.</p>
|
|
2175
|
+
* @public
|
|
2176
2176
|
*/
|
|
2177
2177
|
export interface ServicePrincipalName {
|
|
2178
2178
|
/**
|
|
2179
|
-
* @public
|
|
2180
2179
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
2180
|
+
* @public
|
|
2181
2181
|
*/
|
|
2182
2182
|
DirectoryRegistrationArn?: string;
|
|
2183
2183
|
/**
|
|
2184
|
-
* @public
|
|
2185
2184
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector.html</a>.</p>
|
|
2185
|
+
* @public
|
|
2186
2186
|
*/
|
|
2187
2187
|
ConnectorArn?: string;
|
|
2188
2188
|
/**
|
|
2189
|
-
* @public
|
|
2190
2189
|
* <p>The status of a service principal name.</p>
|
|
2190
|
+
* @public
|
|
2191
2191
|
*/
|
|
2192
2192
|
Status?: ServicePrincipalNameStatus;
|
|
2193
2193
|
/**
|
|
2194
|
-
* @public
|
|
2195
2194
|
* <p>Additional information for the status of a service principal name if the status is
|
|
2196
2195
|
* failed.</p>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
StatusReason?: ServicePrincipalNameStatusReason;
|
|
2199
2199
|
/**
|
|
2200
|
-
* @public
|
|
2201
2200
|
* <p>The date and time that the service principal name was created.</p>
|
|
2201
|
+
* @public
|
|
2202
2202
|
*/
|
|
2203
2203
|
CreatedAt?: Date;
|
|
2204
2204
|
/**
|
|
2205
|
-
* @public
|
|
2206
2205
|
* <p>The date and time that the service principal name was updated.</p>
|
|
2206
|
+
* @public
|
|
2207
2207
|
*/
|
|
2208
2208
|
UpdatedAt?: Date;
|
|
2209
2209
|
}
|
|
@@ -2212,8 +2212,8 @@ export interface ServicePrincipalName {
|
|
|
2212
2212
|
*/
|
|
2213
2213
|
export interface GetServicePrincipalNameResponse {
|
|
2214
2214
|
/**
|
|
2215
|
-
* @public
|
|
2216
2215
|
* <p>The service principal name that the connector uses to authenticate with Active Directory.</p>
|
|
2216
|
+
* @public
|
|
2217
2217
|
*/
|
|
2218
2218
|
ServicePrincipalName?: ServicePrincipalName;
|
|
2219
2219
|
}
|
|
@@ -2222,27 +2222,27 @@ export interface GetServicePrincipalNameResponse {
|
|
|
2222
2222
|
*/
|
|
2223
2223
|
export interface GetTemplateRequest {
|
|
2224
2224
|
/**
|
|
2225
|
-
* @public
|
|
2226
2225
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
2226
|
+
* @public
|
|
2227
2227
|
*/
|
|
2228
2228
|
TemplateArn: string | undefined;
|
|
2229
2229
|
}
|
|
2230
2230
|
/**
|
|
2231
|
-
* @public
|
|
2232
2231
|
* <p>The revision version of the template. Template updates will increment the minor
|
|
2233
2232
|
* revision. Re-enrolling all certificate holders will increment the major revision.</p>
|
|
2233
|
+
* @public
|
|
2234
2234
|
*/
|
|
2235
2235
|
export interface TemplateRevision {
|
|
2236
2236
|
/**
|
|
2237
|
-
* @public
|
|
2238
2237
|
* <p>The revision version of the template. Re-enrolling all certificate holders will
|
|
2239
2238
|
* increment the major revision.</p>
|
|
2239
|
+
* @public
|
|
2240
2240
|
*/
|
|
2241
2241
|
MajorRevision: number | undefined;
|
|
2242
2242
|
/**
|
|
2243
|
-
* @public
|
|
2244
2243
|
* <p>The revision version of the template. Re-enrolling all certificate holders will
|
|
2245
2244
|
* increment the major revision.</p>
|
|
2245
|
+
* @public
|
|
2246
2246
|
*/
|
|
2247
2247
|
MinorRevision: number | undefined;
|
|
2248
2248
|
}
|
|
@@ -2259,63 +2259,63 @@ export declare const TemplateStatus: {
|
|
|
2259
2259
|
*/
|
|
2260
2260
|
export type TemplateStatus = (typeof TemplateStatus)[keyof typeof TemplateStatus];
|
|
2261
2261
|
/**
|
|
2262
|
-
* @public
|
|
2263
2262
|
* <p>An Active Directory compatible certificate template. Connectors issue certificates against these
|
|
2264
2263
|
* templates based on the requestor's Active Directory group membership. </p>
|
|
2264
|
+
* @public
|
|
2265
2265
|
*/
|
|
2266
2266
|
export interface Template {
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
2269
|
+
* @public
|
|
2270
2270
|
*/
|
|
2271
2271
|
Arn?: string;
|
|
2272
2272
|
/**
|
|
2273
|
-
* @public
|
|
2274
2273
|
* <p> The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
2274
|
+
* @public
|
|
2275
2275
|
*/
|
|
2276
2276
|
ConnectorArn?: string;
|
|
2277
2277
|
/**
|
|
2278
|
-
* @public
|
|
2279
2278
|
* <p>Template configuration to define the information included in certificates. Define
|
|
2280
2279
|
* certificate validity and renewal periods, certificate request handling and enrollment
|
|
2281
2280
|
* options, key usage extensions, application policies, and cryptography settings.</p>
|
|
2281
|
+
* @public
|
|
2282
2282
|
*/
|
|
2283
2283
|
Definition?: TemplateDefinition;
|
|
2284
2284
|
/**
|
|
2285
|
-
* @public
|
|
2286
2285
|
* <p>Name of the templates. Template names must be unique.</p>
|
|
2286
|
+
* @public
|
|
2287
2287
|
*/
|
|
2288
2288
|
Name?: string;
|
|
2289
2289
|
/**
|
|
2290
|
-
* @public
|
|
2291
2290
|
* <p>Object identifier of a template.</p>
|
|
2291
|
+
* @public
|
|
2292
2292
|
*/
|
|
2293
2293
|
ObjectIdentifier?: string;
|
|
2294
2294
|
/**
|
|
2295
|
-
* @public
|
|
2296
2295
|
* <p>The template schema version. Template schema versions can be v2, v3, or v4. The template
|
|
2297
2296
|
* configuration options change based on the template schema version.</p>
|
|
2297
|
+
* @public
|
|
2298
2298
|
*/
|
|
2299
2299
|
PolicySchema?: number;
|
|
2300
2300
|
/**
|
|
2301
|
-
* @public
|
|
2302
2301
|
* <p>Status of the template. Status can be creating, active, deleting, or failed.</p>
|
|
2302
|
+
* @public
|
|
2303
2303
|
*/
|
|
2304
2304
|
Status?: TemplateStatus;
|
|
2305
2305
|
/**
|
|
2306
|
-
* @public
|
|
2307
2306
|
* <p>The version of the template. Template updates will increment the minor revision.
|
|
2308
2307
|
* Re-enrolling all certificate holders will increment the major revision.</p>
|
|
2308
|
+
* @public
|
|
2309
2309
|
*/
|
|
2310
2310
|
Revision?: TemplateRevision;
|
|
2311
2311
|
/**
|
|
2312
|
-
* @public
|
|
2313
2312
|
* <p>The date and time that the template was created.</p>
|
|
2313
|
+
* @public
|
|
2314
2314
|
*/
|
|
2315
2315
|
CreatedAt?: Date;
|
|
2316
2316
|
/**
|
|
2317
|
-
* @public
|
|
2318
2317
|
* <p>The date and time that the template was updated.</p>
|
|
2318
|
+
* @public
|
|
2319
2319
|
*/
|
|
2320
2320
|
UpdatedAt?: Date;
|
|
2321
2321
|
}
|
|
@@ -2324,9 +2324,9 @@ export interface Template {
|
|
|
2324
2324
|
*/
|
|
2325
2325
|
export interface GetTemplateResponse {
|
|
2326
2326
|
/**
|
|
2327
|
-
* @public
|
|
2328
2327
|
* <p>A certificate template that the connector uses to issue certificates from a private
|
|
2329
2328
|
* CA.</p>
|
|
2329
|
+
* @public
|
|
2330
2330
|
*/
|
|
2331
2331
|
Template?: Template;
|
|
2332
2332
|
}
|
|
@@ -2335,14 +2335,14 @@ export interface GetTemplateResponse {
|
|
|
2335
2335
|
*/
|
|
2336
2336
|
export interface GetTemplateGroupAccessControlEntryRequest {
|
|
2337
2337
|
/**
|
|
2338
|
-
* @public
|
|
2339
2338
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
2339
|
+
* @public
|
|
2340
2340
|
*/
|
|
2341
2341
|
TemplateArn: string | undefined;
|
|
2342
2342
|
/**
|
|
2343
|
-
* @public
|
|
2344
2343
|
* <p>Security identifier (SID) of the group object from Active Directory. The SID starts with
|
|
2345
2344
|
* "S-".</p>
|
|
2345
|
+
* @public
|
|
2346
2346
|
*/
|
|
2347
2347
|
GroupSecurityIdentifier: string | undefined;
|
|
2348
2348
|
}
|
|
@@ -2351,9 +2351,9 @@ export interface GetTemplateGroupAccessControlEntryRequest {
|
|
|
2351
2351
|
*/
|
|
2352
2352
|
export interface GetTemplateGroupAccessControlEntryResponse {
|
|
2353
2353
|
/**
|
|
2354
|
-
* @public
|
|
2355
2354
|
* <p>An access control entry allows or denies an Active Directory group from enrolling and/or
|
|
2356
2355
|
* autoenrolling with a template.</p>
|
|
2356
|
+
* @public
|
|
2357
2357
|
*/
|
|
2358
2358
|
AccessControlEntry?: AccessControlEntry;
|
|
2359
2359
|
}
|
|
@@ -2362,61 +2362,61 @@ export interface GetTemplateGroupAccessControlEntryResponse {
|
|
|
2362
2362
|
*/
|
|
2363
2363
|
export interface ListServicePrincipalNamesRequest {
|
|
2364
2364
|
/**
|
|
2365
|
-
* @public
|
|
2366
2365
|
* <p>Use this parameter when paginating results to specify the maximum number of items to
|
|
2367
2366
|
* return in the response on each page. If additional items exist beyond the number you
|
|
2368
2367
|
* specify, the <code>NextToken</code> element is sent in the response. Use this
|
|
2369
2368
|
* <code>NextToken</code> value in a subsequent request to retrieve additional
|
|
2370
2369
|
* items.</p>
|
|
2370
|
+
* @public
|
|
2371
2371
|
*/
|
|
2372
2372
|
MaxResults?: number;
|
|
2373
2373
|
/**
|
|
2374
|
-
* @public
|
|
2375
2374
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2376
2375
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2377
2376
|
* parameter from the response you just received.</p>
|
|
2377
|
+
* @public
|
|
2378
2378
|
*/
|
|
2379
2379
|
NextToken?: string;
|
|
2380
2380
|
/**
|
|
2381
|
-
* @public
|
|
2382
2381
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
2382
|
+
* @public
|
|
2383
2383
|
*/
|
|
2384
2384
|
DirectoryRegistrationArn: string | undefined;
|
|
2385
2385
|
}
|
|
2386
2386
|
/**
|
|
2387
|
-
* @public
|
|
2388
2387
|
* <p>The service principal name that the connector uses to authenticate with Active Directory.</p>
|
|
2388
|
+
* @public
|
|
2389
2389
|
*/
|
|
2390
2390
|
export interface ServicePrincipalNameSummary {
|
|
2391
2391
|
/**
|
|
2392
|
-
* @public
|
|
2393
2392
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html">CreateDirectoryRegistration</a>.</p>
|
|
2393
|
+
* @public
|
|
2394
2394
|
*/
|
|
2395
2395
|
DirectoryRegistrationArn?: string;
|
|
2396
2396
|
/**
|
|
2397
|
-
* @public
|
|
2398
2397
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
2398
|
+
* @public
|
|
2399
2399
|
*/
|
|
2400
2400
|
ConnectorArn?: string;
|
|
2401
2401
|
/**
|
|
2402
|
-
* @public
|
|
2403
2402
|
* <p>The status of a service principal name.</p>
|
|
2403
|
+
* @public
|
|
2404
2404
|
*/
|
|
2405
2405
|
Status?: ServicePrincipalNameStatus;
|
|
2406
2406
|
/**
|
|
2407
|
-
* @public
|
|
2408
2407
|
* <p>Additional information for the status of a service principal name if the status is
|
|
2409
2408
|
* failed.</p>
|
|
2409
|
+
* @public
|
|
2410
2410
|
*/
|
|
2411
2411
|
StatusReason?: ServicePrincipalNameStatusReason;
|
|
2412
2412
|
/**
|
|
2413
|
-
* @public
|
|
2414
2413
|
* <p>The date and time that the service principal name was created.</p>
|
|
2414
|
+
* @public
|
|
2415
2415
|
*/
|
|
2416
2416
|
CreatedAt?: Date;
|
|
2417
2417
|
/**
|
|
2418
|
-
* @public
|
|
2419
2418
|
* <p>Time when the service principal name was updated.</p>
|
|
2419
|
+
* @public
|
|
2420
2420
|
*/
|
|
2421
2421
|
UpdatedAt?: Date;
|
|
2422
2422
|
}
|
|
@@ -2425,16 +2425,16 @@ export interface ServicePrincipalNameSummary {
|
|
|
2425
2425
|
*/
|
|
2426
2426
|
export interface ListServicePrincipalNamesResponse {
|
|
2427
2427
|
/**
|
|
2428
|
-
* @public
|
|
2429
2428
|
* <p>The service principal name, if any, that the connector uses to authenticate with
|
|
2430
2429
|
* Active Directory.</p>
|
|
2430
|
+
* @public
|
|
2431
2431
|
*/
|
|
2432
2432
|
ServicePrincipalNames?: ServicePrincipalNameSummary[];
|
|
2433
2433
|
/**
|
|
2434
|
-
* @public
|
|
2435
2434
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2436
2435
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2437
2436
|
* parameter from the response you just received.</p>
|
|
2437
|
+
* @public
|
|
2438
2438
|
*/
|
|
2439
2439
|
NextToken?: string;
|
|
2440
2440
|
}
|
|
@@ -2443,8 +2443,8 @@ export interface ListServicePrincipalNamesResponse {
|
|
|
2443
2443
|
*/
|
|
2444
2444
|
export interface ListTagsForResourceRequest {
|
|
2445
2445
|
/**
|
|
2446
|
-
* @public
|
|
2447
2446
|
* <p>The Amazon Resource Name (ARN) that was returned when you created the resource. </p>
|
|
2447
|
+
* @public
|
|
2448
2448
|
*/
|
|
2449
2449
|
ResourceArn: string | undefined;
|
|
2450
2450
|
}
|
|
@@ -2453,8 +2453,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2453
2453
|
*/
|
|
2454
2454
|
export interface ListTagsForResourceResponse {
|
|
2455
2455
|
/**
|
|
2456
|
-
* @public
|
|
2457
2456
|
* <p>The tags, if any, that are associated with your resource.</p>
|
|
2457
|
+
* @public
|
|
2458
2458
|
*/
|
|
2459
2459
|
Tags?: Record<string, string>;
|
|
2460
2460
|
}
|
|
@@ -2463,24 +2463,24 @@ export interface ListTagsForResourceResponse {
|
|
|
2463
2463
|
*/
|
|
2464
2464
|
export interface ListTemplateGroupAccessControlEntriesRequest {
|
|
2465
2465
|
/**
|
|
2466
|
-
* @public
|
|
2467
2466
|
* <p>Use this parameter when paginating results to specify the maximum number of items to
|
|
2468
2467
|
* return in the response on each page. If additional items exist beyond the number you
|
|
2469
2468
|
* specify, the <code>NextToken</code> element is sent in the response. Use this
|
|
2470
2469
|
* <code>NextToken</code> value in a subsequent request to retrieve additional
|
|
2471
2470
|
* items.</p>
|
|
2471
|
+
* @public
|
|
2472
2472
|
*/
|
|
2473
2473
|
MaxResults?: number;
|
|
2474
2474
|
/**
|
|
2475
|
-
* @public
|
|
2476
2475
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2477
2476
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2478
2477
|
* parameter from the response you just received.</p>
|
|
2478
|
+
* @public
|
|
2479
2479
|
*/
|
|
2480
2480
|
NextToken?: string;
|
|
2481
2481
|
/**
|
|
2482
|
-
* @public
|
|
2483
2482
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
2483
|
+
* @public
|
|
2484
2484
|
*/
|
|
2485
2485
|
TemplateArn: string | undefined;
|
|
2486
2486
|
}
|
|
@@ -2489,16 +2489,16 @@ export interface ListTemplateGroupAccessControlEntriesRequest {
|
|
|
2489
2489
|
*/
|
|
2490
2490
|
export interface ListTemplateGroupAccessControlEntriesResponse {
|
|
2491
2491
|
/**
|
|
2492
|
-
* @public
|
|
2493
2492
|
* <p>An access control entry grants or denies permission to an Active Directory group to enroll
|
|
2494
2493
|
* certificates for a template.</p>
|
|
2494
|
+
* @public
|
|
2495
2495
|
*/
|
|
2496
2496
|
AccessControlEntries?: AccessControlEntrySummary[];
|
|
2497
2497
|
/**
|
|
2498
|
-
* @public
|
|
2499
2498
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2500
2499
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2501
2500
|
* parameter from the response you just received.</p>
|
|
2501
|
+
* @public
|
|
2502
2502
|
*/
|
|
2503
2503
|
NextToken?: string;
|
|
2504
2504
|
}
|
|
@@ -2507,85 +2507,85 @@ export interface ListTemplateGroupAccessControlEntriesResponse {
|
|
|
2507
2507
|
*/
|
|
2508
2508
|
export interface ListTemplatesRequest {
|
|
2509
2509
|
/**
|
|
2510
|
-
* @public
|
|
2511
2510
|
* <p>Use this parameter when paginating results to specify the maximum number of items to
|
|
2512
2511
|
* return in the response on each page. If additional items exist beyond the number you
|
|
2513
2512
|
* specify, the <code>NextToken</code> element is sent in the response. Use this
|
|
2514
2513
|
* <code>NextToken</code> value in a subsequent request to retrieve additional
|
|
2515
2514
|
* items.</p>
|
|
2515
|
+
* @public
|
|
2516
2516
|
*/
|
|
2517
2517
|
MaxResults?: number;
|
|
2518
2518
|
/**
|
|
2519
|
-
* @public
|
|
2520
2519
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2521
2520
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2522
2521
|
* parameter from the response you just received.</p>
|
|
2522
|
+
* @public
|
|
2523
2523
|
*/
|
|
2524
2524
|
NextToken?: string;
|
|
2525
2525
|
/**
|
|
2526
|
-
* @public
|
|
2527
2526
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
2527
|
+
* @public
|
|
2528
2528
|
*/
|
|
2529
2529
|
ConnectorArn: string | undefined;
|
|
2530
2530
|
}
|
|
2531
2531
|
/**
|
|
2532
|
-
* @public
|
|
2533
2532
|
* <p>An Active Directory compatible certificate template. Connectors issue certificates against these
|
|
2534
2533
|
* templates based on the requestor's Active Directory group membership.</p>
|
|
2534
|
+
* @public
|
|
2535
2535
|
*/
|
|
2536
2536
|
export interface TemplateSummary {
|
|
2537
2537
|
/**
|
|
2538
|
-
* @public
|
|
2539
2538
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
2539
|
+
* @public
|
|
2540
2540
|
*/
|
|
2541
2541
|
Arn?: string;
|
|
2542
2542
|
/**
|
|
2543
|
-
* @public
|
|
2544
2543
|
* <p> The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>
|
|
2544
|
+
* @public
|
|
2545
2545
|
*/
|
|
2546
2546
|
ConnectorArn?: string;
|
|
2547
2547
|
/**
|
|
2548
|
-
* @public
|
|
2549
2548
|
* <p>Template configuration to define the information included in certificates. Define
|
|
2550
2549
|
* certificate validity and renewal periods, certificate request handling and enrollment
|
|
2551
2550
|
* options, key usage extensions, application policies, and cryptography settings.</p>
|
|
2551
|
+
* @public
|
|
2552
2552
|
*/
|
|
2553
2553
|
Definition?: TemplateDefinition;
|
|
2554
2554
|
/**
|
|
2555
|
-
* @public
|
|
2556
2555
|
* <p>Name of the template. The template name must be unique.</p>
|
|
2556
|
+
* @public
|
|
2557
2557
|
*/
|
|
2558
2558
|
Name?: string;
|
|
2559
2559
|
/**
|
|
2560
|
-
* @public
|
|
2561
2560
|
* <p>Object identifier of a template.</p>
|
|
2561
|
+
* @public
|
|
2562
2562
|
*/
|
|
2563
2563
|
ObjectIdentifier?: string;
|
|
2564
2564
|
/**
|
|
2565
|
-
* @public
|
|
2566
2565
|
* <p>The template schema version. Template schema versions can be v2, v3, or v4. The template
|
|
2567
2566
|
* configuration options change based on the template schema version.</p>
|
|
2567
|
+
* @public
|
|
2568
2568
|
*/
|
|
2569
2569
|
PolicySchema?: number;
|
|
2570
2570
|
/**
|
|
2571
|
-
* @public
|
|
2572
2571
|
* <p>Status of the template. Status can be creating, active, deleting, or failed.</p>
|
|
2572
|
+
* @public
|
|
2573
2573
|
*/
|
|
2574
2574
|
Status?: TemplateStatus;
|
|
2575
2575
|
/**
|
|
2576
|
-
* @public
|
|
2577
2576
|
* <p>The revision version of the template. Template updates will increment the minor
|
|
2578
2577
|
* revision. Re-enrolling all certificate holders will increment the major revision.</p>
|
|
2578
|
+
* @public
|
|
2579
2579
|
*/
|
|
2580
2580
|
Revision?: TemplateRevision;
|
|
2581
2581
|
/**
|
|
2582
|
-
* @public
|
|
2583
2582
|
* <p>The date and time that the template was created.</p>
|
|
2583
|
+
* @public
|
|
2584
2584
|
*/
|
|
2585
2585
|
CreatedAt?: Date;
|
|
2586
2586
|
/**
|
|
2587
|
-
* @public
|
|
2588
2587
|
* <p>The date and time that the template was updated.</p>
|
|
2588
|
+
* @public
|
|
2589
2589
|
*/
|
|
2590
2590
|
UpdatedAt?: Date;
|
|
2591
2591
|
}
|
|
@@ -2594,15 +2594,15 @@ export interface TemplateSummary {
|
|
|
2594
2594
|
*/
|
|
2595
2595
|
export interface ListTemplatesResponse {
|
|
2596
2596
|
/**
|
|
2597
|
-
* @public
|
|
2598
2597
|
* <p>Custom configuration templates used when issuing a certificate. </p>
|
|
2598
|
+
* @public
|
|
2599
2599
|
*/
|
|
2600
2600
|
Templates?: TemplateSummary[];
|
|
2601
2601
|
/**
|
|
2602
|
-
* @public
|
|
2603
2602
|
* <p>Use this parameter when paginating results in a subsequent request after you receive a
|
|
2604
2603
|
* response with truncated results. Set it to the value of the <code>NextToken</code>
|
|
2605
2604
|
* parameter from the response you just received.</p>
|
|
2605
|
+
* @public
|
|
2606
2606
|
*/
|
|
2607
2607
|
NextToken?: string;
|
|
2608
2608
|
}
|
|
@@ -2611,13 +2611,13 @@ export interface ListTemplatesResponse {
|
|
|
2611
2611
|
*/
|
|
2612
2612
|
export interface TagResourceRequest {
|
|
2613
2613
|
/**
|
|
2614
|
-
* @public
|
|
2615
2614
|
* <p>The Amazon Resource Name (ARN) that was returned when you created the resource. </p>
|
|
2615
|
+
* @public
|
|
2616
2616
|
*/
|
|
2617
2617
|
ResourceArn: string | undefined;
|
|
2618
2618
|
/**
|
|
2619
|
-
* @public
|
|
2620
2619
|
* <p>Metadata assigned to a directory registration consisting of a key-value pair.</p>
|
|
2620
|
+
* @public
|
|
2621
2621
|
*/
|
|
2622
2622
|
Tags: Record<string, string> | undefined;
|
|
2623
2623
|
}
|
|
@@ -2626,25 +2626,25 @@ export interface TagResourceRequest {
|
|
|
2626
2626
|
*/
|
|
2627
2627
|
export interface UpdateTemplateGroupAccessControlEntryRequest {
|
|
2628
2628
|
/**
|
|
2629
|
-
* @public
|
|
2630
2629
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
2630
|
+
* @public
|
|
2631
2631
|
*/
|
|
2632
2632
|
TemplateArn: string | undefined;
|
|
2633
2633
|
/**
|
|
2634
|
-
* @public
|
|
2635
2634
|
* <p>Security identifier (SID) of the group object from Active Directory. The SID starts with
|
|
2636
2635
|
* "S-".</p>
|
|
2636
|
+
* @public
|
|
2637
2637
|
*/
|
|
2638
2638
|
GroupSecurityIdentifier: string | undefined;
|
|
2639
2639
|
/**
|
|
2640
|
-
* @public
|
|
2641
2640
|
* <p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>
|
|
2641
|
+
* @public
|
|
2642
2642
|
*/
|
|
2643
2643
|
GroupDisplayName?: string;
|
|
2644
2644
|
/**
|
|
2645
|
-
* @public
|
|
2646
2645
|
* <p>Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a
|
|
2647
2646
|
* template.</p>
|
|
2647
|
+
* @public
|
|
2648
2648
|
*/
|
|
2649
2649
|
AccessRights?: AccessRights;
|
|
2650
2650
|
}
|
|
@@ -2653,22 +2653,22 @@ export interface UpdateTemplateGroupAccessControlEntryRequest {
|
|
|
2653
2653
|
*/
|
|
2654
2654
|
export interface UpdateTemplateRequest {
|
|
2655
2655
|
/**
|
|
2656
|
-
* @public
|
|
2657
2656
|
* <p>The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>.</p>
|
|
2657
|
+
* @public
|
|
2658
2658
|
*/
|
|
2659
2659
|
TemplateArn: string | undefined;
|
|
2660
2660
|
/**
|
|
2661
|
-
* @public
|
|
2662
2661
|
* <p>Template configuration to define the information included in certificates. Define
|
|
2663
2662
|
* certificate validity and renewal periods, certificate request handling and enrollment
|
|
2664
2663
|
* options, key usage extensions, application policies, and cryptography settings.</p>
|
|
2664
|
+
* @public
|
|
2665
2665
|
*/
|
|
2666
2666
|
Definition?: TemplateDefinition;
|
|
2667
2667
|
/**
|
|
2668
|
-
* @public
|
|
2669
2668
|
* <p>This setting allows the major version of a template to be increased automatically. All
|
|
2670
2669
|
* members of Active Directory groups that are allowed to enroll with a template will receive a new
|
|
2671
2670
|
* certificate issued using that template.</p>
|
|
2671
|
+
* @public
|
|
2672
2672
|
*/
|
|
2673
2673
|
ReenrollAllCertificateHolders?: boolean;
|
|
2674
2674
|
}
|
|
@@ -2677,14 +2677,14 @@ export interface UpdateTemplateRequest {
|
|
|
2677
2677
|
*/
|
|
2678
2678
|
export interface UntagResourceRequest {
|
|
2679
2679
|
/**
|
|
2680
|
-
* @public
|
|
2681
2680
|
* <p>The Amazon Resource Name (ARN) that was returned when you created the resource.</p>
|
|
2681
|
+
* @public
|
|
2682
2682
|
*/
|
|
2683
2683
|
ResourceArn: string | undefined;
|
|
2684
2684
|
/**
|
|
2685
|
-
* @public
|
|
2686
2685
|
* <p>Specifies a list of tag keys that you want to remove from the specified
|
|
2687
2686
|
* resources.</p>
|
|
2687
|
+
* @public
|
|
2688
2688
|
*/
|
|
2689
2689
|
TagKeys: string[] | undefined;
|
|
2690
2690
|
}
|