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

Commit

Permalink
Merge pull request #61 from resourceguru/sso-required-mode-docs
Browse files Browse the repository at this point in the history
Update authentication.md with SSO-only mode information
  • Loading branch information
kmckelvin committed Jan 11, 2019
2 parents ee905fc + 81d2104 commit f415ae4
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion sections/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ authentication. We offer OAuth2 as the standard way to authenticate with our API
as this offers a simple flow for users to allow app access without you having to store
their credentials.

### Considerations when Single Sign On is required

If your account is configured to require SSO for logins, API access through OAuth2
is only available when authenticating as the account owner. This restriction ensures
that users who have been removed from your identity provider (IdP) aren't able to
continue accessing your Resource Guru account with unexpired API tokens.

### Getting started

We recommend using an OAuth2 library for the platform you're working with, rather than
Expand All @@ -28,7 +35,7 @@ You'll need to configure these URLs as well:
#### Quick start using user's login credentials

This method is only recommended for private apps, such as data imports and exports or internal business reporting.
It's useful to get started quickly without all of the overhead of OAuth2 though, which makes it great for exploration.
It's useful to get started quickly without all of the overhead of OAuth2 though, which makes it great for exploration.
This should not be used for integrating 3rd party apps with Resource Guru as it requires knowing the user's private credentials.

We support the OAuth2 `password` grant type. To authenticate, make an HTTP `POST` to `/oauth/token` with the following:
Expand Down

0 comments on commit f415ae4

Please sign in to comment.