-
Notifications
You must be signed in to change notification settings - Fork 174
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Display userinfo #484
Display userinfo #484
Conversation
…isplay-user-name-or-email
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check my comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added some comments
docs/authorization-configuration.md
Outdated
@@ -39,6 +40,7 @@ auth: { | |||
- **automaticSilentRenew** enables the automatic silent renewal of the token if it is supported by the server. The default value is `false`. For this mechanism to work, the browser must have third-party cookies support enabled. | |||
- **accessTokenExpiringNotificationTime** is the number of seconds before an access token is to expire and triggers silent token refresh. The default value is 60. | |||
- **thirdPartyCookiesScriptLocation** is the URL to the page containing third-party cookies support check. For details, see [Third-party cookies and silent token refresh section](#Third-party-cookies-and-silent-token-refresh). | |||
- **userInfoFn** provides a function to get user information. It returns a promise of an user info object which contains user name and/or email to display it in the profile dropdown. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **userInfoFn** provides a function to get user information. It returns a promise of an user info object which contains user name and/or email to display it in the profile dropdown. | |
- **userInfoFn** provides a function to get user information. It returns a promise of a user info object which contains user name and/or email to display in the profile dropdown. |
docs/authorization-configuration.md
Outdated
@@ -74,6 +77,39 @@ auth: { | |||
- **response_type** defaults to the **id_token**. Any other parameter that is added to oAuthData is also added to the authorization payload. | |||
- **nonceFn** provides a function that returns a string in order to override the default **nonce**. | |||
- **logoutFn** provides the function to override the **logoutUrl** functionality for a custom logout. It needs to execute the **logoutCallback()** function after logout. | |||
- **userInfoFn** provides a function to get user information. It returns a promise of an user info object which contains user name and/or email to display it in the profile dropdown. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **userInfoFn** provides a function to get user information. It returns a promise of an user info object which contains user name and/or email to display it in the profile dropdown. | |
- **userInfoFn** provides a function to get user information. It returns a promise of a user info object which contains user name and/or email to display in the profile dropdown. |
docs/authorization-configuration.md
Outdated
|
||
userInfo(){ | ||
// logic to get some user information | ||
// returns a promise of an userinfo object which contains user name and/or email to display it in the profile dropdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// returns a promise of an userinfo object which contains user name and/or email to display it in the profile dropdown | |
// returns a promise of a userinfo object which contains user name and/or email to display in the profile dropdown menu |
docs/authorization-configuration.md
Outdated
- **userInfoFn** provides a function to get user information. It returns a promise of an user info object which contains user name and/or email to display it in the profile dropdown. | ||
|
||
|
||
### Custom Authentification Provider |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering, should it be authentification
or authentication
? I was researching similar providers and it was authentication
🤔 but I might be wrong :) However, it is used to authenticate the user right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are totally right :)
docs/authorization-configuration.md
Outdated
|
||
### Custom Authentification Provider | ||
|
||
If you are using any authentification provider you also have the possibility to implement some functions that luigi can deal with. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you are using any authentification provider you also have the possibility to implement some functions that luigi can deal with. | |
If you are using any authentication provider you can also implement some other functions for Luigi to use. |
docs/authorization-configuration.md
Outdated
|
||
login(){ | ||
// logic to handle the login mechanism | ||
// returns a promise which contains a error message if something went wrong |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// returns a promise which contains a error message if something went wrong | |
// returns a promise which contains an error message if something went wrong |
docs/authorization-configuration.md
Outdated
|
||
userInfo(){ | ||
// logic to get some user information | ||
// returns a promise of a userinfo object which contains user name and/or email to display in the profile dropdown menu |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// returns a promise of a userinfo object which contains user name and/or email to display in the profile dropdown menu | |
// returns a promise of a userinfo object which contains a user name and/or email to display in the profile dropdown menu |
docs/authorization-configuration.md
Outdated
@@ -39,6 +40,7 @@ auth: { | |||
- **automaticSilentRenew** enables the automatic silent renewal of the token if it is supported by the server. The default value is `false`. For this mechanism to work, the browser must have third-party cookies support enabled. | |||
- **accessTokenExpiringNotificationTime** is the number of seconds before an access token is to expire and triggers silent token refresh. The default value is 60. | |||
- **thirdPartyCookiesScriptLocation** is the URL to the page containing third-party cookies support check. For details, see [Third-party cookies and silent token refresh section](#Third-party-cookies-and-silent-token-refresh). | |||
- **userInfoFn** provides a function to get user information. It returns a promise of a user info object which contains user name and/or email to display in the profile dropdown. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **userInfoFn** provides a function to get user information. It returns a promise of a user info object which contains user name and/or email to display in the profile dropdown. | |
- **userInfoFn** provides a function to get user information. It returns a promise of a **userinfo** object which contains user name and/or email to display in the profile dropdown menu. |
docs/authorization-configuration.md
Outdated
@@ -74,6 +77,39 @@ auth: { | |||
- **response_type** defaults to the **id_token**. Any other parameter that is added to oAuthData is also added to the authorization payload. | |||
- **nonceFn** provides a function that returns a string in order to override the default **nonce**. | |||
- **logoutFn** provides the function to override the **logoutUrl** functionality for a custom logout. It needs to execute the **logoutCallback()** function after logout. | |||
- **userInfoFn** provides a function to get user information. It returns a promise of a user info object which contains user name and/or email to display in the profile dropdown. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **userInfoFn** provides a function to get user information. It returns a promise of a user info object which contains user name and/or email to display in the profile dropdown. | |
- **userInfoFn** provides a function to get user information. It returns a promise of a **userinfo** object which contains user name and/or email to display in the profile dropdown menu. |
No description provided.