Set Ui Customization

cognitoidentityprovider_set_ui_customization

R Documentation

Sets the user interface (UI) customization information for a user pool's built-in app UI¶

Description¶

Sets the user interface (UI) customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration.

To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.

Usage¶

cognitoidentityprovider_set_ui_customization(UserPoolId, ClientId, CSS,
  ImageFile)

Arguments¶

UserPoolId: [required] The user pool ID for the user pool.
ClientId: The client ID for the client app.
CSS: The CSS values in the UI customization.
ImageFile: The uploaded logo image for the UI customization.

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
)