Skip to content

Commit 2f01b56

Browse files
authored
📖 Add doc about SAML SSO (#67)
* add text * fix * updates * updates * test * test * test * test
1 parent 723d581 commit 2f01b56

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,15 @@ To install the Scorecards GitHub Action, you need to:
4040
* `write:discussion > read:discussion`
4141

4242
![image](/images/tokenscopes.png)
43-
43+
4444
2. Copy the token value.
4545

4646
3. [Create a new repository secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the following settings:
4747
- Name: `SCORECARD_READ_TOKEN`
4848
- Value: the value of the token created in step 1 above.
4949

50+
4. (Optional) If you install Scorecard on a repository owned by an organization that uses [SAML SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on), be sure to [enable SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on) for your PAT token.
51+
5052
### Workflow Setup
5153
1) From your GitHub project's main page, click “Security” in the top ribbon.
5254

@@ -88,6 +90,8 @@ To verify that the Action is running successfully, click the repository's Action
8890
### Troubleshooting
8991
If the run has failed, the most likely reason is an authentication failure. Confirm that the Personal Access Token is saved as an encrypted secret within the same repository (see [Authentication](#authentication)).
9092

93+
If you install Scorecard on a repository owned by an organization that uses [SAML SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on) or if you see `403 Resource protected by organization SAML enforcement` in the logs, be sure to [enable SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on) for your PAT token (see [Authentication](#authentication)).
94+
9195
If the PAT is saved as an encrypted secret and the run is still failing, confirm that you have not made any changes to the workflow yaml file that affected the syntax. Review the [workflow example](#workflow-example) and reset to the default values if necessary.
9296

9397
## Manual Action Setup

0 commit comments

Comments
 (0)