Skip to content

Query and Get API Key Information endpoints support for profile uid #2473

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.

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

Merged
merged 2 commits into from
Apr 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions output/openapi/elasticsearch-serverless-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

104 changes: 101 additions & 3 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions output/schema/validation-errors.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions specification/security/_types/ApiKey.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,22 @@ export class ApiKey {
* Realm name of the principal for which this API key was created.
*/
realm?: string
/**
* Realm type of the principal for which this API key was created
* @availability stack since=8.14.0
* @availability serverless
*/
realm_type?: string
/**
* Principal for which this API key was created
*/
username?: Username
/**
* The profile uid for the API key owner principal, if requested and if it exists
* @availability stack since=8.14.0
* @availability serverless
*/
profile_uid?: string
/**
* Metadata of the API key
* @availability stack since=7.13.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,12 @@ export interface Request extends RequestBase {
* @availability serverless
*/
active_only?: boolean
/**
* Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
* @server_default false
* @availability stack since=8.14.0
* @availability serverless
*/
with_profile_uid?: boolean
}
}
15 changes: 14 additions & 1 deletion specification/security/query_api_keys/QueryApiKeysRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,22 @@ export interface Request extends RequestBase {
* An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
* @availability stack since=8.5.0
* @availability serverless

*/
with_limited_by?: boolean
/**
* Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
* @server_default false
* @availability stack since=8.14.0
* @availability serverless
*/
with_profile_uid?: boolean
/**
* Determines whether aggregation names are prefixed by their respective types in the response.
* @server_default false
* @availability stack since=8.14.0
* @availability serverless
*/
typed_keys?: boolean
}
body: {
/**
Expand Down
Loading