Skip to content

Commit

Permalink
docs: improving documentation for oauth config
Browse files Browse the repository at this point in the history
Signed-off-by: Tiago Barbosa <[email protected]>
  • Loading branch information
t1agob committed Aug 16, 2024
1 parent 043abf2 commit c28af0f
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions docs/getting-started/backstage.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,17 @@ pagerDuty:
oauth:
clientId: ${PD_CLIENT_ID}
clientSecret: ${PD_CLIENT_SECRET}
subDomain: ${PD_ACCOUNT_SUBDOMAIN}
region: ${PD_ACCOUNT_REGION} // Optional. allowed values: 'us', 'eu'.
// Defaults to 'us'.
subDomain: ${PD_ACCOUNT_SUBDOMAIN}
region: ${PD_ACCOUNT_REGION} // Optional.
// Allowed values: 'us', 'eu'.
// Defaults to 'us'.
```

!!! note
The `subDomain` property requires only the first segment of your PagerDuty account url. **Example:** If your PagerDuty account url is `https://myaccount.pagerduty.com` then your `subDomain` value should be `myaccount`.

Configuring it with an invalid value might cause authentication to fail.

#### REST API Token

In `app-config.yaml` file add the following configuration to set your REST API Token:
Expand Down Expand Up @@ -212,7 +218,7 @@ pagerDuty:
oauth:
clientId: ${PD_CLIENT_ID_1}
clientSecret: ${PD_CLIENT_SECRET_1}
subDomain: ${PD_ACCOUNT_SUBDOMAIN_!}
subDomain: ${PD_ACCOUNT_SUBDOMAIN_1}
region: ${PD_ACCOUNT_REGION_1} // Optional. allowed values: 'us', 'eu'.
// Defaults to 'us'.
- id: ${PD_ACCOUNT_SUBDOMAIN_2}
Expand All @@ -223,6 +229,11 @@ pagerDuty:
subDomain: ${PD_ACCOUNT_SUBDOMAIN_2}
```

!!! note
The `subDomain` property requires only the first segment of your PagerDuty account url. **Example:** If your PagerDuty account url is `https://myaccount.pagerduty.com` then your `subDomain` value should be `myaccount`.

Configuring it with an invalid value might cause authentication to fail.

#### REST API Token

In `app-config.yaml` file add the following configuration to set your REST API Token:
Expand Down

0 comments on commit c28af0f

Please sign in to comment.