Sign In By Email/Phone/Username

POST 
/auth/v1/signin

错误处理：invalid_password: 密码不正确 user_pending: 用户未激活 user_blocked: 用户被禁用 invalid_argument: 参数不正确, 请检查SDK参数是否不足或不合法 permission_denied client id 缺少scope为user 的权限 invalid_status: 该用户输错密码的次数过多, 请稍后重试 not_found 用户不存在 invalid_status 用户输入密码已经超过频次限制 phone_required 用户需要通过手机验证码完成登录 captcha_required: 需要接入验证码

Request

application/json

Body

required

username string
password password 密码 (string)
verification_token 通过手机验证码登录: 验证码TOKEN (string)
provider_token 登录时绑定三方账号 (string)
public_key_thumbprint 数据加密的 (string)
params 加密的数据 (string)

Responses

200

A successful response.

application/json

Schema

Schema

token_type string
access_token string
refresh_token string
id_token string
expires_in int32
scope string
sub string
groups string[]
need_weda_resource boolean

Example (from schema)

{
  "token_type": "string",
  "access_token": "string",
  "refresh_token": "string",
  "id_token": "string",
  "expires_in": 0,
  "scope": "string",
  "sub": "string",
  "groups": [
    "string"
  ],
  "need_weda_resource": true
}

401

the oauth2.0 access token is not correct or expired

application/json

Schema

Schema

any

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...