github.com/twilio/twilio-go@v1.20.1/rest/verify/v2/docs/ServicesEntitiesFactorsApi.md (about)

     1  # ServicesEntitiesFactorsApi
     2  
     3  All URIs are relative to *https://verify.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateNewFactor**](ServicesEntitiesFactorsApi.md#CreateNewFactor) | **Post** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors | 
     8  [**DeleteFactor**](ServicesEntitiesFactorsApi.md#DeleteFactor) | **Delete** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid} | 
     9  [**FetchFactor**](ServicesEntitiesFactorsApi.md#FetchFactor) | **Get** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid} | 
    10  [**ListFactor**](ServicesEntitiesFactorsApi.md#ListFactor) | **Get** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors | 
    11  [**UpdateFactor**](ServicesEntitiesFactorsApi.md#UpdateFactor) | **Post** /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid} | 
    12  
    13  
    14  
    15  ## CreateNewFactor
    16  
    17  > VerifyV2NewFactor CreateNewFactor(ctx, ServiceSidIdentityoptional)
    18  
    19  
    20  
    21  Create a new Factor for the Entity
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **ServiceSid** | **string** | The unique SID identifier of the Service.
    30  **Identity** | **string** | Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
    31  
    32  ### Other Parameters
    33  
    34  Other parameters are passed through a pointer to a CreateNewFactorParams struct
    35  
    36  
    37  Name | Type | Description
    38  ------------- | ------------- | -------------
    39  **FriendlyName** | **string** | The friendly name of this Factor. This can be any string up to 64 characters, meant for humans to distinguish between Factors. For `factor_type` `push`, this could be a device name. For `factor_type` `totp`, this value is used as the “account name” in constructing the `binding.uri` property. At the same time, we recommend avoiding providing PII.
    40  **FactorType** | **string** | 
    41  **BindingAlg** | **string** | The algorithm used when `factor_type` is `push`. Algorithm supported: `ES256`
    42  **BindingPublicKey** | **string** | The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64.  Required when `factor_type` is `push`
    43  **ConfigAppId** | **string** | The ID that uniquely identifies your app in the Google or Apple store, such as `com.example.myapp`. It can be up to 100 characters long.  Required when `factor_type` is `push`.
    44  **ConfigNotificationPlatform** | **string** | 
    45  **ConfigNotificationToken** | **string** | For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Must be between 32 and 255 characters long.  Required when `factor_type` is `push`.
    46  **ConfigSdkVersion** | **string** | The Verify Push SDK version used to configure the factor  Required when `factor_type` is `push`
    47  **BindingSecret** | **string** | The shared secret for TOTP factors encoded in Base32. This can be provided when creating the Factor, otherwise it will be generated.  Used when `factor_type` is `totp`
    48  **ConfigTimeStep** | **int** | Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. The default value is defined at the service level in the property `totp.time_step`. Defaults to 30 seconds if not configured.  Used when `factor_type` is `totp`
    49  **ConfigSkew** | **int** | The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. The default value is defined at the service level in the property `totp.skew`. If not configured defaults to 1.  Used when `factor_type` is `totp`
    50  **ConfigCodeLength** | **int** | Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. The default value is defined at the service level in the property `totp.code_length`. If not configured defaults to 6.  Used when `factor_type` is `totp`
    51  **ConfigAlg** | **string** | 
    52  **Metadata** | [**interface{}**](interface{}.md) | Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\\\"os\\\": \\\"Android\\\"}`. Can be up to 1024 characters in length.
    53  
    54  ### Return type
    55  
    56  [**VerifyV2NewFactor**](VerifyV2NewFactor.md)
    57  
    58  ### Authorization
    59  
    60  [accountSid_authToken](../README.md#accountSid_authToken)
    61  
    62  ### HTTP request headers
    63  
    64  - **Content-Type**: application/x-www-form-urlencoded
    65  - **Accept**: application/json
    66  
    67  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    68  [[Back to Model list]](../README.md#documentation-for-models)
    69  [[Back to README]](../README.md)
    70  
    71  
    72  ## DeleteFactor
    73  
    74  > DeleteFactor(ctx, ServiceSidIdentitySid)
    75  
    76  
    77  
    78  Delete a specific Factor.
    79  
    80  ### Path Parameters
    81  
    82  
    83  Name | Type | Description
    84  ------------- | ------------- | -------------
    85  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    86  **ServiceSid** | **string** | The unique SID identifier of the Service.
    87  **Identity** | **string** | Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
    88  **Sid** | **string** | A 34 character string that uniquely identifies this Factor.
    89  
    90  ### Other Parameters
    91  
    92  Other parameters are passed through a pointer to a DeleteFactorParams struct
    93  
    94  
    95  Name | Type | Description
    96  ------------- | ------------- | -------------
    97  
    98  ### Return type
    99  
   100   (empty response body)
   101  
   102  ### Authorization
   103  
   104  [accountSid_authToken](../README.md#accountSid_authToken)
   105  
   106  ### HTTP request headers
   107  
   108  - **Content-Type**: Not defined
   109  - **Accept**: Not defined
   110  
   111  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   112  [[Back to Model list]](../README.md#documentation-for-models)
   113  [[Back to README]](../README.md)
   114  
   115  
   116  ## FetchFactor
   117  
   118  > VerifyV2Factor FetchFactor(ctx, ServiceSidIdentitySid)
   119  
   120  
   121  
   122  Fetch a specific Factor.
   123  
   124  ### Path Parameters
   125  
   126  
   127  Name | Type | Description
   128  ------------- | ------------- | -------------
   129  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   130  **ServiceSid** | **string** | The unique SID identifier of the Service.
   131  **Identity** | **string** | Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
   132  **Sid** | **string** | A 34 character string that uniquely identifies this Factor.
   133  
   134  ### Other Parameters
   135  
   136  Other parameters are passed through a pointer to a FetchFactorParams struct
   137  
   138  
   139  Name | Type | Description
   140  ------------- | ------------- | -------------
   141  
   142  ### Return type
   143  
   144  [**VerifyV2Factor**](VerifyV2Factor.md)
   145  
   146  ### Authorization
   147  
   148  [accountSid_authToken](../README.md#accountSid_authToken)
   149  
   150  ### HTTP request headers
   151  
   152  - **Content-Type**: Not defined
   153  - **Accept**: application/json
   154  
   155  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   156  [[Back to Model list]](../README.md#documentation-for-models)
   157  [[Back to README]](../README.md)
   158  
   159  
   160  ## ListFactor
   161  
   162  > []VerifyV2Factor ListFactor(ctx, ServiceSidIdentityoptional)
   163  
   164  
   165  
   166  Retrieve a list of all Factors for an Entity.
   167  
   168  ### Path Parameters
   169  
   170  
   171  Name | Type | Description
   172  ------------- | ------------- | -------------
   173  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   174  **ServiceSid** | **string** | The unique SID identifier of the Service.
   175  **Identity** | **string** | Customer unique identity for the Entity owner of the Factors. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
   176  
   177  ### Other Parameters
   178  
   179  Other parameters are passed through a pointer to a ListFactorParams struct
   180  
   181  
   182  Name | Type | Description
   183  ------------- | ------------- | -------------
   184  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   185  **Limit** | **int** | Max number of records to return.
   186  
   187  ### Return type
   188  
   189  [**[]VerifyV2Factor**](VerifyV2Factor.md)
   190  
   191  ### Authorization
   192  
   193  [accountSid_authToken](../README.md#accountSid_authToken)
   194  
   195  ### HTTP request headers
   196  
   197  - **Content-Type**: Not defined
   198  - **Accept**: application/json
   199  
   200  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   201  [[Back to Model list]](../README.md#documentation-for-models)
   202  [[Back to README]](../README.md)
   203  
   204  
   205  ## UpdateFactor
   206  
   207  > VerifyV2Factor UpdateFactor(ctx, ServiceSidIdentitySidoptional)
   208  
   209  
   210  
   211  Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param.
   212  
   213  ### Path Parameters
   214  
   215  
   216  Name | Type | Description
   217  ------------- | ------------- | -------------
   218  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   219  **ServiceSid** | **string** | The unique SID identifier of the Service.
   220  **Identity** | **string** | Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
   221  **Sid** | **string** | A 34 character string that uniquely identifies this Factor.
   222  
   223  ### Other Parameters
   224  
   225  Other parameters are passed through a pointer to a UpdateFactorParams struct
   226  
   227  
   228  Name | Type | Description
   229  ------------- | ------------- | -------------
   230  **AuthPayload** | **string** | The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.
   231  **FriendlyName** | **string** | The new friendly name of this Factor. It can be up to 64 characters.
   232  **ConfigNotificationToken** | **string** | For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Required when `factor_type` is `push`. If specified, this value must be between 32 and 255 characters long.
   233  **ConfigSdkVersion** | **string** | The Verify Push SDK version used to configure the factor
   234  **ConfigTimeStep** | **int** | Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive
   235  **ConfigSkew** | **int** | The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive
   236  **ConfigCodeLength** | **int** | Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive
   237  **ConfigAlg** | **string** | 
   238  **ConfigNotificationPlatform** | **string** | The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`.  Required when `factor_type` is `push`.
   239  
   240  ### Return type
   241  
   242  [**VerifyV2Factor**](VerifyV2Factor.md)
   243  
   244  ### Authorization
   245  
   246  [accountSid_authToken](../README.md#accountSid_authToken)
   247  
   248  ### HTTP request headers
   249  
   250  - **Content-Type**: application/x-www-form-urlencoded
   251  - **Accept**: application/json
   252  
   253  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   254  [[Back to Model list]](../README.md#documentation-for-models)
   255  [[Back to README]](../README.md)
   256