Get Ui Customization

cognitoidentityprovider_get_ui_customization

R Documentation

Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any¶

Description¶

Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding information if no app client branding is applied, or if you don't specify an app client ID. Returns an empty object if you haven't applied hosted UI branding to either the client or the user pool. For more information, see Hosted UI (classic) branding.

Usage¶

cognitoidentityprovider_get_ui_customization(UserPoolId, ClientId)

Arguments¶

UserPoolId

[required] The ID of the user pool that you want to query for branding settings.

ClientId

The ID of the app client that you want to query for branding settings.

Value¶

A list with the following syntax:

list(
  UICustomization = list(
    UserPoolId = "string",
    ClientId = "string",
    ImageUrl = "string",
    CSS = "string",
    CSSVersion = "string",
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    CreationDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

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