匿名登录
POST/auth/v1/signin/anonymously
接口说明
匿名登录接口,同一个设备ID最多只能注册一个匿名用户,生成匿名用户的access_token
入参要求:
x-device-id: 设备id(必填,请求头中传入)client_id: 应用对应的客户端id(可选,默认为环境id)
前置条件:
- 同一个设备ID只能注册一个匿名用户
- 设备ID需要客户端随机生成并缓存
出参:
- 返回标准的token响应(access_token、refresh_token等)
- scope为"anonymous",表示匿名用户
匿名登录请求示例
POST /auth/v1/signin/anonymously
x-device-id: device_123456
Content-Type: application/json
{}
匿名登录响应示例
{
"token_type": "Bearer",
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ",
"expires_in": 7200,
"scope": "anonymous",
"sub": "7ft9WRremXrz-TfgoAR9Uw"
}
关键特性:
- 同一个设备ID只能生成一个匿名用户
- 匿名用户没有用户名、密码等个人信息
- 适合临时使用或体验功能的场景
- 可以通过绑定其他登录方式升级为正式用户
Request
Query Parameters
client_id string
应用对应的客户端id,可从云开发平台-->身份认证-->开发设置获取。默认为环境id,可以不传
Header Parameters
x-device-id stringrequired
匿名登录时必填。设备id,当前登录设备的id。客户端应随机生成,并缓存到客户端。此参数在匿名登录时用于计算用户id,未缓存会导致匿名用户再次登录,用户id发生变化
- application/json
Body
object
Responses
- 200
- 400
- 403
- 500
A successful response.
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
token_type 访问令牌类型 (string)
统一返回 Bearer
access_token 用户的访问令牌 (string)
用于访问云开发HTTP API的令牌,长度4096位以内
refresh_token 用户的刷新令牌 (string)
access_token过期可通过refresh_token刷新获取新的access_token,过期时间默认为31天。长度128位以内
expires_in int32
access_token的过期时间,单位为秒
scope 授权范围 (string)
sub 用户的唯一id (string)
groups string[]
{
"token_type": "string",
"access_token": "string",
"refresh_token": "string",
"expires_in": 0,
"scope": "string",
"sub": "string",
"groups": [
"string"
]
}
{
"token_type": "Bearer",
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5leGFtcGxlLmNvbSIsInN1YiI6Ijk4NzY1NDMyMTAxMjM0NTY3ODkiLCJhdWQiOiJkZW1vLWFwcC0yZjhhOWMzZTFiNGQiLCJleHAiOjE3MzQ2NzU4ODksImlhdCI6MTczNDY2ODY4OSwic2NvcGUiOiJ1c2VyIn0.dGhpc19pc19hX2Zha2Vfc2lnbmF0dXJlX2Zvcl9leGFtcGxlX3B1cnBvc2VzX29ubHlfZG9fbm90X3VzZV9pbl9wcm9kdWN0aW9uX2Vudmlyb25tZW50X3RoaXNfaXNfbm90X3JlYWxfdG9rZW5fZGF0YQ",
"expires_in": 7200,
"scope": "anonymous",
"sub": "7ft9WRremXrz-TfgoAR9Uw"
}
- invalid_argument请在请求头添加设备id,x-device-id在Header中未传入
- unimplemented请联系管理员开启匿名登录,匿名登录未开启,前往云开发平台开启
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
object
{}
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
object
{}
{
"error": "permission_denied",
"error_code": 7,
"error_description": "cors permission denied, please check if demo-app-3g4h5i6j7k8l-9876543210.example.com in your client XyZ9aB1cD2eF3gH4iJ5 domains"
}
An unexpected error response.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
error 错误信息 (string)
error_code int32
error_description 错误描述 (string)
{
"error": "string",
"error_code": 0,
"error_description": "string"
}
Loading...