API による Flow365 ユーザー アカウントの作成と削除

  • 更新

フロントライン ワーカーがトレーニングを受講するには、Flow365 ユーザー アカウントが必要です。

Flow365 ユーザー アカウントは Learn365 管理センターで作成することもできます。

ここでは、API を通じた Flow365 ユーザー アカウントの作成と削除について説明します。

Flow365 ユーザー アカウントの作成

Learn365 API を通じた Flow365 ユーザー アカウントの作成、以下の手順に沿って行います。

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

2.Users セクションに移動し、 POST /services/users/v2/Users Creates the user from the specified source based on directory object id, sign-in type or request models を選択し、右上の「Try it out」をクリックします。

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

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

  • title:Learn365に表示するユーザーの名前(フルネーム)。
  • email:ユーザーの Eメールアドレス。これはユニークでなければなりません。既存のユーザーのものは使用できません。
  • userSource: Flow365 ユーザー アカウントの場合、ユーザーソースは「AzureB2C」です。
  • signInType:サインインには次の 3つのタイプがあります。
    • Email:メール アドレスによるサインイン
    • Phone:電話番号によるサインイン。ただし、ユーザーを作成する際には、Eメールでサインイン リンクを受け取るため、Eメールアドレスの入力が必要です。
    • Username:ユーザー名によるサインイン
  • username:この列は、ユーザー名でサインインするタイプの場合に入力します。ユーザー名はユニークでなければなりません。既存のユーザーのものは使用できません。使用できる特殊記号はアンダースコア( _ )とダッシュ( - )のみです。ユーザー名の最初は、文字または数字でなければなりません。
  • profile:電話番号でサインインするタイプの場合、プロファイル オブジェクトに以下のパラメータを入力します。
    • phone:ユーザーの電話番号。でなければなりません。既存のユーザーのものは使用できません。

body の記述例:

 

メール アドレスによるサインインの場合

{
"title": "John Doe",
"email": "jdoe@test.com",
"userSource": "AzureB2C",
"signInType": "Email"
}

 


電話番号によるサインインの場合

{
"title": "John Doe",
"email": "jdoe@test.com", 
"userSource": "AzureB2C",
"signInType": "Phone",
"profile": {
"phone": "+5555555"
}
}

 


ユーザー名によるサインインの場合

{
"title": "John Doe",
"username": "j_doe", 
"userSource": "AzureB2C",
"signInType": "Username"
}

CreateFlowUSerAPI-1.png

 

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

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

  • Code 200は、リクエストが正しく動作したことを示します。Response body にユーザーの詳細が表示されます。

  • ユーザー名でサインインするタイプで、作成した場合、Response body には、「TemporaryPassword」パラメーターにメタデータが表示されています。これをユーザーに与えることで、ユーザーがログインできるようになります。

  • エラーの場合、Response body には、問題を説明するコードとメッセージ キーを持つエラー オブジェクトが含まれます。

Flow365 ユーザーは、サインインのリンクを Eメールで受け取ります。メールアドレスでサインインするタイプの場合、仮パスワードも記載されています。

  • メールアドレスでサインインするタイプの場合、ユーザーはメールアドレスと仮パスワードでサインインします。ユーザーは、初回サインイン時に仮パスワードを新しいものに変更する必要があります。
  • 電話番号でサインインするタイプの場合、ユーザーは電話番号とサインイン時にワンタイム コードを受け取ります。
  • ユーザー名でサインするタイプの場合、ユーザーはユーザー名とResponse body で提供された仮パスワードでサインインします。仮パスワードは、Learn365 管理センターの「すべてのコースカタログ」>ユーザー ページでリセットし、新しい仮パスワードを発行することもできます。ユーザーは、初回サインイン時に仮パスワードを新しいものに変更する必要があります。

サインインが完了すると、Flow365 にアクセスできます。

 

Flow365 ユーザー アカウントの削除

Flow365 ユーザー アカウントを削除します。ユーザー アカウントを削除すると、そのアカウントは、サブスクリプションの Flow365 ユーザー数にカウントされません。(ライセンスは解放されます。)

Flow365 ユーザー アカウントは、Learn365 管理センターで削除することもできます。

API を通じて Flow365 ユーザーアカウントを削除するには、ユーザー ID が必要です。ユーザー ID はこちらの手順で取得できます。

API を通じた、Flow365 ユーザーアカウントの削除は、以下の手順に沿って行います。

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

2.Users セクションに移動し、 DELETE /services/users/v2/Users/{id} Deletes the user を選択し、右上の「Try it out」をクリックします。

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

  • idユーザー ID を入力します。(このパラメータは入力必須です。

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

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

  • Code 204は、リクエストが正しく動作したことを示します。Response body は空です。
  • エラーの場合、Response body には、問題を説明するコードとメッセージ キーを持つエラー オブジェクトが含まれます。