コンテンツにスキップ

メンバー招待¶

POST /api/v1/workspace/member/batch_invitation

概要¶

1人または複数のメンバーを招待します。

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

パラメータ名	型	必須	説明
to	array	Y	招待対象者リスト例: ['xxx@guance.com', 'xxx@guance.com'] 空を許可: True
roleUUIDs	array	Y	招待対象者のロールUUIDリスト例: ['wsAdmin'] 空を許可: False
method	string	Y	招待方法例: None 空を許可: False 選択可能な値: ['email']

パラメータ補足説明¶

roleUUIDs の説明

ロール	説明
wsAdmin	管理者ロール。owner / wsAdmin のみ招待可能
general	標準メンバーロール
readOnly	読み取り専用ロール
role_xxx	カスタムロール

招待による owner ロールの設定はサポートされていません。

リクエスト例¶

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

レスポンス¶

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