Amazon Cognito Cognito Term API

openapi: 3.2.0
info:
  title: Amazon Cognito Identity Provider Term API
  version: '2016-04-18'
  description: Generated from AWS's published Smithy model for Amazon Cognito Identity Provider. 6 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: Term
paths:
  /#CreateTerms:
    post:
      operationId: CreateTerms
      summary: Create Terms
      description: Creates terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client. You can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for their current language, with fallback to default if no document exists for the language. Each request accepts one type of terms document and a map of language-to-link for that document type. You must provide both types of terms documents in at least one language before Amazon Cognito displays your terms documents. Supply each type in separate requests. For more information, see Terms documents. 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/CreateTermsResponse'
        '400':
          description: ConcurrentModificationException; InvalidParameterException; LimitExceededException; OperationNotEnabledException; TermsExistsException
          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.CreateTerms
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateTermsRequest'
      tags:
      - Term
  /#DeleteTerms:
    post:
      operationId: DeleteTerms
      summary: Delete Terms
      description: Deletes the terms documents with the requested ID from your app client. 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.DeleteTerms
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteTermsRequest'
      tags:
      - Term
  /#DescribeTerms:
    post:
      operationId: DescribeTerms
      summary: Describe Terms
      description: Returns details for the requested terms documents ID. For more information, see Terms documents. 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/DescribeTermsResponse'
        '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.DescribeTerms
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeTermsRequest'
      tags:
      - Term
  /#DescribeTermsByClient:
    post:
      operationId: DescribeTermsByClient
      summary: Describe Terms By Client
      description: Returns details for the terms documents that are associated with an app client, identified by the app client ID, user pool ID, and terms name. For more information, see Terms documents. To call DescribeTermsByClient, you must have the cognito-idp:DescribeTermsByClient Identity and Access Management (IAM) permission. An IAM policy that denies cognito-idp:DescribeTerms also denies requests to DescribeTermsByClient. 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/DescribeTermsByClientResponse'
        '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.DescribeTermsByClient
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeTermsByClientRequest'
      tags:
      - Term
  /#ListTerms:
    post:
      operationId: ListTerms
      summary: List Terms
      description: Returns details about all terms documents for the requested user pool. 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/ListTermsResponse'
        '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.ListTerms
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTermsRequest'
      tags:
      - Term
  /#UpdateTerms:
    post:
      operationId: UpdateTerms
      summary: Update Terms
      description: Modifies existing terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client. You can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for their current language, with fallback to default if no document exists for the language. Each request accepts one type of terms document and a map of language-to-link for that document type. You must provide both types of terms documents in at least one language before Amazon Cognito displays your terms documents. Supply each type in separate requests. For more information, see Terms documents. 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/UpdateTermsResponse'
        '400':
          description: ConcurrentModificationException; InvalidParameterException; OperationNotEnabledException; TermsExistsException
          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.UpdateTerms
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateTermsRequest'
      tags:
      - Term
components:
  schemas:
    CreateTermsRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool where you want to create terms documents.
        ClientId:
          type: string
          description: The ID of the app client where you want to create terms documents. Must be an app client in the requested user pool.
        TermsName:
          type: string
          description: A friendly name for the document that you want to create in the current request. Must begin with terms-of-use or privacy-policy as identification of the document type. Provide URLs for both terms-of-use and privacy-policy in separate requests.
        TermsSource:
          type: string
          enum:
          - LINK
          description: This parameter is reserved for future use and currently accepts only one value.
        Enforcement:
          type: string
          enum:
          - NONE
          description: This parameter is reserved for future use and currently accepts only one value.
        Links:
          type: object
          additionalProperties:
            type: string
          description: 'A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don''t have a language-specific URL. For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".'
      required:
      - UserPoolId
      - ClientId
      - TermsName
      - TermsSource
      - Enforcement
    TooManyRequestsException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a too many requests exception.
    CreateTermsResponse:
      type: object
      properties:
        Terms:
          $ref: '#/components/schemas/TermsType'
    UpdateTermsRequest:
      type: object
      properties:
        TermsId:
          type: string
          description: The ID of the terms document that you want to update.
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the terms that you want to update.
        TermsName:
          type: string
          description: The new name that you want to apply to the requested terms documents.
        TermsSource:
          type: string
          enum:
          - LINK
          description: This parameter is reserved for future use and currently accepts only one value.
        Enforcement:
          type: string
          enum:
          - NONE
          description: This parameter is reserved for future use and currently accepts only one value.
        Links:
          type: object
          additionalProperties:
            type: string
          description: 'A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don''t have a language-specific URL. For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".'
      required:
      - TermsId
      - UserPoolId
    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.
    DescribeTermsByClientRequest:
      type: object
      properties:
        ClientId:
          type: string
          description: The ID of the app client that the terms documents are associated with.
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the terms documents that you want to describe.
        TermsName:
          type: string
          description: The name of the terms documents that you want to describe.
      required:
      - ClientId
      - UserPoolId
      - TermsName
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a resource not found exception.
    InternalErrorException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when Amazon Cognito throws an internal error exception.
    TermsType:
      type: object
      properties:
        TermsId:
          type: string
          description: The ID of the terms documents.
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the terms documents.
        ClientId:
          type: string
          description: The ID of the app client that the terms documents are assigned to.
        TermsName:
          type: string
          description: The type and friendly name of the terms documents.
        TermsSource:
          type: string
          enum:
          - LINK
          description: This parameter is reserved for future use and currently accepts one value.
        Enforcement:
          type: string
          enum:
          - NONE
          description: This parameter is reserved for future use and currently accepts one value.
        Links:
          type: object
          additionalProperties:
            type: string
          description: 'A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don''t have a language-specific URL. For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".'
        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.
      required:
      - TermsId
      - UserPoolId
      - ClientId
      - TermsName
      - TermsSource
      - Enforcement
      - Links
      - CreationDate
      - LastModifiedDate
    UpdateTermsResponse:
      type: object
      properties:
        Terms:
          $ref: '#/components/schemas/TermsType'
    DescribeTermsRequest:
      type: object
      properties:
        TermsId:
          type: string
          description: The ID of the terms documents that you want to describe.
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the terms documents that you want to describe.
      required:
      - TermsId
      - UserPoolId
    DeleteTermsRequest:
      type: object
      properties:
        TermsId:
          type: string
          description: The ID of the terms documents that you want to delete.
        UserPoolId:
          type: string
          description: The ID of the user pool that contains the terms documents that you want to delete.
      required:
      - TermsId
      - UserPoolId
    ListTermsRequest:
      type: object
      properties:
        UserPoolId:
          type: string
          description: The ID of the user pool where you want to list terms documents.
        MaxResults:
          type: integer
          description: The maximum number of terms documents that you want Amazon Cognito to return in the response.
        NextToken:
          type: string
          description: This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
      required:
      - UserPoolId
    DescribeTermsByClientResponse:
      type: object
      properties:
        Terms:
          $ref: '#/components/schemas/TermsType'
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
          description: The message provided when the concurrent exception is thrown.
    ListTermsResponse:
      type: object
      properties:
        Terms:
          type: array
          items:
            $ref: '#/components/schemas/TermsDescriptionType'
          description: A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.
        NextToken:
          type: string
          description: This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
      required:
      - Terms
    TermsDescriptionType:
      type: object
      properties:
        TermsId:
          type: string
          description: The ID of the requested terms documents.
        TermsName:
          type: string
          description: The type and friendly name of the requested terms documents.
        Enforcement:
          type: string
          enum:
          - NONE
          description: This parameter is reserved for future use and currently accepts one value.
        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.
      required:
      - TermsId
      - TermsName
      - Enforcement
      - CreationDate
      - LastModifiedDate
    DescribeTermsResponse:
      type: object
      properties:
        Terms:
          $ref: '#/components/schemas/TermsType'
    NotAuthorizedException:
      type: object
      properties:
        message:
          type: string
          description: The message returned when the Amazon Cognito service returns a not authorized exception.
  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)