From 71cb1280f824b47f60535ba54a85de46d8d35a18 Mon Sep 17 00:00:00 2001 From: vicentepinto98 Date: Tue, 10 Oct 2023 09:31:00 +0100 Subject: [PATCH 1/2] Add disclaimer to key flow doc --- README.md | 4 ++++ templates/index.md.tmpl | 3 +++ 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index f1a9498a..298ef9de 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,11 @@ To configure it, follow this steps: The following instructions assume that you have created a service account and assigned it the necessary permissions, e.g. project.owner. 1. In the Portal, go to `Service Account -> Service Account Keys` and create a key. + - You can create your own RSA key-pair or have the Portal generate one for you. + + **Disclaimer:** as of now, creation of a service account key in the Portal is only available in DEV and QA environments. You can use this flow in these environments by using the options `config.WithWithTokenEndpoint` and `config.WithWithJWKSEndpoint` to configure the corresponding endpoints. + 2. Save the content of the service account key and the corresponding private key by copying them or saving them in a file. The expected format of the service account key is the following: ```json { diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 29eb8f35..2389b54d 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -40,6 +40,9 @@ To configure it, follow this steps: 1. In the Portal, go to `Service Account -> Service Account Keys` and create a key. - You can create your own RSA key-pair or have the Portal generate one for you. + + **Disclaimer:** as of now, creation of a service account key in the Portal is only available in DEV and QA environments. You can use this flow in these environments by using the options `config.WithWithTokenEndpoint` and `config.WithWithJWKSEndpoint` to configure the corresponding endpoints. + 2. Save the content of the service account key and the corresponding private key by copying them or saving them in a file. The expected format of the service account key is the following: ```json { From 1519a1332d3fede69d54567942c14300713fdff5 Mon Sep 17 00:00:00 2001 From: vicentepinto98 Date: Tue, 10 Oct 2023 09:46:02 +0100 Subject: [PATCH 2/2] Fix wrong options --- README.md | 2 +- templates/index.md.tmpl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3d0f0e82..d4e65dc5 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ To configure it, follow this steps: - You can create your own RSA key-pair or have the Portal generate one for you. - **Disclaimer:** as of now, creation of a service account key in the Portal is only available in DEV and QA environments. You can use this flow in these environments by using the options `config.WithWithTokenEndpoint` and `config.WithWithJWKSEndpoint` to configure the corresponding endpoints. + **Disclaimer:** as of now, creation of a service account key in the Portal is only available in DEV and QA environments. You can use this flow in these environments by setting the fields `token_custom_endpoint` and `jwks_custom_endpoint` to the corresponding endpoints in the provider block. 2. Save the content of the service account key and the corresponding private key by copying them or saving them in a file. diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 8142537a..d2f7620a 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -42,7 +42,7 @@ To configure it, follow this steps: - You can create your own RSA key-pair or have the Portal generate one for you. -**Disclaimer:** as of now, creation of a service account key in the Portal is only available in DEV and QA environments. You can use this flow in these environments by using the options `config.WithWithTokenEndpoint` and `config.WithWithJWKSEndpoint` to configure the corresponding endpoints. +**Disclaimer:** as of now, creation of a service account key in the Portal is only available in DEV and QA environments. You can use this flow in these environments by setting the fields `token_custom_endpoint` and `jwks_custom_endpoint` to the corresponding endpoints in the provider block. 2. Save the content of the service account key and the corresponding private key by copying them or saving them in a file.