Describe User Pool Client

cognitoidentityprovider_describe_user_pool_client

R Documentation

Given an app client ID, returns configuration information

Description

Given an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_describe_user_pool_client(UserPoolId, ClientId)

Arguments

UserPoolId

[required] The ID of the user pool that contains the app client you want to describe.

ClientId

[required] The ID of the app client that you want to describe.

Value

A list with the following syntax:

list(
  UserPoolClient = list(
    UserPoolId = "string",
    ClientName = "string",
    ClientId = "string",
    ClientSecret = "string",
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    CreationDate = as.POSIXct(
      "2015-01-01"
    ),
    RefreshTokenValidity = 123,
    AccessTokenValidity = 123,
    IdTokenValidity = 123,
    TokenValidityUnits = list(
      AccessToken = "seconds"|"minutes"|"hours"|"days",
      IdToken = "seconds"|"minutes"|"hours"|"days",
      RefreshToken = "seconds"|"minutes"|"hours"|"days"
    ),
    ReadAttributes = list(
      "string"
    ),
    WriteAttributes = list(
      "string"
    ),
    ExplicitAuthFlows = list(
      "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"|"ALLOW_USER_AUTH"
    ),
    SupportedIdentityProviders = list(
      "string"
    ),
    CallbackURLs = list(
      "string"
    ),
    LogoutURLs = list(
      "string"
    ),
    DefaultRedirectURI = "string",
    AllowedOAuthFlows = list(
      "code"|"implicit"|"client_credentials"
    ),
    AllowedOAuthScopes = list(
      "string"
    ),
    AllowedOAuthFlowsUserPoolClient = TRUE|FALSE,
    AnalyticsConfiguration = list(
      ApplicationId = "string",
      ApplicationArn = "string",
      RoleArn = "string",
      ExternalId = "string",
      UserDataShared = TRUE|FALSE
    ),
    PreventUserExistenceErrors = "LEGACY"|"ENABLED",
    EnableTokenRevocation = TRUE|FALSE,
    EnablePropagateAdditionalUserContextData = TRUE|FALSE,
    AuthSessionValidity = 123
  )
)

Request syntax

svc$describe_user_pool_client(
  UserPoolId = "string",
  ClientId = "string"
)