Class protos.google.cloud.oslogin.v1beta.SecurityKey (5.3.0)

Represents a SecurityKey.

Package

@google-cloud/os-login

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.oslogin.v1beta.ISecurityKey);

Constructs a new SecurityKey.

Parameter
NameDescription
properties ISecurityKey

Properties to set

Properties

_deviceNickname

public _deviceNickname?: "deviceNickname";

SecurityKey _deviceNickname.

deviceNickname

public deviceNickname?: (string|null);

SecurityKey deviceNickname.

privateKey

public privateKey: string;

SecurityKey privateKey.

protocolType

public protocolType?: ("universalTwoFactor"|"webAuthn");

SecurityKey protocolType.

publicKey

public publicKey: string;

SecurityKey publicKey.

universalTwoFactor

public universalTwoFactor?: (google.cloud.oslogin.v1beta.IUniversalTwoFactor|null);

SecurityKey universalTwoFactor.

webAuthn

public webAuthn?: (google.cloud.oslogin.v1beta.IWebAuthn|null);

SecurityKey webAuthn.

Methods

create(properties)

public static create(properties?: google.cloud.oslogin.v1beta.ISecurityKey): google.cloud.oslogin.v1beta.SecurityKey;

Creates a new SecurityKey instance using the specified properties.

Parameter
NameDescription
properties ISecurityKey

Properties to set

Returns
TypeDescription
SecurityKey

SecurityKey instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.oslogin.v1beta.SecurityKey;

Decodes a SecurityKey message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
SecurityKey

SecurityKey

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.oslogin.v1beta.SecurityKey;

Decodes a SecurityKey message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SecurityKey

SecurityKey

encode(message, writer)

public static encode(message: google.cloud.oslogin.v1beta.ISecurityKey, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SecurityKey message. Does not implicitly messages.

Parameters
NameDescription
message ISecurityKey

SecurityKey message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.oslogin.v1beta.ISecurityKey, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SecurityKey message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message ISecurityKey

SecurityKey message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.oslogin.v1beta.SecurityKey;

Creates a SecurityKey message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
SecurityKey

SecurityKey

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SecurityKey

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this SecurityKey to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.oslogin.v1beta.SecurityKey, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a SecurityKey message. Also converts values to other types if specified.

Parameters
NameDescription
message SecurityKey

SecurityKey

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SecurityKey message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not