Describe Managed Login Branding By Client

cognitoidentityprovider_describe_managed_login_branding_by_client

R Documentation

Given the ID of a user pool app client, returns detailed information about the style assigned to the app client

Description

Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.

Usage

cognitoidentityprovider_describe_managed_login_branding_by_client(
  UserPoolId, ClientId, ReturnMergedResources)

Arguments

UserPoolId

[required] The ID of the user pool that contains the app client where you want more information about the managed login branding style.

ClientId

[required] The app client that's assigned to the branding style that you want 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_by_client(
  UserPoolId = "string",
  ClientId = "string",
  ReturnMergedResources = TRUE|FALSE
)