NIP-97: add redirect URL

This commit is contained in:
Semisol 2024-04-29 23:52:43 +03:00 committed by GitHub
parent ac6909c062
commit d9774ae961
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

10
97.md
View File

@ -24,10 +24,18 @@ The response MUST be a JSON object, with the format:
```json
{
"status": <"success" or "error">,
"message": <OPTIONAL string message to show user in the case of an error>
"message": <OPTIONAL string message to show user in the case of an error>,
"redirect_url": <OPTIONAL redirect URL>
}
```
For `redirect_url`, this should be used to bring the user to where they were while initiating the login process (now with the login complete).
This should be used in a way that is compatible with a different device being used to authorize the sign in than the one being logged in on.
An example for this is checking if the sign in was attempted from this device with a cookie, if so, redirect the user to where wanted to log in,
otherwise show a "continue on device" message.
The `redirect_url` SHOULD be shown to the user and in a way that indicates it will take the user back to the app, such as `Return to website`.
HTTPS should always be used except for `.onion` services, which should be contacted using HTTP.
Clients MAY or MAY NOT decide to implement support for `.onion` services.