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

Commit

Permalink
Merge pull request #87 from LabShare/kv_docs
Browse files Browse the repository at this point in the history
fix(docs): update configuration option documentation LSAUTH-231
  • Loading branch information
KalleV authored Oct 18, 2019
2 parents 0b7f1a7 + 60acf41 commit 86dab86
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ Register the component and register the configuration for the action by injectin

## Configuring the component

## Options

| Property | Type | Details |
| :------- | :---: | :--------------------------------------------------------------------------------------------------------- |
| tenant | string | The LabShare Auth Tenant the Resource Server (API) is registered to. Example: `ncats`. |
| authUrl | string | The full URL to the LabShare Auth API the Resource Server (API) is registered to. Example: `https://a.labshare.org` |
| audience | string | The audience of the Resource Server. This is a unique identifier for the API registered on the LabShare Auth Service. It does not need match an actual API deployment host. This is required to check if a Client (application) is allowed to access the API. Example: `https://my.api.com/v2`. Optional. |
| issuer | string | The issuer of the Bearer Token. Use this to validate the source of the Bearer Token. Optional. Example: `https://a.labshare.org/_api/ls` |

#### Example

```
Expand Down

0 comments on commit 86dab86

Please sign in to comment.