OidcConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.OidcConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OidcConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Use this parameter to configure your OIDC Identity Provider (IdP).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OidcConfig()

Constructors
Constructor and Description
`OidcConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OidcConfig`	`addAuthenticationRequestExtraParamsEntry(String key, String value)` Add a single AuthenticationRequestExtraParams entry
`OidcConfig`	`clearAuthenticationRequestExtraParamsEntries()` Removes all the entries added into AuthenticationRequestExtraParams.
`OidcConfig`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAuthenticationRequestExtraParams()` A string to string map of identifiers specific to the custom identity provider (IdP) being used.
`String`	`getAuthorizationEndpoint()` The OIDC IdP authorization endpoint used to configure your private workforce.
`String`	`getClientId()` The OIDC IdP client ID used to configure your private workforce.
`String`	`getClientSecret()` The OIDC IdP client secret used to configure your private workforce.
`String`	`getIssuer()` The OIDC IdP issuer used to configure your private workforce.
`String`	`getJwksUri()` The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
`String`	`getLogoutEndpoint()` The OIDC IdP logout endpoint used to configure your private workforce.
`String`	`getScope()` An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
`String`	`getTokenEndpoint()` The OIDC IdP token endpoint used to configure your private workforce.
`String`	`getUserInfoEndpoint()` The OIDC IdP user information endpoint used to configure your private workforce.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)` A string to string map of identifiers specific to the custom identity provider (IdP) being used.
`void`	`setAuthorizationEndpoint(String authorizationEndpoint)` The OIDC IdP authorization endpoint used to configure your private workforce.
`void`	`setClientId(String clientId)` The OIDC IdP client ID used to configure your private workforce.
`void`	`setClientSecret(String clientSecret)` The OIDC IdP client secret used to configure your private workforce.
`void`	`setIssuer(String issuer)` The OIDC IdP issuer used to configure your private workforce.
`void`	`setJwksUri(String jwksUri)` The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
`void`	`setLogoutEndpoint(String logoutEndpoint)` The OIDC IdP logout endpoint used to configure your private workforce.
`void`	`setScope(String scope)` An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
`void`	`setTokenEndpoint(String tokenEndpoint)` The OIDC IdP token endpoint used to configure your private workforce.
`void`	`setUserInfoEndpoint(String userInfoEndpoint)` The OIDC IdP user information endpoint used to configure your private workforce.
`String`	`toString()` Returns a string representation of this object.
`OidcConfig`	`withAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)` A string to string map of identifiers specific to the custom identity provider (IdP) being used.
`OidcConfig`	`withAuthorizationEndpoint(String authorizationEndpoint)` The OIDC IdP authorization endpoint used to configure your private workforce.
`OidcConfig`	`withClientId(String clientId)` The OIDC IdP client ID used to configure your private workforce.
`OidcConfig`	`withClientSecret(String clientSecret)` The OIDC IdP client secret used to configure your private workforce.
`OidcConfig`	`withIssuer(String issuer)` The OIDC IdP issuer used to configure your private workforce.
`OidcConfig`	`withJwksUri(String jwksUri)` The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
`OidcConfig`	`withLogoutEndpoint(String logoutEndpoint)` The OIDC IdP logout endpoint used to configure your private workforce.
`OidcConfig`	`withScope(String scope)` An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
`OidcConfig`	`withTokenEndpoint(String tokenEndpoint)` The OIDC IdP token endpoint used to configure your private workforce.
`OidcConfig`	`withUserInfoEndpoint(String userInfoEndpoint)` The OIDC IdP user information endpoint used to configure your private workforce.

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

- Constructor Detail
  - OidcConfig
```
public OidcConfig()
```
- Method Detail
  - setClientId
```
public void setClientId(String clientId)
```
    The OIDC IdP client ID used to configure your private workforce.
    
    Parameters:
    
    clientId - The OIDC IdP client ID used to configure your private workforce.
  - getClientId
```
public String getClientId()
```
    The OIDC IdP client ID used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP client ID used to configure your private workforce.
  - withClientId
```
public OidcConfig withClientId(String clientId)
```
    The OIDC IdP client ID used to configure your private workforce.
    
    Parameters:
    
    clientId - The OIDC IdP client ID used to configure your private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    The OIDC IdP client secret used to configure your private workforce.
    
    Parameters:
    
    clientSecret - The OIDC IdP client secret used to configure your private workforce.
  - getClientSecret
```
public String getClientSecret()
```
    The OIDC IdP client secret used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP client secret used to configure your private workforce.
  - withClientSecret
```
public OidcConfig withClientSecret(String clientSecret)
```
    The OIDC IdP client secret used to configure your private workforce.
    
    Parameters:
    
    clientSecret - The OIDC IdP client secret used to configure your private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIssuer
```
public void setIssuer(String issuer)
```
    The OIDC IdP issuer used to configure your private workforce.
    
    Parameters:
    
    issuer - The OIDC IdP issuer used to configure your private workforce.
  - getIssuer
```
public String getIssuer()
```
    The OIDC IdP issuer used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP issuer used to configure your private workforce.
  - withIssuer
```
public OidcConfig withIssuer(String issuer)
```
    The OIDC IdP issuer used to configure your private workforce.
    
    Parameters:
    
    issuer - The OIDC IdP issuer used to configure your private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthorizationEndpoint
```
public void setAuthorizationEndpoint(String authorizationEndpoint)
```
    The OIDC IdP authorization endpoint used to configure your private workforce.
    
    Parameters:
    
    authorizationEndpoint - The OIDC IdP authorization endpoint used to configure your private workforce.
  - getAuthorizationEndpoint
```
public String getAuthorizationEndpoint()
```
    The OIDC IdP authorization endpoint used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP authorization endpoint used to configure your private workforce.
  - withAuthorizationEndpoint
```
public OidcConfig withAuthorizationEndpoint(String authorizationEndpoint)
```
    The OIDC IdP authorization endpoint used to configure your private workforce.
    
    Parameters:
    
    authorizationEndpoint - The OIDC IdP authorization endpoint used to configure your private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTokenEndpoint
```
public void setTokenEndpoint(String tokenEndpoint)
```
    The OIDC IdP token endpoint used to configure your private workforce.
    
    Parameters:
    
    tokenEndpoint - The OIDC IdP token endpoint used to configure your private workforce.
  - getTokenEndpoint
```
public String getTokenEndpoint()
```
    The OIDC IdP token endpoint used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP token endpoint used to configure your private workforce.
  - withTokenEndpoint
```
public OidcConfig withTokenEndpoint(String tokenEndpoint)
```
    The OIDC IdP token endpoint used to configure your private workforce.
    
    Parameters:
    
    tokenEndpoint - The OIDC IdP token endpoint used to configure your private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserInfoEndpoint
```
public void setUserInfoEndpoint(String userInfoEndpoint)
```
    The OIDC IdP user information endpoint used to configure your private workforce.
    
    Parameters:
    
    userInfoEndpoint - The OIDC IdP user information endpoint used to configure your private workforce.
  - getUserInfoEndpoint
```
public String getUserInfoEndpoint()
```
    The OIDC IdP user information endpoint used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP user information endpoint used to configure your private workforce.
  - withUserInfoEndpoint
```
public OidcConfig withUserInfoEndpoint(String userInfoEndpoint)
```
    The OIDC IdP user information endpoint used to configure your private workforce.
    
    Parameters:
    
    userInfoEndpoint - The OIDC IdP user information endpoint used to configure your private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogoutEndpoint
```
public void setLogoutEndpoint(String logoutEndpoint)
```
    The OIDC IdP logout endpoint used to configure your private workforce.
    
    Parameters:
    
    logoutEndpoint - The OIDC IdP logout endpoint used to configure your private workforce.
  - getLogoutEndpoint
```
public String getLogoutEndpoint()
```
    The OIDC IdP logout endpoint used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP logout endpoint used to configure your private workforce.
  - withLogoutEndpoint
```
public OidcConfig withLogoutEndpoint(String logoutEndpoint)
```
    The OIDC IdP logout endpoint used to configure your private workforce.
    
    Parameters:
    
    logoutEndpoint - The OIDC IdP logout endpoint used to configure your private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJwksUri
```
public void setJwksUri(String jwksUri)
```
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    
    Parameters:
    
    jwksUri - The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
  - getJwksUri
```
public String getJwksUri()
```
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
  - withJwksUri
```
public OidcConfig withJwksUri(String jwksUri)
```
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    
    Parameters:
    
    jwksUri - The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScope
```
public void setScope(String scope)
```
    An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
    
    Parameters:
    
    scope - An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
  - getScope
```
public String getScope()
```
    An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
    
    Returns:
    
    An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
  - withScope
```
public OidcConfig withScope(String scope)
```
    An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
    
    Parameters:
    
    scope - An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAuthenticationRequestExtraParams
```
public Map<String,String> getAuthenticationRequestExtraParams()
```
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    
    Returns:
    
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
  - setAuthenticationRequestExtraParams
```
public void setAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)
```
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    
    Parameters:
    
    authenticationRequestExtraParams - A string to string map of identifiers specific to the custom identity provider (IdP) being used.
  - withAuthenticationRequestExtraParams
```
public OidcConfig withAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)
```
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    
    Parameters:
    
    authenticationRequestExtraParams - A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAuthenticationRequestExtraParamsEntry
```
public OidcConfig addAuthenticationRequestExtraParamsEntry(String key,
                                                           String value)
```
    Add a single AuthenticationRequestExtraParams entry
    
    See Also:
    
    withAuthenticationRequestExtraParams(java.util.Map<java.lang.String, java.lang.String>)
  - clearAuthenticationRequestExtraParamsEntries
```
public OidcConfig clearAuthenticationRequestExtraParamsEntries()
```
    Removes all the entries added into AuthenticationRequestExtraParams.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 OidcConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class OidcConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OidcConfig

Method Detail

setClientId

getClientId

withClientId

setClientSecret

getClientSecret

withClientSecret

setIssuer

getIssuer

withIssuer

setAuthorizationEndpoint

getAuthorizationEndpoint

withAuthorizationEndpoint

setTokenEndpoint

getTokenEndpoint

withTokenEndpoint

setUserInfoEndpoint

getUserInfoEndpoint

withUserInfoEndpoint

setLogoutEndpoint

getLogoutEndpoint

withLogoutEndpoint

setJwksUri

getJwksUri

withJwksUri

setScope

getScope

withScope

getAuthenticationRequestExtraParams

setAuthenticationRequestExtraParams

withAuthenticationRequestExtraParams

addAuthenticationRequestExtraParamsEntry

clearAuthenticationRequestExtraParamsEntries

toString

equals

hashCode

clone

marshall