Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents API

openapi: 3.0.0
info:
  version: '2014-06-30'
  x-release: v4
  title: 'Amazon Cognito Identity #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents API'
  description: <fullname>Amazon Cognito Federated Identities</fullname> <p>Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.</p> <p>Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.</p> <p>For a description of the authentication flow from the Amazon Cognito Developer Guide see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p> <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: cognito-identity
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-identity-2014-06-30.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://cognito-identity.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity multi-region endpoint
- url: https://cognito-identity.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity multi-region endpoint
- url: http://cognito-identity.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-identity.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents'
paths:
  /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: AdminListUserAuthEvents
      description: <p>A history of user activity and any risks detected as part of Amazon Cognito advanced security.</p> <note> <p>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.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminListUserAuthEventsResponse'
              examples:
                AdminListUserAuthEvents200Example:
                  summary: Default AdminListUserAuthEvents 200 response
                  x-microcks-default: true
                  value:
                    AuthEvents: example
                    NextToken: example
        '480':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
              examples:
                AdminListUserAuthEvents480Example:
                  summary: Default AdminListUserAuthEvents 480 response
                  x-microcks-default: true
                  value: example
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                AdminListUserAuthEvents481Example:
                  summary: Default AdminListUserAuthEvents 481 response
                  x-microcks-default: true
                  value: example
        '482':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
              examples:
                AdminListUserAuthEvents482Example:
                  summary: Default AdminListUserAuthEvents 482 response
                  x-microcks-default: true
                  value: example
        '483':
          description: NotAuthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
              examples:
                AdminListUserAuthEvents483Example:
                  summary: Default AdminListUserAuthEvents 483 response
                  x-microcks-default: true
                  value: example
        '484':
          description: UserNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserNotFoundException'
              examples:
                AdminListUserAuthEvents484Example:
                  summary: Default AdminListUserAuthEvents 484 response
                  x-microcks-default: true
                  value: example
        '485':
          description: UserPoolAddOnNotEnabledException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPoolAddOnNotEnabledException'
              examples:
                AdminListUserAuthEvents485Example:
                  summary: Default AdminListUserAuthEvents 485 response
                  x-microcks-default: true
                  value: example
        '486':
          description: InternalErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
              examples:
                AdminListUserAuthEvents486Example:
                  summary: Default AdminListUserAuthEvents 486 response
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminListUserAuthEventsRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.AdminListUserAuthEvents
      summary: Amazon Cognito Admin List User Auth Events
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents'
components:
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    PaginationKey:
      type: string
      pattern: '[\S]+'
      minLength: 1
    ResourceNotFoundException: {}
    RiskDecisionType:
      type: string
      enum:
      - NoRisk
      - AccountTakeover
      - Block
    DateType:
      type: string
      format: date-time
    EventContextDataType:
      type: object
      properties:
        IpAddress:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The source IP address of your user's device.
        DeviceName:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The user's device name.
        Timezone:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The user's time zone.
        City:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The user's city.
        Country:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The user's country.
      description: Specifies the user context data captured at the time of an event request.
    ChallengeResponseListType:
      type: array
      items:
        $ref: '#/components/schemas/ChallengeResponseType'
    EventType:
      type: string
      enum:
      - SignIn
      - SignUp
      - ForgotPassword
      - PasswordChange
      - ResendCode
    AdminListUserAuthEventsResponse:
      type: object
      properties:
        AuthEvents:
          allOf:
          - $ref: '#/components/schemas/AuthEventsType'
          - description: The response object. It includes the <code>EventID</code>, <code>EventType</code>, <code>CreationDate</code>, <code>EventRisk</code>, and <code>EventResponse</code>.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationKey'
          - description: A pagination token.
    AdminListUserAuthEventsRequest:
      type: object
      required:
      - UserPoolId
      - Username
      title: AdminListUserAuthEventsRequest
      properties:
        UserPoolId:
          allOf:
          - $ref: '#/components/schemas/UserPoolIdType'
          - description: The user pool ID.
        Username:
          allOf:
          - $ref: '#/components/schemas/UsernameType'
          - description: The user pool username or an alias.
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/QueryLimitType'
          - description: The maximum number of authentication events to return. Returns 60 events if you set <code>MaxResults</code> to 0, or if you don't include a <code>MaxResults</code> parameter.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationKey'
          - description: A pagination token.
    InvalidParameterException: {}
    EventRiskType:
      type: object
      properties:
        RiskDecision:
          allOf:
          - $ref: '#/components/schemas/RiskDecisionType'
          - description: The risk decision.
        RiskLevel:
          allOf:
          - $ref: '#/components/schemas/RiskLevelType'
          - description: The risk level.
        CompromisedCredentialsDetected:
          allOf:
          - $ref: '#/components/schemas/WrappedBooleanType'
          - description: Indicates whether compromised credentials were detected during an authentication event.
      description: The event risk type.
    EventFeedbackType:
      type: object
      required:
      - FeedbackValue
      - Provider
      properties:
        FeedbackValue:
          allOf:
          - $ref: '#/components/schemas/FeedbackValueType'
          - description: The authentication event feedback value. When you provide a <code>FeedbackValue</code> value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.
        Provider:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The provider.
        FeedbackDate:
          allOf:
          - $ref: '#/components/schemas/DateType'
          - description: The event feedback date.
      description: Specifies the event feedback type.
    EventResponseType:
      type: string
      enum:
      - Pass
      - Fail
      - InProgress
    AuthEventsType:
      type: array
      items:
        $ref: '#/components/schemas/AuthEventType'
    RiskLevelType:
      type: string
      enum:
      - Low
      - Medium
      - High
    QueryLimitType:
      type: integer
      minimum: 0
      maximum: 60
    WrappedBooleanType:
      type: boolean
    UserNotFoundException: {}
    UserPoolAddOnNotEnabledException: {}
    StringType:
      type: string
      minLength: 0
      maxLength: 131072
    ChallengeResponseType:
      type: object
      properties:
        ChallengeName:
          allOf:
          - $ref: '#/components/schemas/ChallengeName'
          - description: The challenge name.
        ChallengeResponse:
          allOf:
          - $ref: '#/components/schemas/ChallengeResponse'
          - description: The challenge response.
      description: The challenge response type.
    UserPoolIdType:
      type: string
      pattern: '[\w-]+_[0-9a-zA-Z]+'
      minLength: 1
      maxLength: 55
    ChallengeName:
      type: string
      enum:
      - Password
      - Mfa
    NotAuthorizedException: {}
    FeedbackValueType:
      type: string
      enum:
      - Valid
      - Invalid
    InternalErrorException: {}
    UsernameType:
      type: string
      pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
      minLength: 1
      maxLength: 128
      format: password
    ChallengeResponse:
      type: string
      enum:
      - Success
      - Failure
    TooManyRequestsException: {}
    AuthEventType:
      type: object
      properties:
        EventId:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The event ID.
        EventType:
          allOf:
          - $ref: '#/components/schemas/EventType'
          - description: The event type.
        CreationDate:
          allOf:
          - $ref: '#/components/schemas/DateType'
          - description: The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was created.
        EventResponse:
          allOf:
          - $ref: '#/components/schemas/EventResponseType'
          - description: The event response.
        EventRisk:
          allOf:
          - $ref: '#/components/schemas/EventRiskType'
          - description: The event risk.
        ChallengeResponses:
          allOf:
          - $ref: '#/components/schemas/ChallengeResponseListType'
          - description: The challenge responses.
        EventContextData:
          allOf:
          - $ref: '#/components/schemas/EventContextDataType'
          - description: The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
        EventFeedback:
          allOf:
          - $ref: '#/components/schemas/EventFeedbackType'
          - description: 'A flag specifying the user feedback captured at the time of an event request is good or bad. '
      description: The authentication event type.
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/cognito-identity/
x-hasEquivalentPaths: true