Reference documentation and code samples for the Google Cloud Chronicle V1 Client class MssoAuthentication.
Info for MssoAuthentication using a username, password, and login api endpoint.
Generated from protobuf message google.cloud.chronicle.v1.MssoAuthentication
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ username |
string
Required. Username for MSSO authentication. There are no restrictions on the format of the username. It has no default, specifically enforced min / max length or character set. The username will have been provided by an MSSO administrator and it is assumed that they have provided a username that is internally consistent with MSSO authentication requirements / validation. |
↳ 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 an MSSO administrator and it is assumed that they have provided a password that is internally consistent with MSSO authentication requirements / validation. |
↳ api_endpoint |
string
Required. The login api endpoint url. This must be a valid URL with an http or https scheme. It has no default. |
getUsername
Required. Username for MSSO authentication.
There are no restrictions on the format of the username. It has no default, specifically enforced min / max length or character set. The username will have been provided by an MSSO administrator and it is assumed that they have provided a username that is internally consistent with MSSO authentication requirements / validation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUsername
Required. Username for MSSO authentication.
There are no restrictions on the format of the username. It has no default, specifically enforced min / max length or character set. The username will have been provided by an MSSO administrator and it is assumed that they have provided a username that is internally consistent with MSSO authentication requirements / validation.
| 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 an MSSO administrator and it is assumed that they have provided a password that is internally consistent with MSSO authentication requirements / validation.
| 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 an MSSO administrator and it is assumed that they have provided a password that is internally consistent with MSSO authentication requirements / validation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApiEndpoint
Required. The login api endpoint url.
This must be a valid URL with an http or https scheme. It has no default.
| Returns | |
|---|---|
| Type | Description |
string |
|
setApiEndpoint
Required. The login api endpoint url.
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 |
|