Prove your password again before a sensitive change (after 401 recent_auth_required): new tokens
POST
/v1/auth/confirm-password
const url = 'https://example.com/v1/auth/confirm-password';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"password":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/auth/confirm-password \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "password": "example" }'Who: a signed-in user, not an API key. Not for API keys.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
password
required
string
Example generated
{ "password": "example"}Responses
Section titled “Responses”OK
Media typeapplication/json
object
access_token
required
string
access_token_expires_at
required
string format: date-time
membership
required
object
account
required
object
id
integer format: int64
kind
required
string | null
account_name
required
string
created_at
required
string | null format: date-time
created_by
required
id
string
owner
required
boolean
role
required
string | null
status
required
string | null
updated_at
required
string | null format: date-time
user
Any of:
object
created_at
required
string format: date-time
created_by
required
email
required
string
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
time_zone
required
string
updated_at
required
string format: date-time
null
user_id
required
string
refresh_token
required
string
refresh_token_expires_at
required
string format: date-time
user
required
object
created_at
required
string format: date-time
created_by
required
email
required
string
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
time_zone
required
string
updated_at
required
string format: date-time
Example
{ "membership": { "account": { "kind": "network" }, "created_by": { "kind": "user" }, "role": "admin", "status": "invited", "user": { "created_by": { "kind": "user" }, "status": "invited" } }, "user": { "created_by": { "kind": "user" }, "status": "invited" }}default
Section titled “default”An error, as go-commons apperr maps it
Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string
Example generated
{ "error": { "code": "example", "fields": { "additionalProperty": "example" }, "message": "example" }}