Workday Security Compliance Reports API

Generate and retrieve compliance reports summarizing audit activity, policy adherence, and regulatory compliance status.

Documentation

Specifications

Other Resources

OpenAPI Specification

workday-security-compliance-reports-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Workday Security Workday Audit and Compliance Account Signons Compliance Reports API
  description: Access audit logs, security reports, and compliance data within the Workday platform. Provides programmatic access to audit trail information for security monitoring, regulatory compliance, and governance reporting. Supports retrieval of configuration change history, security policy modifications, and access control audit records for maintaining a complete compliance trail.
  version: v1
  contact:
    name: Workday Support
    url: https://community.workday.com
    email: support@workday.com
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://{host}/ccx/api/v1/{tenant}
  description: Workday REST API Server
  variables:
    host:
      description: Workday host for your tenant environment
      default: wd2-impl-services1.workday.com
    tenant:
      description: Workday tenant identifier
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Compliance Reports
  description: Generate and retrieve compliance reports summarizing audit activity, policy adherence, and regulatory compliance status.
paths:
  /complianceReports:
    get:
      operationId: listComplianceReports
      summary: Workday Security List compliance reports
      description: Retrieve a collection of available compliance reports for the tenant. Compliance reports summarize audit activity, policy adherence, and regulatory compliance status for defined reporting periods.
      tags:
      - Compliance Reports
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: reportType
        in: query
        description: Filter by the type of compliance report
        schema:
          type: string
          enum:
          - Security_Audit
          - Access_Review
          - Configuration_Change
          - Data_Access
          - Regulatory_Compliance
      responses:
        '200':
          description: Collection of compliance reports
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ComplianceReport'
                  total:
                    type: integer
                    description: Total number of compliance reports
        '401':
          description: Unauthorized - invalid or expired access token
        '403':
          description: Forbidden - insufficient permissions
components:
  parameters:
    limit:
      name: limit
      in: query
      description: Maximum number of results to return per page
      schema:
        type: integer
        default: 20
        minimum: 1
        maximum: 100
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
        minimum: 0
  schemas:
    ComplianceReport:
      type: object
      description: A compliance report summarizing audit activity, policy adherence, or regulatory compliance status for a defined reporting period.
      properties:
        id:
          type: string
          description: Unique identifier for the compliance report
        descriptor:
          type: string
          description: Human-readable title of the compliance report
        reportType:
          type: string
          enum:
          - Security_Audit
          - Access_Review
          - Configuration_Change
          - Data_Access
          - Regulatory_Compliance
          description: Classification of the compliance report
        periodStart:
          type: string
          format: date
          description: Start date of the reporting period
        periodEnd:
          type: string
          format: date
          description: End date of the reporting period
        generatedOn:
          type: string
          format: date-time
          description: Timestamp when the report was generated
        status:
          type: string
          enum:
          - Pending
          - Generated
          - Reviewed
          - Approved
          description: Current status of the compliance report
        totalEvents:
          type: integer
          minimum: 0
          description: Total number of events covered by the report
        summary:
          type: string
          description: Executive summary of the compliance report findings
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from the Workday token endpoint.
externalDocs:
  description: Workday Audit and Compliance API Documentation
  url: https://community.workday.com/sites/default/files/file-hosting/productionapi/Security/v44.0/Audit.html