用户名密码模式
请求说明
请求方式:POST
请求地址:https://{your_domain}/api/v1/authorize/{app_code}/oauth2/token
请求头
参数名 | 中文名称 | 必须 | 示例值 | 描述 |
---|---|---|---|---|
Authorization | 认证信息 | 是 | Basic MTk4MzhkOTc0ZTM= | 使用client_id和client_secret进行basic64认证,格式为: base64(client_id:client_secret)。 |
Content-Type | 数据类型 | 是 | application/x-www-form-urlencoded | 使用表单方式提交参数。 |
请求示例
POST https://{your_domain}/api/v1/oauth2/token
Authorization: Basic MmJhZTg3ZDx....GUxYmIzYc0ZTM=
Content-Type: application/x-www-form-urlencoded
grant_type=password&username=smallbun&password=v8Wrly4VDQJxCBic
请求参数
参数名 | 中文名称 | 必须 | 示例值 | 描述 |
---|---|---|---|---|
grant_type | 授权类型 | 是 | password | 此值固定为 password。 |
username | 登录名 | 是 | smallbun | 用户名/手机号/邮箱。 |
password | 密码 | 是 | v8Wrly4VDQJxCBic | 密码。 |
scope | 授权范围 | 否 | openid profile | 授权范围。 |
响应参数
参数名 | 中文名称 | 必须 | 示例值 | 描述 |
---|---|---|---|---|
access_token | 授权令牌 | 是 | 5Vy9tHWsp6xORfDaTVJ49_qtFZ6wXSy | 授权服务器返回给第三方应用的授权令牌。 |
expires_in | 授权令牌的有效期 | 是 | 21599 | 授权服务器返回给应用的访问票据的有效期。注意:有效期以秒为单位。 |
refresh_token | 刷新令牌 | 是 | Su9TAyeB2igIjQD07s81BeycRQ0dppyHuc | 授权服务器返回给第三方应用的刷新令牌。 |
token_type | 令牌类型 | 是 | Bearer | 始终为 Bearer。 |
scope | 授权范围 | 是 | openid profile | |
id_token | 用户令牌 | 是 | eyJraWQiOiIxMTISlh...H2UOrwiXF9CUKm1Zbe-j1 |
响应示例
成功
{
"access_token": "5Vy9tHWsp6xORfDaTVJ49_qtFZ6wXSy",
"refresh_token": "Su9TAyeB2igIjQD07s81BeycRQ0dppyHuc",
"scope": "openid profile",
"id_token": "eyJraWQiOiIxMTISlh...H2UOrwiXF9CUKm1Zbe-j1",
"token_type": "Bearer",
"expires_in": 21599
}
客户端未认证
{
"error_description": "Full authentication is required to access this resource",
"error": "access_denied",
"error_uri": "https://topiam.cn/docs/application/oidc/faq/#错误码"
}
grant_type 错误
{
"error_description": "OAuth 2.0 Parameter: grant_type",
"error": "unsupported_grant_type",
"error_uri": "https://topiam.cn/docs/application/oidc/faq/#错误码"
}
client_id 或 client_secret 错误
{
"error_description": "Client authentication failed. Either the client or the client credentials are invalid.",
"error": "invalid_client",
"error_uri": "https://topiam.cn/docs/application/oidc/faq/#错误码"
}