Reference documentation and code samples for the Google Cloud Chronicle V1 Client class TrellixLocalAuthentication.
Info for TrellixLocalAuthentication using a username, password, endpoint, and header name.
Generated from protobuf message google.cloud.chronicle.v1.TrellixLocalAuthentication
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ username |
string
Required. Username for Trellix Local authentication. This is a unique username for the user that is generated on a Trellix device. It has no default, specifically enforced min / max length, or character set. |
↳ password |
string
Required. Password of the account identified by username. There are no restrictions on the format of the password. It has no default, specifically enforced min / max length or character set. The password will have been provided by the Trellix administrator. |
↳ token_endpoint |
string
Required. The endpoint to fetch the token from. This must be a valid URL with an http or https scheme. It has no default. |
↳ token_header |
string
Required. The HTTP header name to use for the token for authentcated requests. It varies per Trellix product. Refer to the Trellix API documentation for the correct value. It has no default. |
getUsername
Required. Username for Trellix Local authentication.
This is a unique username for the user that is generated on a Trellix device. It has no default, specifically enforced min / max length, or character set.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUsername
Required. Username for Trellix Local authentication.
This is a unique username for the user that is generated on a Trellix device. It has no default, specifically enforced min / max length, or character set.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPassword
Required. Password of the account identified by username.
There are no restrictions on the format of the password. It has no default, specifically enforced min / max length or character set. The password will have been provided by the Trellix administrator.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPassword
Required. Password of the account identified by username.
There are no restrictions on the format of the password. It has no default, specifically enforced min / max length or character set. The password will have been provided by the Trellix administrator.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTokenEndpoint
Required. The endpoint to fetch the token from.
This must be a valid URL with an http or https scheme. It has no default.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTokenEndpoint
Required. The endpoint to fetch the token from.
This must be a valid URL with an http or https scheme. It has no default.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTokenHeader
Required. The HTTP header name to use for the token for authentcated requests. It varies per Trellix product. Refer to the Trellix API documentation for the correct value. It has no default.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTokenHeader
Required. The HTTP header name to use for the token for authentcated requests. It varies per Trellix product. Refer to the Trellix API documentation for the correct value. It has no default.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|