---
swagger: "2.0"
info:
  title: Revoke Token
  description: The revoke token resource
  version: 1.0.0-rev1
  x-ibm-name: revoke-token
basePath: /api
schemes:
- https
x-ibm-configuration:
  enforced: true
  phase: realized
  testable: false
  externalDocs: []
  attachments: []
tags: []
definitions:
  RevokeTokenResponse:
    properties:
      status:
        type: string
        description: The status of the token revocation request.
        example: success
  ErrorResponse:
    properties:
      error:
        type: string
        enum:
        - invalid_request
        - unauthorized_client
        - access_denied
        - unsupported_response_type
        - invalid_scope
        - server_error
        - temporarily_unavailable
        - unsupported_token_type
        description: If the request fails due to a missing, invalid, or mismatching
          redirection URI, or if the client identifier is missing or invalid, the
          authorization server SHOULD inform the resource owner of the error and MUST
          NOT automatically redirect the user-agent to the invalid redirection URI.
      error_description:
        type: string
        description: Human-readable ASCII [USASCII] text providing additional information,
          used to assist the client developer in understanding the error that occurred
      error_uri:
        type: string
        description: A URI identifying a human-readable web page with information
          about the error, used to provide the client developer with additional information
          about the error.
    required:
    - error
securityDefinitions:
  Client_Id:
    type: apiKey
    name: X-IBM-Client-Id
    in: header
    description: ""
  Client_Id (Query):
    type: apiKey
    name: client_id
    in: query
    description: ""
  Client_Secret:
    type: apiKey
    name: X-IBM-Client-Secret
    in: header
    description: ""
  Client_Secret (Query):
    type: apiKey
    name: client_secret
    in: query
    description: ""
paths:
  /password/oauth2/revoke:
    post:
      description: The token revoke call requires the resource owner to pass the valid
        client credentails, a valid token and the token type as inputs. The inputs
        are validated by the authorization server and after successful validation
        the token is tagged as revoked. If you pass access Token in the request, the
        corresponding refresh token will also be revoked and vice-versa. The tokens
        are marked invalid after revocation is successful.
      tags:
      - Authorization Code Grant – Revoke Token Endpoint
      summary: Revoke access
      parameters:
      - description: 'HTTP Basic authentication by passing base64 encoded value of
          the client id and client secret separated by colon (:).Example: Base64(client_id:client_secret)
          will be passed as Basic KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ=='
        name: Authorization
        type: string
        required: true
        in: header
      - description: Content type. Value is application/x-www-form-urlencoded
        name: Content-Type
        type: string
        required: true
        in: header
      - schema: []
        description: ""
        name: body
        in: body
      responses:
        200:
          description: The request has succeeded
          schema:
            $ref: '#/definitions/RevokeTokenResponse'
        400:
          description: ' <table><tr><td>error</td></tr> <tr><td>invalid_request</td></tr>             <tr><td>invalid_grant</td></tr><tr><td>unauthorized_client</td></tr><tr><td>unsupported_grant_type</td></tr></table>'
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: ' <table><tr><td>error</td></tr><tr><td>invalid_client</td></tr>
            </table>'
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: server_error
      security:
      - Client_Id (Query): []
        Client_Secret (Query): []
      - Client_Id: []
        Client_Secret (Query): []
      - Client_Id (Query): []
        Client_Secret: []
      - Client_Id: []
        Client_Secret: []
security:
- Client_Id (Query): []
  Client_Secret (Query): []
- Client_Id: []
  Client_Secret (Query): []
- Client_Id (Query): []
  Client_Secret: []
- Client_Id: []
  Client_Secret: []
x-ibm-endpoints:
- endpointUrl: https://aspac.sandbox.api.citi.com/gcbap
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...