Management API で認証方法を管理する

Auth0 Management API を使用して、ユーザーの MFA 認証方法を管理する方法について説明します。

始める前に

• machine-to-machine (M2M) アプリケーションを設定し、次のスコープを付与してAuth0 Management API へのアクセスを許可します。

  • create:authentication_methods
  • read:authentication_methods
  • update:authentication_methods
  • delete:authentication_methods

Auth0 Management API には、ユーザーのMFA認証方法を管理するために利用できる複数のエンドポイントがあります。

この方法では、機密アプリケーションを使用して認証を行います。機密アプリケーションと公開アプリケーションの違いについて詳しくは、Confidential and Public Applicationsをご覧ください。

​

すべての認証方法を取得する

認証方法の一覧を取得するエンドポイントを使用すると、ユーザーが完全または部分的に登録済みのすべての認証方法の一覧を取得できます。

このエンドポイントを使用するには、スコープ read:authentication_methods が必要です。

​

例

次のリクエストは、指定したユーザーのすべての認証方法の一覧を返します。

​

レスポンス

有効なリクエストごとに、Management API はJSON形式でレスポンスを返します。

[
  {
    "id": "totp|dev_XXXXXXXXXXXXXXXX",
    "type": "totp",
    "confirmed": true,
    "created_at": "2021-09-23T22:57:30.206Z",
    "last_auth_at": "2021-09-23T22:57:51.652Z"
  }
]

​

1 つの認証方法を取得する

ユーザーの認証方法を 1 つ取得するには、ID で認証方法を取得するエンドポイントを使用します。認証方法の ID を指定して取得できます。

このエンドポイントには、スコープ read:authentication_methods が必要です。

​

例

以下のリクエストは、指定した認証方法のIDに基づいて、ユーザーの単一の認証方法を返します。

​

レスポンス

有効な各リクエストに対して、Management API は JSON 形式のレスポンスを返します。

{
    "id": "totp|dev_XXXXXXXXXXXXXXXX",
    "type": "totp",
    "confirmed": true,
    "created_at": "2021-09-23T22:57:30.206Z",
    "last_auth_at": "2021-09-23T22:57:51.652Z"
}

​

認証方法を作成する

指定したユーザーの認証方法を作成するエンドポイントを使用すると、SMS、メール、ワンタイムパスワード (OTP) 、WebAuthn with Security Keys などの認証方法をユーザーに対して作成できます。利用可能な MFA の認証要素の詳細については、Multi-Factor Authentication Factorsを参照してください。

このエンドポイントには、スコープ create:authentication_methods が必要です。

このエンドポイントで作成された認証方法は、自動的に確認済みとなり、すぐに利用可能になります。認証方法が正しく設定されており、引き続き有効であることをユーザーに確認してください。

​

SMS

SMSでユーザーにOTPを送信し、認証を完了する前にそのOTPの入力を求めます。

​

例

次のリクエストにより、ユーザーのSMS認証方法が作成されます。

​

レスポンス

有効な各リクエストに対して、Management API は JSON 形式のレスポンスを返します。

{
    "type": "phone",
    "name": "SMS",
    "created_at": "2023-01-01T00:00:00.000Z",
    "phone_number": "[e-mail]",
    "id": "phone|dev_XXXXXXXXXXXXXXXX"
}

​

Email

メールでユーザーにOTPを送信し、ユーザーは認証を完了する前に、そのOTPの入力を求められます。メール認証要素は、ユーザーが利用可能なほかの認証要素を持っていない場合にのみサポートされます。

​

例

以下のリクエストは、ユーザーのEmail認証方法を作成します。

​

レスポンス

有効なリクエストごとに、Management API は JSON 形式でレスポンスを返します。

{
    "type": "email",
    "name": "Email Factor",
    "created_at": "2023-01-01T00:00:00.000Z",
    "email": "[e-mail]",
    "id": "email|dev_XXXXXXXXXXXXXXXX"
}

​

ワンタイムパスワード (OTP)

ユーザーが Google Authenticator などの認証アプリを個人の端末で使用して、一定時間ごとに変化する OTP を生成し、認証完了前にその OTP を入力できるようにします。

​

例

次のリクエストは、ユーザーのOTP認証方法を作成します。

​

レスポンス

有効な各リクエストに対して、Management API は JSON 形式のレスポンスを返します。

{
    "type": "totp",
    "name": "OTP Application",
    "created_at": "2023-01-01T00:00:00.000Z",
    "email": "[e-mail]",
    "id": "totp|dev_XXXXXXXXXXXXXXXX"
}

​

WebAuthn with security keys

ユーザーが FIDO 準拠のセキュリティ キー (たとえば Yubikey や Google Titan) を使用して、多要素認証を行えるようにします。

​

例

以下のリクエストは、ユーザーのWebAuthn with Security Keys認証方法を作成します。

​

レスポンス

有効な各リクエストに対して、Management API は JSON 形式のレスポンスを返します。

{
    "type": "webauthn-roaming",
    "name": "WebAuthn with security keys",
    "relyingPartyIdentifier": "example-tenant.auth0.com",
    "keyId": "X9FrwMfmzj...",
    "publicKey": "bXktcHVibGljLWtle...",
    "created_at": "2023-03-09T17:33:47.545Z",
    "id": "webauthn-roaming|dev_XXXXXXXXXXXXXXXX"
}

​

すべての認証方法を置き換える

既存のすべての認証方法を指定したものに置き換えるには、指定した認証方法ですべての認証方法を置き換えて更新するエンドポイントを使用します。

このエンドポイントには、スコープ update:authentication_methods が必要です。

​

例

次のリクエストでは、ユーザーの既存の認証方法がすべて置き換えられます。

​

レスポンス

有効な各リクエストに対して、Management API は JSON 形式のレスポンスを返します。

[
  {
    "id": "phone|dev_XXXXXXXXXXXXXXXX",
    "type": "phone",
    "name": "SMS",
    "phone_number": "+00000000000",
    "created_at": "2023-03-09T17:53:23.647Z",
    "preferred_authentication_method": "sms",
    "authentication_methods": [
      {
        "id": "sms|dev_XXXXXXXXXXXXXXXX",
        "type": "sms"
      }
    ]
  }
]

​

1 つの認証方法を更新する

ユーザーの認証方法を 1 つ更新するには、認証方法を更新するエンドポイントを使用します。

このエンドポイントを利用するには、スコープ update:authentication_methods が必要です。

​

例

次のリクエストは、特定の認証方法のIDに基づいて、ユーザーの単一の認証方法を更新します。

​

レスポンス

有効な各リクエストに対して、Management API は JSON 形式のレスポンスを返します。

{
    "type": "phone",
    "name": "Mobile SMS",
    "created_at": "2023-01-12T00:03:52.855Z",
    "last_auth_at": "2023-01-12T00:04:05.157Z",
    "phone_number": "+00000000000",
    "preferred_authentication_method": "sms",
    "id": "phone|dev_XXXXXXXXXXXXXXXX",
    "authentication_methods": [
        {
            "id": "phone|dev_XXXXXXXXXXXXXXXX",
            "type": "phone"
        }
    ]
}

​

すべての認証方法を削除

ユーザーのすべての認証方法を削除するには、指定されたユーザーのすべての認証方法を削除するエンドポイントを使用します。

このエンドポイントを使用するには、次のスコープが必要です: delete:authentication_methods.

​

例

次のリクエストは、ユーザーのすべての認証方法を削除します。

​

レスポンス

有効な各リクエストに対し、Management API はステータスコード 204、本文が空のレスポンスを返します。

​

1 つの認証方法を削除する

ユーザーの認証方法を 1 つ削除するには、ID で認証方法を削除するエンドポイントを使用します。

​

例

以下のリクエストは、指定した認証方法のIDに基づいて、ユーザーの認証方法を1つ削除します。

​

レスポンス

有効な各リクエストに対し、Management API はステータスコード 204、本文が空のレスポンスを返します。

​

詳しくはこちら

• 多要素認証の認証要素
• Machine-to-Machine アプリケーションを登録する
• 本番環境向けの Management API アクセストークンを取得する
• 機密アプリケーションとパブリックアプリケーション