メインコンテンツまでスキップ

メンバーを招待

メンバーを CelerData Cloud BYOC アカウントに招待します。

リクエスト​

基本情報
HTTP URLhttps://cloud-api.celerdata.com/api/1.0/invite-member
HTTP メソッドPOST
頻度600/分

リクエストボディ​

パラメータ例必須タイプ説明
members[{ "lastName": "Doe", "firstName": "John", "email": "johndoe@email.com", "roles": ["12345678-1234-1234-1234-123456789012"] }]はいArray招待するメンバーオブジェクトの配列。各オブジェクトには lastName、firstName、email、および roles（オプション）が含まれます。詳細は Member object を参照してください。
defaultRoles["12345678-1234-1234-1234-123456789012"]いいえArray招待されたすべてのメンバーに割り当てられるデフォルトの役割を表すIDの配列。API role-list を使用して役割IDを取得できます。このパラメータは、roles パラメータが指定されているメンバーオブジェクトには影響しません。システム定義の役割 Public は、ID が指定されているかどうかにかかわらず、すべてのメンバーに必ず割り当てられます。

メンバーオブジェクト​

パラメータ例必須タイプ説明
firstName"Doe"はいStringメンバーの姓。
lastName"John"はいStringメンバーの名。
email"johndoe@email.com"はいStringメンバーのメールアドレス。
roles["12345678-1234-1234-1234-123456789012"]いいえArrayメンバーに割り当てられる役割を表すIDの配列。API role-list を使用して役割IDを取得できます。

ヘッダーパラメータ​

パラメータ例必須タイプ説明
AuthorizationBearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUYはいStringCelerData Cloud API にアクセスするために使用されるアクセストークン。形式: Bearer <access_token>。

アクセストークンの取得 を参照してください。

レスポンス​

サンプルレスポンス​

{
    "successes": [
        {
            "email": "success@email.com",
            "bizID": "qwertyui-2db1-4d01-a045-936da932bc59"
        }
    ],
    "failures": [
        {
            "email": "failed@email.com",
            "msg": "member exist"
        }
    ]
}

レスポンス要素​

パラメータ例タイプ説明
successes-Array招待に成功したメンバーを表すオブジェクトの配列。各オブジェクトには email と bizID が含まれます。
successes[0]-Object招待に成功したメンバーの詳細。
successes[0].email"success@email.com"String招待されたメンバーのメールアドレス。
successes[0].bizID"qwertyui-2db1-4d01-a045-936da932bc59"String招待に成功したメンバーに割り当てられたビジネスID。
failures-Array招待に失敗したメンバーを表すオブジェクトの配列。各オブジェクトには email と msg が含まれます。
failures[0]-Object招待に失敗したメンバーの詳細。
failures[0].email"failed@email.com"String招待に失敗したメンバーのメールアドレス。
failures[0].msg"member exist"String招待が失敗した理由。例えば、member exist や role doesn't exist など。