Kestra Plugin List

Kestra Plugin List

Certified

List invitations

Lists pending invitations for the current tenant. Supports pagination (size defaults to 100) or fetches all pages when no page is set.

yaml
type: io.kestra.plugin.kestra.ee.iam.invitations.List

List all pending invitations.

yaml
id: iam_invitation_list
namespace: company.team

tasks:
  - id: list_invitations
    type: io.kestra.plugin.kestra.ee.iam.invitations.List
    fetchType: FETCH
Properties

Select API authentication

Use either an API token or HTTP Basic (username/password); do not provide both.

Definitions
apiTokenstring

API token for bearer auth

autobooleanstring
Defaulttrue

Automatically 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-token to use an API token
  • Set kestra.tasks.sdk.authentication.username and kestra.tasks.sdk.authentication.password for HTTP basic authentication
  • Set kestra.tasks.sdk.authentication.url to also default the Kestra API endpoint (see kestraUrl above) 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.
passwordstring

Password for HTTP Basic auth

usernamestring

Username for HTTP Basic auth

DefaultSTORE
Possible Values
STOREFETCHFETCH_ONENONE

Output fetch type

Defines how results are returned: FETCH for direct output, STORE to persist as an ION file.

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 number

If omitted, all pages are fetched. Set to 1 or higher to retrieve a single page.

Reference (ref) of the pluginDefaults to apply to this task.

Default100

Page size

Number of invitations per page; defaults to 100.

Override target tenant

Tenant identifier applied to API calls; defaults to the current execution tenant.

List of fetched invitations

Only populated when using fetchType=FETCH or fetchType=FETCH_ONE.

Definitions
acceptedAtstring
Formatdate-time
emailstring
expiredAtstring
Formatdate-time
groupsarray
idstring
namestring
idstring
instanceOwnerboolean
linkstring
rolesarray
idstring
isDefaultboolean
isManagedboolean
namestring
sentAtstring
Formatdate-time
statusstring
Possible Values
PENDINGACCEPTEDEXPIREDUNKNOWN_DEFAULT_OPEN_API
tenantIdstring

Number of fetched invitations

Only populated if fetchType is not NONE.

Formaturi

Kestra internal storage URI of the stored invitations

Only populated when using fetchType=STORE.

More Plugins in this Category

Core Plugins and tasks
Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

Core

122 tasks

580 blueprints

Ruby
Ruby

Tasks that run Ruby scripts.

Core

4 tasks