Workday Security Security Groups API

openapi: 3.1.0
info:
  title: Workday Security Workday Audit and Compliance Account Signons Security Groups 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: Security Groups
  description: Create, retrieve, and manage security groups that control access to Workday domains, business processes, and securable items.
paths:
  /securityGroups:
    get:
      operationId: listSecurityGroups
      summary: Workday Security List security groups
      description: Retrieve a collection of security groups configured in the Workday tenant. Supports filtering by security group type, status, and search terms. Returns security group metadata including type, membership count, and associated domain security policies.
      tags:
      - Security Groups
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: type
        in: query
        description: Filter by security group type
        schema:
          type: string
          enum:
          - Integration_System
          - Role_Based
          - User_Based
          - Job_Based
          - Unconstrained
          - Constrained
          - Intersection
          - Aggregation
      - name: search
        in: query
        description: Search term to filter security groups by name or description
        schema:
          type: string
      - name: inactive
        in: query
        description: Include inactive security groups in the results
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Collection of security groups
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SecurityGroup'
                  total:
                    type: integer
                    description: Total number of security groups matching the criteria
        '401':
          description: Unauthorized - invalid or expired access token
        '403':
          description: Forbidden - insufficient permissions
  /securityGroups/{securityGroupId}:
    get:
      operationId: getSecurityGroup
      summary: Workday Security Get a specific security group
      description: Retrieve detailed information about a specific security group including its type, members, and associated domain security policies.
      tags:
      - Security Groups
      parameters:
      - name: securityGroupId
        in: path
        required: true
        description: Unique identifier of the security group
        schema:
          type: string
      responses:
        '200':
          description: Security group details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityGroup'
        '401':
          description: Unauthorized - invalid or expired access token
        '403':
          description: Forbidden - insufficient permissions
        '404':
          description: Security group 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:
    SecurityGroup:
      type: object
      description: A security group that controls access to securable items within Workday domains and business processes. Security groups can be role-based, user-based, integration system-based, or derived from job or organizational criteria.
      properties:
        id:
          type: string
          description: Unique identifier for the security group
        descriptor:
          type: string
          description: Human-readable name of the security group
        type:
          type: string
          enum:
          - Integration_System
          - Role_Based
          - User_Based
          - Job_Based
          - Unconstrained
          - Constrained
          - Intersection
          - Aggregation
          description: Classification of the security group that determines how membership is derived and managed
        description:
          type: string
          description: Detailed description of the security group purpose
        inactive:
          type: boolean
          description: Whether the security group is currently inactive
        memberCount:
          type: integer
          minimum: 0
          description: Number of members currently in the security group
        domainPolicies:
          type: array
          items:
            $ref: '#/components/schemas/DomainSecurityPolicyRef'
          description: Domain security policies associated with this security group
        createdOn:
          type: string
          format: date-time
          description: Timestamp when the security group was created
        lastModified:
          type: string
          format: date-time
          description: Timestamp when the security group was last modified
    DomainSecurityPolicyRef:
      type: object
      description: Reference to a domain security policy
      properties:
        id:
          type: string
          description: Unique identifier of the domain security policy
        descriptor:
          type: string
          description: Display name of the domain security policy
        href:
          type: string
          format: uri
          description: API URL for the domain security policy 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