Skip to content

Add specification for certificate_identity field for cross-cluster ap… #5424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Add specification for certificate_identity field for cross-cluster ap… #5424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38fdc3a
Add specification for certificate_identity field for cross-cluster ap…
gmjehovich Oct 6, 2025
9de139f
run prettier
gmjehovich Oct 6, 2025
d6524cf
Merge branch 'main' into add-certificate-identity-field
gmjehovich Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions specification/security/_types/ApiKey.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,13 @@ export class ApiKey {
* @availability serverless
*/
access?: Access
/**
* The certificate identity associated with a cross-cluster API key.
* Restricts the API key to connections authenticated by a specific TLS certificate.
* Only applicable to cross-cluster API keys.
* @availability stack since=9.3.0
*/
certificate_identity?: string
/**
* The profile uid for the API key owner principal, if requested and if it exists
* @availability stack since=8.14.0
Expand Down
6 changes: 6 additions & 0 deletions specification/security/create_cross_cluster_api_key/CreateCrossClusterApiKeyRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,11 @@ export interface Request extends RequestBase {
metadata?: Metadata
/** Specifies the name for this API key. */
name: Name
/**
* The certificate identity to associate with this API key.
* This field is used to restrict the API key to connections authenticated by a specific TLS certificate.
* The value should match the certificate's distinguished name (DN) pattern.
*/
certificate_identity?: string
}
}
9 changes: 9 additions & 0 deletions specification/security/update_cross_cluster_api_key/UpdateCrossClusterApiKeyRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,14 @@ export interface Request extends RequestBase {
* When specified, this information fully replaces metadata previously associated with the API key.
*/
metadata?: Metadata
/**
* The certificate identity to associate with this API key.
* This field is used to restrict the API key to connections authenticated by a specific TLS certificate.
* The value should match the certificate's distinguished name (DN) pattern.
* When specified, this fully replaces any previously assigned certificate identity.
* To clear an existing certificate identity, explicitly set this field to `null`.
* When omitted, the existing certificate identity remains unchanged.
*/
certificate_identity?: string
}
}
Loading