账号查看当前身份

账号

查看当前身份

描述调用所用的令牌:类型、应用、代表的用户、Workspace、scope、模式和过期时间。任何有效令牌都能读取。

GEThttps://api.sofia-post.com/api/v1/me
GET/v1/me
curl -X GET 'https://api.sofia-post.com/api/v1/me' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

授权

  • Authorizationstring必填

    你的个人密钥或 OAuth 访问令牌,以 Bearer <token> 发送。

响应

200application/json

调用所用令牌的身份和 scope。

  • tokenTypestring必填

    令牌类型:personal_key、authorization_code 或 client_credentials

    允许的值: personal_keyauthorization_codeclient_credentials

  • applicationobject必填

    令牌背后的应用

    显示子属性
    • idstring必填

      应用的标识符(或个人密钥的标识符)

    • clientIdstring必填

      应用的 client_id

    • namestring必填

      应用的名称

  • userobject必填

    令牌所代表的用户

    显示子属性
    • idstring必填

      令牌所代表的用户:密钥的创建者,或授予同意的人

  • coveragestring必填

    workspace:一个 Workspace;account:密钥创建者所属的全部 Workspace

    允许的值: workspaceaccount

  • workspacesobject[]必填

    令牌当前可操作的范围

    显示子属性
    • idstring必填

      Workspace 的标识符

    • namestring必填

      以其活跃门店命名

  • scopesstring[]必填

    令牌持有的 scope

  • modestring必填

    test 或 live

    允许的值: testlive

  • expiresAtstring<date-time>

    令牌的过期时间;无过期时间的密钥不出现

4XXapplication/json

其他任何错误,以错误结构返回。