public interface ThreeLeggedOAuthOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAuthorizationUrl()
public abstract String getAuthorizationUrl()Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.example.com/authorize"
string authorization_url = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The authorizationUrl. |
getAuthorizationUrlBytes()
public abstract ByteString getAuthorizationUrlBytes()Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.example.com/authorize"
string authorization_url = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for authorizationUrl. |
getClientId()
public abstract String getClientId()Optional. The client ID of the OAuth client.
string client_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The clientId. |
getClientIdBytes()
public abstract ByteString getClientIdBytes()Optional. The client ID of the OAuth client.
string client_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clientId. |
getClientSecret()
public abstract String getClientSecret()Optional. Input only. The client secret of the OAuth client.
string client_secret = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The clientSecret. |
getClientSecretBytes()
public abstract ByteString getClientSecretBytes()Optional. Input only. The client secret of the OAuth client.
string client_secret = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clientSecret. |
getDefaultContinueUri()
public abstract String getDefaultContinueUri()Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
string default_continue_uri = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The defaultContinueUri. |
getDefaultContinueUriBytes()
public abstract ByteString getDefaultContinueUriBytes()Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.
string default_continue_uri = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for defaultContinueUri. |
getEnablePkce()
public abstract boolean getEnablePkce()Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.
bool enable_pkce = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enablePkce. |
getRedirectUrl()
public abstract String getRedirectUrl()Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
string redirect_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The redirectUrl. |
getRedirectUrlBytes()
public abstract ByteString getRedirectUrlBytes()Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.
string redirect_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for redirectUrl. |
getTokenUrl()
public abstract String getTokenUrl()Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.example.com/oauth/token"
string token_url = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The tokenUrl. |
getTokenUrlBytes()
public abstract ByteString getTokenUrlBytes()Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.example.com/oauth/token"
string token_url = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for tokenUrl. |