Azure API Management でユーザー アカウントを管理する方法

  • [アーティクル]

API Management では、開発者は、API Management を使用して公開された API のユーザーになります。 このガイドでは、開発者を作成する方法と、API Management インスタンスで公開した API および成果物を案内する招待メッセージを開発者に送信する方法について説明します。 プログラムによるユーザー アカウントの管理については、「API Management REST (API Management REST)」リファレンスのユーザー エンティティに関するドキュメントを参照してください。

可用性

重要

この機能は、API Management の Premium、Standard、Basic、Developer レベルで使用できます。

前提条件

「Create an Azure API Management instance (Azure API Management インスタンスを作成する)」の記事にあるタスクを完了します。

API Management インスタンスに移動します。

  1. Azure portal で、API Management サービス を検索して選択します。

    [API Management サービス] を選択する

  2. [API Management サービス] ページで、ご自身の API Management インスタンスを選択します。

    API Management インスタンスを選択する

新しい開発者の作成

新しいユーザーを追加するには、このセクションの手順に従います。

  1. 画面の左にある [ユーザー] タブを選択します。

  2. [+ 追加] を押します。

  3. 適切なユーザー情報を入力します。

  4. [追加] をクリックします。

    新しいユーザーの追加

既定では、新しく作成された開発者アカウントはアクティブになり、開発者グループに関連付けられます。 [アクティブ] 状態の開発者アカウントを使用すると、サブスクリプションがあるすべての API にアクセスできます。 新しく作成した開発者を追加のグループに関連付ける方法については、「 グループと開発者の関連付け」を参照してください。

開発者の招待

開発者を招待するには、このセクションの手順に従います。

  1. 画面の左にある [ユーザー] タブを選択します。
  2. [+ 招待] を押します。

確認メッセージが表示されます。ただし、新しく招待した開発者は、招待を受け入れるまで一覧に表示されません。

開発者を招待すると、招待された開発者に電子メールが送信されます。 この電子メールはテンプレートを使用して生成され、カスタマイズできます。 詳細については、「 電子メール テンプレートの構成」を参照してください。

招待が受け入れられると、そのアカウントがアクティブになります。

招待リンクは 2 日間有効です。

開発者アカウントを非アクティブ化するか再アクティブ化する

既定では、新しく作成または招待された開発者アカウントは アクティブになります。 開発者アカウントを非アクティブ化するには、 [ブロック]をクリックします。 ブロックされている開発者アカウントを再アクティブ化するには、 [アクティブ化]をクリックします。 ブロックされている開発者アカウントは、開発者ポータルにアクセスすることも、API を呼び出すこともできません。 ユーザー アカウントを削除するには、 [削除]をクリックします。

ユーザーをブロックするには、次の手順に従います。

  1. 画面の左にある [ユーザー] タブを選択します。
  2. ブロックするユーザーをクリックします。
  3. [ブロック] を押します。

ユーザーのパスワードのリセット

プログラムによってユーザー アカウントを操作するには、「API Management REST API」リファレンスのユーザー エンティティに関するドキュメントを参照してください。 ユーザー アカウントのパスワードを特定の値にリセットするには、 ユーザーの更新 操作を使用して目的のパスワードを指定します。

次のステップ

開発者アカウントを作成した後は、このアカウントをロールに関連付け、成果物と API をサブスクライブできます。 詳細については、「 How to create and use groups (グループを作成して使用する方法)」をご覧ください。