org.cloudfoundry.uaa.identityproviders

Class OpenIdConnectConfiguration

java.lang.Object

org.cloudfoundry.uaa.identityproviders.OpenIdConnectConfiguration

All Implemented Interfaces:

IdentityProviderConfiguration

@Generated(value={"Immutables.generator","_OpenIdConnectConfiguration"})
public final class OpenIdConnectConfiguration
extends Object

The payload for the OpenId Connect (oidc) identity provider configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenIdConnectConfiguration.Builder Builds instances of type OpenIdConnectConfiguration.

Method Summary

Modifier and Type	Method and Description
static OpenIdConnectConfiguration.Builder	builder() Creates a builder for OpenIdConnectConfiguration.
boolean	equals(Object another) This instance is equal to all instances of OpenIdConnectConfiguration that have equal attribute values.
Boolean	getAddShadowUserOnLogin() Determines whether or not shadow users must be created before login by an administrator.
AttributeMappings	getAttributeMappings()
String	getAuthUrl() The OAuth 2.0 authorization endpoint URL
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
Boolean	getLinkText() Text to use for the login link to the provider
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
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.
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() The Open Id user info endpoint URL.
int	hashCode() Computes a hash code from attributes: userInfoUrl, addShadowUserOnLogin, authUrl, linkText, relyingPartyId, relyingPartySecret, scopes, showLinkText, skipSslVerification, tokenKey, tokenKeyUrl, tokenUrl, attributeMappings, externalGroupsWhitelist, emailDomains, providerDescription.
String	toString() Prints the immutable value OpenIdConnectConfiguration with attribute values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getUserInfoUrl

public String getUserInfoUrl()

The Open Id user info endpoint URL. Reserved for future OIDC use.

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 Boolean 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

getAttributeMappings

public AttributeMappings getAttributeMappings()

Returns:

The value of the attributeMappings attribute

getExternalGroupsWhitelist

public List<String> getExternalGroupsWhitelist()

The external group white list

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

equals

public boolean equals(Object another)

This instance is equal to all instances of OpenIdConnectConfiguration 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: userInfoUrl, addShadowUserOnLogin, authUrl, linkText, relyingPartyId, relyingPartySecret, scopes, showLinkText, skipSslVerification, tokenKey, tokenKeyUrl, tokenUrl, attributeMappings, externalGroupsWhitelist, emailDomains, providerDescription.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value OpenIdConnectConfiguration with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static OpenIdConnectConfiguration.Builder builder()

Creates a builder for OpenIdConnectConfiguration.

Returns:

A new OpenIdConnectConfiguration builder