Workday Security Authentication Configuration API

Manage authentication policies and configurations including SSO, SAML, and multi-factor authentication settings.

Documentation

Specifications

Other Resources

OpenAPI Specification

workday-security-authentication-configuration-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Workday Security Workday Audit and Compliance Account Signons Authentication Configuration 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: Authentication Configuration
  description: Manage authentication policies and configurations including SSO, SAML, and multi-factor authentication settings.
paths:
  /api/v1/{tenant}/authenticationPolicies:
    get:
      operationId: listAuthenticationPolicies
      summary: Workday Security List authentication policies
      description: Retrieve the collection of authentication policies configured for the tenant, including SSO settings, multi-factor authentication requirements, and password policies.
      tags:
      - Authentication Configuration
      parameters:
      - $ref: '#/components/parameters/tenant'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Collection of authentication policies
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AuthenticationPolicy'
                  total:
                    type: integer
                    description: Total number of authentication policies
        '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:
    AuthenticationPolicy:
      type: object
      description: An authentication policy that defines the rules and requirements for authenticating users, including SSO configuration, password policies, and multi-factor authentication requirements.
      properties:
        id:
          type: string
          description: Unique identifier for the authentication policy
        descriptor:
          type: string
          description: Human-readable name of the authentication policy
        ssoEnabled:
          type: boolean
          description: Whether single sign-on is enabled for this policy
        samlIdentityProvider:
          type: string
          description: The SAML identity provider configured for SSO authentication
        mfaRequired:
          type: boolean
          description: Whether multi-factor authentication is required
        passwordPolicyEnabled:
          type: boolean
          description: Whether a custom password policy is enforced
        sessionTimeoutMinutes:
          type: integer
          minimum: 1
          description: Session timeout duration in minutes before re-authentication is required
        allowedAuthenticationTypes:
          type: array
          items:
            type: string
          description: List of authentication methods permitted under this policy
  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