Skip to content
This repository has been archived by the owner on Jan 24, 2023. It is now read-only.

Commit

Permalink
Add docs for UAA SSO user permissions management (#4554)
Browse files Browse the repository at this point in the history
* Bump docusaurus version and versioning
- Bump docusaurus to latest 2.0 version
- Fix errors thrown up by new linting process
- Add version support, setup 4.0.0
- Enable dark mode and fix in home screen

* Move status_updates back into root project docs folder

* Fix links
- fix dead links
- ensure all links are relative (so work when versioned)

* Remove version 4.0.0

* WIP

* WIP

* Completed

* Temporarily remove docsVersionDropdown until first version added to internal-versions

* Update website docs

* Build fix for temp situation where there's no versions

* Add custom version of 'not latest released docs' message

* Improve versioning and dark mode toggle
- Add `All Versions page`
- Conditionally include versions in drop down
- Improve dark mode toggle icons

* Temporarily remove dependent on versions
- will be added back in when 4.0 sha is known

* Update Versions Process

* Add 4.0.0

* Fix in `build`/`serve` world
- worked fine in `start` world...

* Update 4.0.0 with temp version

* Add troubleshooting section for SSO

* Update SSO auth troubleshooting section
  • Loading branch information
richard-cox committed Sep 4, 2020
1 parent b63e39a commit c767913
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
17 changes: 16 additions & 1 deletion website/docs/advanced/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,19 @@ SSO_WHITELIST=https://your.domain/*,https://your.other.domain/*

When set, any requests to log in with a different `state` will be denied.

In order for the SSO `state` to match an entry from the whitelist the schema, hostname, port and path must match exactly. A wildcard `*` can be provided for the path to match anything.
In order for the SSO `state` to match an entry from the whitelist the schema, hostname, port and path must match exactly. A wildcard `*` can be provided for the path to match anything.

## Troubleshooting

1. User has selected the incorrect application authorities when logging in to Stratos via SSO for the first time.
- The user can update their permissions and other account settings via https://login.< uaa address >/profile
2. Administrator wants to remove the application authorities selection users see when logging in to Stratos via SSO for the first time
- This is carried out at the Admins discretion
- Using the `uaac` cli update the 'autoapprove' property of the client used by Stratos to either `true` for all authorities or a comma separated list for the authorities to be removed.

```
uaac client update <console client> --autoapprove true
```
3. User sees the error message `No scopes were granted` when trying to log in to Stratos via SSO
- User may not have selected any of the application authorities when logging in to Stratos via SSO for the first time
- Either of the resolutions to 1 and 2 can be made
2 changes: 1 addition & 1 deletion website/docs/deploy/cloud-foundry/cloud-foundry.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Follow instructions [here](db-migration).

## Use SSO Login

By default Stratos will present its own login UI and only supports username and password authentication with your UAA. You can configure Stratos to use UAA's login UI by specifying the the `SSO_LOGIN` environment variable in the manifest, for example:
By default Stratos will present its own login UI and only supports username and password authentication with your UAA. You can configure Stratos to use UAA's login UI by specifying the `SSO_LOGIN` environment variable in the manifest, for example:

```
applications:
Expand Down
2 changes: 0 additions & 2 deletions website/src/theme/DocVersionSuggestions/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ function DocVersionSuggestions() {
const activeVersionName = activeVersion.name; // try to link to same doc in latest version (not always possible)
// fallback to main doc of latest version

styles;

const suggestedDoc =
latestDocSuggestion ?? getVersionMainDoc(latestVersionSuggestion);
return (
Expand Down

0 comments on commit c767913

Please sign in to comment.