UserPoolClientType (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.cognitoidentityprovider.model.UserPoolClientType

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<UserPoolClientType.Builder,UserPoolClientType>

@Generated("software.amazon.awssdk:codegen")
public class UserPoolClientType
extends Object
implements StructuredPojo, ToCopyableBuilder<UserPoolClientType.Builder,UserPoolClientType>

A user pool of the client type.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UserPoolClientType.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`UserPoolClientType.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`allowedOAuthFlows()`	Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`Boolean`	`allowedOAuthFlowsUserPoolClient()`	Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`List<String>`	`allowedOAuthScopes()`	A list of allowed `OAuth` scopes.
`static UserPoolClientType.Builder`	`builder()`
`List<String>`	`callbackURLs()`	A list of allowed callback URLs for the identity providers.
`String`	`clientId()`	The ID of the client associated with the user pool.
`String`	`clientName()`	The client name from the user pool request of the client type.
`String`	`clientSecret()`	The client secret from the user pool request of the client type.
`Date`	`creationDate()`	The date the user pool client was created.
`String`	`defaultRedirectURI()`	The default redirect URI.
`boolean`	`equals(Object obj)`
`List<String>`	`explicitAuthFlows()`	The explicit authentication flows.
`int`	`hashCode()`
`Date`	`lastModifiedDate()`	The date the user pool client was last modified.
`List<String>`	`logoutURLs()`	A list ofallowed logout URLs for the identity providers.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`List<String>`	`readAttributes()`	The Read-only attributes.
`Integer`	`refreshTokenValidity()`	The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`static Class<? extends UserPoolClientType.Builder>`	`serializableBuilderClass()`
`List<String>`	`supportedIdentityProviders()`	A list of provider names for the identity providers that are supported on this client.
`UserPoolClientType.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`userPoolId()`	The user pool ID for the user pool client.
`List<String>`	`writeAttributes()`	The writeable attributes.

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

- Method Detail
  - userPoolId
```
public String userPoolId()
```
    The user pool ID for the user pool client.
    
    Returns:
    
    The user pool ID for the user pool client.
  - clientName
```
public String clientName()
```
    The client name from the user pool request of the client type.
    
    Returns:
    
    The client name from the user pool request of the client type.
  - clientId
```
public String clientId()
```
    The ID of the client associated with the user pool.
    
    Returns:
    
    The ID of the client associated with the user pool.
  - clientSecret
```
public String clientSecret()
```
    The client secret from the user pool request of the client type.
    
    Returns:
    
    The client secret from the user pool request of the client type.
  - lastModifiedDate
```
public Date lastModifiedDate()
```
    The date the user pool client was last modified.
    
    Returns:
    
    The date the user pool client was last modified.
  - creationDate
```
public Date creationDate()
```
    The date the user pool client was created.
    
    Returns:
    
    The date the user pool client was created.
  - refreshTokenValidity
```
public Integer refreshTokenValidity()
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Returns:
    
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - readAttributes
```
public List<String> readAttributes()
```
    The Read-only attributes.
    
    Returns:
    
    The Read-only attributes.
  - writeAttributes
```
public List<String> writeAttributes()
```
    The writeable attributes.
    
    Returns:
    
    The writeable attributes.
  - explicitAuthFlows
```
public List<String> explicitAuthFlows()
```
    The explicit authentication flows.
    
    Returns:
    
    The explicit authentication flows.
    
    See Also:
    
    ExplicitAuthFlowsType
  - supportedIdentityProviders
```
public List<String> supportedIdentityProviders()
```
    A list of provider names for the identity providers that are supported on this client.
    
    Returns:
    
    A list of provider names for the identity providers that are supported on this client.
  - callbackURLs
```
public List<String> callbackURLs()
```
    A list of allowed callback URLs for the identity providers.
    
    Returns:
    
    A list of allowed callback URLs for the identity providers.
  - logoutURLs
```
public List<String> logoutURLs()
```
    A list ofallowed logout URLs for the identity providers.
    
    Returns:
    
    A list ofallowed logout URLs for the identity providers.
  - defaultRedirectURI
```
public String defaultRedirectURI()
```
    The default redirect URI. Must be in the CallbackURLs list.
    
    Returns:
    
    The default redirect URI. Must be in the CallbackURLs list.
  - allowedOAuthFlows
```
public List<String> allowedOAuthFlows()
```
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Returns:
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    See Also:
    
    OAuthFlowType
  - allowedOAuthScopes
```
public List<String> allowedOAuthScopes()
```
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Returns:
    
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
  - allowedOAuthFlowsUserPoolClient
```
public Boolean allowedOAuthFlowsUserPoolClient()
```
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns:
    
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - toBuilder
```
public UserPoolClientType.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserPoolClientType.Builder,UserPoolClientType>
    
    Returns:
    
    a builder for type T
  - builder
```
public static UserPoolClientType.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UserPoolClientType.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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.

Class UserPoolClientType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

userPoolId

clientName

clientId

clientSecret

lastModifiedDate

creationDate

refreshTokenValidity

readAttributes

writeAttributes

explicitAuthFlows

supportedIdentityProviders

callbackURLs

logoutURLs

defaultRedirectURI

allowedOAuthFlows

allowedOAuthScopes

allowedOAuthFlowsUserPoolClient

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall