For data security, encryption, and credential storage information that applies across all connectors, see Data & Security - Enterprise Search Connectors.
The connector requests the minimum set of permissions the Workday APIs allow for its functionality, and only read-oriented scopes wherever the source APIs permit it.
The connector never writes to or modifies data in Workday.
Credentials are stored encrypted and are never exposed in logs, search results, or the Simpplr UI after initial entry.
Where a source API forces a broader scope than the connector's actual usage, this is called out explicitly in Understanding the credential scope below, together with the guardrails that apply.
Auth type: OAuth 2.0 (refresh token grant).
The connector authenticates as a Workday Integration System User through an API Client for Integrations, exchanging a long-lived refresh token for short-lived access tokens.
The integration security group you create in Workday must be granted the following, and nothing else:
Permission | Why it's needed |
|---|---|
Help Article REST API — Get (Integration Permissions) | Lets the connector call the Workday Help Article service to list published article versions and read their content. This is the only security domain the connector needs. |
Help functional area scope (on the API client) | Scopes the OAuth API client to the Help functional area, which is what makes the Help Article service reachable with the access tokens it issues. |
Non-Expiring Refresh Tokens (on the API client) | Keeps the refresh token valid indefinitely so the connector can continue generating access tokens. Without it the token expires and syncs begin failing with an authentication error. |
These permissions are granted by a Workday administrator holding the Integration Security, Security Configuration, and Security Administration domains. Permission changes do not take effect until the administrator runs Activate Pending Security Policy Changes — skipping that task is the most common cause of a connector that cannot read anything.
Why it's required: Workday secures its Help Article service under the Help Article REST API domain. An integration user must belong to an unconstrained Integration System Security Group to call that service for the tenant instead of for an individual worker's data. Workday provides no narrower grant that returns only public-audience articles, so the credential can retrieve any Help Article in the tenant, including audience-restricted ones.
What the connector actually does with it: read-only calls that list published article versions and read their title, body, and metadata. Every record is filtered to status Published and an audience that includes Public before anything is indexed. Articles in any other audience are discarded inside the connector and are never stored or made searchable.
Guardrails: there is no code path that writes to Workday. The domain grants no access to worker, personal, compensation, staffing, or payroll data, and no such domain is requested. All connector activity is visible in the sync dashboard at Enterprise Search → Workday → Status.
If not granted: Workday returns a permission error and no articles are indexed. The connector cannot function without this domain.
Workday does not offer a narrower permission model for the Help Article REST service this connector uses. Scoping happens on the Workday side instead: the connector indexes only the articles your HR team has published to the Public audience, so moving an article out of that audience removes it from Simpplr search at the next full sync.
Supported: Workday HCM cloud tenants with Workday Help (Knowledge Management) enabled. Implementation and production tenants are both supported — each has its own service host, which is why the host and tenant name are entered as separate fields.
Not supported: tenants where OAuth 2.0 Clients Enabled is not selected under Edit Tenant Setup - Security. No API client can reach the Workday API for such a tenant.
Workday permissions are not read or enforced per article by this connector. Only Public Help articles is supported
Page | What it covers |
|---|---|
What the connector indexes and capabilities at a glance | |
Prerequisites and step-by-step configuration | |
Fields synced per content type, sync schedules, data freshness, limitations in detail | |
Connector-specific issues and FAQs |