bridge-client/org.sagebionetworks.bridge.kmm.shared.models/PhoneSignInRequest

PhoneSignInRequest

@Serializable
data class PhoneSignInRequest(val appId: String, val phone: Phone, val type: String? = null)

Make a request to sign in using an SMS message. This request will trigger a message to be sent to an existing account's phone number. The SMS message will include a numeric token that must be included in a subsequent request to the server to authenticate.

Parameters

appId

The identifier for the participant's app.

phone
type

PhoneSignInRequest

Constructors

Link copied to clipboard
constructor(appId: String, phone: Phone, type: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "appId")
val appId: String
Link copied to clipboard
@SerialName(value = "phone")
val phone: Phone
Link copied to clipboard
@SerialName(value = "type")
val type: String? = null