Merge pull request #28141 from jolies93/patch-2

Update provider.md
This commit is contained in:
Andre Wanlin
2024-12-19 11:31:54 -06:00
committed by GitHub
+10 -4
View File
@@ -28,7 +28,7 @@ Name your integration and click on the `Create` button.
Settings for local development:
- Callback URL: `http://localhost:7007/api/auth/atlassian`
- Callback URL: `http://localhost:7007/api/auth/atlassian/handler/frame`
- Use rotating refresh tokens
- For permissions, you **must** enable `View user profile` for the currently
logged-in user, under `User identity API`
@@ -46,18 +46,24 @@ auth:
development:
clientId: ${AUTH_ATLASSIAN_CLIENT_ID}
clientSecret: ${AUTH_ATLASSIAN_CLIENT_SECRET}
scope: ${AUTH_ATLASSIAN_SCOPES}
audience: 'https://api.atlassian.com'
callbackUrl: 'https://backstage.example.com/api/auth/atlassian/handler/frame'
additionalScopes:
- 'read:jira-user'
- 'read:jira-work'
signIn:
resolvers:
# See https://backstage.io/docs/auth/atlassian/provider#resolvers for more resolvers
- resolver: usernameMatchingUserEntityName
```
The Atlassian provider is a structure with three configuration keys:
The Atlassian provider is a structure with the following configuration keys:
- `clientId`: The Key you generated in the developer console.
- `clientSecret`: The Secret tied to the generated Key.
- `scope`: List of scopes the app has permissions for, separated by spaces.
- `audience`: (Optional) Specifies the intended recipient of the tokens.
- `callbackUrl`: (Optional) Must match the redirect URL set in Atlassian OAuth settings.
- `additionalScopes` : (Optional) Additional permissions requested from Atlassian.
**NOTE:** the scopes `offline_access`, `read:jira-work`, and `read:jira-user` are provided by default.