Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: address auth rewrite feedback #4380

Merged
merged 6 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/apis-tools/administration-api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Learn about access tokens and client credentials and scopes to get

All Administration API requests require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) and include it in each request.

## Generating a token
## Generate a token

1. Create client credentials by clicking **Console > Organization > Administration API > Create new credentials**.
2. Add permissions to this client for [the needed scopes](#client-credentials-and-scopes).
3. Upon creating the client, capture the following values required to generate a token:
3. Once you have created the client, capture the following values required to generate a token:
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
| Name | Environment variable name | Default value |
| ------------------------ | -------------------------------- | -------------------------------------------- |
Expand All @@ -21,7 +21,7 @@ All Administration API requests require authentication. To authenticate, generat
| Authorization Server URL | `CAMUNDA_OAUTH_URL` | `https://login.cloud.camunda.io/oauth/token` |
| Audience | `CAMUNDA_CONSOLE_OAUTH_AUDIENCE` | `api.cloud.camunda.io` |
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
:::tip
:::caution
When client credentials are created, the `Client Secret` is only shown once. Save this `Client Secret` somewhere safe.
:::
4. Execute an authentication request to the token issuer:
Expand All @@ -33,7 +33,7 @@ All Administration API requests require authentication. To authenticate, generat
--data-urlencode "client_id=${CAMUNDA_CONSOLE_CLIENT_ID}" \
--data-urlencode "client_secret=${CAMUNDA_CONSOLE_CLIENT_SECRET}"
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -43,9 +43,9 @@ All Administration API requests require authentication. To authenticate, generat
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

## Using a token
## Use a token

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "The Administration API for Self-Managed is a REST API and provides

All Administration Self-Managed API requests require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) and include it in each request.

## Generating a token
## Generate a token

1. [Add an M2M application in Identity](/self-managed/identity/user-guide/additional-features/incorporate-applications.md).
2. [Add permissions to this application](/self-managed/identity/user-guide/additional-features/incorporate-applications.md) for **Administration Self-Managed API**.
Expand All @@ -20,7 +20,7 @@ All Administration Self-Managed API requests require authentication. To authenti
--data-urlencode "client_secret=${CLIENT_SECRET}" \
--data-urlencode 'grant_type=client_credentials'
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -30,13 +30,13 @@ All Administration Self-Managed API requests require authentication. To authenti
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

## Using a token
## Use a token

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the ["Get current clusters" endpoint](./specifications/get-clusters.api.mdx):
For example, to send a request to the ["Get current clusters"](./specifications/get-clusters.api.mdx) endpoint:

:::tip
The `${CAMUNDA_BASE_URL}` variable below represents the URL of the Self-Managed environment. You can configure this value in your Self-Managed installation. The default value is `http://localhost:8080`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import TabItem from "@theme/TabItem";

All Camunda 8 REST API requests require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) depending on your environment and include it in each request.

## Generating a token
## Generate a token

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand All @@ -21,7 +21,7 @@ All Camunda 8 REST API requests require authentication. To authenticate, generat

1. [Create client credentials](/guides/setup-client-connection-credentials.md) in the **Clusters > Cluster name > API** tab of [Camunda Console](https://console.camunda.io/).
2. Add permissions to this client for **Zeebe**.
3. Upon creating the client, capture the following values required to generate a token:
3. Once you have created the client, capture the following values required to generate a token:
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
| Name | Environment variable name | Default value |
| ------------------------ | -------------------------------- | -------------------------------------------- |
Expand All @@ -31,7 +31,7 @@ All Camunda 8 REST API requests require authentication. To authenticate, generat
| Audience | `ZEEBE_TOKEN_AUDIENCE` | `zeebe.camunda.io` |
| Zeebe REST Address | `ZEEBE_REST_ADDRESS` | - |
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
:::tip
:::caution
When client credentials are created, the `Client Secret` is only shown once. Save this `Client Secret` somewhere safe.
:::
4. Execute an authentication request to the token issuer:
Expand All @@ -43,7 +43,7 @@ All Camunda 8 REST API requests require authentication. To authenticate, generat
--data-urlencode "client_id=${ZEEBE_CLIENT_ID}" \
--data-urlencode "client_secret=${ZEEBE_CLIENT_SECRET}"
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -53,7 +53,7 @@ All Camunda 8 REST API requests require authentication. To authenticate, generat
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

</TabItem>

Expand All @@ -70,7 +70,7 @@ All Camunda 8 REST API requests require authentication. To authenticate, generat
--data-urlencode "client_secret=${CLIENT_SECRET}" \
--data-urlencode 'grant_type=client_credentials'
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -80,13 +80,13 @@ All Camunda 8 REST API requests require authentication. To authenticate, generat
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

</TabItem>

</Tabs>

## Using a token
## Use a token

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

Expand Down
18 changes: 9 additions & 9 deletions docs/apis-tools/operate-api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import TabItem from "@theme/TabItem";

All Operate REST API requests require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) and include it in each request.

## Generating a token
## Generate a token

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand All @@ -20,7 +20,7 @@ All Operate REST API requests require authentication. To authenticate, generate

1. [Create client credentials](/guides/setup-client-connection-credentials.md) in the **Clusters > Cluster name > API** tab of [Camunda Console](https://console.camunda.io/).
2. Add permissions to this client for **Operate**.
3. Upon creating the client, capture the following values required to generate a token:
3. Once you have created the client, capture the following values required to generate a token:
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
| Name | Environment variable name | Default value |
| ------------------------ | -------------------------------- | -------------------------------------------- |
Expand All @@ -30,7 +30,7 @@ All Operate REST API requests require authentication. To authenticate, generate
| Audience | | `operate.camunda.io` |
| Operate REST Address | `CAMUNDA_OPERATE_BASE_URL` | - |
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
:::tip
:::caution
When client credentials are created, the `Client Secret` is only shown once. Save this `Client Secret` somewhere safe.
:::
4. Execute an authentication request to the token issuer:
Expand All @@ -42,7 +42,7 @@ All Operate REST API requests require authentication. To authenticate, generate
--data-urlencode "client_id=${ZEEBE_CLIENT_ID}" \
--data-urlencode "client_secret=${ZEEBE_CLIENT_SECRET}"
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -52,7 +52,7 @@ All Operate REST API requests require authentication. To authenticate, generate
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

</TabItem>

Expand All @@ -69,7 +69,7 @@ All Operate REST API requests require authentication. To authenticate, generate
--data-urlencode "client_secret=${CLIENT_SECRET}" \
--data-urlencode 'grant_type=client_credentials'
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -79,19 +79,19 @@ All Operate REST API requests require authentication. To authenticate, generate
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

See the [Operate Configuration - Authentication](/self-managed/operate-deployment/operate-authentication.md#identity) documentation for more information about this authentication method.

</TabItem>

</Tabs>

## Using a token
## Use a token

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the Operate REST API's ["Search process instances" endpoint](./specifications/search-1.api.mdx):
For example, to send a request to the Operate REST API's ["Search process instances"](./specifications/search-1.api.mdx) endpoint:

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from "@theme/TabItem";

All Tasklist API requests require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) and include it in each request.

## Generating a token
## Generate a token

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand All @@ -21,7 +21,7 @@ All Tasklist API requests require authentication. To authenticate, generate a [J

1. [Create client credentials](/guides/setup-client-connection-credentials.md) in the **Clusters > Cluster name > API** tab of [Camunda Console](https://console.camunda.io/).
2. Add permissions to this client for **Tasklist**.
3. Upon creating the client, capture the following values required to generate a token:
3. Once you have created the client, capture the following values required to generate a token:
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
| Name | Environment variable name | Default value |
| ------------------------ | -------------------------------- | -------------------------------------------- |
Expand All @@ -30,7 +30,7 @@ All Tasklist API requests require authentication. To authenticate, generate a [J
| Authorization Server URL | `ZEEBE_AUTHORIZATION_SERVER_URL` | `https://login.cloud.camunda.io/oauth/token` |
| Tasklist REST Address | `CAMUNDA_TASKLIST_BASE_URL` | - |
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
:::tip
:::caution
When client credentials are created, the `Client Secret` is only shown once. Save this `Client Secret` somewhere safe.
:::
4. Execute an authentication request to the token issuer:
Expand All @@ -42,7 +42,7 @@ All Tasklist API requests require authentication. To authenticate, generate a [J
--data-urlencode "client_id=${ZEEBE_CLIENT_ID}" \
--data-urlencode "client_secret=${ZEEBE_CLIENT_SECRET}"
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -52,7 +52,7 @@ All Tasklist API requests require authentication. To authenticate, generate a [J
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

</TabItem>

Expand All @@ -69,7 +69,7 @@ All Tasklist API requests require authentication. To authenticate, generate a [J
--data-urlencode "client_secret=${CLIENT_SECRET}" \
--data-urlencode 'grant_type=client_credentials'
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -79,19 +79,19 @@ All Tasklist API requests require authentication. To authenticate, generate a [J
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

See the [Tasklist Configuration - Authentication](/self-managed/tasklist-deployment/tasklist-authentication.md#identity) documentation for more information about this authentication method.

</TabItem>

</Tabs>

## Using a token
## Use a token

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

For example, to send a request to the Tasklist API's ["Search tasks" endpoint](./specifications/search-tasks.api.mdx):
For example, to send a request to the Tasklist API's ["Search tasks"](./specifications/search-tasks.api.mdx) endpoint:

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand Down
16 changes: 8 additions & 8 deletions docs/apis-tools/web-modeler-api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from "@theme/TabItem";

All Web Modeler API requests require authentication. To authenticate, generate a [JSON Web Token (JWT)](https://jwt.io/introduction/) depending on your environment and include it in each request.

## Generating a token
## Generate a token

<Tabs groupId="environment" defaultValue="saas" queryString values={
[
Expand All @@ -23,7 +23,7 @@ All Web Modeler API requests require authentication. To authenticate, generate a

1. Create client credentials by clicking **Console > Organization > Administration API > Create new credentials**.
2. Add permissions to this client for **Web Modeler API**.
3. Upon creating the client, capture the following values required to generate a token:
3. Once you have created the client, capture the following values required to generate a token:
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
| Name | Environment variable name | Default value |
| ------------------------ | -------------------------------- | -------------------------------------------- |
Expand All @@ -32,7 +32,7 @@ All Web Modeler API requests require authentication. To authenticate, generate a
| Authorization Server URL | `CAMUNDA_OAUTH_URL` | `https://login.cloud.camunda.io/oauth/token` |
| Audience | `CAMUNDA_CONSOLE_OAUTH_AUDIENCE` | `api.cloud.camunda.io` |
<!-- this comment convinces the markdown processor to still treat the table as a table, but without adding surrounding paragraphs. 🤷 -->
:::tip
:::caution
When client credentials are created, the `Client Secret` is only shown once. Save this `Client Secret` somewhere safe.
:::
4. Execute an authentication request to the token issuer:
Expand All @@ -44,7 +44,7 @@ All Web Modeler API requests require authentication. To authenticate, generate a
--data-urlencode "client_id=${CAMUNDA_CONSOLE_CLIENT_ID}" \
--data-urlencode "client_secret=${CAMUNDA_CONSOLE_CLIENT_SECRET}"
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -54,7 +54,7 @@ All Web Modeler API requests require authentication. To authenticate, generate a
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

</TabItem>

Expand All @@ -71,7 +71,7 @@ All Web Modeler API requests require authentication. To authenticate, generate a
--data-urlencode "client_secret=${CLIENT_SECRET}" \
--data-urlencode 'grant_type=client_credentials'
```
5. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -81,13 +81,13 @@ All Web Modeler API requests require authentication. To authenticate, generate a
"not-before-policy": 0
}
```
6. Capture the value of the `access_token` property and store it as your token.
5. Capture the value of the `access_token` property and store it as your token.

</TabItem>

</Tabs>

## Using a token
## Use a token

Include the previously captured token as an authorization header in each request: `Authorization: Bearer <TOKEN>`.

Expand Down
Loading
Loading