Skip to content

Commit

Permalink
Update github SSO doc to clarify incorrect guidance about org slug (#…
Browse files Browse the repository at this point in the history
…40084)

* Update github docs to remove misleading guidance

based on multiple user feedback, the Organization slug is not lowercased and does not follow the same rules as the team slug.  If following the admonition for organisations, it will not work

~~~
  teams_to_logins:
  - logins:
    - admin
    organization: Teleport-Training-1
    team: admin
~~~

~~~
  "attributes": {
    "Teleport-Training-1": [
      "admin",
      "test-caps-and-spaces"
    ]
  },
  "cluster_name": "ip-172-31-36-239-ec2-internal",
  "code": "T1001I",
  "ei": 0,
  "event": "user.login",
  "method": "github",
  "success": true,
~~~

* Update github-sso.mdx
  • Loading branch information
pschisa authored Apr 8, 2024
1 parent 6638a56 commit e9fd157
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/pages/access-controls/sso/github-sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,9 @@ $ tctl sso configure github \
```
<Admonition type="tip">
GitHub organizations and teams should be referred to by their slug, not display name.
To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase,
To create the team slug, GitHub replaces special characters in the name string, changes all words to lowercase,
and replaces spaces with a `-` separator. For example, `My TEam Näme` would become `my-team-name`.
The organization slug is treated the same except the organization is not changed to lowercase.
You can confirm the slug in GitHub Web application URLs or via the GitHub API.
Example: navigate to the team `My Team` in the GitHub web application.
The URL `https://github.com/orgs/org-name/teams/my-team`
Expand Down

0 comments on commit e9fd157

Please sign in to comment.