Struct AuthenticateRequest

Namespace

Vonage.SimSwap.Authenticate

Assembly

Vonage.dll

Represents a request to authenticate towards SimSwap API.

public readonly struct AuthenticateRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

PhoneNumber

Subscriber number in E.164 format (starting with country code). Optionally prefixed with '+'.

public PhoneNumber PhoneNumber { get; }

Property Value

PhoneNumber

Scope

The authorization scope for the token.

public string Scope { get; }

Property Value

string

Methods

Parse(string, string)

Parses the input into an AuthenticateRequest.

public static Result<AuthenticateRequest> Parse(string number, string tokenScope)

Parameters

number string

The phone number.

tokenScope string

The authorization scope for the token.

Returns

Result<AuthenticateRequest>

Success if the input matches all requirements. Failure otherwise.