コンテンツにスキップ

メンバー追加（デプロイメントプラン）¶

POST /api/v1/workspace/member/batch_add

概要¶

1人または複数のメンバーを追加します（デプロイメントプランのみ対応）

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
accountUUIDs	array	Y	アカウントリスト例: ['acnt_xxxx32'] 空を許可: False
roleUUIDs	array	Y	ユーザーロールUUIDリスト例: ['general', 'readOnly', 'role_xxxx32'] 空を許可: False

パラメータ補足説明¶

リクエストパラメータの説明

パラメータ名	type	説明
accountUUIDs	array	サイト内のアカウントUUIDs
roleUUIDs	array	ワークスペースロールUUIDs

roleUUIDs の説明

ロール	説明
wsAdmin	管理者ロール
general	標準メンバーロール
readOnly	読み取り専用ロール
role_xxx	カスタムロール

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/member/batch_add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"accountUUIDs": ["acnt_xxxx32"], "roleUUIDs": ["general","role_xxxx32"]}' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B6A69C1D-ED27-42C2-93FD-BC943F8675D2"
}