OAuth2Configuration (Cloud Foundry Java Client 5.16.0.RELEASE API)

java.lang.Object
- org.cloudfoundry.uaa.identityproviders.OAuth2Configuration

All Implemented Interfaces:: IdentityProviderConfiguration

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class OAuth2Configuration
extends Object

The payload for the OAuth2 identity provider configuration

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OAuth2Configuration.Builder
Builds instances of type OAuth2Configuration.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OAuth2Configuration.Builder` Builds instances of type `OAuth2Configuration`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OAuth2Configuration.Builder`	`builder()` Creates a builder for `OAuth2Configuration`.
`boolean`	`equals(Object another)` This instance is equal to all instances of `OAuth2Configuration` that have equal attribute values.
`Boolean`	`getAddShadowUserOnLogin()` Determines whether or not shadow users must be created before login by an administrator.
`AttributeMappings`	`getAttributeMappings()`
`String`	`getAuthMethod()` explicit method to authenticate against the identity provider.
`String`	`getAuthUrl()` The OAuth 2.0 authorization endpoint URL
`Boolean`	`getCacheJwks()` A flag controlling whether PKCE (RFC 7636) is active in authorization code flow when requesting tokens from the external provider.
`String`	`getCheckTokenUrl()` The OAuth check token endpoint URL.
`Boolean`	`getClientAuthInBody()` Send the client credentials in the token retrieval call as body parameters instead of a Basic Authorization header.
`List<String>`	`getEmailDomains()` List of email domains associated with the provider for the purpose of associating users to the correct origin upon invitation.
`List<String>`	`getExternalGroupsWhitelist()` The external group white list
`String`	`getIssuer()` The OAuth 2.0 token issuer.
`String`	`getLinkText()` Text to use for the login link to the provider
`String`	`getLogoutUrl()` OAuth 2.0 logout endpoint.
`Boolean`	`getPerformRpInitiatedLogout()` A flag controlling whether to log out of the external provider after a successful UAA logout
`Boolean`	`getPkce()` Option to enable caching for the JWKS (verification key for validating token signatures)
`String`	`getProviderDescription()` Human readable name/description of this provider
`String`	`getRelyingPartyId()` The client ID which is registered with the external OAuth provider for use by the UAA
`String`	`getRelyingPartySecret()` The client secret of the relying party at the external OAuth provider
`String`	`getResponseType()` The OAuth 2.0 response type.
`List<String>`	`getScopes()` What scopes to request on a call to the external OAuth/OpenID provider.
`Boolean`	`getShowLinkText()` A flag controlling whether a link to this provider’s login will be shown on the UAA login page
`Boolean`	`getSkipSslVerification()` Skips validation of the LDAP cert if set to true.
`Boolean`	`getStoreCustomAttributes()` Set to true, to store custom user attributes to be fetched from the /userinfo endpoint
`String`	`getTokenKey()` A verification key for validating token signatures
`String`	`getTokenKeyUrl()` The URL of the token key endpoint which renders a verification key for validating token signatures
`String`	`getTokenUrl()` The OAuth 2.0 authorization endpoint URL
`String`	`getUserInfoUrl()` A URL for fetching user info attributes when queried with the obtained token authorization.
`String`	`getUserPropagationParameter()` Name of the request parameter that is used to pass a known username when redirecting to this identity provider from the account chooser
`int`	`hashCode()` Computes a hash code from attributes: `emailDomains`, `providerDescription`, `authMethod`, `attributeMappings`, `externalGroupsWhitelist`, `storeCustomAttributes`, `addShadowUserOnLogin`, `authUrl`, `linkText`, `relyingPartyId`, `relyingPartySecret`, `scopes`, `showLinkText`, `skipSslVerification`, `tokenKey`, `tokenKeyUrl`, `tokenUrl`, `checkTokenUrl`, `clientAuthInBody`, `issuer`, `responseType`, `userInfoUrl`, `userPropagationParameter`, `cacheJwks`, `pkce`, `logoutUrl`, `performRpInitiatedLogout`.
`String`	`toString()` Prints the immutable value `OAuth2Configuration` with attribute values.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getEmailDomains
```
public List<String> getEmailDomains()
```
    List of email domains associated with the provider for the purpose of associating users to the correct origin upon invitation. If empty list, no invitations are accepted. Wildcards supported.
  - getProviderDescription
```
public String getProviderDescription()
```
    Human readable name/description of this provider
  - getAuthMethod
```
public String getAuthMethod()
```
    explicit method to authenticate against the identity provider.
  - getAttributeMappings
```
public AttributeMappings getAttributeMappings()
```
    Returns:
    
    The value of the attributeMappings attribute
  - getExternalGroupsWhitelist
```
public List<String> getExternalGroupsWhitelist()
```
    The external group white list
  - getStoreCustomAttributes
```
public Boolean getStoreCustomAttributes()
```
    Set to true, to store custom user attributes to be fetched from the /userinfo endpoint
  - getAddShadowUserOnLogin
```
public Boolean getAddShadowUserOnLogin()
```
    Determines whether or not shadow users must be created before login by an administrator.
  - getAuthUrl
```
public String getAuthUrl()
```
    The OAuth 2.0 authorization endpoint URL
  - getLinkText
```
public String getLinkText()
```
    Text to use for the login link to the provider
  - getRelyingPartyId
```
public String getRelyingPartyId()
```
    The client ID which is registered with the external OAuth provider for use by the UAA
  - getRelyingPartySecret
```
public String getRelyingPartySecret()
```
    The client secret of the relying party at the external OAuth provider
  - getScopes
```
public List<String> getScopes()
```
    What scopes to request on a call to the external OAuth/OpenID provider. For example, can provide openid, roles, or profile to request ID token, scopes populated in the ID token external groups attribute mappings, or the user profile information, respectively.
  - getShowLinkText
```
public Boolean getShowLinkText()
```
    A flag controlling whether a link to this provider’s login will be shown on the UAA login page
  - getSkipSslVerification
```
public Boolean getSkipSslVerification()
```
    Skips validation of the LDAP cert if set to true.
  - getTokenKey
```
public String getTokenKey()
```
    A verification key for validating token signatures
  - getTokenKeyUrl
```
public String getTokenKeyUrl()
```
    The URL of the token key endpoint which renders a verification key for validating token signatures
  - getTokenUrl
```
public String getTokenUrl()
```
    The OAuth 2.0 authorization endpoint URL
  - getCheckTokenUrl
```
public String getCheckTokenUrl()
```
    The OAuth check token endpoint URL. Reserved for future OAuth use.
  - getClientAuthInBody
```
public Boolean getClientAuthInBody()
```
    Send the client credentials in the token retrieval call as body parameters instead of a Basic Authorization header.
  - getIssuer
```
public String getIssuer()
```
    The OAuth 2.0 token issuer.
  - getResponseType
```
public String getResponseType()
```
    The OAuth 2.0 response type.
  - getUserInfoUrl
```
public String getUserInfoUrl()
```
    A URL for fetching user info attributes when queried with the obtained token authorization.
  - getUserPropagationParameter
```
public String getUserPropagationParameter()
```
    Name of the request parameter that is used to pass a known username when redirecting to this identity provider from the account chooser
  - getCacheJwks
```
public Boolean getCacheJwks()
```
    A flag controlling whether PKCE (RFC 7636) is active in authorization code flow when requesting tokens from the external provider.
  - getPkce
```
public Boolean getPkce()
```
    Option to enable caching for the JWKS (verification key for validating token signatures)
  - getLogoutUrl
```
public String getLogoutUrl()
```
    OAuth 2.0 logout endpoint.
  - getPerformRpInitiatedLogout
```
public Boolean getPerformRpInitiatedLogout()
```
    A flag controlling whether to log out of the external provider after a successful UAA logout
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of OAuth2Configuration that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: emailDomains, providerDescription, authMethod, attributeMappings, externalGroupsWhitelist, storeCustomAttributes, addShadowUserOnLogin, authUrl, linkText, relyingPartyId, relyingPartySecret, scopes, showLinkText, skipSslVerification, tokenKey, tokenKeyUrl, tokenUrl, checkTokenUrl, clientAuthInBody, issuer, responseType, userInfoUrl, userPropagationParameter, cacheJwks, pkce, logoutUrl, performRpInitiatedLogout.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value OAuth2Configuration with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - builder
```
public static OAuth2Configuration.Builder builder()
```
    Creates a builder for OAuth2Configuration.
```
 OAuth2Configuration.builder()
    .emailDomains(List&lt;String&gt; | null) // nullable emailDomains
    .providerDescription(String | null) // nullable providerDescription
    .authMethod(String | null) // nullable authMethod
    .attributeMappings(org.cloudfoundry.uaa.identityproviders.AttributeMappings | null) // nullable attributeMappings
    .externalGroupsWhitelist(List&lt;String&gt; | null) // nullable externalGroupsWhitelist
    .storeCustomAttributes(Boolean | null) // nullable storeCustomAttributes
    .addShadowUserOnLogin(Boolean | null) // nullable addShadowUserOnLogin
    .authUrl(String) // required authUrl
    .linkText(String | null) // nullable linkText
    .relyingPartyId(String) // required relyingPartyId
    .relyingPartySecret(String | null) // nullable relyingPartySecret
    .scopes(List&lt;String&gt; | null) // nullable scopes
    .showLinkText(Boolean | null) // nullable showLinkText
    .skipSslVerification(Boolean | null) // nullable skipSslVerification
    .tokenKey(String | null) // nullable tokenKey
    .tokenKeyUrl(String | null) // nullable tokenKeyUrl
    .tokenUrl(String) // required tokenUrl
    .checkTokenUrl(String | null) // nullable checkTokenUrl
    .clientAuthInBody(Boolean | null) // nullable clientAuthInBody
    .issuer(String | null) // nullable issuer
    .responseType(String | null) // nullable responseType
    .userInfoUrl(String | null) // nullable userInfoUrl
    .userPropagationParameter(String | null) // nullable userPropagationParameter
    .cacheJwks(Boolean | null) // nullable cacheJwks
    .pkce(Boolean | null) // nullable pkce
    .logoutUrl(String | null) // nullable logoutUrl
    .performRpInitiatedLogout(Boolean | null) // nullable performRpInitiatedLogout
    .build();
 
```
    Returns:
    
    A new OAuth2Configuration builder

Class OAuth2Configuration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getEmailDomains

getProviderDescription

getAuthMethod

getAttributeMappings

getExternalGroupsWhitelist

getStoreCustomAttributes

getAddShadowUserOnLogin

getAuthUrl

getLinkText

getRelyingPartyId

getRelyingPartySecret

getScopes

getShowLinkText

getSkipSslVerification

getTokenKey

getTokenKeyUrl

getTokenUrl

getCheckTokenUrl

getClientAuthInBody

getIssuer

getResponseType

getUserInfoUrl

getUserPropagationParameter

getCacheJwks

getPkce

getLogoutUrl

getPerformRpInitiatedLogout

equals

hashCode

toString

builder