Workday Security User Accounts API

openapi: 3.1.0
info:
  title: Workday Security Workday Audit and Compliance Account Signons User Accounts 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: User Accounts
  description: Manage Workday user accounts including account status, credentials, and associated security configurations.
paths:
  /userAccounts:
    get:
      operationId: listUserAccounts
      summary: Workday Security List user accounts
      description: Retrieve a collection of Workday user accounts including their account status, associated worker, and security configuration. Supports filtering by account status and search terms.
      tags:
      - User Accounts
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: accountStatus
        in: query
        description: Filter by account status
        schema:
          type: string
          enum:
          - Active
          - Disabled
          - Locked
          - Expired
      - name: search
        in: query
        description: Search term to filter user accounts by username or display name
        schema:
          type: string
      responses:
        '200':
          description: Collection of user accounts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserAccount'
                  total:
                    type: integer
                    description: Total number of user accounts
        '401':
          description: Unauthorized - invalid or expired access token
        '403':
          description: Forbidden - insufficient permissions
  /userAccounts/{accountId}:
    get:
      operationId: getUserAccount
      summary: Workday Security Get a specific user account
      description: Retrieve detailed information about a specific Workday user account including account status, associated security groups, and last signon information.
      tags:
      - User Accounts
      parameters:
      - name: accountId
        in: path
        required: true
        description: Unique identifier of the user account
        schema:
          type: string
      responses:
        '200':
          description: User account details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAccount'
        '401':
          description: Unauthorized - invalid or expired access token
        '403':
          description: Forbidden - insufficient permissions
        '404':
          description: User account not found
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:
    UserAccount:
      type: object
      description: A Workday user account representing a person or system that can authenticate to the Workday platform. Contains account credentials, status, and associated security configuration.
      properties:
        id:
          type: string
          description: Unique identifier for the user account
        descriptor:
          type: string
          description: Display name of the user account
        userName:
          type: string
          description: The username used for authentication
        accountStatus:
          type: string
          enum:
          - Active
          - Disabled
          - Locked
          - Expired
          description: Current status of the user account
        accountType:
          type: string
          enum:
          - User
          - IntegrationSystemUser
          description: Type of account indicating whether it is a regular user account or an integration system user account
        lastSignonDateTime:
          type: string
          format: date-time
          description: Timestamp of the most recent successful signon
        accountExpirationDate:
          type: string
          format: date
          description: Date when the account is set to expire if an expiration is configured
        passwordExpirationDate:
          type: string
          format: date
          description: Date when the current password will expire
        mfaEnabled:
          type: boolean
          description: Whether multi-factor authentication is enabled for this account
        worker:
          $ref: '#/components/schemas/WorkerRef'
    WorkerRef:
      type: object
      description: Reference to a Workday worker associated with a user account
      properties:
        id:
          type: string
          description: Unique identifier of the worker
        descriptor:
          type: string
          description: Display name of the worker
        href:
          type: string
          format: uri
          description: API URL for the worker resource
  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