class Stytch::TOTPs
def create(
The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
status_code::
The type of this field is +String+.
The unique ID of the affected User.
user_id::
The type of this field is +User+ (+object+).
The `user` object affected by this API call. See the [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details.
user::
The type of this field is list of +String+.
The recovery codes used to authenticate the user without an authenticator app.
recovery_codes::
The type of this field is +String+.
The QR code image encoded in base64.
qr_code::
The type of this field is +String+.
The TOTP secret key shared between the authenticator app and the server used to generate TOTP codes.
secret::
The type of this field is +String+.
The unique ID for a TOTP instance.
totp_id::
The type of this field is +String+.
Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
request_id::
An object with the following fields:
== Returns:
The type of this field is nilable +Integer+.
The expiration for the TOTP instance. If the newly created TOTP is not authenticated within this time frame the TOTP will be unusable. Defaults to 1440 (1 day) with a minimum of 5 and a maximum of 1440.
expiration_minutes::
The type of this field is +String+.
The `user_id` of an active user the TOTP registration should be tied to.
user_id::
== Parameters:
Create a new TOTP instance for a user. The user can use the authenticator application of their choice to scan the QR code or enter the secret.
def create( user_id:, expiration_minutes: nil ) headers = {} request = { user_id: user_id } request[:expiration_minutes] = expiration_minutes unless expiration_minutes.nil? post_request('/v1/totps', request, headers) end