Invite Users to a Team (ユーザをチームに招待)

HTTP メソッド POST

API 呼び出しの URL

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

HTTP ヘッダ

  • Content-Type: application/json

  • Authorization: Bearer Claris_ID_Token

ボディ

  • users: チームに招待するユーザの一覧を含む配列。

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

  • email (文字列、必須): チームに招待するユーザの Claris ID または外部 IdP の電子メールアドレス。

  • isIdpUser (論理値): 外部 IdP ユーザを招待する場合は true。デフォルトは false です。

  • isTeamManager (論理値): ユーザをチームマネージャとして招待する場合は true。デフォルトは false です。

  • isLicensed (論理値): ユーザをライセンスユーザとして招待する場合は true。デフォルトは false です。

例:

コピー 
POST /public/organizations/<チーム ID>/users/invite HTTP/1.1
Content-Type: application/json
Authorization: Bearer Claris_ID_Token
コピー 
{
  "users": [
    {
      "email": "user1@example.com"
    },
    {
      "email": "user2@example.com",
      "isIdpUser": true
    },
    {
      "email": "user3@example.com",
      "isTeamManager": true
    },
    {
      "email": "user4@example.com",
      "isLicensed": true
    },
    {
      "email": "user5@example.com",
      "isLicensed": true,
      "isTeamManager": true
    }
  ]
}

引数

なし

応答のボディ

  • code (文字列): エラーの場合はエラーコード、エラーがない場合は OK が返されます。

  • message (文字列): エラーの場合はエラーメッセージ、エラーがない場合は null が返されます。

  • succeeded: 成功した要求の一覧を含む配列。

  • failed: 失敗した要求の一覧を含む配列。

  • requestId: 参照に使用する API リクエスト ID。

例:

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

メモ 

  • 複数のユーザを招待して一部のユーザのみ成功した場合、API リクエストは成功したとみなされます。成功および失敗した要求について詳細情報が返されます。

  • 各要求に追加できるユーザの最大数は 50 です。

  • 保留中のユーザ招待の最大数は 50 です。

  • 要求のライセンスユーザの数はサブスクリプションのライセンスユーザを超えることはできません。

  • すでにこの API または Claris Customer Console で同じユーザの設定を行なっている場合、isTeamManager および isLicensed 設定の変更にこの API リクエストを使用することはできません。設定を変更するには、Claris Customer Console を使用します。

  • この API リクエストを使用してチームからユーザを取り除くことはできません。ユーザを取り除くには、Claris Customer Console を使用します。