Skip to content

End the refresh token's session

POST
/v1/auth/sign-out
curl --request POST \
--url https://example.com/v1/auth/sign-out \
--header 'Content-Type: application/json' \
--data '{ "refresh_token": "example" }'

Who: anyone.

Media typeapplication/json
object
refresh_token
required
string

Example generated

{
"refresh_token": "example"
}

Done; no body

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"
}
}