YouTube OAuth2

YouTube OAuth2

Certified

Authenticate with YouTube using OAuth2

This task authenticates with YouTube API using OAuth2 refresh token flow.

yaml
type: io.kestra.plugin.youtube.OAuth2

Authentication with youtube

yaml
id: youtube_auth
namespace: company.team

tasks:
  - id: authenticate
    type: io.kestra.plugin.youtube.OAuth2
    clientId: "{{ secret('YOUTUBE_CLIENT_ID') }}"
    clientSecret: "{{ secret('YOUTUBE_CLIENT_SECRET') }}"
    refreshToken: "{{ secret('YOUTUBE_REFRESH_TOKEN') }}"
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-youtube --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

The OAuth2 Client ID

OAuth2 client ID from Google Cloud console project

The OAuth2 Client Secret

OAuth2 client secret from Google Cloud console project

The OAuth2 Refresh Token

Refresh token obtained during the initial authorization flow

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaulthttps://oauth2.googleapis.com/token

Token endpoint URL

The Google OAuth2 token endpoint URL

Access Token

OAuth2 access token for API authentication. WARNING: This token is stored in task outputs and visible to users with execution read access. Restrict namespace permissions and prefer storing tokens in Kestra's secret store.

Formatdate-time

Expiration time

The exact time when the token expires

Expires In Seconds

Number of seconds until the token expires

Token Scope

Granted OAuth2 scopes

Token Type

Type of the access token (typically 'Bearer')