权限相关接口--客户数据平台（私有化）-火山引擎

文档中心

导航

客户数据平台（私有化）

权限相关接口

最近更新时间：2024.07.11 17:32:54首次发布时间：2023.11.21 17:50:00

1. 获取用户临时Token

基本信息

生效版本	1.21
功能描述	获取代表用户身份的临时Token（ak、sk、session_token)，用于在openapi请求时以相关用户身份访问接口
接口模块	CdpApi
接口名称	GetUserToken
请求类型	GET

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-10-19
duration_seconds	int32	是	临时Token的有效期，单位为秒（最长不超过43200秒）
account	String	是	用户在CDP的账号名称

注意

如果是通过sso打通，业务系统会根据一定的规则在CDP底座创建对应的账号。可以咨询CDP底座oncall了解相关映射规则后，基于映射规则，将业务系统的账号映射为cdp的账号作为account入参，获取用户临时Token。

Body

无
响应样例

成功

{
    "code": 0,
    "message": "",
    "msg": "success",
    "data": {
        "current_time": "2023-10-18T14:13:13.825+08:00",
        "expired_time": "2023-10-18T14:14:53.825+08:00",
        "access_key": "BDPPc362a106f2060d0a0f59e7b839357555",
        "secret_key": "0d6e37c302af740bbe8d1c9a22b2d8e94063f7218606de329e632a4ffcc4b25a",
        "session_token": "STSeyJhdXRoX29iamVjdF9pZCI6MywiYWNjZXNzX2tleV9pZCI6IkJEUFBjMzYyYTEwNmYyMDYwZDBhMGY1OWU3YjgzOTM1NzU1NSIsInNpZ25lZF9zZWNyZXRfYWNjZXNzX2tleSI6IjBkNmUzN2MzMDJhZjc0MGJiZThkMWM5YTIyYjJkOGU5NDA2M2Y3MjE4NjA2ZGUzMjllNjMyYTRmZmNjNGIyNWEiLCJjdXJyZW50X3RpbWUiOiIyMDIzLTEwLTE4VDE0OjEzOjEzLjgyNSswODowMCIsImV4cGlyZWRfdGltZSI6IjIwMjMtMTAtMThUMTQ6MTQ6NTMuODI1KzA4OjAwIiwiYXV0aG9yaXplZF9wcm9qZWN0X2lkcyI6W10sImFjY291bnQiOiJhZG1pbiIsInNpZ25hdHVyZSI6IjMwNDQwMjIwMjFkOWEyZmVkNjYwMTBhYjM2YTdlZjIyMzI0Y2FlOGI5ZDI1NTZiYmJmZmVlMzFmODA4Mjk3ODY4ZDdmOGZhNjAyMjAyM2E4OWE4MTE0ZWU3NTVlNzJjODQzOWE5NDk5ZTcwMTExZWFmYjg4YWRiODQ5NzAzYmUwYTRkMjY2NGZjYjAzIn0="
    }
}

失败

// Token有效期超出限制范围
{
    "msg": "Sts token request timeout overflows, current duration is 1,001,111s.",
    "code": 1130040010128
}

// 使用AccessKey需为集团设置中创建的应用的AccessKey
{
    "msg": "Cannot find open api app by id: [BDPPad1def378c00b79ed2c685fef0b0a1a11].",
    "code": 1130040410124
}

// account对应的用户在cdp中不存在/已删除/已停用
{
    "msg": "Authorization object does not exist, type is [user], business_id is: [adminzx].",
    "code": 1130040410110
}

注意

可通过该接口获得的临时 access_key，secret_key，session_token 可以作为临时凭证，通过 SDK 访问 OpenAPI，详情见 SDK 使用

2. 上传用户标识

基本信息

生效版本	1.22
功能描述	上传用户标识, 支持多个用户, 多个标识设置
接口模块	openapi
接口名称（ApiAction）	UserAttributeUpload
接口版本（ApiVersion）	2024-01-25
请求类型	PUT

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	Number	是	项目ID

请求体

Auth_UserAttributeUploadRequest

名称	数据类型	是否必选	描述
user_attributes	Array	否	用户标识信息

响应结果

CommonResponseInteger

名称	数据类型	描述
msg	String	接口返回信息
code	Number	状态码，0表示正常
data	String	操作成功返回ok