メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Authyユーザー

Before you can secure a user with the Twilio Authy API, you need to create a user. The API requires you set an email, phone number and country code for each user.

When a user is first created, you will receive an authyid which you must then store with the user's profile in your own database. Do not lose this ID - you will use it every time you wish to authenticate a user!

エンドユーザーはAuthyのモバイルまたはデスクトップアプリケーションを使用して、開発者が関知することなく登録されている電話番号を変更できます。 またエンドユーザーは、Authy.com phone change security reviewを使用することもできます。 Webhook API経由で、この電話番号変更時のWebhookを受け取ることができます。

ユーザーを追加する

ユーザーは複数のメールアドレスを持つ可能性がありますが、各authy_idに関連づけられる電話番号はひとつのみです。 同一のデバイスかつ異なるメールアドレスを伴った、2つの別個のユーザー登録のためのAPI呼び出しに対しては、同一のauthy_idが返され、このユーザー用に両方のメールアドレスが保存されます。

POST https://api.authy.com/protected/{FORMAT}/users/new

パラメーター

名前 Type 概要
send_install_link_via_sms ブール値(オプション) Value to enable or disable the initial text message. Default=TRUE. Can be set from the Dashboard. (🏢 not PII )
user[email] 文字列(必須) More than one email can be stored per AuthyID, but only the initially created email will display in the Dashboard until it is removed. (📇 PII )
user[cellphone] 文字列(必須) Foreign key for the AuthyID (the AuthyID will be the primary key going forward). (📇 PII )
user[country_code] 文字列(必須) Numeric calling country code of the country Eg: 1 for the US. 91 for India. 54 for Mexico. See: Country code list dropdown (🏢 not PII )

レスポンス

名前 Type 概要
user ユーザー This is the AuthyID of the created user. (🏢 not PII )

メモ: 電話番号の各部の分割には、ハイフン、ピリオド、スペースが使用できます。 ひと続きで指定しても問題ありません。

curl -XPOST "http://api.authy.com/protected/json/users/new" \
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9" \
-d user[email]="user@domain.com" \
-d user[cellphone]="317-338-9302" \
-d user[country_code]="54"

レスポンス例

{
    "user": {
        "id":2
    }
}

エラーとなるリクエスト

curl "http://api.authy.com/protected/json/users/new" \
-H "X-Authy-API-Key: d57d919d11e6b221c9bf6f7c882028f9" \
-d user[email]="user.com" \
-d user[cellphone]="AAA-338-9302" \
-d user[country_code]="1"

レスポンス例

{
    "errors": {
        "email":"is invalid",
        "cellphone":"must be a valid cellphone number."
    }
}


ユーザーステータスをリクエストする

ユーザーが作成されて開発されたアプリケーションに登録されルト、Twilioからそのユーザーについての情報をリクエストできます。 Userステータスコールを使用すると、下記が受信されます:

  1. country_code
  2. phone number(電話番号): 電話番号の下4桁です。
  3. devices: デバイスの一覧です。 取りうる値: android、android_tablet、ios、iphone、iphone_sdk、chrome、authy_chrome、sms、android_sdk
  4. registered(登録状態): AuthyのモバイルまたはデスクトップAppが登録されているとtrueを返します。
  5. confirmed(確認済): ユーザーが以前に有効なコードを使用したことがある場合はtrueを返します。
GET http://api.authy.com/protected/{FORMAT}/users/{USER ID}/status

パラメーター

名前 Type 概要
user_ip 文字列 IP of the user requesting to see the application details. Optional. (📇 PII )

レスポンス

名前 Type 概要
status ディクショナリー Status contains information about the user. (🏢 not PII )
message 文字列 A message indicating the result of the operation. (🏢 not PII )
success boolean True if the request was successful. (🏢 not PII )

{
    "status": {
        "authy_id":2,
        "confirmed":true,
        "registered":true,
        "country_code":1,
        "phone_number":"XXX-XXX-9302",
        "devices": [
            "authy_chrome",
            "android"
        ]
    },
    "message":"User status.",
    "success":true
}


ユーザーを削除する

開発者のアプリケーションからエンドユーザーを削除したい場合は、削除APIを使用してこれを行えます。 メモ: ユーザーの削除はトークンの検証を直ちに無効にします。

Best practice is to remove a user if they disable Two-factor Authentication or remove an account with your App. If you accidentally remove a user, you can recover users through the Console - but we suggest that you instead go through your registration flow again.

curl -X POST https://api.authy.com/protected/{FORMAT}/users/{USER ID}/remove -H "X-Authy-API-Key: {KEY}"

パラメーター

名前 Type 概要
user_ip 文字列(オプション) The ip requesting to remove the user (📇 PII )

レスポンス

名前 Type 概要
success boolean True if the user was scheduled for deletion. (🏢 not PII )
message 文字列 処理結果を示すメッセージです。
(🏢 not PII )
#### Example
{
    "message": "User removed from application",
    "success": true
}
Rate this page:

ヘルプが必要ですか?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.