文档首页/ 应用身份管理服务 OneAccess/ API参考/ API/ 管理类接口/ 访问凭据/ 获取访问凭据
更新时间：2024-08-30 GMT+08:00
查看PDF
分享

获取访问凭据

功能介绍

获取应用的API访问凭据。Token的有效期默认为30分钟，可在管理门户-设置-服务配置-API认证配置中设置过期时间修改。建议进行缓存，避免频繁调用。使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。重新获取Token，不影响已有Token有效性。

接口约束

无

URI

POST /api/v2/tenant/token

请求参数

表1 FormData参数

参数

是否必选

参数类型

描述

grant_type

是

String

授权类型，固定值：client_credentials。

client_id

是

String

应用标识，注册应用后，分配的ClientId。

client_secret

是

String

应用密钥，注册应用后，分配的ClientSecret。

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

access_token

String

认证凭据，用于调用管理API。

token_type

String

认证凭据类型。固定值：Bearer。

expires_in

Integer

过期时间。单位为秒，默认1800s。

scope

String

获取的Access Token授权访问范围。

id_token

String

授权访问id_token。

状态码： 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误编号。

error_msg

String

错误详情。

请求示例

获取凭据，根据应用的clientid以及clientsecret获取接口鉴权token。

POST https://{domain_name}/api/v2/tenant/token

Content-Type: application/x-www-form-urlencoded

client_id=ONtQq2igSggfFClyGgzmuXR8ubWEP...&
client_secret=XdqUmJpG19hNEHz3472XsPcwvfe...&
grant_type=client_credentials

响应示例

状态码： 200

请求成功。

{
  "access_token" : "334******140",
  "token_type" : "Bearer",
  "expires_in" : 1719,
  "scope" : "all",
  "id_token" : "ey******Is.ey******Yo.EL******YW"
}

状态码

状态码

描述

200

请求成功。

400

参数无效。

错误码

请参见错误码。

父主题： 访问凭据

相关文档