pulumi-aws-kotlin/com.pulumi.aws.cognito.kotlin.outputs/GetUserPoolClientResult

GetUserPoolClientResult

data class GetUserPoolClientResult(val accessTokenValidity: Int, val allowedOauthFlows: List<String>, val allowedOauthFlowsUserPoolClient: Boolean, val allowedOauthScopes: List<String>, val analyticsConfigurations: List<GetUserPoolClientAnalyticsConfiguration>, val callbackUrls: List<String>, val clientId: String, val clientSecret: String, val defaultRedirectUri: String, val enablePropagateAdditionalUserContextData: Boolean, val enableTokenRevocation: Boolean, val explicitAuthFlows: List<String>, val generateSecret: Boolean, val id: String, val idTokenValidity: Int, val logoutUrls: List<String>, val name: String, val preventUserExistenceErrors: String, val readAttributes: List<String>, val refreshTokenValidity: Int, val supportedIdentityProviders: List<String>, val tokenValidityUnits: List<GetUserPoolClientTokenValidityUnit>, val userPoolId: String, val writeAttributes: List<String>)

A collection of values returned by getUserPoolClient.

Constructors

constructor(accessTokenValidity: Int, allowedOauthFlows: List<String>, allowedOauthFlowsUserPoolClient: Boolean, allowedOauthScopes: List<String>, analyticsConfigurations: List<GetUserPoolClientAnalyticsConfiguration>, callbackUrls: List<String>, clientId: String, clientSecret: String, defaultRedirectUri: String, enablePropagateAdditionalUserContextData: Boolean, enableTokenRevocation: Boolean, explicitAuthFlows: List<String>, generateSecret: Boolean, id: String, idTokenValidity: Int, logoutUrls: List<String>, name: String, preventUserExistenceErrors: String, readAttributes: List<String>, refreshTokenValidity: Int, supportedIdentityProviders: List<String>, tokenValidityUnits: List<GetUserPoolClientTokenValidityUnit>, userPoolId: String, writeAttributes: List<String>)

Types

Companion

object Companion

Properties

accessTokenValidity

val accessTokenValidity: Int

(Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in token_validity_units.

allowedOauthFlows

val allowedOauthFlows: List<String>

(Optional) List of allowed OAuth flows (code, implicit, client_credentials).

allowedOauthFlowsUserPoolClient

val allowedOauthFlowsUserPoolClient: Boolean

(Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

allowedOauthScopes

val allowedOauthScopes: List<String>

(Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).

analyticsConfigurations

val analyticsConfigurations: List<GetUserPoolClientAnalyticsConfiguration>

(Optional) Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.

callbackUrls

val callbackUrls: List<String>

(Optional) List of allowed callback URLs for the identity providers.

clientId

val clientId: String

clientSecret

val clientSecret: String

Client secret of the user pool client.

defaultRedirectUri

val defaultRedirectUri: String

(Optional) Default redirect URI. Must be in the list of callback URLs.

enablePropagateAdditionalUserContextData

val enablePropagateAdditionalUserContextData: Boolean

enableTokenRevocation

val enableTokenRevocation: Boolean

(Optional) Enables or disables token revocation.

explicitAuthFlows

val explicitAuthFlows: List<String>

(Optional) List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).

generateSecret

val generateSecret: Boolean

(Optional) Should an application secret be generated.

val id: String

The provider-assigned unique ID for this managed resource.

idTokenValidity

val idTokenValidity: Int

(Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in token_validity_units.

logoutUrls

val logoutUrls: List<String>

(Optional) List of allowed logout URLs for the identity providers.

name

val name: String

preventUserExistenceErrors

val preventUserExistenceErrors: String

(Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

readAttributes

val readAttributes: List<String>

(Optional) List of user pool attributes the application client can read from.

refreshTokenValidity

val refreshTokenValidity: Int

(Optional) Time limit in days refresh tokens are valid for.

supportedIdentityProviders

val supportedIdentityProviders: List<String>

(Optional) List of provider names for the identity providers that are supported on this client. Uses the provider_name attribute of aws.cognito.IdentityProvider resource(s), or the equivalent string(s).

tokenValidityUnits

val tokenValidityUnits: List<GetUserPoolClientTokenValidityUnit>

(Optional) Configuration block for units in which the validity times are represented in. Detailed below.

userPoolId

val userPoolId: String

writeAttributes

val writeAttributes: List<String>

(Optional) List of user pool attributes the application client can write to.