postRevoke a refresh token

Authentication: This endpoint does not require a bearer token.

Ends the session of a refresh token (RFC 7009), as on sign-out: every refresh token of that session stops working. Answers 200 with an empty object for any well-formed request, whether or not the token is known, so the endpoint does not reveal which tokens exist. An access token is accepted and ignored: it stays valid until its exp. token_type_hint is optional; any value is accepted and ignored. A body without token is a 400 invalid_request. Refusals use the same {error, error_description} body as /oauth/token, with Cache-Control: no-store.

Request

Required request body.

Request body schema

Field Type Required Description and constraints
token string Yes minLength: 1
token_type_hint string No

Additional fields are not accepted.

Request URL

POST
POST /oauth/revoke

Request Body

application/json
{
  "token": "yhrt_0000000000000000000000000000000000000000001",
  "token_type_hint": "refresh_token"
}

Responses

Response

application/json
{}

Operation succeeded.

Response 200 schema

Content type: application/json.

application/json body

Type: object. No additional fields

Response 400 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
error "invalid_request" / "invalid_client" / "invalid_grant" / "unsupported_grant_type" / "temporarily_unavailable" / "server_error" Yes
error_description string Yes

Additional fields are not accepted.

Response 401 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
error "invalid_request" / "invalid_client" / "invalid_grant" / "unsupported_grant_type" / "temporarily_unavailable" / "server_error" Yes
error_description string Yes

Additional fields are not accepted.

Response 500 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
error "invalid_request" / "invalid_client" / "invalid_grant" / "unsupported_grant_type" / "temporarily_unavailable" / "server_error" Yes
error_description string Yes

Additional fields are not accepted.

Response 503 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
error "invalid_request" / "invalid_client" / "invalid_grant" / "unsupported_grant_type" / "temporarily_unavailable" / "server_error" Yes
error_description string Yes

Additional fields are not accepted.