DescribeManagedLoginBrandingByClient
Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.
Request Syntax
{
"ClientId": "string",
"ReturnMergedResources": boolean,
"UserPoolId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientId
-
The app client that's assigned to the branding style that you want more information about.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+]+Required: Yes
- ReturnMergedResources
-
When
true, returns values for branding options that are unchanged from Amazon Cognito defaults. Whenfalseor when you omit this parameter, returns only values that you customized in your branding style.Type: Boolean
Required: No
- UserPoolId
-
The ID of the user pool that contains the app client where you want more information about the managed login branding style.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+Required: Yes
Response Syntax
{
"ManagedLoginBranding": {
"Assets": [
{
"Bytes": blob,
"Category": "string",
"ColorMode": "string",
"Extension": "string",
"ResourceId": "string"
}
],
"CreationDate": number,
"LastModifiedDate": number,
"ManagedLoginBrandingId": "string",
"Settings": JSON value,
"UseCognitoProvidedValues": boolean,
"UserPoolId": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ManagedLoginBranding
-
The details of the requested branding style.
Type: ManagedLoginBrandingType object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
- message
-
The message returned when Amazon Cognito throws an internal error exception.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
- message
-
The message returned when the Amazon Cognito service throws an invalid parameter exception.
- reasonCode
-
The reason code of the exception.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
- message
-
The message returned when the Amazon Cognito service returns a not authorized exception.
HTTP Status Code: 400
- OperationNotEnabledException
-
This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
- message
-
The message returned when the Amazon Cognito service returns a resource not found exception.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
- message
-
The message returned when the Amazon Cognito service returns a too many requests exception.
HTTP Status Code: 400
Examples
Example
The following example request returns managed login style details for the app
client with ID 1example23456789.
Sample Request
POST HTTP/1.1
Host: cognito-idp.ca-central-1.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.DescribeManagedLoginBrandingByClient
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"ClientId": "1example23456789",
"ReturnMergedResources": false,
"UserPoolId": "ca-central-1_EXAMPLE"
}Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
"ManagedLoginBranding": {
"Assets": [
{
"Bytes": "[encoded image file]",
"Category": "PAGE_FOOTER_LOGO",
"ColorMode": "LIGHT",
"Extension": "JPEG"
}
],
"CreationDate": 1732667944.313,
"LastModifiedDate": 1732668950.888,
"ManagedLoginBrandingId": "ef1bb4d9-a28f-4dc6-94c6-49a605de6a6a",
"Settings": {
"categories": {
"auth": {
"authMethodOrder": [
[
{
"display": "BUTTON",
"type": "FEDERATED"
},
{
"display": "INPUT",
"type": "USERNAME_PASSWORD"
}
]
],
"federation": {
"interfaceStyle": "BUTTON_LIST",
"order": [
]
}
},
"form": {
"displayGraphics": true,
"instructions": {
"enabled": false
},
"languageSelector": {
"enabled": false
},
"location": {
"horizontal": "CENTER",
"vertical": "CENTER"
},
"sessionTimerDisplay": "NONE"
},
"global": {
"colorSchemeMode": "LIGHT",
"pageFooter": {
"enabled": true
},
"pageHeader": {
"enabled": true
},
"spacingDensity": "REGULAR"
},
"signUp": {
"acceptanceElements": [
{
"enforcement": "NONE",
"textKey": "en"
}
]
}
},
"componentClasses": {
"buttons": {
"borderRadius": 8.0
},
"divider": {
"darkMode": {
"borderColor": "232b37ff"
},
"lightMode": {
"borderColor": "ebebf0ff"
}
},
"dropDown": {
"borderRadius": 8.0,
"darkMode": {
"defaults": {
"itemBackgroundColor": "192534ff"
},
"hover": {
"itemBackgroundColor": "081120ff",
"itemBorderColor": "5f6b7aff",
"itemTextColor": "e9ebedff"
},
"match": {
"itemBackgroundColor": "d1d5dbff",
"itemTextColor": "89bdeeff"
}
},
"lightMode": {
"defaults": {
"itemBackgroundColor": "ffffffff"
},
"hover": {
"itemBackgroundColor": "f4f4f4ff",
"itemBorderColor": "7d8998ff",
"itemTextColor": "000716ff"
},
"match": {
"itemBackgroundColor": "414d5cff",
"itemTextColor": "0972d3ff"
}
}
},
"focusState": {
"darkMode": {
"borderColor": "539fe5ff"
},
"lightMode": {
"borderColor": "0972d3ff"
}
},
"idpButtons": {
"icons": {
"enabled": true
}
},
"input": {
"borderRadius": 8.0,
"darkMode": {
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "5f6b7aff"
},
"placeholderColor": "8d99a8ff"
},
"lightMode": {
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "7d8998ff"
},
"placeholderColor": "5f6b7aff"
}
},
"inputDescription": {
"darkMode": {
"textColor": "8d99a8ff"
},
"lightMode": {
"textColor": "5f6b7aff"
}
},
"inputLabel": {
"darkMode": {
"textColor": "d1d5dbff"
},
"lightMode": {
"textColor": "000716ff"
}
},
"link": {
"darkMode": {
"defaults": {
"textColor": "539fe5ff"
},
"hover": {
"textColor": "89bdeeff"
}
},
"lightMode": {
"defaults": {
"textColor": "0972d3ff"
},
"hover": {
"textColor": "033160ff"
}
}
},
"optionControls": {
"darkMode": {
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "7d8998ff"
},
"selected": {
"backgroundColor": "539fe5ff",
"foregroundColor": "000716ff"
}
},
"lightMode": {
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "7d8998ff"
},
"selected": {
"backgroundColor": "0972d3ff",
"foregroundColor": "ffffffff"
}
}
},
"statusIndicator": {
"darkMode": {
"error": {
"backgroundColor": "1a0000ff",
"borderColor": "eb6f6fff",
"indicatorColor": "eb6f6fff"
},
"pending": {
"indicatorColor": "AAAAAAAA"
},
"success": {
"backgroundColor": "001a02ff",
"borderColor": "29ad32ff",
"indicatorColor": "29ad32ff"
},
"warning": {
"backgroundColor": "1d1906ff",
"borderColor": "e0ca57ff",
"indicatorColor": "e0ca57ff"
}
},
"lightMode": {
"error": {
"backgroundColor": "fff7f7ff",
"borderColor": "d91515ff",
"indicatorColor": "d91515ff"
},
"pending": {
"indicatorColor": "AAAAAAAA"
},
"success": {
"backgroundColor": "f2fcf3ff",
"borderColor": "037f0cff",
"indicatorColor": "037f0cff"
},
"warning": {
"backgroundColor": "fffce9ff",
"borderColor": "8d6605ff",
"indicatorColor": "8d6605ff"
}
}
}
},
"components": {
"alert": {
"borderRadius": 12.0,
"darkMode": {
"error": {
"backgroundColor": "1a0000ff",
"borderColor": "eb6f6fff"
}
},
"lightMode": {
"error": {
"backgroundColor": "fff7f7ff",
"borderColor": "d91515ff"
}
}
},
"favicon": {
"enabledTypes": [
"ICO",
"SVG"
]
},
"form": {
"backgroundImage": {
"enabled": false
},
"borderRadius": 8.0,
"darkMode": {
"backgroundColor": "0f1b2aff",
"borderColor": "424650ff"
},
"lightMode": {
"backgroundColor": "ffffffff",
"borderColor": "c6c6cdff"
},
"logo": {
"enabled": false,
"formInclusion": "IN",
"location": "CENTER",
"position": "TOP"
}
},
"idpButton": {
"custom": {
},
"standard": {
"darkMode": {
"active": {
"backgroundColor": "354150ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
},
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "c6c6cdff",
"textColor": "c6c6cdff"
},
"hover": {
"backgroundColor": "192534ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
}
},
"lightMode": {
"active": {
"backgroundColor": "d3e7f9ff",
"borderColor": "033160ff",
"textColor": "033160ff"
},
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "424650ff",
"textColor": "424650ff"
},
"hover": {
"backgroundColor": "f2f8fdff",
"borderColor": "033160ff",
"textColor": "033160ff"
}
}
}
},
"pageBackground": {
"darkMode": {
"color": "0f1b2aff"
},
"image": {
"enabled": true
},
"lightMode": {
"color": "ffffffff"
}
},
"pageFooter": {
"backgroundImage": {
"enabled": false
},
"darkMode": {
"background": {
"color": "0f141aff"
},
"borderColor": "424650ff"
},
"lightMode": {
"background": {
"color": "fafafaff"
},
"borderColor": "d5dbdbff"
},
"logo": {
"enabled": true,
"location": "CENTER"
}
},
"pageHeader": {
"backgroundImage": {
"enabled": false
},
"darkMode": {
"background": {
"color": "0f141aff"
},
"borderColor": "424650ff"
},
"lightMode": {
"background": {
"color": "fafafaff"
},
"borderColor": "d5dbdbff"
},
"logo": {
"enabled": false,
"location": "START"
}
},
"pageText": {
"darkMode": {
"bodyColor": "b6bec9ff",
"descriptionColor": "b6bec9ff",
"headingColor": "d1d5dbff"
},
"lightMode": {
"bodyColor": "414d5cff",
"descriptionColor": "414d5cff",
"headingColor": "000716ff"
}
},
"phoneNumberSelector": {
"displayType": "TEXT"
},
"primaryButton": {
"darkMode": {
"active": {
"backgroundColor": "539fe5ff",
"textColor": "000716ff"
},
"defaults": {
"backgroundColor": "539fe5ff",
"textColor": "000716ff"
},
"disabled": {
"backgroundColor": "ffffffff",
"borderColor": "ffffffff"
},
"hover": {
"backgroundColor": "89bdeeff",
"textColor": "000716ff"
}
},
"lightMode": {
"active": {
"backgroundColor": "033160ff",
"textColor": "ffffffff"
},
"defaults": {
"backgroundColor": "0972d3ff",
"textColor": "ffffffff"
},
"disabled": {
"backgroundColor": "ffffffff",
"borderColor": "ffffffff"
},
"hover": {
"backgroundColor": "033160ff",
"textColor": "ffffffff"
}
}
},
"secondaryButton": {
"darkMode": {
"active": {
"backgroundColor": "354150ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
},
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "539fe5ff",
"textColor": "539fe5ff"
},
"hover": {
"backgroundColor": "192534ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
}
},
"lightMode": {
"active": {
"backgroundColor": "d3e7f9ff",
"borderColor": "033160ff",
"textColor": "033160ff"
},
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "0972d3ff",
"textColor": "0972d3ff"
},
"hover": {
"backgroundColor": "f2f8fdff",
"borderColor": "033160ff",
"textColor": "033160ff"
}
}
}
}
},
"UseCognitoProvidedValues": false,
"UserPoolId": "ca-central-1_EXAMPLE"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
