Kestra Plugin List
CertifiedList groups
Kestra Plugin List
List groups
Lists groups for the current tenant. Supports pagination (size defaults to 100) or fetches all pages when no page is set.
type: io.kestra.plugin.kestra.ee.iam.groups.ListExamples
List all groups.
id: iam_group_list
namespace: company.team
tasks:
- id: list_groups
type: io.kestra.plugin.kestra.ee.iam.groups.List
fetchType: FETCH
Properties
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150auth
Select API authentication
Use either an API token or HTTP Basic (username/password); do not provide both.
io.kestra.plugin.kestra.AbstractKestraTask-Auth
API token for bearer auth
trueAutomatically retrieve credentials from Kestra's configuration if available
The default configuration can be configured globally inside the Kestra configuration file:
- Set
kestra.tasks.sdk.authentication.api-tokento use an API token - Set
kestra.tasks.sdk.authentication.usernameandkestra.tasks.sdk.authentication.passwordfor HTTP basic authentication - Set
kestra.tasks.sdk.authentication.urlto also default the Kestra API endpoint (seekestraUrlabove) The Enterprise edition also provides setting a default configuration at the Namespace or Tenant level by an administrator. Set to false to also opt out of the default URL, and to call a Kestra API that requires no authentication when no credentials are set either.
Password for HTTP Basic auth
Username for HTTP Basic auth
fetchType string
STORESTOREFETCHFETCH_ONENONEOutput fetch type
Defines how results are returned: FETCH for direct output, STORE to persist as an ION file.
kestraUrl string
Override Kestra API endpoint
URL used for calls to the Kestra API. When null, falls back to the url configured alongside the default SDK authentication (Namespace or Tenant level, Enterprise edition), then renders {{ kestra.url }} from configuration; if still empty, defaults to http://localhost: 8080. Trailing slashes are stripped before use.
page integerstring
Page number
If omitted, all pages are fetched. Set to 1 or higher to retrieve a single page.
size integerstring
100Page size
Number of groups per page; defaults to 100.
tenantId string
Override target tenant
Tenant identifier applied to API calls; defaults to the current execution tenant.
Outputs
groups array
List of fetched groups
Only populated when using fetchType=FETCH or fetchType=FETCH_ONE.
io.kestra.sdk.model.ApiGroupSummary
size integer
Number of fetched groups
Only populated if fetchType is not NONE.
uri string
uriKestra internal storage URI of the stored groups
Only populated when using fetchType=STORE.
