Skip to content

Set Ui Customization

cognitoidentityprovider_set_ui_customization R Documentation

Configures UI branding settings for domains with the hosted UI (classic) branding version

Description

Configures UI branding settings for domains with the hosted UI (classic) branding version. Your user pool must have a domain. Configure a domain with .

Set the default configuration for all clients with a ClientId of ALL. When the ClientId value is an app client ID, the settings you pass in this request apply to that app client and override the default ALL configuration.

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

Usage

cognitoidentityprovider_set_ui_customization(UserPoolId, ClientId, CSS,
  ImageFile)

Arguments

UserPoolId

[required] The ID of the user pool where you want to apply branding to the classic hosted UI.
ClientId

The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to ALL.
CSS

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool App clients tab, select Login pages, edit Hosted UI (classic) style, and select the link to ⁠CSS template.css⁠.
ImageFile

The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.

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$set_ui_customization(
  UserPoolId = "string",
  ClientId = "string",
  CSS = "string",
  ImageFile = raw
)