Workday Security Sessions API

openapi: 3.1.0
info:
  title: Workday Security Workday Audit and Compliance Account Signons Sessions 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: Sessions
  description: Retrieve and manage active authentication sessions including signon history and session metadata.
paths:
  /api/v1/{tenant}/sessions:
    get:
      operationId: listActiveSessions
      summary: Workday Security List active sessions
      description: Retrieve a collection of currently active authentication sessions for the tenant. Returns session metadata including signon timestamps, IP addresses, device information, and authentication methods used.
      tags:
      - Sessions
      parameters:
      - $ref: '#/components/parameters/tenant'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Collection of active sessions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Session'
                  total:
                    type: integer
                    description: Total number of active sessions
        '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
    tenant:
      name: tenant
      in: path
      required: true
      description: Workday tenant identifier
      schema:
        type: string
  schemas:
    Session:
      type: object
      description: Represents an active authentication session within the Workday tenant, including details about the signon event, device, and session lifetime.
      properties:
        id:
          type: string
          description: Unique session identifier
        sessionId:
          type: string
          description: Workday-assigned session identifier
        systemAccount:
          type: string
          description: The system account or username associated with the session
        signonDateTime:
          type: string
          format: date-time
          description: Timestamp when the signon occurred
        sessionStart:
          type: string
          format: date-time
          description: Timestamp when the session started
        sessionEnd:
          type: string
          format: date-time
          description: Timestamp when the session ended or will expire
        ipAddress:
          type: string
          description: IP address from which the signon originated
        authenticationType:
          type: string
          description: Authentication method used for the signon such as SAML, password, or OAuth
        browserType:
          type: string
          description: Browser type used for the signon
        deviceType:
          type: string
          description: Device type from which the signon was made
        deviceIsTrusted:
          type: boolean
          description: Whether the device is registered as a trusted device
        isDeviceManaged:
          type: boolean
          description: Whether the device is managed by the organization
        isFailed:
          type: boolean
          description: Whether the signon attempt was unsuccessful
        multiFactorType:
          type: string
          description: Multi-factor authentication type used if applicable
  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