Skip to content

Commit

Permalink
Client creds docs: describe helpdesk request approach
Browse files Browse the repository at this point in the history
instead of CF ticket approach
  • Loading branch information
soxofaan committed Nov 25, 2024
1 parent 0316234 commit 0d56f3e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 60 deletions.
Binary file not shown.
Binary file not shown.
70 changes: 10 additions & 60 deletions APIs/openEO/authentication/client_credentials.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -84,72 +84,22 @@ for the client credentials flow with the openEO service of Copernicus Data Space

### Request A Service Account From The CDSE Account Management Service


The [account management service in the Copernicus Data Space Ecosystem](https://identity.dataspace.copernicus.eu/auth/realms/CDSE/account){target="_blank"}
(managed by [CloudFerro](https://cloudferro.com/){target="_blank"})
supports the creation of OIDC/OAuth clients (e.g. service accounts based on the client credentials grant)
through CloudFerro's JIRA ticketing system.


::: {.callout-warning}

Creating a such a ticket requires a valid user account on the CloudFerro JIRA system,
which is currently not covered by this documentation.
Contact the [CDSE support team](https://helpcenter.dataspace.copernicus.eu/)
for more information.

:::


Follow these steps
to request the creation of an OIDC/OAuth client (with client credentials support)
for a given use case or project:

0. Before beginning, collect the following:

- A short, but descriptive *project name*.
It can be a couple of words or a project acronym,
but it should be descriptive enough to be unique
within the Copernicus Data Space Ecosystem.
- A short description of the project,
preferably with some pointers to the project website,
contact info, involved parties, ...

In the following, `$ProjectName$` will be used as placeholder of the project name

1. [Log in on CloudFerro JIRA](https://jira.cloudferro.com/login.jsp)
2. [Start creating a JIRA ticket](https://jira.cloudferro.com/secure/CreateIssue!default.jspa){target="_blank"}
as follows:

- Project: select "CDSE Operations (CDSE)"
- Issue Type: select "New KC client"
- Click the "Next" button

![JIRA ticket creation: select issue type](_images/cf-new-kc-client-01.png)

3. Fill in these client details:

- Summary: "OIDC Client for `$ProjectName$`"
- Client ID: this must be a unique identifier
and it is recommended to start with prefix `sh-`.
For example, use the following Python snippet to generate such a identifier:
which can be [requested through the help center](https://helpcenter.dataspace.copernicus.eu/hc/en-gb/requests/new).

```python
import uuid
print(f"sh-{uuid.uuid4()}")
```

- Name: "Service Account for `$ProjectName$`".
- Description: put the project description here.
- Client authentication: select "On"
- Authentication flow:
enable "Service Accounts Role" to enable the "Client Credentials Grant" on the client.
- All other options can be left empty/default as-is.
- Click the "Create" button at the bottom.
Make sure to include the following information in the description of the request:

![JIRA ticket creation: client details](_images/cf-new-kc-client-02.png)
- A short, but descriptive *project name*.
It can be a couple of words or a project acronym,
but it should be descriptive enough to be unique
within the Copernicus Data Space Ecosystem.
- A short description of the project,
preferably with some pointers to the project website,
contact info, involved parties, ...

4. After submitting this JIRA ticket:
allow the CloudFerro team some time to review and address the client creation request.


## Obtain The OIDC Identifier Of A Service Account
Expand Down

0 comments on commit 0d56f3e

Please sign in to comment.