Added suggestions from code review

elastic · May 27, 2021 · 845d06b · 845d06b
1 parent f6bddae
commit 845d06b
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 46 deletions.
diff --git a/docs/user/security/api-keys/images/create-api-key.png b/docs/user/security/api-keys/images/create-api-key.png
diff --git a/x-pack/plugins/security/public/management/api_keys/api_keys_grid/create_api_key_flyout.tsx b/x-pack/plugins/security/public/management/api_keys/api_keys_grid/create_api_key_flyout.tsx
@@ -62,42 +62,8 @@ const defaultDefaultValues: ApiKeyFormValues = {
   customExpiration: false,
   customPrivileges: false,
   includeMetadata: false,
-  role_descriptors: JSON.stringify(
-    {
-      'role-a': {
-        cluster: ['all'],
-        indices: [
-          {
-            names: ['index-a*'],
-            privileges: ['read'],
-          },
-        ],
-      },
-      'role-b': {
-        cluster: ['all'],
-        indices: [
-          {
-            names: ['index-b*'],
-            privileges: ['all'],
-          },
-        ],
-      },
-    },
-    null,
-    2
-  ),
-  metadata: JSON.stringify(
-    {
-      application: 'my-application',
-      environment: {
-        level: 1,
-        trusted: true,
-        tags: ['dev', 'staging'],
-      },
-    },
-    null,
-    2
-  ),
+  role_descriptors: '{}',
+  metadata: '{}',
 };
 
 export const CreateApiKeyFlyout: FunctionComponent<CreateApiKeyFlyoutProps> = ({
@@ -242,7 +208,6 @@ export const CreateApiKeyFlyout: FunctionComponent<CreateApiKeyFlyoutProps> = ({
           <EuiSpacer />
           <EuiFormFieldset>
             <EuiSwitch
-              id="apiKeyCustom"
               label={i18n.translate(
                 'xpack.security.accountManagement.createApiKey.customPrivilegesLabel',
                 {
@@ -285,7 +250,6 @@ export const CreateApiKeyFlyout: FunctionComponent<CreateApiKeyFlyoutProps> = ({
           <EuiSpacer />
           <EuiFormFieldset>
             <EuiSwitch
-              name="customExpiration"
               label={i18n.translate(
                 'xpack.security.accountManagement.createApiKey.customExpirationLabel',
                 {
@@ -330,7 +294,6 @@ export const CreateApiKeyFlyout: FunctionComponent<CreateApiKeyFlyoutProps> = ({
           <EuiSpacer />
           <EuiFormFieldset>
             <EuiSwitch
-              id="apiKeyCustom"
               label={i18n.translate(
                 'xpack.security.accountManagement.createApiKey.includeMetadataLabel',
                 {

diff --git a/x-pack/plugins/security/server/authentication/api_keys/api_keys.ts b/x-pack/plugins/security/server/authentication/api_keys/api_keys.ts
@@ -30,15 +30,21 @@ export interface CreateAPIKeyParams {
   name: string;
   role_descriptors: Record<string, any>;
   expiration?: string;
+  metadata?: Record<string, any>;
 }
 
-interface GrantAPIKeyParams {
-  api_key: CreateAPIKeyParams;
-  grant_type: 'password' | 'access_token';
-  username?: string;
-  password?: string;
-  access_token?: string;
-}
+type GrantAPIKeyParams =
+  | {
+      api_key: CreateAPIKeyParams;
+      grant_type: 'password';
+      username: string;
+      password: string;
+    }
+  | {
+      api_key: CreateAPIKeyParams;
+      grant_type: 'access_token';
+      access_token: string;
+    };
 
 /**
  * Represents the params for invalidating multiple API keys

diff --git a/x-pack/test/api_integration/apis/security/api_keys.ts b/x-pack/test/api_integration/apis/security/api_keys.ts
@@ -46,6 +46,23 @@ export default function ({ getService }: FtrProviderContext) {
             expect(name).to.eql('test_api_key');
           });
       });
+
+      it('should allow an API Key to be created with metadata', async () => {
+        await supertest
+          .post('/internal/security/api_key')
+          .set('kbn-xsrf', 'xxx')
+          .send({
+            name: 'test_api_key_with_metadata',
+            metadata: {
+              foo: 'bar',
+            },
+          })
+          .expect(200)
+          .then((response: Record<string, any>) => {
+            const { name } = response.body;
+            expect(name).to.eql('test_api_key_with_metadata');
+          });
+      });
     });
   });
 }