OAuth签发访问令牌
返回 Sofia

OAuth

签发访问令牌

client_credentials、authorization_code、refresh_token 可换取 3600 秒有效的令牌。

POSThttps://api.sofia-post.com/api/v1/oauth/token

请求体

application/x-www-form-urlencoded, application/json

  • grant_typestring必填

    要交换的授权类型：client_credentials、authorization_code 或 refresh_token

    允许的值： client_credentialsauthorization_coderefresh_token

  • client_idstring必填

    客户端应用的标识符

  • client_secretstring

    保密客户端的密钥（client_secret_post），或放在 Authorization: Basic 标头中（client_secret_basic），不可同时使用；公开客户端无需提供

  • scopestring

    申请的 scope，以空格分隔；省略则为该授权的全部 scope

  • workspace_idstring

    令牌所操作的 Workspace：在 client_credentials 下应用有多个时必填，只有一个时可选

  • codestring

    authorization_code：在重定向地址收到的授权码

  • code_verifierstring

    authorization_code：PKCE 验证码（RFC 7636）

  • redirect_uristring

    authorization_code：与授权时相同的重定向地址

  • refresh_tokenstring

    refresh_token：刷新令牌，仅可使用一次

响应

200application/json

访问令牌；只有授予了 offline_access 才会包含 refresh_token。

  • access_tokenstring必填

    不透明的访问令牌

  • token_typestring必填

    始终为 Bearer

    允许的值： Bearer

  • expires_innumber必填

    有效期，单位为秒

  • scopestring必填

    已授予的 scope，以空格分隔

  • refresh_tokenstring

    仅限 authorization_code 和 refresh_token，且已授予 offline_access：仅可使用一次，每次交换都会轮换

400

invalid_request、invalid_grant、unsupported_grant_type、invalid_scope 或 unauthorized_client。

401

invalid_client：未知客户端、密钥错误或缺失，或应用已被撤销。