Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Revokes an access token previously obtained. This method results in the revocation of an access token by a party such that it cannot be used by the requesting party to gain access to a service.

Excerpt
namepost token revoke
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MUST support a POST call to a /token/revoke endpoint to revoke an access token

...

Excerpt
namepost token revoke 1
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MUST validate that a POST request to a /token/revoke endpoint contains the HTTP headers as described in the table below

...

For information about the parameters that are common to trust framework’s API’s see Generic API Requirements.

Excerpt
namepost token revoke 2
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MUST validate that a POST request to a /token/revoke endpoint contains the parameters as described in the table below

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MUST validate the client credentials in the client_assertion received in a POST to a /token/revoke endpoint

...

For information about the parameters that are common to trust framework’s API’s see Generic API Requirements.

200 OK

When the access token is successfully revoked, or an invalid token is submitted, the data service provider should send an OK result.

Excerpt
namepost token revoke 3
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MUST respond with a 200 OK to a successful POST call to a /token/revoke endpoint

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MUST respond with a 200 OK to a POST call to a /token/revoke endpoint containing an invalid access token

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MUST no longer accept the revoked the access token after a 200 OK response is responded

...

Excerpt
namepost token revoke 4
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MUST include the parameters as described in the table below in the HTTP payload in a response to a failed POST request to a /token/revoke endpoint

...

Excerpt
namepost token revoke 5
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Parties MAY include a Retry-After header in the 503 response to a /token/revoke endpoint to indicate the expected unavailability of the service