@devries-cameron20 / composio Mirror · read-only
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 06:00 UTC

next
md 49 lines 4.08 KB
Rendered Raw
1 ## How do I set up custom OAuth credentials for Workday?
2
3 Workday has no Composio-managed OAuth app, so you register an API client in your own Workday tenant. You need administrator or integration security permissions in Workday, and your tenant name, which appears in your Workday URLs.
4
5 ### Register the Workday API client
6
7 1. Sign in to your Workday tenant, type `Register API Client` in the search bar, and press Enter.
8 2. Under **Tasks and Reports**, open **Register API Client**. Don't pick the Integrations variant or the external OAuth client task. If the task doesn't appear, your account lacks the required security permissions.
9 3. Fill in the form:
10 - **Client Name**: for example, `composio-workday`.
11 - **Client Grant Type**: **Authorization Code Grant**.
12 - **Access Token Type**: **Bearer**.
13 - **Support PKCE**: leave unchecked.
14 - **Redirection URI**: `https://backend.composio.dev/api/v1/auth-apps/add`. It must exactly match the `oauth_redirect_uri` field in your Composio auth config, or the connection fails with `redirect_uri_mismatch`.
15 - **Non-Expiring Refresh Tokens**: enable.
16 - **Scopes**: select the areas your tools need, and check **Include Workday Owned Scope**.
17
18 ![Workday Register API Client form with the client name, Authorization Code Grant, Bearer token type, and redirection URI](/images/toolkits/workday/register-api-client-form.webp)
19
20 ![Workday Register API Client form with Non-Expiring Refresh Tokens, functional scopes, and Include Workday Owned Scope checked](/images/toolkits/workday/register-api-client-scopes.webp)
21 4. Click **OK**, review the summary, and click **Done**.
22
23 ![Workday registered API client summary with the Composio redirection URI](/images/toolkits/workday/registered-client-summary.webp)
24 5. On the client detail page, copy five values: **Client ID**, **Client Secret**, **REST API Endpoint**, **Token Endpoint**, and **Authorization Endpoint**. Copy them now; the secret can be masked once you leave the page, and you'd have to regenerate it.
25
26 ### Create the auth config in Composio
27
28 1. In the Composio dashboard, go to **Auth Configs**, click **Create Auth Config**, and select **Workday** (OAuth2).
29 2. Paste the **Client ID** and **Client Secret**, then create the auth config.
30 3. Click **Connect Account** and enter a stable user ID from your own system, such as a UUID from your user database.
31 4. Enter the three tenant URLs you copied, then click **Connect Account** and complete the Workday consent flow:
32 - **REST API base URL**: for example, `https://wd2-impl-services1.workday.com/ccx/api/v1/<tenant>`.
33 - **Authorization URL**: for example, `https://wd2-impl-services1.workday.com/ccx/oauth2/<tenant>/authorize`.
34 - **Token URL**: for example, `https://wd2-impl-services1.workday.com/ccx/oauth2/<tenant>/token`.
35 5. Confirm the account shows as **Active** under **Connected Accounts**.
36
37 Use the exact URLs from your API client's detail page. Generic Workday URLs fail the token exchange.
38
39 See [Custom auth configs](/docs/auth-configuration/custom-auth-configs) for the general flow.
40
41 ### Set up an Integration System User and security group
42
43 Workday recommends running API clients as an Integration System User (ISU) with the right domain permissions. Most tenants already have one; check with your Workday admin first.
44
45 1. Run **Create Integration System User**. Set a username and password, set **Session Timeout Minutes** to `0`, and check **Do Not Allow UI Sessions**.
46 2. Run **Maintain Password Rules** and add the ISU to **System Users exempt from password expiration**.
47 3. Run **Create Security Group** and choose **Integration System Security Group (Unconstrained)** for access to all data instances, or **(Constrained)** for access scoped by context. Add the ISU as a member.
48 4. Run **Maintain Permissions for Security Group**, select the group, and on **Domain Security Policy Permissions** grant GET access to `Integration Build`, `Integration Process`, `Integration Debug`, `Integration Event`, `Worker Data: Current Staffing Information`, and `Worker Data: Public Worker Reports`.
49 5. Run **Activate Pending Security Policy Changes**, enter a comment, and confirm.