openapi: 3.2.0
info:
  title: Atlar API (v2) Audit logs API
  description: Atlar API (v2)
  version: '0.1'
  contact:
    email: support@atlar.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.txt
servers:
- url: https://api.atlar.com
tags:
- name: Audit Logs
  description: Audit logs for IAM-related user events, such as login, logout, and password reset.
  x-displayName: Audit logs
paths:
  /iam/v2beta/audit-log-entries:
    get:
      summary: List audit log entries
      description: Returns a list of audit log entries.
      tags:
      - Audit Logs
      parameters:
      - $ref: '#/components/parameters/QueryLimit'
      - $ref: '#/components/parameters/PaginationToken'
      responses:
        '200':
          description: A list of audit log entries.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ListResponse'
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/AuditLogEntry'
        '400':
          $ref: '#/components/responses/BadRequest'
      security:
      - basicAuth: []
      operationId: getIamV2betaAuditLogEntries
      x-operation-id-source: derived
components:
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: 400
            message: There is some problem with the data you submitted.
  schemas:
    AuditLogEntryLoginStepPasswordFailedReason:
      type: string
      enum:
      - USER_DOES_NOT_EXIST
      - PASSWORD_INCORRECT
      - EMAIL_ADDRESS_NOT_CONFIRMED
      - PASSWORD_RESET_REQUIRED
      - USER_BLOCKED
    AuditLogEntryPasswordResetFailedDetails:
      type: object
      description: A user password reset has failed. See reason for more details.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        reason:
          $ref: '#/components/schemas/AuditLogEntryPasswordResetFailedReason'
          description: "The reason why the password reset failed. <ul>\n\n\n\n\n\n\n  <li><code>CONFIRMATION_CODE_INVALID</code> The confirmation code is\nnot a valid one for this user.</li>\n\n\n\n\n\n  <li><code>CONFIRMATION_CODE_EXPIRED</code> The confirmation code is\nvalid, but has expired.</li>\n\n\n\n\n\n  <li><code>PASSWORD_INVALID</code> Provided password cannot be used for\nsecurity reasons. Reasons could be\n\n\n\n\n\n    that the password is commonly used or has been compromised in a data\nbreach.</li> </ul> The list of reasons might be extended in the future."
      required:
      - type
      - reason
    AuditLogEntryLoginStepSSOFailedReason:
      type: string
      enum:
      - IDENTITY_PROVIDER_DISABLED
      - EMAIL_ADDRESS_DOMAIN_NOT_ALLOWED
      - INVITATION_REQUIRED
      - EMAIL_ADDRESS_NOT_MATCHING_INVITATION
      - USER_BLOCKED
    AuditLogEntryLoginStepMFAFailedReason:
      type: string
      enum:
      - SESSION_EXPIRED
      - MFA_FAILED
      - CLIENT_ERROR
    AuditLogEntryMFACredentialType:
      type: string
      enum:
      - WEBAUTHN
    AuditLogEntryLoginStepPasswordFailedDetails:
      type: object
      description: A user authenticating using username and password has failed. See reason for more details.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        reason:
          $ref: '#/components/schemas/AuditLogEntryLoginStepPasswordFailedReason'
          description: "The reason why the username and password authentication failed. <ul>\n\n\n\n\n\n\n  <li><code>USER_DOES_NOT_EXIST</code> No user with the provided username\nexist. The user needs to sign\n\n\n\n\n\n    up.</li>\n  <li><code>PASSWORD_INCORRECT</code> The password provided is not correct\nfor the user. If the user has\n\n\n\n\n\n    forgotten their password, they can reset their password.</li>\n  <li><code>EMAIL_ADDRESS_NOT_CONFIRMED</code> The user's email address\nhas not been confirmed. When signing\n\n\n\n\n\n    up, the user will get an email with a confirmation link. It's possible\nto request this email to be\n\n\n\n\n\n    resent.</li>\n  <li><code>PASSWORD_RESET_REQUIRED</code> Provided password cannot be\nused for security reasons. Reasons\n\n\n\n\n\n    could be that the password is commonly used or has been compromised\nin a data breach. The user needs to\n\n\n\n\n\n    reset their password.</li>\n  <li><code>USER_BLOCKED</code> The user has been blocked from logging\nin by Atlar. Reason is unknown and\n\n\n\n\n\n    might differ case-by-case.</li>\n</ul> The list of reasons might be extended in the future."
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user tried to authenticate when responding to an invitation, this is the ID of the invitation.
          example: 2f5d6827-bd67-4cdd-ac2b-9729e49ffa37
      required:
      - type
      - reason
    AuditLogEntrySignUpEmailConfirmationFailedReason:
      type: string
      enum:
      - CONFIRMATION_CODE_INVALID
      - CONFIRMATION_CODE_EXPIRED
    AuditLogEntryMFACredentialDeletedDetails:
      type: object
      description: A user has successfully added a new MFA credential.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        credential:
          oneOf:
          - $ref: '#/components/schemas/AuditLogEntryMFACredentialWebAuthn'
          discriminator:
            propertyName: type
            mapping:
              WEBAUTHN: '#/components/schemas/AuditLogEntryMFACredentialWebAuthn'
      required:
      - type
      - credential
    AuditLogEntrySignUpEmailConfirmationSucceededDetails:
      type: object
      description: The user has successfully confirmed their email address. Note that a user does not have to confirm their email address when authenticating using SSO.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user signed up when responding to an invitation, this is the ID of the invitation.
          example: 20662aec-fdd3-4fa9-92cf-7664ca9f6029
      required:
      - type
    AuditLogEntryLoginDetails:
      type: object
      description: Login represents a user logging into an organization with a specific role specified by the membership. Note that this happens after the user has been authenticated, which is a separate entry.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        roleId:
          $ref: '#/components/schemas/ResourceID'
          description: ID of the role that the user logged in as.
          example: 7bf53dbc-5c65-49e0-82f1-600a1c531e96
      required:
      - type
      - roleId
    AuditLogEntryMFACredentialCreatedDetails:
      type: object
      description: A user has successfully added a new MFA credential.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        credential:
          oneOf:
          - $ref: '#/components/schemas/AuditLogEntryMFACredentialWebAuthn'
          discriminator:
            propertyName: type
            mapping:
              WEBAUTHN: '#/components/schemas/AuditLogEntryMFACredentialWebAuthn'
      required:
      - type
      - credential
    ETag:
      type: string
      description: '[ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the

        resource version. This can be passed along in `If-Match` HTTP

        header when updating a resource to perform a conditional

        update.'
      pattern: ^version:\d{1,4}$
      example: version:3
      readOnly: true
      externalDocs:
        url: https://en.wikipedia.org/wiki/HTTP_ETag
    ListResponse:
      type: object
      properties:
        items:
          description: A list of resources.
        nextToken:
          description: 'Pagination token for next page.

            The value will be a non-empty string if there are more resources to be fetched.

            The value will be an empty string if there are no more resources to be fetched.'
          type: string
          example: eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9
        token:
          description: 'The pagination token that was used for this request.

            The value will be an empty string if no `token` query parameter was provided with the request.'
          type: string
          example: eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9
        limit:
          description: The page limit that was used for this request.
          example: 100
          type: integer
      required:
      - items
      - nextToken
      - token
      - limit
    ResourceID:
      type: string
      description: Unique resource identifier.
      minLength: 32
      maxLength: 64
      examples:
      - 2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8
    AuditLogEntryLoginStepMFASucceededDetails:
      type: object
      description: A user has successfully authenticated using MFA and is now fully authenticated. They can now log in.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        credential:
          oneOf:
          - $ref: '#/components/schemas/AuditLogEntryMFACredentialWebAuthn'
          discriminator:
            propertyName: type
            mapping:
              WEBAUTHN: '#/components/schemas/AuditLogEntryMFACredentialWebAuthn'
      required:
      - type
      - credential
    AuditLogEntryType:
      type: string
      enum:
      - SIGNUP_SUCCEEDED
      - SIGNUP_FAILED
      - SIGNUP_EMAIL_CONFIRMATION_RESENT
      - SIGNUP_EMAIL_CONFIRMATION_SUCCEEDED
      - SIGNUP_EMAIL_CONFIRMATION_FAILED
      - LOGIN_STEP_PASSWORD_SUCCEEDED
      - LOGIN_STEP_PASSWORD_FAILED
      - LOGIN_STEP_SSO_SUCCEEDED
      - LOGIN_STEP_SSO_FAILED
      - MFA_CREDENTIAL_CREATED
      - MFA_CREDENTIAL_DELETED
      - LOGIN_STEP_MFA_SUCCEEDED
      - LOGIN_STEP_MFA_FAILED
      - LOGIN
      - PASSWORD_RESET_SENT
      - PASSWORD_RESET_SUCCEEDED
      - PASSWORD_RESET_FAILED
    AuditLogEntry:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ResourceID'
        organizationId:
          $ref: '#/components/schemas/OrganizationID'
          description: ID of the organization that the user has logged in to, or performing an action towards. Not set when it's not possible to determine the organization, e.g. when the user doesn't exist or the user doesn't have any memberships. Note that the user does not have to be authenticated to perform an action towards an organization, e.g. when signing up or when in the process of authenticating towards the organization.
          example: 2c34d064-df8c-4fba-bdf9-2a3c8d56a727
        userId:
          $ref: '#/components/schemas/ResourceID'
          description: ID of the user that performed the action. Not set when it isn't possible to determine the user, e.g. when the user doesn't exist. Note that the user might not be authenticated when performing the action, e.g. when signing up or when in the process of authenticating.
          example: fc1ba48f-086a-44d9-8184-ade4524f1664
        roleId:
          $ref: '#/components/schemas/ResourceID'
          description: ID of the role that the user has logged in as when performing the action. Not set when it isn't possible to determine the role, e.g. when the user has not yet logged in to any organization.
          example: df643e52-8e99-4f03-9e2a-62bde5ff721b
        sessionId:
          $ref: '#/components/schemas/ResourceID'
          description: ID of the session that the action was performed in.
          example: d007cc18-f0e6-4a0a-8cd2-a0b291e4c703
        requestId:
          type: string
          description: ID of the request that triggered the action.
          example: 519d7f18-6701-4db2-b751-962ab6113a6b
        actionTimestamp:
          type: string
          format: date-time
          description: Timestamp when the action was performed.
          example: '2025-03-10T16:34:56.639Z'
        details:
          oneOf:
          - $ref: '#/components/schemas/AuditLogEntrySignUpSucceededDetails'
          - $ref: '#/components/schemas/AuditLogEntrySignUpFailedDetails'
          - $ref: '#/components/schemas/AuditLogEntrySignUpEmailConfirmationResentDetails'
          - $ref: '#/components/schemas/AuditLogEntrySignUpEmailConfirmationSucceededDetails'
          - $ref: '#/components/schemas/AuditLogEntrySignUpEmailConfirmationFailedDetails'
          - $ref: '#/components/schemas/AuditLogEntryLoginStepPasswordSucceededDetails'
          - $ref: '#/components/schemas/AuditLogEntryLoginStepPasswordFailedDetails'
          - $ref: '#/components/schemas/AuditLogEntryLoginStepSSOSucceededDetails'
          - $ref: '#/components/schemas/AuditLogEntryLoginStepSSOFailedDetails'
          - $ref: '#/components/schemas/AuditLogEntryMFACredentialCreatedDetails'
          - $ref: '#/components/schemas/AuditLogEntryMFACredentialDeletedDetails'
          - $ref: '#/components/schemas/AuditLogEntryLoginStepMFASucceededDetails'
          - $ref: '#/components/schemas/AuditLogEntryLoginStepMFAFailedDetails'
          - $ref: '#/components/schemas/AuditLogEntryLoginDetails'
          - $ref: '#/components/schemas/AuditLogEntryPasswordResetSentDetails'
          - $ref: '#/components/schemas/AuditLogEntryPasswordResetSucceededDetails'
          - $ref: '#/components/schemas/AuditLogEntryPasswordResetFailedDetails'
          discriminator:
            propertyName: type
            mapping:
              SIGNUP_SUCCEEDED: '#/components/schemas/AuditLogEntrySignUpSucceededDetails'
              SIGNUP_FAILED: '#/components/schemas/AuditLogEntrySignUpFailedDetails'
              SIGNUP_EMAIL_CONFIRMATION_RESENT: '#/components/schemas/AuditLogEntrySignUpEmailConfirmationResentDetails'
              SIGNUP_EMAIL_CONFIRMATION_SUCCEEDED: '#/components/schemas/AuditLogEntrySignUpEmailConfirmationSucceededDetails'
              SIGNUP_EMAIL_CONFIRMATION_FAILED: '#/components/schemas/AuditLogEntrySignUpEmailConfirmationFailedDetails'
              LOGIN_STEP_PASSWORD_SUCCEEDED: '#/components/schemas/AuditLogEntryLoginStepPasswordSucceededDetails'
              LOGIN_STEP_PASSWORD_FAILED: '#/components/schemas/AuditLogEntryLoginStepPasswordFailedDetails'
              LOGIN_STEP_SSO_SUCCEEDED: '#/components/schemas/AuditLogEntryLoginStepSSOSucceededDetails'
              LOGIN_STEP_SSO_FAILED: '#/components/schemas/AuditLogEntryLoginStepSSOFailedDetails'
              MFA_CREDENTIAL_CREATED: '#/components/schemas/AuditLogEntryMFACredentialCreatedDetails'
              MFA_CREDENTIAL_DELETED: '#/components/schemas/AuditLogEntryMFACredentialDeletedDetails'
              LOGIN_STEP_MFA_SUCCEEDED: '#/components/schemas/AuditLogEntryLoginStepMFASucceededDetails'
              LOGIN_STEP_MFA_FAILED: '#/components/schemas/AuditLogEntryLoginStepMFAFailedDetails'
              LOGIN: '#/components/schemas/AuditLogEntryLoginDetails'
              PASSWORD_RESET_SENT: '#/components/schemas/AuditLogEntryPasswordResetSentDetails'
              PASSWORD_RESET_SUCCEEDED: '#/components/schemas/AuditLogEntryPasswordResetSucceededDetails'
              PASSWORD_RESET_FAILED: '#/components/schemas/AuditLogEntryPasswordResetFailedDetails'
          description: Details of the action that was performed. The details are specific to the type of action.
        version:
          $ref: '#/components/schemas/ResourceVersion'
        etag:
          $ref: '#/components/schemas/ETag'
        created:
          $ref: '#/components/schemas/CreatedTimestamp'
      required:
      - id
      - sessionId
      - requestId
      - actionTimestamp
      - details
      - version
      - etag
      - created
      additionalProperties: false
    ErrorDetails:
      type: object
      description: Error detail.
      properties:
        code:
          description: An error code for this error. Not always present.
          example: invalid_value
          type: string
        error:
          description: A description of this specific error.
          example: Must be one of [direct_debits mandates payments]
          type: string
        field:
          description: The field which has an error. This only set if the error has to do with a specific field, such as for validation errors. Nested fields are concatenated with `.`, as well as indexed fields in lists.
          example: filter.0.resource
          type: string
    AuditLogEntrySignUpFailedDetails:
      type: object
      description: A user sign up has failed. See reason for more details.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        reason:
          $ref: '#/components/schemas/AuditLogEntrySignUpFailedReason'
          description: "The reason why the sign up failed. <ul>\n\n\n\n\n\n\n  <li><code>USER_ALREADY_EXISTS</code> The user has already signed up.\nThe user needs to log in or reset\n\n\n\n\n\n    their password.</li>\n  <li><code>PASSWORD_INVALID</code> Provided password cannot be used for\nsecurity reasons. Reasons could be\n\n\n\n\n\n    that the password is commonly used or has been compromised in a data\nbreach.</li> </ul> The list of reasons might be extended in the future."
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user tried to sign up when responding to an invitation, this is the ID of the invitation.
          example: f5184c64-941d-4d8e-bfa1-8d3d32561f4d
      required:
      - type
      - reason
    AuditLogEntryPasswordResetFailedReason:
      type: string
      enum:
      - CONFIRMATION_CODE_INVALID
      - CONFIRMATION_CODE_EXPIRED
      - NEW_PASSWORD_INVALID
    AuditLogEntrySignUpSucceededDetails:
      type: object
      description: A user has successfully signed up. The user also needs to verify their email address before they can authenticate and log in. Note that a user does not have to sign up when authenticating using SSO.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user signed up when responding to an invitation, this is the ID of the invitation.
          example: 35834c2c-26d2-48b5-9a6e-7bf28e826fc4
      required:
      - type
    CreatedTimestamp:
      type: string
      format: date-time
      description: Time at which the resource was created.
      example: '2022-05-04T18:31:12.889104898Z'
      readOnly: true
    AuditLogEntryPasswordResetSentDetails:
      type: object
      description: A user has requested to reset their password. An email with a reset link has been sent.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
      required:
      - type
    ResourceVersion:
      type: integer
      description: 'Resource version. Starts at value `1` when the resource is

        created and increases by one for each successive update.'
      example: 1
      minimum: 1
      readOnly: true
    AuditLogEntrySignUpFailedReason:
      type: string
      enum:
      - USER_ALREADY_EXISTS
      - PASSWORD_INVALID
    AuditLogEntryLoginStepMFAFailedDetails:
      type: object
      description: A user authentication using MFA has failed. See reason for more details.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        reason:
          $ref: '#/components/schemas/AuditLogEntryLoginStepMFAFailedReason'
          description: "The reason why the identity provider authentication failed. <ul>\n\n\n\n\n\n\n  <li><code>SESSION_EXPIRED</code> The user took to long to complete the\nauthentication. For security\n\n\n\n\n\n    reasons, the authentication session is expired.</li>\n  <li><code>MFA_FAILED</code> The authentication failed. Reason could\nbe that the challenge response wasn't\n\n\n\n\n\n    signed with the correct private key.</li>\n  <li><code>CLIENT_ERROR</code> The authenticator or browser reported\na failure before a credential\n\n\n\n\n\n    assertion could be obtained (e.g. user cancelled, no authenticator\navailable, or a transport\n\n\n\n\n\n    error occurred).</li>\n</ul> The list of reasons might be extended in the future."
      required:
      - type
      - reason
    AuditLogEntrySignUpEmailConfirmationFailedDetails:
      type: object
      description: An email confirmation has failed. See reason for more details.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        reason:
          $ref: '#/components/schemas/AuditLogEntrySignUpEmailConfirmationFailedReason'
          description: "The reason why the email confirmation failed. <ul>\n\n\n\n\n\n\n  <li><code>CONFIRMATION_CODE_INVALID</code> The confirmation code is\nnot a valid one for this user.</li>\n\n\n\n\n\n  <li><code>CONFIRMATION_CODE_EXPIRED</code> The confirmation code is\nvalid, but has expired.</li> </ul> The list of reasons might be extended in the future."
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user signed up when responding to an invitation, this is the ID of the invitation.
          example: 70f78b76-2fe4-4a0f-8086-a906e58df935
      required:
      - type
      - reason
    AuditLogEntryMFACredentialWebAuthn:
      type: object
      description: Information related to the WebAuthn credential.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryMFACredentialType'
        id:
          $ref: '#/components/schemas/ResourceID'
          description: ID of the WebAuthn credential.
          example: b154b981-852b-482f-b6f1-026fa73b1422
      required:
      - type
      - id
    ErrorResponse:
      type: object
      description: Error response.
      properties:
        status:
          description: The HTTP status code.
          example: 400
          type: integer
          readOnly: true
        message:
          description: A top-level message describing the error(s).
          example: There is some problem with the data you submitted.
          type: string
          readOnly: true
        details:
          description: A list of details for each error that occurred.
          items:
            $ref: '#/components/schemas/ErrorDetails'
          type: array
          readOnly: true
          x-omitempty: true
    OrganizationID:
      type: string
      description: Unique resource identifier for an Organization.
      examples:
      - 0160f6ab-5741-49e1-af46-9138927e547e
    AuditLogEntryLoginStepSSOFailedDetails:
      type: object
      description: A user authentication using an identity provider has failed. See reason for more details.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        reason:
          $ref: '#/components/schemas/AuditLogEntryLoginStepSSOFailedReason'
          description: "The reason why the identity provider authentication failed. <ul>\n\n\n\n\n\n\n  <li><code>IDENTITY_PROVIDER_DISABLED</code> The identity provider used\nto log in is currently not enabled\n\n\n\n\n\n    to be used.</li>\n  <li><code>EMAIL_ADDRESS_DOMAIN_NOT_ALLOWED</code> For security reasons,\nthe email address domain is not\n\n\n\n\n\n    allowed to be used with the identity provider.</li>\n  <li><code>INVITATION_REQUIRED</code> The user needs to be invited before\nlogging in.</li>\n\n\n\n\n\n  <li><code>EMAIL_ADDRESS_NOT_MATCHING_INVITATION</code> The email address\ndoes not match the email address\n\n\n\n\n\n    in the invitation.</li>\n  <li><code>USER_BLOCKED</code> The user has been blocked from logging\nin by Atlar. Reason is unknown and\n\n\n\n\n\n    might differ case-by-case.</li>\n</ul> The list of reasons might be extended in the future."
        identityProviderId:
          $ref: '#/components/schemas/ResourceID'
          description: ID of the identity provider that the user authenticated with.
          example: 6b773197-bfd7-40a9-af8c-9d01b0944633
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user tried to authenticate when responding to an invitation, this is the ID of the invitation.
          example: d75df69e-d731-452b-b94a-2c6e53a1dd90
      required:
      - type
      - reason
      - identityProviderId
    AuditLogEntrySignUpEmailConfirmationResentDetails:
      type: object
      description: An email confirmation has been resent to the user.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user signed up when responding to an invitation, this is the ID of the invitation.
          example: 55851768-24d2-4380-b9b4-3ac4ca61843e
      required:
      - type
    AuditLogEntryLoginStepSSOSucceededDetails:
      type: object
      description: A user has successfully authenticated using an identity provider. Note that the user might need to do an MFA step in order to be fully authenticated and able to log in.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        identityProviderId:
          $ref: '#/components/schemas/ResourceID'
          description: ID of the identity provider that the user authenticated with.
          example: 6b773197-bfd7-40a9-af8c-9d01b0944633
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user authenticated when responding to an invitation, this is the ID of the invitation.
          example: 66db5ecb-7396-435a-b795-15d999416bf2
      required:
      - type
      - identityProviderId
    AuditLogEntryLoginStepPasswordSucceededDetails:
      type: object
      description: A user has provided a correct combination of username and password. Note that the user might need to do an MFA step in order to be fully authenticated and able to log in.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
        invitationId:
          $ref: '#/components/schemas/ResourceID'
          description: If the user authenticated when responding to an invitation, this is the ID of the invitation.
          example: 9160994f-240b-4c1f-a083-8a289baf59f3
      required:
      - type
    AuditLogEntryPasswordResetSucceededDetails:
      type: object
      description: A user has successfully reset their password.
      properties:
        type:
          $ref: '#/components/schemas/AuditLogEntryType'
      required:
      - type
  parameters:
    PaginationToken:
      in: query
      name: token
      description: If a query response contains a non-empty `nextToken`, use that value as `token` query parameter to continue pagination.
      schema:
        type: string
    QueryLimit:
      in: query
      name: limit
      description: Limit the number of items in resulting query response.
      schema:
        type: integer
        default: 100
        minimum: 1
        maximum: 500
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-tagGroups:
- name: Atlar Accounting API
  tags:
  - Documents
  - GL Entities
  - GL Accounts
- name: Atlar Analytics API
  tags:
  - Forecasted Transactions
- name: Atlar Connectivity API
  tags:
  - Connections
- name: Atlar Payments API
  tags:
  - Credit Transfers
  - Direct Debits
  - External Accounts
  - Counterparties
  - Mandates
  - Events (webhooks)
  - Regulatory Reporting
- name: Atlar Financial Data API
  tags:
  - Accounts
  - Transactions
  - Pending Transactions
  - Entities
  - Investments
- name: Atlar IAM API
  tags:
  - OAuth
  - Audit logs
- name: Atlar Platform API
  tags:
  - Webhooks
x-provenance:
  method: searched
  source: https://docs.atlar.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.atlar.com/reference/delete_accounting-v2beta-documents-id.md
  - https://docs.atlar.com/reference/delete_analytics-v2beta-forecasted-transactions-id.md
  - https://docs.atlar.com/reference/delete_financial-data-v2-entities-id-1.md
  - https://docs.atlar.com/reference/delete_payments-v2-counterparties-id-1.md
  - https://docs.atlar.com/reference/delete_payments-v2-external-accounts-id-1.md
  - https://docs.atlar.com/reference/delete_platform-v2beta-webhooks-id-keys-kid.md
  - https://docs.atlar.com/reference/delete_platform-v2beta-webhooks-id.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-documents-batch.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-documents-id.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-documents.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-gl-accounts-id.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-gl-accounts.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-gl-entities-id.md
  - https://docs.atlar.com/reference/get_accounting-v2beta-gl-entities.md
  - https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions-id-events.md
  - https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions-id.md
  - https://docs.atlar.com/reference/get_analytics-v2beta-forecasted-transactions.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-1.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-1.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-id-bank-statements-1.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-id-content-1.md
  - https://docs.atlar.com/reference/get_connectivity-v2beta-connections-cid-reports-rid-bank-statements-id-content-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-accounts-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-accounts-id-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-accounts-id-balances-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-entities-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-entities-id-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-id-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-pending-transactions-id-events-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-transactions-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-transactions-id-1.md
  - https://docs.atlar.com/reference/get_financial-data-v2-transactions-id-events.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-accounts-id-end-of-day-summaries.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-internal-transfers-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-internal-transfers.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-id-holdings.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-activities-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-activities.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-positions-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-hid-positions.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios-pid-holdings-id.md
  - https://docs.atlar.com/reference/get_financial-data-v2beta-portfolios.md
  - https://docs.atlar.com/reference/get_iam-v2beta-audit-log-entries.md
  - https://docs.atlar.com/reference/get_payments-v2-counterparties-1.md
  - https://docs.atlar.com/reference/get_payments-v2-counterparties-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-counterparties-id-events-1.md
  - https://docs.atlar.com/reference/get_payments-v2-credit-transfers-1.md
  - https://docs.atlar.com/reference/get_payments-v2-credit-transfers-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-credit-transfers-id-events-1.md
  - https://docs.atlar.com/reference/get_payments-v2-direct-debits-1.md
  - https://docs.atlar.com/reference/get_payments-v2-direct-debits-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-direct-debits-id-events-1.md
  - https://docs.atlar.com/reference/get_payments-v2-external-accounts-1.md
  - https://docs.atlar.com/reference/get_payments-v2-external-accounts-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-mandates-1.md
  - https://docs.atlar.com/reference/get_payments-v2-mandates-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2-mandates-id-events-1.md
  - https://docs.atlar.com/reference/get_payments-v2-regulatory-reporting-codes.md
  - https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-1.md
  - https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-id-1.md
  - https://docs.atlar.com/reference/get_payments-v2beta-credit-transfer-batches-id-results-1.md
  - https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches-id-results.md
  - https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches-id.md
  - https://docs.atlar.com/reference/get_payments-v2beta-direct-debit-batches.md
  - https://docs.atlar.com/reference/get_platform-v2beta-webhooks-id-keys.md
  - https://docs.atlar.com/reference/get_platform-v2beta-webhooks-id.md
  - https://docs.atlar.com/reference/get_platform-v2beta-webhooks.md
  - https://docs.atlar.com/reference/patch_accounting-v2beta-documents-id.md
  - https://docs.atlar.com/reference/patch_accounting-v2beta-gl-accounts-id.md
  - https://docs.atlar.com/reference/patch_accounting-v2beta-gl-entities-id.md
  - https://docs.atlar.com/reference/patch_analytics-v2beta-forecasted-transactions-id.md
  - https://docs.atlar.com/reference/patch_financial-data-v2-accounts-id-1.md
  - https://docs.atlar.com/reference/patch_financial-data-v2-entities-id-1.md
  - https://docs.atlar.com/reference/patch_financial-data-v2-transactions-id-1.md
  - https://docs.atlar.com/reference/patch_financial-data-v2beta-pending-transactions-id.md
  - https://docs.atlar.com/reference/patch_payments-v2-counterparties-id-1.md
  - https://docs.atlar.com/reference/patch_payments-v2-credit-transfers-id-1.md
  - https://docs.atlar.com/reference/patch_payments-v2-external-accounts-id-1.md
  - https://docs.atlar.com/reference/patch_platform-v2beta-webhooks-id.md
  - https://docs.atlar.com/reference/post_accounting-v2beta-documents.md
  - https://docs.atlar.com/reference/post_accounting-v2beta-gl-accounts.md
  - https://docs.atlar.com/reference/post_accounting-v2beta-gl-entities.md
  - https://docs.atlar.com/reference/post_analytics-v2beta-forecasted-transactions.md
  - https://docs.atlar.com/reference/post_connectivity-v2beta-connections-cid-reports.md
  - https://docs.atlar.com/reference/post_financial-data-v2-entities-1.md
  - https://docs.atlar.com/reference/post_iam-v2-oauth2-token.md
  - https://docs.atlar.com/reference/post_payments-v2-counterparties-1.md
  - https://docs.atlar.com/reference/post_payments-v2-credit-transfers-1.md
  - https://docs.atlar.com/reference/post_payments-v2-credit-transfers-id-approve-1.md
  - https://docs.atlar.com/reference/post_payments-v2-credit-transfers-id-reject-1.md
  - https://docs.atlar.com/reference/post_payments-v2-direct-debits-1.md
  - https://docs.atlar.com/reference/post_payments-v2-direct-debits-id-approve-1.md
  - https://docs.atlar.com/reference/post_payments-v2-direct-debits-id-reject-1.md
  - https://docs.atlar.com/reference/post_payments-v2-external-accounts-1.md
  - https://docs.atlar.com/reference/post_payments-v2-mandates-1.md
  - https://docs.atlar.com/reference/post_payments-v2-mandates-id-cancel-1.md
  - https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-1.md
  - https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-id-approve.md
  - https://docs.atlar.com/reference/post_payments-v2beta-credit-transfer-batches-id-reject.md
  - https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches-id-approve.md
  - https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches-id-reject.md
  - https://docs.atlar.com/reference/post_payments-v2beta-direct-debit-batches.md
  - https://docs.atlar.com/reference/post_platform-v2beta-webhooks-id-keys.md
  - https://docs.atlar.com/reference/post_platform-v2beta-webhooks.md
  merge:
    pages: 106
    deduped: 3049
    conflicts_kept_first: 0