From d07e5e5ab75b90f5d3d856e50eaba1e967b887bf Mon Sep 17 00:00:00 2001 From: Charles LE REUN <77982369+CharlesLR-sekoia@users.noreply.github.com> Date: Fri, 28 Jun 2024 11:38:34 +0200 Subject: [PATCH 1/2] Update manage_api_keys.md --- docs/getting_started/manage_api_keys.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/getting_started/manage_api_keys.md b/docs/getting_started/manage_api_keys.md index c648ac463e..dcff7f8bd0 100644 --- a/docs/getting_started/manage_api_keys.md +++ b/docs/getting_started/manage_api_keys.md @@ -37,14 +37,17 @@ On this view, you can: ## Create an API key +!!! Note + Prior to create an API key, one MUST create a **custom role** as API key creation does not support the association to a built-in role. + To create a new API key, you’ll have to: 1. Click on the `+ API key` button 2. Give a name and a description to your key (description should be more than 10 characters and less than 100 characters) -3. Select one or more roles to associate with your key. For instance, if you want to use your key to retrieve information from the Intelligence Center, please select the role `ic_viewer - Intelligence Center Read-Only` +3. Select one or more **custom roles** to associate with your key depending on your need. For instance, if you want to use your key to retrieve information from the Intelligence Center, please select a custom role using one of the permissions `View Intelligence` or `View Intelligence with limited access` 4. Click on `Save` -!!! note +!!! Note The key will only be displayed once. We recommend you to save it into a vault. ## Revoke an API Key From 007e7b1d7d2a8913e63b506a82ce80b5cb5e67de Mon Sep 17 00:00:00 2001 From: Charles LE REUN <77982369+CharlesLR-sekoia@users.noreply.github.com> Date: Fri, 28 Jun 2024 11:57:05 +0200 Subject: [PATCH 2/2] Update manage_api_keys.md --- docs/getting_started/manage_api_keys.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/getting_started/manage_api_keys.md b/docs/getting_started/manage_api_keys.md index dcff7f8bd0..ac5c700aec 100644 --- a/docs/getting_started/manage_api_keys.md +++ b/docs/getting_started/manage_api_keys.md @@ -38,7 +38,11 @@ On this view, you can: ## Create an API key !!! Note - Prior to create an API key, one MUST create a **custom role** as API key creation does not support the association to a built-in role. + API keys can't be assigned built-in roles. + +!!! Note + One MUST first create a custom role before creating API keys. + To create a new API key, you’ll have to: