Expand readme with Style and Options guide#359
Conversation
| #### Scope | ||
|
|
||
| Scope used for authentication. By default is `openid`. It will return not only the **access_token**, but also an **id_token** which is a [JSON Web Token (JWT)](https://jwt.io/). | ||
| You can add additional attributes to your claim, in this case returning the users `name, email and picture` in the **id_token**. [Scope Resources](https://auth0.com/docs/libraries/lock/v10/sending-authentication-parameters#scope-string-) |
There was a problem hiding this comment.
Good, I couldn't find a good source for scope.
|
|
||
| #### Scope | ||
|
|
||
| Scope used for authentication. By default is `openid`. It will return not only the **access_token**, but also an **id_token** which is a [JSON Web Token (JWT)](https://jwt.io/). |
There was a problem hiding this comment.
which is a [JSON Web Token (JWT)](https://jwt.io/) containing some user information.
|
|
||
| You can specify additional parameters that will be sent during an authentication request. [Lock Parameters](https://auth0.com/docs/libraries/lock/v10/sending-authentication-parameters) | ||
|
|
||
| * **nonce**: This can be used to help prevent [Replay Attacks](https://en.wikipedia.org/wiki/Replay_attack). |
There was a problem hiding this comment.
Let's not talk about these parameters since Lock handles more flows than web auth
There was a problem hiding this comment.
Shall I just drop this section?
| } | ||
| ``` | ||
|
|
||
| #### Database Ux |
|
|
||
| #### Custom Signup Fields | ||
|
|
||
| When signing up the default information requirements are the user's *email* and *password*. You can expand your data capture requirements as needed. |
There was a problem hiding this comment.
Note that you need to specify the icon yourself
| ``` | ||
|
|
||
| In the code above, the *loggerOutput* has been set to use [CleanroomLogger](https://github.com/emaloney/CleanroomLogger). This can typically | ||
| be achieved by subclassing *loggerOutput*. |
There was a problem hiding this comment.
I think LoggerOutput is a protocol
| } | ||
| ``` | ||
|
|
||
| In the code above, the *loggerOutput* has been set to use [CleanroomLogger](https://github.com/emaloney/CleanroomLogger). This can typically |
There was a problem hiding this comment.
But you can use your favorite Logger library
| #### Logging | ||
|
|
||
| * **logLevel**: By default this is `.off`, *Syslog* logging levels are supported. | ||
| * **logHttpRequest**: Log Auth0.swift network requests. By default this is `false` |
There was a problem hiding this comment.
network -> authentication/authorization
There was a problem hiding this comment.
Maybe we need to change the option name
There was a problem hiding this comment.
Be tempted to simply say API requests as the output is a combination of information. You have signup etc as well.
In that light I think *logAPIRequests might be better. I'm not that bothered about name.
|
|
||
| * **logLevel**: By default this is `.off`, *Syslog* logging levels are supported. | ||
| * **logHttpRequest**: Log Auth0.swift network requests. By default this is `false` | ||
| * **loggerOutput**: Specify output hander, by default this uses the `print` statement. |
| } | ||
| ``` | ||
|
|
||
| ## Lock options |
2 participants
No description provided.