文档API 参考

Rust · 0.1.0

SignInResponse

应用协议结构。字段名称及继承的描述保留原始语言。

此结构在哪里使用

以下链接根据协议快照中的直接引用生成。认证、可写字段和运行行为应以调用操作为准;可复用资源结构本身并不是完整的写入请求。

结构与字段

object

字段类型 / 是否必需描述
userallOf
User
The authenticated user's information.
accessTokenstringThe short-lived access token for API requests. Store in memory only, not in localStorage.
accessTokenExpiresAtstring (date-time)When the access token expires. Client should call RefreshToken before this time.

完整结构

约束与嵌套结构请以这份完整 JSON 定义为准。字段出现在这里,并不意味着每位调用者都能修改它。

{
  "type": "object",
  "properties": {
    "user": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "description": "The authenticated user's information."
    },
    "accessToken": {
      "type": "string",
      "description": "The short-lived access token for API requests.\n Store in memory only, not in localStorage."
    },
    "accessTokenExpiresAt": {
      "type": "string",
      "description": "When the access token expires.\n Client should call RefreshToken before this time.",
      "format": "date-time"
    }
  }
}