内容协作平台账号操作API有哪些？

URI scheme

域名 : {domainId}.auth.alicloudccp.com基础路径 : /v2协议 : HTTP, HTTPS 请求Content-Type

application/json

返回Content-Type

application/json

API

取消绑定关系

POST /v2/account/cancel_link

说明

取消绑定关系，生成新用户，返回访问令牌 Body参数

取消绑定关系

名称 : 取消绑定关系请求标志 : 必填类型 : CancelLinkRequest 响应 HTTP代码 说明 类型 200 成功 AccountAccessTokenResponse 400 参数错误 1.InvalidParameterMissingError.TemporaryToken:临时token缺失 InvalidParameterMissingError 403 无权限 ForbiddenError 500 内部错误 InternalErrorError 标签

account

HTTP请求示例 请求 path

/v2/account/cancel_link

请求 body

{
  "temporary_token" : "ey***s="
}

HTTP响应示例 响应 200

{
  "access_token" : "cnskjajkahwdhwialsnd",
  "avatar" : "cherry",
  "default_drive_id" : "100",
  "exist_link" : [ ],
  "expire_time" : "2019-09-01T06:57:48.813Z",
  "expires_in" : 3600,
  "need_link" : false,
  "nick_name" : "cherry",
  "refresh_token" : "cnskjajkahwdhwialsnd",
  "role" : "user",
  "state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
  "token_type" : "Bearer",
  "user_data" : "{ is_student: true }",
  "user_id" : "DING-xxxxx",
  "user_name" : "cherry"
}

响应 400

{
  "code" : "InvalidParameterMissing",
  "message" : "The input parameter {parameter_name} is missing."
}

响应 403

{
  "code" : "Forbidden",
  "message" : "User not authorized to operate on the specified APIs."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

确定绑定关系

POST /v2/account/confirm_link

说明

确认绑定关系, 成功后返回访问令牌 Body参数

确认绑定关系

名称 : 确定绑定关系请求标志 : 必填类型 : ConfirmLinkRequest 响应 HTTP代码 说明 类型 200 成功 AccountAccessTokenResponse 400 参数错误 1.InvalidParameterMissingError.TemporaryToken:临时token缺失 2.InvalidParameterError.TemporaryToken:临时token无效 InvalidParameterMissingError 403 无权限 ForbiddenNoPermissionError 404 资源未找到错误 1.NotFoundError.User:用户不存在 NotFoundError 500 内部错误 InternalErrorError 标签

account

HTTP请求示例 请求 path

/v2/account/confirm_link

请求 body

{
  "temporary_token" : "ey***s="
}

HTTP响应示例 响应 200

{
  "access_token" : "cnskjajkahwdhwialsnd",
  "avatar" : "cherry",
  "default_drive_id" : "100",
  "exist_link" : [ ],
  "expire_time" : "2019-09-01T06:57:48.813Z",
  "expires_in" : 3600,
  "need_link" : false,
  "nick_name" : "cherry",
  "refresh_token" : "cnskjajkahwdhwialsnd",
  "role" : "user",
  "state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
  "token_type" : "Bearer",
  "user_data" : "{ is_student: true }",
  "user_id" : "DING-xxxxx",
  "user_name" : "cherry"
}

响应 400

{
  "code" : "InvalidParameterMissing",
  "message" : "The input parameter {parameter_name} is missing."
}

响应 403

{
  "code" : "ForbiddenNoPermission",
  "message" : "No Permission to access resource {resource_name}."
}

响应 404

{
  "code" : "NotFound",
  "message" : "The resource {resource_name} cannot be found. Please check."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

修改登录密码

POST /v2/account/default/change_password

说明

修改手机登录密码，密码必须包含数字、大小写字母和特殊字符，长度10-32个字符 Body参数

修改登录密码

名称 : 修改登录密码标志 : 必填类型 : DefaultChangePasswordRequest 响应 HTTP代码 说明 类型 204 成功 无内容 400 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.PhoneNumber:phone_number缺失 3.InvalidParameterMissingError.SmsCodeId:sms_code_id缺失 4.InvalidParameterMissingError.SmsCode:sms_code缺失 5.InvalidParameterError.SmsCode:sms_code无效 6.PasswordTooSimpleError:密码太简单 InvalidParameterMissingError 403 无权限 ForbiddenError 500 内部错误 InternalErrorError 标签

account

HTTP请求示例 请求 path

/v2/account/default/change_password

请求 body

{
  "app_id" : "csaklidwasdhjwid",
  "new_password" : "123456,Abc",
  "phone_number" : "152*****341",
  "sms_code" : "1234",
  "sms_code_id" : "csjanwia"
}

HTTP响应示例 响应 400

{
  "code" : "InvalidParameterMissing",
  "message" : "The input parameter {parameter_name} is missing."
}

响应 403

{
  "code" : "Forbidden",
  "message" : "User not authorized to operate on the specified APIs."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

设置登录密码

POST /v2/account/default/set_password

说明

设置手机登录密码，密码必须包含数字、大小写字母和特殊字符，长度10-32个字符 Body参数

设置登录密码

名称 : 设置登录密码标志 : 必填类型 : DefaultSetPasswordRequest 响应 HTTP代码 说明 类型 204 成功 无内容 400 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 2.InvalidParameterMissingError.State:state缺失 3.InvalidParameterMissingError.NewPassword:new_password缺失 4.InvalidParameterError.State:state无效 5.PasswordTooSimpleError:密码太简单 InvalidParameterMissingError 403 无权限 ForbiddenError 500 内部错误 InternalErrorError 标签

account

HTTP请求示例 请求 path

/v2/account/default/set_password

请求 body

{
  "app_id" : "csaklidwasdhjwid",
  "new_password" : "123456,Abc",
  "state" : "abc"
}

HTTP响应示例 响应 400

{
  "code" : "InvalidParameterMissing",
  "message" : "The input parameter {parameter_name} is missing."
}

响应 403

{
  "code" : "Forbidden",
  "message" : "User not authorized to operate on the specified APIs."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

通过账号获取访问令牌

POST /v2/account/get_access_token_by_link_info

说明

管理员通过账号信息直接获取用户的访问令牌 Body参数

获取令牌信息

名称 : 获取访问令牌请求标志 : 必填类型 : GetAccessTokenByLinkInfoRequest 响应 HTTP代码 说明 类型 200 成功 AccountAccessTokenResponse 400 参数错误 1.InvalidParameterError.Type:账号类型错误 2.InvalidParameterMissingError.Identity:identity缺失 InvalidParameterError 403 无权限 ForbiddenError 404 资源未找到错误 1.NotFoundError.Account:账号不存在 2.NotFoundError.User:用户不存在 NotFoundError 500 内部错误 InternalErrorError 标签

account

HTTP请求示例 请求 path

/v2/account/get_access_token_by_link_info

请求 body

{
  "identity" : "15208333333",
  "type" : "mobile"
}

HTTP响应示例 响应 200

{
  "access_token" : "cnskjajkahwdhwialsnd",
  "avatar" : "cherry",
  "default_drive_id" : "100",
  "exist_link" : [ ],
  "expire_time" : "2019-09-01T06:57:48.813Z",
  "expires_in" : 3600,
  "need_link" : false,
  "nick_name" : "cherry",
  "refresh_token" : "cnskjajkahwdhwialsnd",
  "role" : "user",
  "state" : "klafhjas-asdasd-asd-as-d-asd-asd-asdasd",
  "token_type" : "Bearer",
  "user_data" : "{ is_student: true }",
  "user_id" : "DING-xxxxx",
  "user_name" : "cherry"
}

响应 400

{
  "code" : "InvalidParameter",
  "message" : "The input parameter {parameter_name} is not valid."
}

响应 403

{
  "code" : "Forbidden",
  "message" : "User not authorized to operate on the specified APIs."
}

响应 404

{
  "code" : "NotFound",
  "message" : "The resource {resource_name} cannot be found. Please check."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

获取图片验证码

POST /v2/account/get_captcha

说明

获取图片验证码，用于人机校验，默认不需要 Body参数

获取图片验证码

名称 : 获取图片验证码标志 : 必填类型 : GetCaptchaRequest 响应 HTTP代码 说明 类型 200 成功 Captcha 400 参数错误 1.InvalidParameterMissingError.AppId:app_id缺失 InvalidParameterMissingError 403 无权限 ForbiddenError 500 内部错误 InternalErrorError 标签

account

HTTP请求示例 请求 path

/v2/account/get_captcha

请求 body

{
  "app_id" : "csaklidwasdhjwid"
}

HTTP响应示例 响应 200

{
  "captcha" : "iVBORw0KGgoAAAANSUhEUgAAAFAAAAAaCAIAAACvsEzwAAABRElEQVR42t3YsQ4CIQwA0CZ+i36Bg5uTo1/gqquDTvf1JwkJqRR7vZYCJ2HClOMBVw5h/i7P9yvU+X8LFFsju728wRNhcQR+gyj27G2GtQGHxy5USaN6PV1n2Qt8Ou6ZKllPJ/MQ4PN0CzXrs9i4jS2dIelKMuBse18vd1zdweHZdnC2V3kwDsm0OnYHMDVLtnQICbZ0XuIpqAamaaMjmGbvOAV0Fmqew7XAmXlV0kqButcYhDs5PqYiGA9dDm6atCK7bpbGx5Jknxszlj5pYR5t8QMX8b5gLMSVCZGfw4svdtHsDqZmPooHJxte5NTCnx3twKvKIhgLcaXrSbP0iGBhIK/99aXlnrQst1/7BajDt7Txxl/rrqvuBOaGJY3Szt4GOBuoka2LhQYw/ic1eyww/5eV95x229IDmqHlS1vdrOjkA5iK2BYUhM2zAAAAAElFTkSuQmCC",
  "captcha_format" : "png",
  "captcha_id" : "f4690fc255e2fb24c10ede079d3802b4cClRimRh67Q"
}

响应 400

{
  "code" : "InvalidParameterMissing",
  "message" : "The input parameter {parameter_name} is missing."
}

响应 403

{
  "code" : "Forbidden",
  "message" : "User not authorized to operate on the specified APIs."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

获取用户认证方式详情

POST /v2/account/get_link_info

说明

获取用户认证方式详情 Body参数

获取用户认证方式详情

名称 : 获取用户认证方式详情请求标志 : 必填类型 : GetByLinkInfoRequest 响应 HTTP代码 说明 类型 200 成功 LinkInfoResponse 400 参数错误 1.InvalidParameterError.Type:账号类型错误 2.InvalidParameterMissingError.Identity:identity缺失 InvalidParameterError 403 无权限 ForbiddenError 404 资源未找到错误 1.NotFoundError.Account:账号不存在 NotFoundError 500 内部错误 InternalErrorError 标签

account

HTTP请求示例 请求 path

/v2/account/get_link_info

请求 body

{
  "identity" : "15208333333",
  "type" : "mobile"
}

HTTP响应示例 响应 200

{
  "authentication_type" : "mobile",
  "created_at" : 1556163159820,
  "domain_id" : "5000",
  "identity" : "15208345000",
  "last_login_time" : 1556163159820,
  "status" : "normal",
  "user_id" : "00016a587b62b50003deea299a4f5b50"
}

响应 400

{
  "code" : "InvalidParameter",
  "message" : "The input parameter {parameter_name} is not valid."
}

响应 403

{
  "code" : "Forbidden",
  "message" : "User not authorized to operate on the specified APIs."
}

响应 404

{
  "code" : "NotFound",
  "message" : "The resource {resource_name} cannot be found. Please check."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

获取用户绑定信息

POST /v2/account/get_link_info_by_user_id

说明

获取用户的所有绑定信息 Body参数

获取用户的所有绑定信息

名称 : 获取用户绑定信息请求标志 : 必填类型 : GetLinkInfoByUserIDRequest 响应 HTTP代码 说明 类型 200 成功 LinkInfoListResponse 400 参数错误 1.InvalidParameterMissingError.UserId:user_id缺失 InvalidParameterMissingError 403 无权限 ForbiddenError 500 内部错误 InternalErrorError 标签

account

HTTP请求示例 请求 path

/v2/account/get_link_info_by_user_id

请求 body

{
  "user_id" : "123987123617823"
}

HTTP响应示例 响应 200

{
  "items" : [ ]
}