List Groups
okta.list_groups
ActionBusiness appsconnection required
Calls the Okta API with the connection's credentials.
List groups in the org, narrowed with Okta's 'q' name prefix, an indexed 'filter' expression, or the richer 'search' expression grammar.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Okta
- Secret shape
- the API token, or {"api_token": "…"}
- Config it needs
- org_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
q A prefix matched against the group name. | string | No | — | — | — |
filter An Okta filter expression, for example type eq "OKTA_GROUP". | string | No | — | — | — |
search An Okta search expression over group properties, including custom profile attributes. | string | No | — | — | — |
limit How many records Okta should return per page; Okta caps this per endpoint. | number | No | — | ≥ 1 | 200 |
after The opaque cursor from a previous call's 'next_after', to resume where it stopped. | string | No | — | — | — |
max_pages How many 'rel=next' Link-header pages to follow before stopping and reporting a cursor. | number | No | 1 | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 200,
"max_pages": 1
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records Okta returned across the pages that were read. | array | — |
count How many records are in 'items'. | number | — |
pages How many pages were actually fetched. | number | — |
next_url The 'rel=next' URL Okta sent for the following page; empty when the read finished. | string | — |
next_after The 'after' cursor taken from 'next_url'; feed it back in as 'after' to continue. | string | — |
{
"count": 0,
"items": [],
"next_after": "",
"next_url": "",
"pages": 0
}Notes
- Okta paginates with a Link header, not a body field; 'next_after' carries the cursor.
- Okta sends a 'rel=next' link even on a final page, so paging stops on an empty page.
See List Groups run in a workflow.
In a technical demo we add the Okta connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.