Workday Security Domain Security Policies API

openapi: 3.1.0
info:
  title: Workday Security Workday Audit and Compliance Account Signons Domain Security Policies 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: Domain Security Policies
  description: Manage domain security policies that define which security groups have access to specific Workday functional domains and the permission levels granted.
paths:
  /domainSecurityPolicies:
    get:
      operationId: listDomainSecurityPolicies
      summary: Workday Security List domain security policies
      description: Retrieve a collection of domain security policies configured in the Workday tenant. Domain security policies define which security groups have access to specific Workday functional domains and what level of access is granted, such as View or Modify permissions.
      tags:
      - Domain Security Policies
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: domain
        in: query
        description: Filter by Workday domain name
        schema:
          type: string
      - name: search
        in: query
        description: Search term to filter policies by domain name or description
        schema:
          type: string
      responses:
        '200':
          description: Collection of domain security policies
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DomainSecurityPolicy'
                  total:
                    type: integer
                    description: Total number of domain security policies
        '401':
          description: Unauthorized - invalid or expired access token
        '403':
          description: Forbidden - insufficient permissions
  /domainSecurityPolicies/{policyId}:
    get:
      operationId: getDomainSecurityPolicy
      summary: Workday Security Get a specific domain security policy
      description: Retrieve detailed information about a specific domain security policy including the security groups with access and their permission levels.
      tags:
      - Domain Security Policies
      parameters:
      - name: policyId
        in: path
        required: true
        description: Unique identifier of the domain security policy
        schema:
          type: string
      responses:
        '200':
          description: Domain security policy details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainSecurityPolicy'
        '401':
          description: Unauthorized - invalid or expired access token
        '403':
          description: Forbidden - insufficient permissions
        '404':
          description: Domain security policy 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:
    DomainSecurityPolicy:
      type: object
      description: A domain security policy that defines access permissions for a specific Workday functional domain. Specifies which security groups can view or modify resources within the domain.
      properties:
        id:
          type: string
          description: Unique identifier for the domain security policy
        descriptor:
          type: string
          description: Human-readable name of the domain security policy
        domain:
          type: string
          description: The Workday functional domain this policy governs
        description:
          type: string
          description: Detailed description of the policy and its scope
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/PolicyPermission'
          description: List of permission assignments defining which security groups have access and at what level
        lastModified:
          type: string
          format: date-time
          description: Timestamp when the policy was last modified
    PolicyPermission:
      type: object
      description: A permission assignment within a domain security policy that grants a specific security group a level of access to the domain.
      properties:
        securityGroup:
          $ref: '#/components/schemas/SecurityGroupRef'
        accessLevel:
          type: string
          enum:
          - View
          - Modify
          - Get
          - Put
          description: Level of access granted to the security group for this domain
    SecurityGroupRef:
      type: object
      description: Reference to a security group
      properties:
        id:
          type: string
          description: Unique identifier of the security group
        descriptor:
          type: string
          description: Display name of the security group
        href:
          type: string
          format: uri
          description: API URL for the security group 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