Workday Security Security Group Members API

openapi: 3.1.0
info:
  title: Workday Security Workday Audit and Compliance Account Signons Security Group Members 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 Group Members
  description: Manage the membership of users and integration system users within security groups.
paths:
  /securityGroups/{securityGroupId}/members:
    get:
      operationId: listSecurityGroupMembers
      summary: Workday Security List members of a security group
      description: Retrieve the collection of users and integration system users that are members of the specified security group. Returns member details including account information and assignment metadata.
      tags:
      - Security Group Members
      parameters:
      - name: securityGroupId
        in: path
        required: true
        description: Unique identifier of the security group
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Collection of security group members
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SecurityGroupMember'
                  total:
                    type: integer
                    description: Total number of members in the security group
        '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:
    AccountRef:
      type: object
      description: Reference to a Workday user account
      properties:
        id:
          type: string
          description: Unique identifier of the user account
        descriptor:
          type: string
          description: Display name of the user account
        href:
          type: string
          format: uri
          description: API URL for the user account resource
    SecurityGroupMember:
      type: object
      description: A member of a security group, which can be a user account or an integration system user that has been assigned to the group.
      properties:
        id:
          type: string
          description: Unique identifier of the membership assignment
        account:
          $ref: '#/components/schemas/AccountRef'
        assignedOn:
          type: string
          format: date-time
          description: Timestamp when the member was assigned to the security group
        assignedBy:
          type: string
          description: The account that assigned this member to the group
  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