habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

stages/authenticator_sms: verify-only (#3011)

Browse Source
This commit is contained in:
Jens L
2022-06-01 23:16:28 +02:00
committed by GitHub
parent fc1c1a849a
commit c0cb891078
22 changed files with 372 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
website/docs/flow/stages/authenticator_sms/index.md
View File

@ -4,7 +4,9 @@ title: SMS authenticator setup stage
This stage configures an SMS-based authenticator using either Twilio, or a generic HTTP endpoint.
## Twilio
## Providers
#### Twilio
Navigate to https://console.twilio.com/, and log in to your existing account, or create a new one.
@ -22,7 +24,7 @@ Afterwards, copy the value of **Messaging Service SID**. This is the value for t
Navigate back to the root of your Twilio console, and copy the Auth token. This is the value for the _Twilio Auth Token_ field in authentik.
## Generic
#### Generic
For the generic provider, a POST request will be sent to the URL you have specified in the _External API URL_ field. The request payload looks like this
@ -35,3 +37,11 @@ For the generic provider, a POST request will be sent to the URL you have specif
```
Authentication can either be done as HTTP Basic, or via a Bearer Token. Any response with status 400 or above is counted as failed, and will prevent the user from proceeding.
## Verify only
:::info
Requires authentik 2022.6
:::
To only verify the validity of a users' phone number, without saving it in an easily accessible way, you can enable this option. Phone numbers from devices enrolled through this stage will only have their hashed phone number saved. These devices can also not be used with the [Authenticator validation](../authenticator_validate/) stage.