Add Users to a Group (ユーザをグループに追加)

HTTP メソッド

PUT

API 呼び出しの URL

https://api-cp-global.ifmcloud.com/public/organizations/<チーム ID>/groups/users

HTTP ヘッダ
  • Content-Type: application/json
  • Authorization: Bearer Claris_ID_Token
ボディ
  • groupName (文字列、必須): グループの名前。
  • users: グループに追加するユーザの一覧を含む配列。

ユーザごとに次のデータが必要です:

  • email (文字列、必須): グループに追加するユーザの電子メールアドレス。
  • isIdpUser (論理値): 外部 IdP ユーザをグループに追加する場合は true。デフォルトは false です。

例:

コピー 
PUT /public/organizations/<チーム ID>/groups/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer Claris_ID_Token
コピー 
{
  "groupName": "Example Group",
 
  "users": [
    {
      "email": "user1@example.com"
    },
    {
      "email":"user2@example.com",
      "isIdpUser": true
    },
    {
      "email":"user3@example.com"
    }
  ]
}
引数 なし
応答のボディ
  • code (文字列): エラーの場合はエラーコード、エラーがない場合は OK が返されます。
  • message (文字列): エラーの場合はエラーメッセージ、エラーがない場合は null が返されます。
  • succeeded: 成功した要求の一覧を含む配列。
  • failed: 失敗した要求の一覧を含む配列。
  • requestId: 参照に使用する API リクエスト ID。

例:

コピー 
{
  "code": "OK",
  "message": null,
  "succeeded": [
    {
      "request": {
        "email": "user1@example.com",
        "isIdpUser": false,
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "user2@example.com",
        "isIdpUser": false,
      },
      "code": "EmailNotValid",
      "message": "user2@example.com is not a valid email."
    }
  ],
  "requestId": "{Request_ID}"
}

メモ 

  • 複数のユーザをグループに追加して一部のユーザのみ成功した場合、API リクエストは成功したとみなされます。成功および失敗した要求について詳細情報が返されます。
  • 各要求に追加できるユーザの最大数は 100 です。
  • この API リクエストを使用してユーザを外部グループに招待することはできません。