Skip to content

Commit

Permalink
docs: move "successful auth response" paragraph into the previous bullet
Browse files Browse the repository at this point in the history
  • Loading branch information
pepopowitz committed Oct 1, 2024
1 parent 5a92149 commit 118b37e
Show file tree
Hide file tree
Showing 14 changed files with 50 additions and 50 deletions.
4 changes: 2 additions & 2 deletions docs/apis-tools/administration-api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +43,7 @@ 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.

## Use a token

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +30,7 @@ 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.

## Use a token

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +80,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 Down
8 changes: 4 additions & 4 deletions docs/apis-tools/operate-api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +79,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.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +79,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.

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

Expand Down
8 changes: 4 additions & 4 deletions docs/apis-tools/web-modeler-api/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +81,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 Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ All Zeebe REST API requests require authentication. To authenticate, generate a
--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 Zeebe REST 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 @@ -69,7 +69,7 @@ All Zeebe REST 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 @@ -79,7 +79,7 @@ All Zeebe REST 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 Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ All Optimize API requests except [the health readiness endpoint](./health-readin
--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 @@ -51,7 +51,7 @@ All Optimize API requests except [the health readiness endpoint](./health-readin
"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 Optimize API requests except [the health readiness endpoint](./health-readin
--data-urlencode "client_secret=${CLIENT_SECRET}" \
--data-urlencode 'grant_type=client_credentials'
```
6. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -79,7 +79,7 @@ All Optimize API requests except [the health readiness endpoint](./health-readin
"not-before-policy": 0
}
```
7. Capture the value of the `access_token` property and store it as your token.
6. Capture the value of the `access_token` property and store it as your token.

:::note
The Optimize API can also be configured in a Self-Managed environment to authenticate with a single shared access token. Refer to [Public API Configuration](/self-managed/optimize-deployment/configuration/system-configuration.md#public-api) for the configuration required to access the public API using a specific token.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ All Optimize API requests except [the health readiness endpoint](./health-readin
--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 @@ -51,7 +51,7 @@ All Optimize API requests except [the health readiness endpoint](./health-readin
"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 Optimize API requests except [the health readiness endpoint](./health-readin
--data-urlencode "client_secret=${CLIENT_SECRET}" \
--data-urlencode 'grant_type=client_credentials'
```
6. A successful authentication response looks like the following:
A successful authentication response looks like the following:
```json
{
"access_token": "<TOKEN>",
Expand All @@ -79,7 +79,7 @@ All Optimize API requests except [the health readiness endpoint](./health-readin
"not-before-policy": 0
}
```
7. Capture the value of the `access_token` property and store it as your token.
6. Capture the value of the `access_token` property and store it as your token.

:::note
The Optimize API can also be configured in a Self-Managed environment to authenticate with a single shared access token. Refer to [Public API Configuration](/self-managed/optimize-deployment/configuration/system-configuration.md#public-api) for the configuration required to access the public API using a specific token.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +43,7 @@ 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.

## Use a token

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +79,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.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,7 +79,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.

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

Expand Down
Loading

0 comments on commit 118b37e

Please sign in to comment.