cognitoidentityprovider_set_ui_customization: Sets the UI customization information for a user pool's...

Description Usage Arguments Details Request syntax

View source: R/cognitoidentityprovider_operations.R

Description

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

Usage

1
2
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.

Details

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 will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back 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.

Request syntax

1
2
3
4
5
6
svc$set_ui_customization(
  UserPoolId = "string",
  ClientId = "string",
  CSS = "string",
  ImageFile = raw
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.