Skip to content

Update Workato connector docs: environment roles and data centers#376

Open
c1-dev-bot[bot] wants to merge 1 commit into
mainfrom
docs/cxh-1993
Open

Update Workato connector docs: environment roles and data centers#376
c1-dev-bot[bot] wants to merge 1 commit into
mainfrom
docs/cxh-1993

Conversation

@c1-dev-bot

@c1-dev-bot c1-dev-bot Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add Environment Roles to the capabilities table with Sync and Provision support, matching the connector's declared capabilities in baton_capabilities.json
  • Add a note explaining environment role behavior: RBAC v2 requirement, one-role-per-environment semantics (granting replaces the existing role), and that direct revocation is not supported
  • Add environment role API permissions (GET /api/environment_roles and GET /api/environment_roles/:id) to the client role setup table, with footnotes explaining RBAC v2 availability and provisioning requirements
  • Expand the data center list to include IL (Israel) and Sandbox (Trial) in all three locations: the lookup reference list, the cloud-hosted configuration step, and the self-hosted Kubernetes secrets YAML

All changes verified against the connector source code (baton_capabilities.json, pkg/config/config.go, pkg/connector/client/helpers.go, pkg/connector/environment_role.go).

Test plan

  • Verify the Mintlify build succeeds with no rendering errors
  • Confirm the capabilities table renders correctly with the new Environment Roles row
  • Confirm the <Note> block renders properly below the capabilities table
  • Confirm the API permissions table renders with the two new environment role rows and footnotes
  • Confirm all three data center references now include il and sandbox
  • Review for accuracy against current Workato RBAC v2 behavior

Automated PR Notice

This PR was automatically created by c1-dev-bot as a potential documentation update.

This documentation requires:

  • Human review for accuracy and completeness
  • Verification that it matches current product behavior
  • Approval from the appropriate team before merging

…ters

- Add Environment Roles to the capabilities table (Sync + Provision)
- Add note explaining RBAC v2 requirement and one-role-per-environment
  assignment semantics (grant replaces; direct revoke not supported)
- Add environment role API permissions (List/Get environment roles) to
  the client role setup table with RBAC v2 footnotes
- Add IL and Sandbox data centers to all three references (lookup list,
  cloud-hosted config, self-hosted Kubernetes secrets)
@linear-code

linear-code Bot commented Jul 6, 2026

Copy link
Copy Markdown

CXH-1993

@mintlify

mintlify Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
conductorone 🟢 Ready View Preview Jul 6, 2026, 9:30 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mindymo

mindymo commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

@manuel-ts-14 — flagging a sync conflict between this PR and baton-workato#57.

When baton-workato#57 merges, the sync bot will push connector.mdx from that repo into baton/workato.mdx here, which would overwrite the changes in this PR. The connector.mdx in that PR is also missing some content that this PR adds:

  1. RBAC v2 availability caveat — the <Note> here explains that environment roles only apply to workspaces using the RBAC v2 model, and that legacy role model workspaces can skip them. connector.mdx has no equivalent warning.
  2. Environment role API endpoints — this PR adds GET /api/environment_roles and GET /api/environment_roles/:id to the permissions table, with footnotes explaining when each is required. connector.mdx doesn't add those rows, so users setting up credentials won't know which Workato API permissions to grant.
  3. Minor: this PR uses "Sandbox" for the IL/sandbox data center label; connector.mdx uses "Developer Sandbox" and adds a "(developer sandbox)" clarification in the data center field step — the connector.mdx wording is slightly clearer.

Proposed fix: add the missing content to connector.mdx in baton-workato#57 before it merges, then close this PR as superseded. That way the sync brings the correct content into the docs repo automatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant