paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 34 Packages Projects Releases Wiki Activity

Merge pull request #28180 from AdityaK60/Update_doc

Browse Source 
minor updates in provider doc file
This commit is contained in:
Andre Wanlin
2024-12-20 09:41:52 -06:00
committed by GitHub
parent 3f82a0c99e 303fc5d8fb
commit ca6d1d42bf
3 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/auth/atlassian/provider.md
+8 -8
View File
@@ -22,7 +22,7 @@ To add Atlassian authentication, you must create an OAuth 2.0 (3LO) app.
Go to `https://developer.atlassian.com/console/myapps/`.
Click on the drop down `Create`, and choose `OAuth 2.0 integration`.
Click on the drop-down `Create` and choose `OAuth 2.0 integration`.
Name your integration and click on the `Create` button.
@@ -65,27 +65,27 @@ The Atlassian provider is a structure with the following configuration keys:
- `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.
**NOTE:** The scopes `offline_access`, `read:jira-work`, and `read:jira-user` are provided by default.
### Resolvers
This provider includes several resolvers out of the box that you can use:
- `emailMatchingUserEntityProfileEmail`: Matches the email address from the auth provider with the User entity that has a matching `spec.profile.email`. If no match is found it will throw a `NotFoundError`.
- `emailLocalPartMatchingUserEntityName`: Matches the [local part](https://en.wikipedia.org/wiki/Email_address#Local-part) of the email address from the auth provider with the User entity that has a matching `name`. If no match is found it will throw a `NotFoundError`.
- `usernameMatchingUserEntityName`: Matches the username from the auth provider with the User entity that has a matching `name`. If no match is found it will throw a `NotFoundError`.
- `emailMatchingUserEntityProfileEmail`: Matches the email address from the auth provider with the User entity that has a matching `spec.profile.email`. If no match is found, it will throw a `NotFoundError`.
- `emailLocalPartMatchingUserEntityName`: Matches the [local part](https://en.wikipedia.org/wiki/Email_address#Local-part) of the email address from the auth provider with the User entity that has a matching `name`. If no match is found, it will throw a `NotFoundError`.
- `usernameMatchingUserEntityName`: Matches the username from the auth provider with the User entity that has a matching `name`. If no match is found, it will throw a `NotFoundError`.
:::note Note
The resolvers will be tried in order, but will only be skipped if they throw a `NotFoundError`.
The resolvers will be tried in order but will only be skipped if they throw a `NotFoundError`.
:::
If these resolvers do not fit your needs you can build a custom resolver, this is covered in the [Building Custom Resolvers](../identity-resolver.md#building-custom-resolvers) section of the Sign-in Identities and Resolvers documentation.
If these resolvers do not fit your needs, you can build a custom resolver, this is covered in the [Building Custom Resolvers](../identity-resolver.md#building-custom-resolvers) section of the Sign-in Identities and Resolvers documentation.
## Backend Installation
To add the provider to the backend we will first need to install the package by running this command:
To add the provider to the backend, we will first need to install the package by running this command:
```bash title="from your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-auth-backend-module-atlassian-provider