Google Cloud OsLogin V1beta Client - Class SecurityKey (1.7.0)

Reference documentation and code samples for the Google Cloud OsLogin V1beta Client class SecurityKey.

The credential information for a Google registered security key.

Generated from protobuf message google.cloud.oslogin.v1beta.SecurityKey

Namespace

Google \ Cloud \ OsLogin \ V1beta

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ public_key string

Public key text in SSH format, defined by RFC4253 section 6.6.

↳ private_key string

Hardware-backed private key text in SSH format.

↳ universal_two_factor Google\Cloud\OsLogin\V1beta\UniversalTwoFactor

The U2F protocol type.

↳ web_authn Google\Cloud\OsLogin\V1beta\WebAuthn

The Web Authentication protocol type.

↳ device_nickname string

The security key nickname explicitly set by the user.

getPublicKey

Public key text in SSH format, defined by RFC4253 section 6.6.

Returns
TypeDescription
string

setPublicKey

Public key text in SSH format, defined by RFC4253 section 6.6.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPrivateKey

Hardware-backed private key text in SSH format.

Returns
TypeDescription
string

setPrivateKey

Hardware-backed private key text in SSH format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUniversalTwoFactor

The U2F protocol type.

Returns
TypeDescription
Google\Cloud\OsLogin\V1beta\UniversalTwoFactor|null

hasUniversalTwoFactor

setUniversalTwoFactor

The U2F protocol type.

Parameter
NameDescription
var Google\Cloud\OsLogin\V1beta\UniversalTwoFactor
Returns
TypeDescription
$this

getWebAuthn

The Web Authentication protocol type.

Returns
TypeDescription
Google\Cloud\OsLogin\V1beta\WebAuthn|null

hasWebAuthn

setWebAuthn

The Web Authentication protocol type.

Parameter
NameDescription
var Google\Cloud\OsLogin\V1beta\WebAuthn
Returns
TypeDescription
$this

getDeviceNickname

The security key nickname explicitly set by the user.

Returns
TypeDescription
string

hasDeviceNickname

clearDeviceNickname

setDeviceNickname

The security key nickname explicitly set by the user.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProtocolType

Returns
TypeDescription
string