java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.OidcConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OidcConfig.Builder,OidcConfig>
```
@Generated("software.amazon.awssdk:codegen")
public final class OidcConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OidcConfig.Builder,OidcConfig>
```
Use this parameter to configure your OIDC Identity Provider (IdP).

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface OidcConfig.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`authenticationRequestExtraParams()`	A string to string map of identifiers specific to the custom identity provider (IdP) being used.
`String`	`authorizationEndpoint()`	The OIDC IdP authorization endpoint used to configure your private workforce.
`static OidcConfig.Builder`	`builder()`
`String`	`clientId()`	The OIDC IdP client ID used to configure your private workforce.
`String`	`clientSecret()`	The OIDC IdP client secret used to configure your private workforce.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAuthenticationRequestExtraParams()`	For responses, this returns true if the service returned a value for the AuthenticationRequestExtraParams property.
`int`	`hashCode()`
`String`	`issuer()`	The OIDC IdP issuer used to configure your private workforce.
`String`	`jwksUri()`	The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
`String`	`logoutEndpoint()`	The OIDC IdP logout endpoint used to configure your private workforce.
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends OidcConfig.Builder>`	`serializableBuilderClass()`
`OidcConfig.Builder`	`toBuilder()`
`String`	`tokenEndpoint()`	The OIDC IdP token endpoint used to configure your private workforce.
`String`	`toString()`	Returns a string representation of this object.
`String`	`userInfoEndpoint()`	The OIDC IdP user information endpoint used to configure your private workforce.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientId
```
public final String clientId()
```
    The OIDC IdP client ID used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP client ID used to configure your private workforce.
  - clientSecret
```
public final String clientSecret()
```
    The OIDC IdP client secret used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP client secret used to configure your private workforce.
  - issuer
```
public final String issuer()
```
    The OIDC IdP issuer used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP issuer used to configure your private workforce.
  - authorizationEndpoint
```
public final String authorizationEndpoint()
```
    The OIDC IdP authorization endpoint used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP authorization endpoint used to configure your private workforce.
  - tokenEndpoint
```
public final String tokenEndpoint()
```
    The OIDC IdP token endpoint used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP token endpoint used to configure your private workforce.
  - userInfoEndpoint
```
public final String userInfoEndpoint()
```
    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.
  - logoutEndpoint
```
public final String logoutEndpoint()
```
    The OIDC IdP logout endpoint used to configure your private workforce.
    
    Returns:
    
    The OIDC IdP logout endpoint used to configure your private workforce.
  - jwksUri
```
public final String jwksUri()
```
    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.
  - scope
```
public final 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.
    
    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.
  - hasAuthenticationRequestExtraParams
```
public final boolean hasAuthenticationRequestExtraParams()
```
    For responses, this returns true if the service returned a value for the AuthenticationRequestExtraParams property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - authenticationRequestExtraParams
```
public final Map<String,String> authenticationRequestExtraParams()
```
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthenticationRequestExtraParams() method.
    
    Returns:
    
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
  - toBuilder
```
public OidcConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OidcConfig.Builder,OidcConfig>
  - builder
```
public static OidcConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OidcConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class OidcConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientId

clientSecret

issuer

authorizationEndpoint

tokenEndpoint

userInfoEndpoint

logoutEndpoint

jwksUri

scope

hasAuthenticationRequestExtraParams

authenticationRequestExtraParams

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField