取消授权

2024-08-08 04:19

POST /v1/authorizations/revoke

使用此接口取消用户对商户的授权。Antom 收到撤销请求后，访问令牌将失效，商户无法再使用该访问令牌访问用户资源的作用域。此外，商户也无法使用相关的刷新令牌获取新的访问令牌。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息，有关报文头的结构信息，请参阅：

注意：将每个字段（除数组外）的数据类型设置为字符串。这意味字段值必须使用双引号（" "）括起来。例如：

如果字段的数据类型为整数属性，且其值为 20，设置为 "20"。
如果字段的数据类型为布尔属性，且其值为 true，设置为 "true"。

入参

accessToken String REQUIRED

用于访问用户资源相应作用域的访问令牌。

更多信息：

最大长度：128 字符

出参

result Result object REQUIRED

表示此接口是否调用成功。如果接口调用成功，授权将成功取消。

Show child parameters

API Explorer

示例代码沙箱运行

请求

URL

请求体

响应

Case

Success

响应体

结果处理逻辑

对于不同的请求结果，需要执行不同的操作。详情如下：

如果 result.resultStatus 的值为S，授权已成功取消。访问令牌不能再用于访问用户的资源。此外，相关的 refreshToken 也不能再用于更新 accessToken。
如果 result.resultStatus 的值为F，发生了系统缺陷或系统故障。建议人工检查系统，并根据结果代码采取相应行动。
如果 result.resultStatus 的值为U，此接口的调用状态未知。通过再次调用此接口来重试过程。

结果码

结果码	值	结果码信息	行动建议
SUCCESS	S	成功	撤销成功。访问令牌已失效。
ACCESS_DENIED	F	访问被拒绝。	请联系 Antom 技术支持以获取详细原因。
CLIENT_FORBIDDEN_ACCESS_API	F	客户端无权使用此接口。	请联系 Antom 技术支持以获取详细原因。
INVALID_ACCESS_TOKEN	F	访问令牌已过期、被撤销或不存在。	请检查 accessToken 是否正确。如果不正确，请传入正确的值。如果正确，请联系 Antom 技术支持以获取详细原因。
INVALID_API	F	调用的接口无效或未激活。	请联系 Antom 技术支持来解决问题。
INVALID_CLIENT_STATUS	F	客户端状态无效。	请联系 Antom 技术支持以获取详细原因。
INVALID_SIGNATURE	F	签名验证失败。用于签署请求的私钥与 Antom Dashboard 的公钥不匹配。	检查用于签署请求的私钥是否与 Antom Dashboard 的公钥匹配。以下签名参考信息很有用：请求头中的签名字段如何生成签名
KEY_NOT_FOUND	F	未找到 Antom 或商户的私钥或公钥。	检查私钥或公钥是否存在。如果不存在，请在 Antom Dashboard 中上传私钥。
NO_INTERFACE_DEF	F	接口未定义。	检查链接是否正确。请参考接口文档中的端点。
OAUTH_FAILED	F	OAuth 授权流程失败。	请联系 Antom 技术支持以获取详细原因。
PARAM_ILLEGAL	F	缺少必需的参数，或者存在非法参数。例如，非数字输入，无效的日期，或者参数的长度和类型错误。	检查并验证当前接口所需的请求字段（包括头字段和正文字段）是否正确传递并有效。
PROCESS_FAIL	F	发生了常见的业务失败。	获取 Antom 技术支持前请勿重试。
SYSTEM_ERROR	F	发生了系统错误。	获取 Antom 技术支持前请勿重试。
UNKNOWN_CLIENT	F	客户端未知。	请联系 Antom 技术支持以获取详细原因。
REQUEST_TRAFFIC_EXCEED_LIMIT	U	请求流量超过了限制。	再次调用接口以解决问题。如果未解决，请联系 Antom 技术支持。
UNKNOWN_EXCEPTION	U	由于未知原因，接口调用失败。	再次调用接口以解决问题。如果未解决，请联系 Antom 技术支持。