メニュー

Expand
ページを評価:

Factor Resource

Verify Push is in Public Beta.

The Factor resource represents a verification factor/channel. When the factor_type is push, then it contains the metadata for a single registered device. A single Entity contains multiple Factors and a single Factor contains multiple Challenges.

Factor properties

Resource Properties in REST API format
sid
sid<YF> Not PII

A 34 character string that uniquely identifies this Factor.

account_sid
sid<AC> Not PII

The unique SID identifier of the Account.

service_sid
sid<VA> Not PII

The unique SID identifier of the Service.

entity_sid
sid<YE> Not PII

The unique SID identifier of the Entity.

identity
文字列 PII MTL: 30 DAYS

The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user's UUID, GUID, or SID.

date_created
date_time<iso8601> Not PII

The date that this Factor was created, given in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date that this Factor was updated, given in ISO 8601 format.

friendly_name
文字列 Not PII

A human readable description of this resource, up to 64 characters. For a push factor, this can be the device's name.

status
enum:factor_statuses Not PII

The Status of this Factor. One of unverified or verified.

factor_type
enum:factor_types Not PII

The Type of this Factor. Currently only push is supported.

config
オブジェクト Not PII

An object that contains configurations specific to a factor_type.

url
url Not PII

The URL of this resource.

Create a Factor resource

post
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors
パラメーター
Parameters in REST API format
service_sid
Path
post sid<VA> Not PII

The unique SID identifier of the Service.

identity
Path
post 文字列 PII MTL: 30 DAYS

Customer unique identity for the Entity owner of the Factor

friendly_name
必須
post 文字列 Not PII

The friendly name of this Factor

factor_type
必須
post ienum:factor_types Not PII

The Type of this Factor. Currently only push is supported

binding.alg
オプション
post 文字列 Not PII

The algorithm used when factor_type is push. Algorithm supported: ES256

binding.public_key
オプション
post base64 Not PII

The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64

config.app_id
オプション
post 文字列 Not PII

The ID that uniquely identifies your app in the Google or Apple store, such as com.example.myapp. Required when factor_type is push

config.notification_platform
オプション
post ienum:notification_platforms Not PII

The transport technology used to generate the Notification Token. Can be apn or fcm. Required when factor_type is push

config.notification_token
オプション
post 文字列 Not PII

For APN, the device token. For FCM the registration token. It used to send the push notifications. Required when factor_type is push

config.sdk_version
オプション
post 文字列 Not PII

The Verify Push SDK version used to configure the factor

例 1
        
        
        
        

        Fetch a Factor resource

        GET
        https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
        パラメーター
        Parameters in REST API format
        service_sid
        Path
        GET sid<VA> Not PII

        The unique SID identifier of the Service.

        identity
        Path
        GET 文字列 PII MTL: 30 DAYS

        Customer unique identity for the Entity owner of the Factor

        sid
        Path
        GET sid<YF> Not PII

        A 34 character string that uniquely identifies this Factor.

        例 1
              
              
              
              

              Read multiple Factor resources

              GET
              https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors
              パラメーター
              Parameters in REST API format
              service_sid
              Path
              GET sid<VA> Not PII

              The unique SID identifier of the Service.

              identity
              Path
              GET 文字列 PII MTL: 30 DAYS

              Customer unique identity for the Entity owner of the Factor

              例 1
                    
                    
                    
                    

                    Update a Factor resource

                    post
                    https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
                    パラメーター
                    Parameters in REST API format
                    service_sid
                    Path
                    post sid<VA> Not PII

                    The unique SID identifier of the Service.

                    identity
                    Path
                    post 文字列 PII MTL: 30 DAYS

                    Customer unique identity for the Entity owner of the Factor

                    sid
                    Path
                    post sid<YF> Not PII

                    A 34 character string that uniquely identifies this Factor.

                    auth_payload
                    オプション
                    post 文字列 Not PII

                    The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.

                    friendly_name
                    オプション
                    post 文字列 Not PII

                    The new friendly name of this Factor

                    config.notification_token
                    オプション
                    post 文字列 Not PII

                    For APN, the device token. For FCM the registration token. It used to send the push notifications. Required when factor_type is push

                    config.sdk_version
                    オプション
                    post 文字列 Not PII

                    The Verify Push SDK version used to configure the factor

                    例 1
                          
                          
                          
                          

                          Delete a Factor resource

                          削除する
                          https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
                          パラメーター
                          Parameters in REST API format
                          service_sid
                          Path
                          削除する sid<VA> Not PII

                          The unique SID identifier of the Service.

                          identity
                          Path
                          削除する 文字列 PII MTL: 30 DAYS

                          Customer unique identity for the Entity owner of the Factor

                          sid
                          Path
                          削除する sid<YF> Not PII

                          A 34 character string that uniquely identifies this Factor.

                          例 1
                                
                                
                                
                                
                                ページを評価:

                                ヘルプが必要ですか?

                                誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。

                                      
                                      
                                      

                                      フィードバックくださりありがとうございます!

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

                                      Sending your feedback...
                                      🎉 Thank you for your feedback!
                                      Something went wrong. Please try again.

                                      Thanks for your feedback!

                                      Refer us and get $10 in 3 simple steps!

                                      ステップ1

                                      Get link

                                      Get a free personal referral link here

                                      ステップ2:

                                      Give $10

                                      Your user signs up and upgrade using link

                                      ステップ3

                                      Get $10

                                      1,250 free SMSes
                                      OR 1,000 free voice mins
                                      OR 12,000 chats
                                      OR more