AuthenticateOidcActionConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticloadbalancingv2.model.AuthenticateOidcActionConfig

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AuthenticateOidcActionConfig
extends Object
implements Serializable, Cloneable
```
Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AuthenticateOidcActionConfig()

Constructors
Constructor and Description
`AuthenticateOidcActionConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticateOidcActionConfig`	`addAuthenticationRequestExtraParamsEntry(String key, String value)`
`AuthenticateOidcActionConfig`	`clearAuthenticationRequestExtraParamsEntries()` Removes all the entries added into AuthenticationRequestExtraParams.
`AuthenticateOidcActionConfig`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAuthenticationRequestExtraParams()` The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
`String`	`getAuthorizationEndpoint()` The authorization endpoint of the IdP.
`String`	`getClientId()` The OAuth 2.0 client identifier.
`String`	`getClientSecret()` The OAuth 2.0 client secret.
`String`	`getIssuer()` The OIDC issuer identifier of the IdP.
`String`	`getOnUnauthenticatedRequest()` The behavior if the user is not authenticated.
`String`	`getScope()` The set of user claims to be requested from the IdP.
`String`	`getSessionCookieName()` The name of the cookie used to maintain session information.
`Long`	`getSessionTimeout()` The maximum duration of the authentication session, in seconds.
`String`	`getTokenEndpoint()` The token endpoint of the IdP.
`String`	`getUserInfoEndpoint()` The user info endpoint of the IdP.
`int`	`hashCode()`
`void`	`setAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)` The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
`void`	`setAuthorizationEndpoint(String authorizationEndpoint)` The authorization endpoint of the IdP.
`void`	`setClientId(String clientId)` The OAuth 2.0 client identifier.
`void`	`setClientSecret(String clientSecret)` The OAuth 2.0 client secret.
`void`	`setIssuer(String issuer)` The OIDC issuer identifier of the IdP.
`void`	`setOnUnauthenticatedRequest(String onUnauthenticatedRequest)` The behavior if the user is not authenticated.
`void`	`setScope(String scope)` The set of user claims to be requested from the IdP.
`void`	`setSessionCookieName(String sessionCookieName)` The name of the cookie used to maintain session information.
`void`	`setSessionTimeout(Long sessionTimeout)` The maximum duration of the authentication session, in seconds.
`void`	`setTokenEndpoint(String tokenEndpoint)` The token endpoint of the IdP.
`void`	`setUserInfoEndpoint(String userInfoEndpoint)` The user info endpoint of the IdP.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AuthenticateOidcActionConfig`	`withAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)` The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
`AuthenticateOidcActionConfig`	`withAuthorizationEndpoint(String authorizationEndpoint)` The authorization endpoint of the IdP.
`AuthenticateOidcActionConfig`	`withClientId(String clientId)` The OAuth 2.0 client identifier.
`AuthenticateOidcActionConfig`	`withClientSecret(String clientSecret)` The OAuth 2.0 client secret.
`AuthenticateOidcActionConfig`	`withIssuer(String issuer)` The OIDC issuer identifier of the IdP.
`AuthenticateOidcActionConfig`	`withOnUnauthenticatedRequest(AuthenticateOidcActionConditionalBehaviorEnum onUnauthenticatedRequest)` The behavior if the user is not authenticated.
`AuthenticateOidcActionConfig`	`withOnUnauthenticatedRequest(String onUnauthenticatedRequest)` The behavior if the user is not authenticated.
`AuthenticateOidcActionConfig`	`withScope(String scope)` The set of user claims to be requested from the IdP.
`AuthenticateOidcActionConfig`	`withSessionCookieName(String sessionCookieName)` The name of the cookie used to maintain session information.
`AuthenticateOidcActionConfig`	`withSessionTimeout(Long sessionTimeout)` The maximum duration of the authentication session, in seconds.
`AuthenticateOidcActionConfig`	`withTokenEndpoint(String tokenEndpoint)` The token endpoint of the IdP.
`AuthenticateOidcActionConfig`	`withUserInfoEndpoint(String userInfoEndpoint)` The user info endpoint of the IdP.

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

- Constructor Detail
  - AuthenticateOidcActionConfig
```
public AuthenticateOidcActionConfig()
```
- Method Detail
  - setIssuer
```
public void setIssuer(String issuer)
```
    The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    issuer - The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
  - getIssuer
```
public String getIssuer()
```
    The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
  - withIssuer
```
public AuthenticateOidcActionConfig withIssuer(String issuer)
```
    The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    issuer - The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizationEndpoint
```
public void setAuthorizationEndpoint(String authorizationEndpoint)
```
    The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    authorizationEndpoint - The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
  - getAuthorizationEndpoint
```
public String getAuthorizationEndpoint()
```
    The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
  - withAuthorizationEndpoint
```
public AuthenticateOidcActionConfig withAuthorizationEndpoint(String authorizationEndpoint)
```
    The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    authorizationEndpoint - The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTokenEndpoint
```
public void setTokenEndpoint(String tokenEndpoint)
```
    The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    tokenEndpoint - The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
  - getTokenEndpoint
```
public String getTokenEndpoint()
```
    The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
  - withTokenEndpoint
```
public AuthenticateOidcActionConfig withTokenEndpoint(String tokenEndpoint)
```
    The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    tokenEndpoint - The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserInfoEndpoint
```
public void setUserInfoEndpoint(String userInfoEndpoint)
```
    The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    userInfoEndpoint - The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
  - getUserInfoEndpoint
```
public String getUserInfoEndpoint()
```
    The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
  - withUserInfoEndpoint
```
public AuthenticateOidcActionConfig withUserInfoEndpoint(String userInfoEndpoint)
```
    The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    userInfoEndpoint - The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientId
```
public void setClientId(String clientId)
```
    The OAuth 2.0 client identifier.
    
    Parameters:
    
    clientId - The OAuth 2.0 client identifier.
  - getClientId
```
public String getClientId()
```
    The OAuth 2.0 client identifier.
    
    Returns:
    
    The OAuth 2.0 client identifier.
  - withClientId
```
public AuthenticateOidcActionConfig withClientId(String clientId)
```
    The OAuth 2.0 client identifier.
    
    Parameters:
    
    clientId - The OAuth 2.0 client identifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    The OAuth 2.0 client secret.
    
    Parameters:
    
    clientSecret - The OAuth 2.0 client secret.
  - getClientSecret
```
public String getClientSecret()
```
    The OAuth 2.0 client secret.
    
    Returns:
    
    The OAuth 2.0 client secret.
  - withClientSecret
```
public AuthenticateOidcActionConfig withClientSecret(String clientSecret)
```
    The OAuth 2.0 client secret.
    
    Parameters:
    
    clientSecret - The OAuth 2.0 client secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSessionCookieName
```
public void setSessionCookieName(String sessionCookieName)
```
    The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
    
    Parameters:
    
    sessionCookieName - The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
  - getSessionCookieName
```
public String getSessionCookieName()
```
    The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
    
    Returns:
    
    The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
  - withSessionCookieName
```
public AuthenticateOidcActionConfig withSessionCookieName(String sessionCookieName)
```
    The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
    
    Parameters:
    
    sessionCookieName - The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScope
```
public void setScope(String scope)
```
    The set of user claims to be requested from the IdP. The default is openid.
    
    To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
    
    Parameters:
    
    scope - The set of user claims to be requested from the IdP. The default is openid.
    
    To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
  - getScope
```
public String getScope()
```
    The set of user claims to be requested from the IdP. The default is openid.
    
    To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
    
    Returns:
    
    The set of user claims to be requested from the IdP. The default is openid.
    
    To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
  - withScope
```
public AuthenticateOidcActionConfig withScope(String scope)
```
    The set of user claims to be requested from the IdP. The default is openid.
    
    To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
    
    Parameters:
    
    scope - The set of user claims to be requested from the IdP. The default is openid.
    
    To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSessionTimeout
```
public void setSessionTimeout(Long sessionTimeout)
```
    The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
    
    Parameters:
    
    sessionTimeout - The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
  - getSessionTimeout
```
public Long getSessionTimeout()
```
    The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
    
    Returns:
    
    The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
  - withSessionTimeout
```
public AuthenticateOidcActionConfig withSessionTimeout(Long sessionTimeout)
```
    The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
    
    Parameters:
    
    sessionTimeout - The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAuthenticationRequestExtraParams
```
public Map<String,String> getAuthenticationRequestExtraParams()
```
    The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
    
    Returns:
    
    The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
  - setAuthenticationRequestExtraParams
```
public void setAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)
```
    The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
    
    Parameters:
    
    authenticationRequestExtraParams - The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
  - withAuthenticationRequestExtraParams
```
public AuthenticateOidcActionConfig withAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)
```
    The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
    
    Parameters:
    
    authenticationRequestExtraParams - The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAuthenticationRequestExtraParamsEntry
```
public AuthenticateOidcActionConfig addAuthenticationRequestExtraParamsEntry(String key,
                                                                             String value)
```
  - clearAuthenticationRequestExtraParamsEntries
```
public AuthenticateOidcActionConfig clearAuthenticationRequestExtraParamsEntries()
```
    Removes all the entries added into AuthenticationRequestExtraParams.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOnUnauthenticatedRequest
```
public void setOnUnauthenticatedRequest(String onUnauthenticatedRequest)
```
    The behavior if the user is not authenticated. The following are possible values:
    - deny- Return an HTTP 401 Unauthorized error.
    Parameters: onUnauthenticatedRequest - The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. See Also: AuthenticateOidcActionConditionalBehaviorEnum
  getOnUnauthenticatedRequest public String getOnUnauthenticatedRequest() The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Returns: The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. See Also: AuthenticateOidcActionConditionalBehaviorEnum withOnUnauthenticatedRequest public AuthenticateOidcActionConfig withOnUnauthenticatedRequest(String onUnauthenticatedRequest) The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Parameters: onUnauthenticatedRequest - The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Returns: Returns a reference to this object so that method calls can be chained together. See Also: AuthenticateOidcActionConditionalBehaviorEnum withOnUnauthenticatedRequest public AuthenticateOidcActionConfig withOnUnauthenticatedRequest(AuthenticateOidcActionConditionalBehaviorEnum onUnauthenticatedRequest) The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Parameters: onUnauthenticatedRequest - The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Returns: Returns a reference to this object so that method calls can be chained together. See Also: AuthenticateOidcActionConditionalBehaviorEnum toString public String toString() Returns a string representation of this object; useful for testing and debugging. Overrides: toString in class Object Returns: A string representation of this object. See Also: Object.toString() equals public boolean equals(Object obj) Overrides: equals in class Object hashCode public int hashCode() Overrides: hashCode in class Object clone public AuthenticateOidcActionConfig clone() Overrides: clone in class Object

Did this page help you?

Class AuthenticateOidcActionConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthenticateOidcActionConfig

Method Detail

setIssuer

getIssuer

withIssuer

setAuthorizationEndpoint

getAuthorizationEndpoint

withAuthorizationEndpoint

setTokenEndpoint

getTokenEndpoint

withTokenEndpoint

setUserInfoEndpoint

getUserInfoEndpoint

withUserInfoEndpoint

setClientId

getClientId

withClientId

setClientSecret

getClientSecret

withClientSecret

setSessionCookieName

getSessionCookieName

withSessionCookieName

setScope

getScope

withScope

setSessionTimeout

getSessionTimeout

withSessionTimeout

getAuthenticationRequestExtraParams

setAuthenticationRequestExtraParams

withAuthenticationRequestExtraParams

addAuthenticationRequestExtraParamsEntry

clearAuthenticationRequestExtraParamsEntries

setOnUnauthenticatedRequest

getOnUnauthenticatedRequest

withOnUnauthenticatedRequest

withOnUnauthenticatedRequest

toString

equals

hashCode

clone