Jump to

• Request
• Response

Revoke Refresh Token

post

/oauth2/v1/revoke

Request

Supported Media Types

• application/x-www-form-urlencoded

Header Parameters

• Authorization: string
  Basic Authorization. Base64 encoding of client credentials

Body ()

Root Schema : schema

Type: object

Show Source

• token: string
  Refresh Token

  Example: eyJ4NXQiOiI4Wk5NMEFfNWFuSTc0dGp3Y3FWcWtMN3Z0Q2ciLCJraWQiOiJwcml2YWVrZXkxIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI1YzA4NDcyMi03Njk3LTQ2NzgtOWVmNC01ZDMxYjg5MjgzYTMiLCJhdWQiOiI1YzA4NDcyMi03Njk3LTQ2NzgtOWVmNC01ZDMxYjg5MjgzYTMiLCJuYmYiOjE0NDA3NTk0MDgsInNjb3BlIjoiQUNNRUNhbmRpZGF0ZVByb2ZpbGVTZXJ2aWNlLnJlc3VtZXNfbW9udGhzIG9mZmxpbmVfYWNjZXNzIiwiaXNzIjoiaWRjcy5vcmFjbGUuY29tIiwiZXhwIjoxNDQwOTc1NDA4LCJpYXQiOjE0NDA3NTk0MDgsInRlbmFudCI6IlRFTkFOVDEiLCJqdGkiOiIwNGQwZDcyYi1iMDZmLTQ5YzItOGZkZi00ZjliYTllOTMxNGYifQ.AQfGzQ9Qe6RgQqwr_V1z2Nl3N7NG5qsy-lMNIMto8xvKAxyQcEVQ_IN6dPZZtJ90uNr8Y1eavtGmaFIcY4KVwg

{
    "type":"object",
    "properties":{
        "token":{
            "description":"Refresh Token",
            "type":"string",
            "example":"eyJ4NXQiOiI4Wk5NMEFfNWFuSTc0dGp3Y3FWcWtMN3Z0Q2ciLCJraWQiOiJwcml2YWVrZXkxIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI1YzA4NDcyMi03Njk3LTQ2NzgtOWVmNC01ZDMxYjg5MjgzYTMiLCJhdWQiOiI1YzA4NDcyMi03Njk3LTQ2NzgtOWVmNC01ZDMxYjg5MjgzYTMiLCJuYmYiOjE0NDA3NTk0MDgsInNjb3BlIjoiQUNNRUNhbmRpZGF0ZVByb2ZpbGVTZXJ2aWNlLnJlc3VtZXNfbW9udGhzIG9mZmxpbmVfYWNjZXNzIiwiaXNzIjoiaWRjcy5vcmFjbGUuY29tIiwiZXhwIjoxNDQwOTc1NDA4LCJpYXQiOjE0NDA3NTk0MDgsInRlbmFudCI6IlRFTkFOVDEiLCJqdGkiOiIwNGQwZDcyYi1iMDZmLTQ5YzItOGZkZi00ZjliYTllOTMxNGYifQ.AQfGzQ9Qe6RgQqwr_V1z2Nl3N7NG5qsy-lMNIMto8xvKAxyQcEVQ_IN6dPZZtJ90uNr8Y1eavtGmaFIcY4KVwg"
        }
    },
    "required":[
        "token"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Refresh Token revoked

400 Response

Invalid request

Body ()

Root Schema : error

Type: object

Error message that appears during Access Token generation

Show Source

• error: string
  Error values that are based on the OAuth specification
• error_description: string
  Detailed error messages

{
    "description":"Error message that appears during Access Token generation",
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error values that are based on the OAuth specification"
        },
        "error_description":{
            "type":"string",
            "description":"Detailed error messages"
        }
    },
    "required":[
        "error",
        "error_description"
    ]
}

401 Response

Invalid client

Body ()

Root Schema : error

Type: object

Error message that appears during Access Token generation

Show Source

• error: string
  Error values that are based on the OAuth specification
• error_description: string
  Detailed error messages

{
    "description":"Error message that appears during Access Token generation",
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error values that are based on the OAuth specification"
        },
        "error_description":{
            "type":"string",
            "description":"Detailed error messages"
        }
    },
    "required":[
        "error",
        "error_description"
    ]
}

Back to Top