Reference documentation and code samples for the Google Cloud IoT Core V1 Client class DeviceCredential.
A server-stored device credential used for authentication.
Generated from protobuf message google.cloud.iot.v1.DeviceCredential
Namespace
Google \ Cloud \ Iot \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ public_key |
Google\Cloud\Iot\V1\PublicKeyCredential
A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate. |
↳ expiration_time |
Google\Protobuf\Timestamp
[Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted. |
getPublicKey
A public key used to verify the signature of JSON Web Tokens (JWTs).
When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iot\V1\PublicKeyCredential|null |
|
hasPublicKey
setPublicKey
A public key used to verify the signature of JSON Web Tokens (JWTs).
When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Iot\V1\PublicKeyCredential
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpirationTime
[Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasExpirationTime
clearExpirationTime
setExpirationTime
[Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCredential
| Returns | |
|---|---|
| Type | Description |
string |
|