Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .stainless/stainless.yml
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ resources:
methods:
create: post /auth/credentials
verify: post /auth/credentials/{id}/verify
challenge: post /auth/credentials/{id}/challenge
models:
auth_method_type: '#/components/schemas/AuthMethodType'
auth_method: '#/components/schemas/AuthMethod'
Expand Down
88 changes: 88 additions & 0 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

88 changes: 88 additions & 0 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions openapi/components/schemas/errors/Error429.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
type: object
required:
- message
- status
- code
properties:
status:
type: integer
enum:
- 429
description: HTTP status code
code:
type: string
description: |
| Error Code | Description |
|------------|-------------|
| RATE_LIMITED | Too many requests in a short window; retry after the interval indicated by the `Retry-After` response header |
enum:
- RATE_LIMITED
message:
type: string
description: Error message
details:
type: object
description: Additional error details
additionalProperties: true
2 changes: 2 additions & 0 deletions openapi/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

70 changes: 70 additions & 0 deletions openapi/paths/auth/auth_credentials_{id}_challenge.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
post:
summary: Resend an authentication credential challenge
description: >
Re-issue the challenge for an existing authentication credential.


For `EMAIL_OTP` credentials, this triggers a new one-time password email to
the address on file. After the user receives the new OTP, call
`POST /auth/credentials/{id}/verify` to complete verification and issue a
session.
operationId: challengeAuthCredential
Comment thread
DhruvPareek marked this conversation as resolved.
tags:
- Embedded Wallet Auth
security:
- BasicAuth: []
parameters:
- name: id
in: path
description: >-
The id of the authentication credential to re-challenge (the `id` field
of the `AuthMethod` returned from `POST /auth/credentials`).
required: true
schema:
type: string
responses:
'200':
description: Challenge re-issued for the authentication credential
content:
application/json:
schema:
$ref: ../../components/schemas/auth/AuthMethod.yaml
'400':
description: Bad request
content:
application/json:
schema:
$ref: ../../components/schemas/errors/Error400.yaml
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: ../../components/schemas/errors/Error401.yaml
'404':
description: Authentication credential not found
content:
application/json:
schema:
$ref: ../../components/schemas/errors/Error404.yaml
'429':
description: >-
Too many requests. Returned with `RATE_LIMITED` when challenge
re-issues are requested more frequently than the OTP rate limit
allows. Clients should back off and retry after the interval
indicated by the `Retry-After` response header.
headers:
Retry-After:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: ../../components/schemas/errors/Error429.yaml
'500':
description: Internal service error
content:
application/json:
schema:
$ref: ../../components/schemas/errors/Error500.yaml
Comment thread
pengying marked this conversation as resolved.
Loading