子账号修改

PATCH

/api/v2/sub-account/{accountId}

请求参数

Path 参数

accountId

string

子账号 ID

必需

示例值:

61de53a7887185045fa82b6e

Header 参数

Authorization

string

Token

必需

示例值:

Bearer eyJsdfsdf

x-authing-userpool-id

string

用户池 ID

必需

示例值:

61b95d6c96d42670da568408

Body 参数application/json

active

boolean

是否激活

可选

remarks

string

备注

可选

displayName

string

子账号名称

可选

password

string

子账号密码

可选

secretKey

string

密钥 Key

可选

accessKey

string

访问密钥 Key

可选

account

string

子账号

可选

mainAccountId

string

主账号 ID

可选

appId

string

APP ID

可选

userPoolId

string

用户池 ID

可选

appConfig

object

应用配置信息

可选

示例

{
  "active": true,
  "remarks": "string",
  "displayName": "string",
  "password": "string",
  "secretKey": "string",
  "accessKey": "string",
  "account": "string",
  "mainAccountId": "string",
  "appId": "string",
  "userPoolId": "string",
  "appConfig": {}
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://core.authing.cn/api/v2/sub-account/61de53a7887185045fa82b6e' \
--header 'Authorization: Bearer eyJsdfsdf' \
--header 'x-authing-userpool-id: 61b95d6c96d42670da568408' \
--header 'Content-Type: application/json' \
--data-raw '{
    "active": true,
    "remarks": "string",
    "displayName": "string",
    "password": "string",
    "secretKey": "string",
    "accessKey": "string",
    "account": "string",
    "mainAccountId": "string",
    "appId": "string",
    "userPoolId": "string",
    "appConfig": {}
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

string

必需

createdAt

string

必需

updatedAt

string

必需

userPoolId

string

必需

appId

string

必需

mainAccountId

string

必需

account

string

必需

password

string

必需

displayName

string

必需

remarks

string

必需

active

boolean

必需

示例

{
  "code": 200,
  "message": "修改子账号成功",
  "data": {
    "id": "61dfbfa2cba8cf41a942691f",
    "createdAt": "2022-01-13T05:58:58.575Z",
    "updatedAt": "2022-01-13T06:05:42.356Z",
    "userPoolId": "61b95d6c96d42670da568408",
    "appId": "61df925846bed781f5757166",
    "mainAccountId": "61de53a7887185045fa82b6e",
    "account": "subaccount",
    "password": "subaccount_password",
    "displayName": "我的子账号",
    "remarks": "sdfsdfsdfsdfsdf",
    "active": true
  }
}

子账号添加

子账号删除