Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents API

openapi: 3.2.0
info:
  version: '2016-04-18'
  x-release: v4
  title: 'Amazon Cognito Identity Provider #X Amz Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents API'
  description: <p>With the Amazon Cognito user pools API, you can set up user pools and app clients, and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">link IdP users to native user profiles</a>. Learn more about the authentication and authorization of federated users in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p> <p>This API reference provides detailed information about API operations and object types in Amazon Cognito. At the bottom of the page for each API operation and object, under <i>See Also</i>, you can learn how to use it in an Amazon Web Services SDK in the language of your choice.</p> <p>Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side user operations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <p>You can also start reading about the <code>CognitoIdentityProvider</code> client in the following SDK guides.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services Command Line Interface</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a> </p> </li> <li> <p> <a href="https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html">Amazon Web Services SDK for C++</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a> </p> </li> <li> <p> <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services SDK for JavaScript</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html">Amazon Web Services SDK for PHP V3</a> </p> </li> <li> <p> <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK for Ruby V3</a> </p> </li> </ul> <p>To get started with an Amazon Web Services SDK, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>. For example actions and scenarios, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html">Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs</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-idp
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-idp-2016-04-18.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-idp.{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 Provider multi-region endpoint
- url: https://cognito-idp.{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 Provider multi-region endpoint
- url: http://cognito-idp.{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 Provider endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-idp.{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 Provider 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:
  schemas:
    RiskLevelType:
      type: string
      enum:
      - Low
      - Medium
      - High
    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.
    ResourceNotFoundException: {}
    EventResponseType:
      type: string
      enum:
      - Pass
      - Fail
      - InProgress
    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.
    UserPoolAddOnNotEnabledException: {}
    UserPoolIdType:
      type: string
      pattern: '[\w-]+_[0-9a-zA-Z]+'
      minLength: 1
      maxLength: 55
    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.
    EventType:
      type: string
      enum:
      - SignIn
      - SignUp
      - ForgotPassword
      - PasswordChange
      - ResendCode
    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.
    AuthEventsType:
      type: array
      items:
        $ref: '#/components/schemas/AuthEventType'
    FeedbackValueType:
      type: string
      enum:
      - Valid
      - Invalid
    QueryLimitType:
      type: integer
      minimum: 0
      maximum: 60
    ChallengeName:
      type: string
      enum:
      - Password
      - Mfa
    NotAuthorizedException: {}
    UsernameType:
      type: string
      pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
      minLength: 1
      maxLength: 128
      format: password
    ChallengeResponseListType:
      type: array
      items:
        $ref: '#/components/schemas/ChallengeResponseType'
    ChallengeResponse:
      type: string
      enum:
      - Success
      - Failure
    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.
    PaginationKey:
      type: string
      pattern: '[\S]+'
      minLength: 1
    DateType:
      type: string
      format: date-time
    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.
    UserNotFoundException: {}
    TooManyRequestsException: {}
    RiskDecisionType:
      type: string
      enum:
      - NoRisk
      - AccountTakeover
      - Block
    StringType:
      type: string
      minLength: 0
      maxLength: 131072
    InvalidParameterException: {}
    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.
    InternalErrorException: {}
    WrappedBooleanType:
      type: boolean
  parameters:
    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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      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-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  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-idp/
x-hasEquivalentPaths: true