Create API keys with metadata #100682

thomheymann · 2021-05-26T14:21:50Z

Resolves: #100534
Resolves: #93820

Summary

Added the ability to create API Keys with metadata.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)

elasticmachine · 2021-05-26T15:17:07Z

Pinging @elastic/kibana-security (Team:Security)

legrego

Thanks for putting this together so quickly!

A couple of additional comments:

Can we update the type definitions for both CreateAPIKeyParams and GrantAPIKeyParams within the server-side api key service to allow for metadata to be provided? This is part of the plugin's public contract that is consumed elsewhere, so it'd be good to record that we do in fact support metadata:

kibana/x-pack/plugins/security/server/authentication/api_keys/api_keys.ts

Lines 29 to 41 in 69f013e

    
           export interface CreateAPIKeyParams { 
        
             name: string; 
        
             role_descriptors: Record<string, any>; 
        
             expiration?: string; 
        
           } 
        
           interface GrantAPIKeyParams { 
        
             api_key: CreateAPIKeyParams; 
        
             grant_type: 'password' | 'access_token'; 
        
             username?: string; 
        
             password?: string; 
        
             access_token?: string; 
        
           }

Can we add an API test to ensure that we can pass metadata through successfully?:

kibana/x-pack/test/api_integration/apis/security/api_keys.ts

Line 29 in 69f013e

describe('POST /internal/security/api_key', () => {
If you're up for it, we could update the documentation screenshot to include the new metadata toggle:
https://github.com/elastic/kibana/blob/69f013e2fb64544bc9d16d3fe9f4ec6c14ed9c11/docs/user/security/api-keys/images/create-api-key.png

x-pack/plugins/security/public/management/api_keys/api_keys_grid/create_api_key_flyout.tsx

bytebilly

Great work @thomheymann! LGTM once all comments are resolved 👍
Should we update documentation at https://www.elastic.co/guide/en/kibana/current/api-keys.html#create-api-key too?

legrego

LGTM!

legrego · 2021-06-01T14:33:33Z

@elasticmachine merge upstream

kibanamachine · 2021-06-01T16:20:04Z

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`security`	765.0KB	767.0KB	+2.0KB

Unknown metric groups

References to deprecated APIs

id	before	after	diff
`infra`	256	146	-110
`lens`	67	45	-22
`licensing`	18	15	-3
`lists`	239	236	-3
`ml`	121	115	-6
`stackAlerts`	101	95	-6
total			-150

History

💚 Build #127653 succeeded 1803c50
💚 Build #127405 succeeded f6bddae

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

kibanamachine · 2021-06-01T16:57:59Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

Co-authored-by: Thom Heymann <190132+thomheymann@users.noreply.github.com>

…sens/kibana into reporting/new-png-pdf-report-type * 'reporting/new-png-pdf-report-type' of github.com:jloleysens/kibana: (46 commits) [Security Solution] Add Ransomware canary advanced policy option (elastic#101068) [Exploratory view] Core web vitals (elastic#100320) [Security solution][Endpoint] Add unit tests for fleet event filters/trusted apps cards (elastic#101034) [Lens] Use a setter function for the dimension panel (elastic#101123) [Index Patterns] Fix return saved index pattern object (elastic#101051) [CI] For PRs, build TS refs before public api docs check (elastic#100791) [Maps] fix line and polygon label regression (elastic#101085) Migrate CCR to new ES JS client. (elastic#100131) [Canvas] Switch Canvas to use React Router (elastic#100579) [Expressions] Use table column ID instead of name when set (elastic#99724) [DOCS] Updates docs landing page (elastic#100749) [DOCS] Corrects typo in step 3 (elastic#101079) [DOCS] Updates runtime example in Discover (elastic#100926) Migrate kibana.autocomplete config to data plugin (elastic#100586) [Uptime] New width/delay definition for waterfall sidebar item tooltip (elastic#100147) [FTR] Use importExport for saved_object/basic archive (elastic#100244) [Fleet] Better input for multi text input in agent policy builder (elastic#101020) [CI] Buildkite support with Baseline pipeline (elastic#100492) [Reporting/Telemetry] Do not send telemetry if we are in screenshot mode (elastic#100388) Create API keys with metadata (elastic#100682) ...

Create API keys with metadata

48cf335

thomheymann added v8.0.0 v7.14.0 labels May 26, 2021

Added validation

f6bddae

thomheymann added Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! release_note:enhancement labels May 26, 2021

thomheymann marked this pull request as ready for review May 26, 2021 15:17

thomheymann requested a review from a team as a code owner May 26, 2021 15:17

thomheymann added the auto-backport Deprecated: Automatically backport this PR after it's merged label May 26, 2021

legrego reviewed May 26, 2021

View reviewed changes

x-pack/plugins/security/public/management/api_keys/api_keys_grid/create_api_key_flyout.tsx Outdated Show resolved Hide resolved

x-pack/plugins/security/public/management/api_keys/api_keys_grid/create_api_key_flyout.tsx Outdated Show resolved Hide resolved

legrego requested a review from bytebilly May 26, 2021 17:47

bytebilly approved these changes May 26, 2021

View reviewed changes

thomheymann added 2 commits May 27, 2021 16:05

Added suggestions from code review

845d06b

Merge branch 'master' of github.com:elastic/kibana into apikey-metadata

1803c50

legrego approved these changes Jun 1, 2021

View reviewed changes

Merge branch 'master' into apikey-metadata

1001c5b

thomheymann merged commit 27f790c into elastic:master Jun 1, 2021

kibanamachine mentioned this pull request Jun 1, 2021

[7.x] Create API keys with metadata (#100682) #101074

Merged

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 1, 2021

Create API keys with metadata (elastic#100682)

5b5be1a

kibanamachine added a commit that referenced this pull request Jun 1, 2021

Create API keys with metadata (#100682) (#101074)

313a887

Co-authored-by: Thom Heymann <190132+thomheymann@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create API keys with metadata #100682

Create API keys with metadata #100682

thomheymann commented May 26, 2021 •

edited

Loading

elasticmachine commented May 26, 2021

legrego left a comment

bytebilly left a comment •

edited

Loading

legrego left a comment

legrego commented Jun 1, 2021

kibanamachine commented Jun 1, 2021

References to deprecated APIs

kibanamachine commented Jun 1, 2021

	export interface CreateAPIKeyParams {
	name: string;
	role_descriptors: Record<string, any>;
	expiration?: string;
	}

	interface GrantAPIKeyParams {
	api_key: CreateAPIKeyParams;
	grant_type: 'password' \| 'access_token';
	username?: string;
	password?: string;
	access_token?: string;
	}

Create API keys with metadata #100682

Create API keys with metadata #100682

Conversation

thomheymann commented May 26, 2021 • edited Loading

Summary

Checklist

elasticmachine commented May 26, 2021

legrego left a comment

Choose a reason for hiding this comment

bytebilly left a comment • edited Loading

Choose a reason for hiding this comment

legrego left a comment

Choose a reason for hiding this comment

legrego commented Jun 1, 2021

kibanamachine commented Jun 1, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

References to deprecated APIs

History

kibanamachine commented Jun 1, 2021

💚 Backport successful

thomheymann commented May 26, 2021 •

edited

Loading

bytebilly left a comment •

edited

Loading