find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-cognito:amazon-cognito-managed-login-branding-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Cognito Identity Provider Managed Login Branding API
  version: '2016-04-18'
  description: Generated from AWS's published Smithy model for Amazon Cognito Identity Provider. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cognito-idp.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Managed Login Branding
paths:
  /#CreateManagedLoginBranding:
    post:
      operationId: CreateManagedLoginBranding
      summary: Create Managed Login Branding
      description: Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding editor. Provides values for UI customization in a Settings JSON object and image files in an Assets array. To send the JSON object Document type parameter in Settings, you might need to update to the most recent version of your Amazon Web Services SDK. To create a new style with default settings, set UseCognitoProvidedValues to true and don't provide values for any other options. This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateManagedLoginBrandingResponse'
        '400':
          description: ConcurrentModificationException; InvalidParameterException; LimitExceededException; ManagedLoginBrandingExistsException; OperationNotEnabledException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '403':
          description: NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.CreateManagedLoginBranding
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateManagedLoginBrandingRequest'
      tags:
      - Managed Login Branding
  /#DeleteManagedLoginBranding:
    post:
      operationId: DeleteManagedLoginBranding
      summary: Delete Managed Login Branding
      description: Deletes a managed login branding style. When you delete a style, you delete the branding association for an app client. When an app client doesn't have a style assigned, your managed login pages for that app client are nonfunctional until you create a new style or switch the domain branding version. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ConcurrentModificationException; InvalidParameterException; OperationNotEnabledException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '403':
          description: NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.DeleteManagedLoginBranding
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteManagedLoginBrandingRequest'
      tags:
      - Managed Login Branding
  /#DescribeManagedLoginBranding:
    post:
      operationId: DescribeManagedLoginBranding
      summary: Describe Managed Login Branding
      description: Given the ID of a managed login branding style, returns detailed information about the style.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeManagedLoginBrandingResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; OperationNotEnabledException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '403':
          description: NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.DescribeManagedLoginBranding
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeManagedLoginBrandingRequest'
      tags:
      - Managed Login Branding
  /#DescribeManagedLoginBrandingByClient:
    post:
      operationId: DescribeManagedLoginBrandingByClient
      summary: Describe Managed Login Branding By Client
      description: Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeManagedLoginBrandingByClientResponse'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '400':
          description: InvalidParameterException; OperationNotEnabledException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '403':
          description: NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.DescribeManagedLoginBrandingByClient
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeManagedLoginBrandingByClientRequest'
      tags:
      - Managed Login Branding
  /#UpdateManagedLoginBranding:
    post:
      operationId: UpdateManagedLoginBranding
      summary: Update Managed Login Branding
      description: Configures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding editor. Provides values for UI customization in a Settings JSON object and image files in an Assets array. This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateManagedLoginBrandingResponse'
        '400':
          description: ConcurrentModificationException; InvalidParameterException; OperationNotEnabledException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
        '403':
          description: NotAuthorizedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.UpdateManagedLoginBranding
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateManagedLoginBrandingRequest'
      tags:
      - Managed Login Branding
components:
  schemas:
    CreateManagedLoginBrandingResponse:
      type: object
      properties:
        ManagedLoginBranding:
          $ref: '#/components/schemas/ManagedLoginBrandingType'
    DescribeManagedLoginBrandingRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the managed login branding style that you want to get information about.
        ManagedLoginBrandingId:
          type: string
          description: The ID of the managed login branding style that you want to get more information about.
        ReturnMergedResources:
          type: boolean
          description: 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.
      required:
      - UserPoolId
      - ManagedLoginBrandingId
    AssetType:
      type: object
      properties:
        Category:
          type: string
          enum:
          - 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
          description: The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.
        ColorMode:
          type: string
          enum:
          - LIGHT
          - DARK
          - DYNAMIC
          description: 'The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.'
        Extension:
          type: string
          enum:
          - ICO
          - JPEG
          - PNG
          - SVG
          - WEBP
          description: The file type of the image file.
        Bytes:
          type: string
          format: byte
          description: The image file, in Base64-encoded binary.
        ResourceId:
          type: string
          description: The ID of the asset.
      required:
      - Category
      - ColorMode
      - Extension
    TooManyRequestsException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a too many requests exception.
    DescribeManagedLoginBrandingByClientResponse:
      type: object
      properties:
        ManagedLoginBranding:
          $ref: '#/components/schemas/ManagedLoginBrandingType'
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a resource not found exception.
    UpdateManagedLoginBrandingRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the managed login branding style that you want to update.
        ManagedLoginBrandingId:
          type: string
          description: The ID of the managed login branding style that you want to update.
        UseCognitoProvidedValues:
          type: boolean
          description: When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding editor. When you specify true for this option, you must also omit values for Settings and Assets in the request.
        Settings:
          type: object
          description: 'A JSON file, encoded as a Document type, with the the settings that you want to apply to your style. The following components are not currently implemented and reserved for future use: signUp instructions sessionTimerDisplay languageSelector (for localization, see Managed login localization)'
        Assets:
          type: array
          items:
            $ref: '#/components/schemas/AssetType'
          description: An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
    DeleteManagedLoginBrandingRequest:
      type: object
      properties:
        ManagedLoginBrandingId:
          type: string
          description: The ID of the managed login branding style that you want to delete.
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the managed login branding style that you want to delete.
      required:
      - ManagedLoginBrandingId
      - UserPoolId
    CreateManagedLoginBrandingRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool where you want to create a new branding style.
        ClientId:
          type: string
          description: The app client that you want to create the branding style for. Each style is linked to an app client until you delete it.
        UseCognitoProvidedValues:
          type: boolean
          description: When true, applies the default branding style options. These default options are managed by Amazon Cognito. You can modify them later in the branding editor. When you specify true for this option, you must also omit values for Settings and Assets in the request.
        Settings:
          type: object
          description: 'A JSON file, encoded as a Document type, with the the settings that you want to apply to your style. The following components are not currently implemented and reserved for future use: signUp instructions sessionTimerDisplay languageSelector (for localization, see Managed login localization)'
        Assets:
          type: array
          items:
            $ref: '#/components/schemas/AssetType'
          description: An array of image files that you want to apply to functions like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
      required:
      - UserPoolId
      - ClientId
    DescribeManagedLoginBrandingResponse:
      type: object
      properties:
        ManagedLoginBranding:
          $ref: '#/components/schemas/ManagedLoginBrandingType'
    UpdateManagedLoginBrandingResponse:
      type: object
      properties:
        ManagedLoginBranding:
          $ref: '#/components/schemas/ManagedLoginBrandingType'
    NotAuthorizedException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a not authorized exception.
    InternalErrorException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when Amazon Cognito throws an internal error exception.
    DescribeManagedLoginBrandingByClientRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the app client where you want more information about the managed login branding style.
        ClientId:
          type: string
          description: The app client that's assigned to the branding style that you want more information about.
        ReturnMergedResources:
          type: boolean
          description: 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.
      required:
      - UserPoolId
      - ClientId
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service throws an invalid parameter exception.
        reasonCode:
          type: string
          description: The reason code of the exception.
    ManagedLoginBrandingType:
      type: object
      properties:
        ManagedLoginBrandingId:
          type: string
          description: The ID of the managed login branding style.
        UserPoolId:
          type: string
          description: The user pool where the branding style is assigned.
        UseCognitoProvidedValues:
          type: boolean
          description: When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding editor. When you specify true for this option, you must also omit values for Settings and Assets in the request.
        Settings:
          type: object
          description: 'A JSON file, encoded as a Document type, with the the settings that you want to apply to your style. The following components are not currently implemented and reserved for future use: signUp instructions sessionTimerDisplay languageSelector (for localization, see Managed login localization)'
        Assets:
          type: array
          items:
            $ref: '#/components/schemas/AssetType'
          description: An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
        CreationDate:
          type: string
          format: date-time
          description: The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
        LastModifiedDate:
          type: string
          format: date-time
          description: The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
          description: The message provided when the concurrent exception is thrown.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: cognito-idp
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)