Reference documentation and code samples for the Google Cloud Developer Connect V1 Client class StartOAuthResponse.
Message for responding to starting an OAuth flow.
Generated from protobuf message google.cloud.developerconnect.v1.StartOAuthResponse
Namespace
Google \ Cloud \ DeveloperConnect \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ system_provider_id |
int
The ID of the system provider. |
↳ ticket |
string
The ticket to be used for post processing the callback from the service provider. |
↳ code_challenge |
string
Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.1 |
↳ code_challenge_method |
string
Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.2 |
↳ client_id |
string
The client ID to the OAuth App of the service provider. |
↳ scopes |
array
The list of scopes requested by the application. |
↳ auth_uri |
string
The authorization server URL to the OAuth flow of the service provider. |
getSystemProviderId
The ID of the system provider.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SystemProvider. |
hasSystemProviderId
setSystemProviderId
The ID of the system provider.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SystemProvider. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTicket
The ticket to be used for post processing the callback from the service provider.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTicket
The ticket to be used for post processing the callback from the service provider.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCodeChallenge
Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.1
| Returns | |
|---|---|
| Type | Description |
string |
|
setCodeChallenge
Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.1
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCodeChallengeMethod
Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.2
| Returns | |
|---|---|
| Type | Description |
string |
|
setCodeChallengeMethod
Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.2
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientId
The client ID to the OAuth App of the service provider.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClientId
The client ID to the OAuth App of the service provider.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScopes
The list of scopes requested by the application.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setScopes
The list of scopes requested by the application.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthUri
The authorization server URL to the OAuth flow of the service provider.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAuthUri
The authorization server URL to the OAuth flow of the service provider.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
| Returns | |
|---|---|
| Type | Description |
string |
|