Kestra Plugin Set

Kestra Plugin Set
Certified
Create or update a group

Upserts a group by name: searches for an existing group with the given name and updates it if found, or creates a new one otherwise.

yaml
type: io.kestra.plugin.kestra.ee.iam.groups.Set

Examples

Upsert a group.

yaml
id: iam_group_set
namespace: company.team

tasks:
  - id: upsert_group
    type: io.kestra.plugin.kestra.ee.iam.groups.Set
    name: "data-engineers"
    groupDescription: "Group for the data engineering team"

Properties

name *string

Group name

auth

Select API authentication

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

Definitions

io.kestra.plugin.kestra.AbstractKestraTask-Auth

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

groupDescription string

Group description

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.