TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-03-01 06:27:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(service users): improve client id and client secret docs (#7990)

Browse Source 
# Which Problems Are Solved

- Misaligned heading
- Curl with auth header is hard to understand without the link

# How the Problems Are Solved

Instead of explaining how to create a proper encoding, just use --user
flag for client_id and client_secret
This commit is contained in:
mffap 2024-05-29 11:14:27 +02:00 committed by GitHub
parent 571015703e
commit 3f77b49a41
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/guides/integrate/service-users/client-credentials.md
View File

@ -26,7 +26,7 @@ If you lose it, you will have to generate a new one.
![Create new service user](/img/console_serviceusers_secret.gif) ![Create new service user](/img/console_serviceusers_secret.gif)
## 2. Authenticating a service user and request a token ### 2. Authenticating a service user and request a token
In this step, we will authenticate a service user and receive an access_token to use against the ZITADEL API. In this step, we will authenticate a service user and receive an access_token to use against the ZITADEL API.
@ -36,13 +36,15 @@ You will need to craft a POST request to ZITADEL's token endpoint:
curl --request POST \ curl --request POST \
--url https://$CUSTOM-DOMAIN/oauth/v2/token \ --url https://$CUSTOM-DOMAIN/oauth/v2/token \
--header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic ${BASIC_AUTH}' \
--data grant_type=client_credentials \ --data grant_type=client_credentials \
--data scope='openid profile' --data scope='openid profile' \
--user "$CLIENT_ID:$CLIENT_SECRET"
``` ```
* `CUSTOM_DOMAIN` should be set to your [custom domain](/docs/concepts/features/custom-domain)
* `grant_type` should be set to `client_credentials` * `grant_type` should be set to `client_credentials`
* `scope` should contain any [Scopes](/apis/openidoauth/scopes) you want to include, but must include `openid`. For this example, please include `profile` * `scope` should contain any [Scopes](/apis/openidoauth/scopes) you want to include, but must include `openid`. For this example, please include `profile`
* `CLIENT_ID` and `CLIENT_SECRET` should be set with the values shown in Console when generating a new secret to enable [basic authentication](/docs/apis/openidoauth/authn-methods)
If you want to access ZITADEL APIs, make sure to include the required scopes `urn:zitadel:iam:org:project:id:zitadel:aud`. If you want to access ZITADEL APIs, make sure to include the required scopes `urn:zitadel:iam:org:project:id:zitadel:aud`.
Read our guide [how to access ZITADEL APIs](../zitadel-apis/access-zitadel-apis) to learn more. Read our guide [how to access ZITADEL APIs](../zitadel-apis/access-zitadel-apis) to learn more.