You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ For the most basic OAuth implementation, the following minimal configuration is
34
34
This will create an endpoint at the path `/oauth/token`, authenticating requests against the Umbraco members store, issuing access tokens with a lifespan of 20 minutes.
35
35
36
36
### Advanced Configuration
37
-
For a more advanced OAuth implementation, the following conifguration shows all the supported options.
37
+
For a more advanced OAuth implementation, the following configuration shows all the supported options.
@@ -52,7 +52,7 @@ This will create an endpoint the same as the basic configuration with added supp
52
52
### Configuration Options
53
53
*__Realm : string__
54
54
_[optional, default:"default"]_
55
-
A uniqie alias for the configuration, allowing you to configure multiple endpoints.
55
+
A unique alias for the configuration, allowing you to configure multiple endpoints.
56
56
*__Path : string__
57
57
_[optional, default:"/oauth/token"]_
58
58
The path of the endpoint (__IMPORTANT!__ Be sure to add the base of the path to the `umbracoReservedPaths` app setting, ie `~/oauth/`)
@@ -61,7 +61,7 @@ This will create an endpoint the same as the basic configuration with added supp
61
61
The service from which to validate authentication requests against. Out of the box AuthU comes with 2 implementations, `UmbracoMembersOAuthUserService` and `UmbracoUsersOAuthUserService` which authenticate against the Umbraco members and users store respectively. Custom sources can be configured by implementing the `IOAuthUserService` interface yourself.
62
62
*__SymmetricKey : string__
63
63
_[required]_
64
-
A symetric key used to sign the generated access tokens. Must be a string, 32 characters long, BASE64 encoded.
64
+
A symmetric key used to sign the generated access tokens. Must be a string, 32 characters long, BASE64 encoded.
65
65
*__AccessTokenLifeTime : int__
66
66
_[optional, default:20]_
67
67
Sets the lifespan, in minutes, of an access token before re-authentication is required. Should be short lived.
@@ -76,7 +76,7 @@ This will create an endpoint the same as the basic configuration with added supp
76
76
Sets the lifespan, in minutes, of a refresh token before it can no longer be used. Can be long lived. If a client store is configured, this will get overridden by the client settings.
77
77
*__AllowedOrigin : string__
78
78
_[optional, default:"*"]_
79
-
Sets the allowed domain from which authentication requests can be made. If developing a web application, it is strongly recommended to set this to the domain from which your app is hosted at to prevent access from unwanted sources. If developing a mobile app, it can be set to wildcard "*" which will allow any source to access it, however it is strongly recommended you use a client store which requires a secret key to be passed. If a client store is configured, this will get overridden by the client settings.
79
+
Sets the allowed domain from which authentication requests can be made. If developing a web application, it is strongly recommended to set this to the domain from which your app is hosted at to prevent access from unwanted sources. If developing a mobile app, it can be set to wildcard "*" which will allow any source to access it, however it is strongly recommended you use a client store which requires a secret key to be passed. If a client store is configured, this will get overridden by the client settings. If you are managing CORS headers yourself and you don't want AuthU to set the allowed origins header for you, you will need to explicitly set this to `null`.
80
80
*__AllowInsecureHttp : bool__
81
81
_[optional, default:false]_
82
82
Sets whether the api should allow requests over insecure HTTP. You'll probably want to set this to `true` during development, but it is strongly advised to disable this in the live environment.
@@ -89,15 +89,16 @@ With an endpoint configured, initial authentication can be performed by sending
89
89
*__password__ = The users password
90
90
*__client_id__ = A valid client id (Only required if a client store is configured)
91
91
*__client_secret__ = A valid client secret (Only required if a client store is configured, and the client is "secure")
92
+
*__device_id__ = An optional device id to associate the token with, allowing login from multiple devices
92
93
93
94
Example (with client store and refresh token stores configured):
0 commit comments