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 \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setPublicKey
Public key text in SSH format, defined by RFC4253 section 6.6.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrivateKey
Hardware-backed private key text in SSH format.
| Returns | |
|---|---|
| Type | Description |
string | |
setPrivateKey
Hardware-backed private key text in SSH format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUniversalTwoFactor
The U2F protocol type.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\OsLogin\V1beta\UniversalTwoFactor|null | |
hasUniversalTwoFactor
setUniversalTwoFactor
The U2F protocol type.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\OsLogin\V1beta\UniversalTwoFactor
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWebAuthn
The Web Authentication protocol type.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\OsLogin\V1beta\WebAuthn|null | |
hasWebAuthn
setWebAuthn
The Web Authentication protocol type.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\OsLogin\V1beta\WebAuthn
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeviceNickname
The security key nickname explicitly set by the user.
| Returns | |
|---|---|
| Type | Description |
string | |
hasDeviceNickname
clearDeviceNickname
setDeviceNickname
The security key nickname explicitly set by the user.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProtocolType
| Returns | |
|---|---|
| Type | Description |
string | |