Skip to content

Commit 3baaab0

Browse files
authored
PAS-546 | Add concept entry about Credential Hints (#142)
1 parent dec4340 commit 3baaab0

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

src/guide/admin-console/applications.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@ You should now be able to call `https://v4.passwordless.dev/magic-links/send` to
5353

5454
### Authentication Configurations
5555

56-
Authentication Configurations allow you to fine tune the tokens being used through the `signin` or `stepup` client methods. The two default purposes are `sign-in` and `step-up`. You can configure the TTL on each of them and change the User Verification requirement. However, they cannot be deleted.
56+
Authentication Configurations allow you to fine tune the tokens being used through the `signin` or `stepup` client methods. The two default purposes are `sign-in` and `step-up`, and they cannot be deleted. You can create additional configurations to suit your needs and pass through the purposes through the `stepup()` client method.
5757

58-
You can create additional configurations to suit your needs and pass through the purposes through the `stepup()` client method.
58+
For each authentication configuration, including the built-in ones, you can configure the TTL on each of them, change the User Verification requirement, and modify some other options.

src/guide/concepts.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,24 @@ The relying party can use the attestation information to make informed decisions
115115

116116
### Authentication Configurations
117117

118-
Authentication configurations allow you to configure your authentication token used in the `signin()` and `stepup()` client methods. Each method passes parameters into the authenticator accessed by the browser. Authentication Configurations allow for the Time to Live of the authentication token and the User Verification Requirement setting to be set for the given authentication workflow.
118+
Authentication configurations allow you to configure your authentication token used in the `signin()` and `stepup()` client methods. Each method passes parameters into the authenticator accessed by the browser. Authentication Configurations allow for the Time to Live of the authentication token and the User Verification Requirement setting to be set for the given authentication workflow. There are also other options available for configuration.
119119

120120
There are two default Authentication Configurations for each application, `step-up` and `sign-in`. They are used in their respective client methods as the `purpose` of the authentication. They can be edited, and if deleted, they will revert back to their default settings. Authentication Configurations can be accessed via the [API](./api.md#auth-configs) or [Admin Console](./admin-console/applications.md#authentication-configurations).
121121

122+
### Credential Hints
123+
124+
When performing a sign-in operation, the Passwordless.dev API can provide hints to the user agent for how best to authenticate the user. These hints are not requirements and the user agent retains the liberty to choose how to react to them.
125+
126+
The following hints are available:
127+
128+
- `SecurityKey` - the user agent should use a security key for authentication.
129+
- `ClientDevice` - the user agent should use the device's built-in authenticator for authentication.
130+
- `Hybrid` - the user agent should use a general-purpose authenticator for authentication, such as a smartphone.
131+
132+
Credential hints can be combined in an ordered list to provide the user agent with a preference for how to authenticate the user. The user agent should use the first hint in the list that it can satisfy.
133+
134+
In Passwordless.dev, credential hints are configured as part of an [authentication configuration](#authentication-configurations).
135+
122136
## More terms
123137

124138
### Relying party

0 commit comments

Comments
 (0)