Skip to content

Commit aa21417

Browse files
authored
Add certificate identity field to Cross-Cluster API Key Specs (#5446)
* Add specification for certificate_identity field for cross-cluster api keys * run prettier
1 parent e5a8b60 commit aa21417

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

specification/security/_types/ApiKey.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,13 @@ export class ApiKey {
100100
* @availability serverless
101101
*/
102102
access?: Access
103+
/**
104+
* The certificate identity associated with a cross-cluster API key.
105+
* Restricts the API key to connections authenticated by a specific TLS certificate.
106+
* Only applicable to cross-cluster API keys.
107+
* @availability stack since=9.3.0
108+
*/
109+
certificate_identity?: string
103110
/**
104111
* The profile uid for the API key owner principal, if requested and if it exists
105112
* @availability stack since=8.14.0

specification/security/create_cross_cluster_api_key/CreateCrossClusterApiKeyRequest.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,5 +76,11 @@ export interface Request extends RequestBase {
7676
metadata?: Metadata
7777
/** Specifies the name for this API key. */
7878
name: Name
79+
/**
80+
* The certificate identity to associate with this API key.
81+
* This field is used to restrict the API key to connections authenticated by a specific TLS certificate.
82+
* The value should match the certificate's distinguished name (DN) pattern.
83+
*/
84+
certificate_identity?: string
7985
}
8086
}

specification/security/update_cross_cluster_api_key/UpdateCrossClusterApiKeyRequest.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,5 +81,14 @@ export interface Request extends RequestBase {
8181
* When specified, this information fully replaces metadata previously associated with the API key.
8282
*/
8383
metadata?: Metadata
84+
/**
85+
* The certificate identity to associate with this API key.
86+
* This field is used to restrict the API key to connections authenticated by a specific TLS certificate.
87+
* The value should match the certificate's distinguished name (DN) pattern.
88+
* When specified, this fully replaces any previously assigned certificate identity.
89+
* To clear an existing certificate identity, explicitly set this field to `null`.
90+
* When omitted, the existing certificate identity remains unchanged.
91+
*/
92+
certificate_identity?: string
8493
}
8594
}

0 commit comments

Comments
 (0)