Skip to content

Commit

Permalink
Updating documentation for new endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
diegosperes committed Apr 1, 2024
1 parent c8a647a commit 127729e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ services:
- "${REDIS_PORT:-8701}:6379"

mysql:
# platform: linux/x86_64
platform: linux/x86_64
image: mysql:5.7
platform: linux/amd64
ports:
Expand Down
18 changes: 9 additions & 9 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,10 @@ Visibility: Private

`DELETE /accounts/:id/oauth`

| Params | Type | Notes |
| ------------------- | ------- | --------------- |
| `id` | integer | User account Id |
| `oauth_providers` | integer | User account Id |
| Params | Type | Notes |
| ------------------- | -------------- | --------------- |
| `id` | integer | User account Id |
| `oauth_providers` | array[string] | Provider names |

#### Success:

Expand Down Expand Up @@ -655,7 +655,7 @@ Visibility: Public

| Params | Type | Notes |
| ------ | ---- | ----- |
| `providerName` | string | * google |
| `providerName` | string | google |
| `redirect_uri` | URL | Return URL after OAuth. Must be in your application's domain. |

Redirect a user to this URL when you want to authenticate them with OAuth, and include a `redirect_uri` where you want them to return when they're done. From here, a user will proceed to the OAuth provider and back to AuthN's [OAuth Return](#oauth-return) endpoint (as configured with the provider).
Expand Down Expand Up @@ -729,11 +729,11 @@ Visibility: Public

`DELETE /oauth/:providerName`

| Params | Type | Notes |
| ------ | ---- | ----- |
| `providerName` | string | * google |
| Params | Type | Notes |
| -------------- | ------ | ------ |
| `providerName` | string | google |

Delete an OAuth account from the current session. If the session was initiated via the OAuth flow, the account will be flagged to reset the password during the next sign-in attempt.
Delete an OAuth account from the current session. If the session was initiated via the OAuth flow, the endpoint will returns an error requesting user to reset password.

#### Success:

Expand Down

0 comments on commit 127729e

Please sign in to comment.