basePath: /v1beta1
definitions:
  controller.openApiError:
    properties:
      code:
        type: string
      error: {}
      msgPrefix:
        type: string
      status:
        type: integer
    type: object
  controller.orgAuditLog:
    properties:
      clusterId:
        description: The cluster ID.
        example: ""
        type: string
      clusterName:
        description: The cluster name.
        type: string
      clusterType:
        description: The cluster type.
        type: string
      details:
        description: The detail information of the event.
        type: string
      endTime:
        description: The audit event end time, in the ISO 8601 format.
        type: string
      eventType:
        description: The audit event type
        type: string
      id:
        description: The audit event id
        type: string
      operationEmail:
        description: The operation email.
        type: string
      operationId:
        description: The operation id.
        example: ""
        type: string
      operationIp:
        description: The operation IP.
        type: string
      operationLoginMethod:
        description: The operation login method.
        type: string
      operationType:
        description: The operation type, indicating the operator is user or api.
        type: string
      organizationId:
        description: The organization id.
        example: ""
        type: string
      organizationName:
        description: The organization name.
        type: string
      projectId:
        description: The project id.
        example: ""
        type: string
      projectName:
        description: The project name.
        type: string
      result:
        description: The restult of the event, indicating Success or Failure.
        type: string
      tranceId:
        description: The audit trace ID.
        type: string
    type: object
  controller.queryAuditLogRsp:
    properties:
      auditLogs:
        description: A list of console audit logs that match the query.
        items:
          $ref: '#/definitions/controller.orgAuditLog'
        type: array
      nextPageToken:
        description: The token to retrieve the next page of results. Use this value
          as the pageToken parameter in the next request. This field is empty when
          there are no more pages.
        type: string
      totalSize:
        description: The total number of console audit logs that match the query.
        type: integer
    type: object
host: iam.tidbapi.com
info:
  contact: {}
  description: This is an account system server.
  title: Account System OPENAPI
  version: v1beta1
paths:
  /auditLogs:
    get:
      consumes:
      - application/json
      description: Lists all console audit logs from current organization.
      parameters:
      - description: The pagination token received from a previous List Audit Logs
          request. Use this token to retrieve the next page of results.
        in: query
        name: pageToken
        type: string
      - description: The maximum number of audit logs to return. If not specified,
          at most 100 audit logs will be returned.
        in: query
        name: pageSize
        type: integer
      - description: The start timestamp to list audit logs, in the ISO 8601 format.
        in: query
        name: startTime
        type: integer
      - description: The end timestamp to list audit logs, in the ISO 8601 format.
        in: query
        name: endTime
        type: integer
      - description: The auditing event types to include in the audit log list. Refer
          Console audit event types for more information.
        in: query
        name: auditEventTypes
        type: string
      - description: The search keyword to include in the audit log list.
        in: query
        name: keyword
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/controller.queryAuditLogRsp'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/controller.openApiError'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/controller.openApiError'
      summary: List Audit Logs
      tags:
      - AuditLog
swagger: "2.0"