Management APIを使用してユーザーを管理する
Dashboardに加え、Management APIを使用することでも、ユーザーの取得、作成、更新または削除を行うことができます。Management APIを直接呼び出したい場合は、先に適切なアクセストークンを生成する必要があります。詳細については、「Management APIのアクセストークン」をお読みください。あるいは、SDKを使用して、アプリケーションからManagement APIを呼び出すために必要な機能性を実装できます。使用できるSDKのリストについては、サポートマトリックスのSDKセクションをお読みください。
チームメンバーによるAuth0 Dashboardへのアクセスを管理する方法については、「ダッシュボードアクセスを管理する」をお読みください。
権限
以下の権限を使用して、マシンツーマシンアプリケーションのアクセストークンを取得します。詳細については、「マシンツーマシンアプリケーションを登録する」をお読みください。
権限 | 説明 |
---|---|
read:users |
アプリケーションは、Auth0テナントに保管されている任意のユーザーレコードを検索して取得することができます。これには、/api/v2/users 、/api/v2/users-by-email 、および/api/v2/jobs/users-export エンドポイントを使用した読み出しが含まれます。 |
create:users |
アプリケーションは、Auth0テナントにある任意のデータベースやパスワードレス接続にユーザーを作成することができます。これには、/api/v2/users や/api/v2/jobs/users-import エンドポイントを使用した作成が含まれます。/api/v2/users エンドポイントには、サインアップエンドポイントと同様に、クライアントIDも接続のenabled_clients プロパティに追加する必要があります。 |
update:users |
アプリケーションは、Auth0テナントに保管されている任意のユーザーを更新することができます。これには、/api/v2/users エンドポイントを使用した更新が含まれます。 |
update:users_app_metadata |
アプリケーションは、Auth0テナントに保管されている任意のユーザーのuser.app_metadata 属性だけを更新することができます。これには、/api/v2/users endpoint を使用した更新が含まれます。 |
delete:users |
アプリケーションは、Auth0テナントに保管されている任意のユーザーを削除することができます。これには、/api/v2/users エンドポイントを使用した削除が含まれます。 |
制限事項
特に設定を変更しない限り、Auth0以外のIDプロバイダー(Google、Facebook、Xなど)によって提供されるユーザープロファイル属性は、ユーザーがログインするたびにIDプロバイダーから更新されるため、直接編集することはできません。
正規化ユーザープロファイルのルート属性であるname
、nickname
、given_name
、family_name
、picture
を編集可能にするには、接続がAuth0と同期されるように構成して、ユーザー属性がユーザープロファイルの作成時のみIDプロバイダーに更新されるようにしなければなりません。そうすれば、これらのルート属性を個別に、または一括インポートを通じて編集できるようになります。
パスワードはcreate
エンドポイントまたはupdate
エンドポイントを使用して設定できますが、セキュリティ上の理由から、get
コマンドまたはlist user
コマンドでパスワードを閲覧することはできません。APIエクスプローラーの右側に、特定の呼び出しに対して閲覧または編集できるユーザープロファイル属性に関するヒントが提供されています。
エンドポイント
すべてのユーザーに関する情報を取得するには、
/users
エンドポイントを使用します。特定のユーザーを検索する検索条件を含めることもできます。user_id
に基づいて1人のユーザーに関する情報を取得するには、/user_id
を使用します。user_id
は、接続名とユーザーの一意の識別子で構成される内部識別子です。user_id
はIDトークンとは異なります。/userinfo
エンドポイントは、入力としてAuth0アクセストークンを受け取り、ユーザープロファイル情報を返します。このエンドポイントにはすべてのルールの結果が含まれ、この中には認証トランザクション時にユーザープロファイルを変更した可能性のあるものも含まれますが、結果であるユーザープロファイルはいずれのスコーピングによってもフィルタリングされません。/tokeninfo
エンドポイントは入力としてAuth0 IDトークンを受け取り、ユーザープロファイル情報を返します。このエンドポイントが返す結果には、ユーザープロファイルを変更したいかなるルールの結果も含みません。