Describe Managed Login Branding

cognitoidentityprovider_describe_managed_login_branding

R Documentation

Given the ID of a managed login branding style, returns detailed information about the style

Description

Given the ID of a managed login branding style, returns detailed information about the style.

Usage

cognitoidentityprovider_describe_managed_login_branding(UserPoolId,
  ManagedLoginBrandingId, ReturnMergedResources)

Arguments

UserPoolId

[required] The ID of the user pool that contains the managed login branding style that you want to get information about.

ManagedLoginBrandingId

[required] The ID of the managed login branding style that you want to get more information about.

ReturnMergedResources

When true, returns values for branding options that are unchanged from Amazon Cognito defaults. When false or when you omit this parameter, returns only values that you customized in your branding style.

Value

A list with the following syntax:

list(
  ManagedLoginBranding = list(
    ManagedLoginBrandingId = "string",
    UserPoolId = "string",
    UseCognitoProvidedValues = TRUE|FALSE,
    Settings = list(),
    Assets = list(
      list(
        Category = "FAVICON_ICO"|"FAVICON_SVG"|"EMAIL_GRAPHIC"|"SMS_GRAPHIC"|"AUTH_APP_GRAPHIC"|"PASSWORD_GRAPHIC"|"PASSKEY_GRAPHIC"|"PAGE_HEADER_LOGO"|"PAGE_HEADER_BACKGROUND"|"PAGE_FOOTER_LOGO"|"PAGE_FOOTER_BACKGROUND"|"PAGE_BACKGROUND"|"FORM_BACKGROUND"|"FORM_LOGO"|"IDP_BUTTON_ICON",
        ColorMode = "LIGHT"|"DARK"|"DYNAMIC",
        Extension = "ICO"|"JPEG"|"PNG"|"SVG"|"WEBP",
        Bytes = raw,
        ResourceId = "string"
      )
    ),
    CreationDate = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$describe_managed_login_branding(
  UserPoolId = "string",
  ManagedLoginBrandingId = "string",
  ReturnMergedResources = TRUE|FALSE
)