API による Flow365 招待の送信と削除

  • 更新

ここでは、API を通じた Flow365 ユーザーへの招待の送信と、招待の削除について説明します。

 

Flow365 招待の送信

Learn365 API を通じた Flow365 ユーザーへの招待の送信は、以下の手順に沿って行います。

1.https://api.365.systems/  にアクセスし、APIキーで認証します。

2.Invitations セクションに移動し、 POST /services/users/Invitations を選択し、右上の「Try it out」を選択します。

3.パラメータを入力します。

「Edit Value」フィールドで、以下を入力します。

  • "email": "string"このパラメータは入力必須です。ユーザーのEメールアドレス。Eメールはユニークであり、既存の Flow365ユーザーのEメール アドレスは使用できません。

  • "phone": "string":ユーザーの電話番号。電話番号はユニークであり、既存の Flow365ユーザーの電話番号は使用できません。(このパラメータは任意です。)
  • "department": "string":ユーザーの部署。(このパラメータは任意です。)
  • "jobTitle": "string":ユーザーの役職。(このパラメータは任意です。)
  • "displayName": "string":Learn365 に表示するユーザーの名前。アカウントが有効の間は、ユーザーの表示名を変更することができます。(このパラメータは任意です。)

 

Send Flow365 invitations via API-1.png

 

4.「Execute」を選択してリクエストを実行します。

5.Responses ブロックで結果を確認します。

  • Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
  • 400 バリデーションエラー(たとえば、Eメールが一意でない)の場合、Response body には問題を説明するエラー配列が含まれます。
  • その他のエラーの場合、Response body には、問題を説明するコードとメッセージ キーを持つエラー オブジェクトが含まれます。
  • Downloadオプションを使用して、APIリクエストの結果を JSON フォーマットでローカルデバイスに保存できます。

Send Flow365 invitations via API-2.png

 

Flow365 招待の削除

API を通じて Flow365 ユーザーへの招待を削除するには、招待 ID が必要です。招待 ID を取得する方法は 2つあります。

  • POST /services/users/Invitations  でユーザーを招待したときの レスポンスに「id」パラメーターが含まれています。
  • GET /services/users/api/Invitations でリクエストを実行すると、レスポンスに「id」を含む保留中の招待を表示します。詳細については、こちらの記事を参照してください。

Learn365 API を通じた Flow365 ユーザーの招待の削除は、以下の手順に沿って行います。

1.https://api.365.systems/  にアクセスし、APIキーで認証します。

2.Invitations セクションに移動し、 DELETE /services/users/Invitations を選択し、右上の「Try it out」を選択します。

3.パラメータを入力します。

  • Id:フィールドに招待 ID を入力します。

4.「Execute」を選択してリクエストを実行します。

 

Send Flow365 invitations via API-3.png

 

5.Responses ブロックで結果を確認します。

  • Code の下の204 は、リクエストが正しく動作したことを示します。
  • 該当の招待 ID がない場合は、404コードが表示されます。
  • その他のエラーの場合、Response body には、問題を説明するコードとメッセージ キーを含むエラー オブジェクトが含まれます。

Send Flow365 invitations via API-4.png