Skip to content

Conversation

@mindymo
Copy link
Collaborator

@mindymo mindymo commented Jan 29, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Push rules documentation including feature overview, supported connectors (Active Directory, Microsoft Entra), step-by-step configuration workflow, attribute mapping options, custom attribute support, user filtering capabilities, operational guidelines, and practical examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 29, 2026

📝 Walkthrough

Walkthrough

A new documentation file introducing the Push rules feature has been added. It covers the purpose, supported connectors, creation workflows, attribute mapping methods including CEL expressions, custom attributes support, user filtering, and operational constraints.

Changes

Cohort / File(s) Summary
Push Rules Documentation
product/admin/push-rules.mdx
New documentation page explaining the Push rules feature, including configuration guidance, attribute mapping methods, connector support, and usage examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A new page hops into view, with rules to push and paths so true,
Connectors dance, attributes map, from directories we'll fill the gap!
CEL expressions weave their spell, documentation tells it well! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'WIP - Push attributes' is vague and generic. While 'Push attributes' relates to the added documentation about push rules, the title lacks specificity about what feature is being documented and uses 'WIP' prefix which doesn't convey meaningful information about the changeset. Consider revising the title to be more specific and descriptive, such as 'Add Push rules documentation' or 'Document push attributes feature with configuration examples' to clearly indicate the main change.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Fix all issues with AI agents
In `@product/admin/push-rules.mdx`:
- Around line 81-83: The "Manage service users" section in
product/admin/push-rules.mdx is incomplete; either populate it with the intended
use case details (describe goals, actors, steps, permissions, and examples for
service user lifecycle: create, update, revoke) under the "Manage service users"
heading or remove the heading and placeholder entirely if this feature won't
ship in the initial release; update any cross-references in the document to
reflect the change.
- Around line 51-57: Under the "## Filter users" section you need to replace the
placeholder with concrete filter configuration details: describe the filter
schema (attribute names, supported operators like equals/contains/exists, value
types), show at least one small YAML/JSON example of a rule targeting users by
attribute, state default behavior when no filters are present, and add a short
note linking this to profile type mappings; keep the existing <Warning> about
profile type mapping dependency in place and reference it from the examples so
readers see that attributes used in filters must be granted by the profile type.
- Around line 29-31: The document push-rules.mdx contains placeholder lines
("[Navigation path to be added]" and "[Additional steps to be added]") that must
be replaced with the actual UI navigation and concrete configuration steps;
update the content in product/admin/push-rules.mdx to (1) insert the full
navigation path users should follow to reach the connector/configuration screen
(replace the first placeholder), and (2) replace the "[Additional steps to be
added]" line with step-by-step instructions for selecting the connector,
configuring required fields, saving changes, and any post-save verification
actions so the guide is complete and publishable.
- Around line 47-49: The "Add custom attributes" placeholder in
product/admin/push-rules.mdx must be replaced with concrete connector-specific
details: enumerate each connector (e.g., "Salesforce", "Zendesk", "Okta") and
list the supported custom attributes and their data types, any
naming/serialization rules, examples of attribute declarations and usage in push
rules, and any limits (length, count) or required permissions; include links or
references to the connector implementation or schema docs and a short note on
how missing attributes are handled by the Push Rules processor (e.g., ignored
vs. error) so readers can implement rules accurately.
🧹 Nitpick comments (2)
product/admin/push-rules.mdx (2)

1-8: Frontmatter and editor refresh look good.

The required fields (title, description) and optional fields (og:title, og:description, sidebarTitle) are present. Editor refresh comment follows the correct format.

Minor note: Line 5 has a trailing double space after the description text.

🧹 Suggested fix
-description: Automatically sync user attributes from ConductorOne to connected systems.  
+description: Automatically sync user attributes from ConductorOne to connected systems.

41-45: Consider adding a CEL expression code example.

The documentation mentions CEL expressions and references an email format example but doesn't provide actual code. A practical example would help users understand the syntax. As per coding guidelines, documentation should include simple, practical, tested code examples.

💡 Example addition
 CEL expressions let you map different values for different app users. For example, you could map different email formats for regular accounts versus privileged accounts.
+
+```cel
+app_user.email.endsWith("_admin") ? subject.email : subject.workEmail
+```

Comment on lines +29 to +31
1. [Navigation path to be added]
2. Select the connector you want to configure
3. [Additional steps to be added]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Incomplete placeholder content.

The navigation path and additional steps need to be filled in before this documentation is ready for publication.

Would you like me to help draft these steps once the UI workflow is finalized?

🤖 Prompt for AI Agents
In `@product/admin/push-rules.mdx` around lines 29 - 31, The document
push-rules.mdx contains placeholder lines ("[Navigation path to be added]" and
"[Additional steps to be added]") that must be replaced with the actual UI
navigation and concrete configuration steps; update the content in
product/admin/push-rules.mdx to (1) insert the full navigation path users should
follow to reach the connector/configuration screen (replace the first
placeholder), and (2) replace the "[Additional steps to be added]" line with
step-by-step instructions for selecting the connector, configuring required
fields, saving changes, and any post-save verification actions so the guide is
complete and publishable.

Comment on lines +47 to +49
### Add custom attributes

Some connectors support custom attributes beyond the standard schema. [Details on which connectors support this to be added]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Placeholder content needs completion.

The custom attributes section references connector-specific details that need to be added.

🤖 Prompt for AI Agents
In `@product/admin/push-rules.mdx` around lines 47 - 49, The "Add custom
attributes" placeholder in product/admin/push-rules.mdx must be replaced with
concrete connector-specific details: enumerate each connector (e.g.,
"Salesforce", "Zendesk", "Okta") and list the supported custom attributes and
their data types, any naming/serialization rules, examples of attribute
declarations and usage in push rules, and any limits (length, count) or required
permissions; include links or references to the connector implementation or
schema docs and a short note on how missing attributes are handled by the Push
Rules processor (e.g., ignored vs. error) so readers can implement rules
accurately.

Comment on lines +51 to +57
## Filter users

You can configure filters to control which users receive attribute pushes. [Configuration details to be added]

<Warning>
Push rules rely on profile type mappings. Users must have the required attributes granted by their profile type for the rule to apply.
</Warning>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Filter configuration details pending; Warning component is well-placed.

Line 53 needs configuration details. The Warning component appropriately highlights the profile type mapping dependency.

🤖 Prompt for AI Agents
In `@product/admin/push-rules.mdx` around lines 51 - 57, Under the "## Filter
users" section you need to replace the placeholder with concrete filter
configuration details: describe the filter schema (attribute names, supported
operators like equals/contains/exists, value types), show at least one small
YAML/JSON example of a rule targeting users by attribute, state default behavior
when no filters are present, and add a short note linking this to profile type
mappings; keep the existing <Warning> about profile type mapping dependency in
place and reference it from the examples so readers see that attributes used in
filters must be granted by the profile type.

Comment on lines +81 to +83
### Manage service users

[Use case details to be added] No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Incomplete use case section.

The "Manage service users" section needs content or should be removed if not applicable for initial release.

🤖 Prompt for AI Agents
In `@product/admin/push-rules.mdx` around lines 81 - 83, The "Manage service
users" section in product/admin/push-rules.mdx is incomplete; either populate it
with the intended use case details (describe goals, actors, steps, permissions,
and examples for service user lifecycle: create, update, revoke) under the
"Manage service users" heading or remove the heading and placeholder entirely if
this feature won't ship in the initial release; update any cross-references in
the document to reflect the change.

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.

2 participants