PluginsAzureTasksAuthOauthAccessToken

OauthAccessToken​Oauth​Access​Token

OauthAccessToken OauthAccessToken

yaml
type: "io.kestra.plugin.azure.auth.OauthAccessToken"

Fetch an OAuth access token.

Examples

yaml
id: azure_get_token
namespace: company.team

tasks:
  - id: get_access_token
    type: io.kestra.plugin.azure.oauth.OauthAccessToken
    tenantId: "{{ secret('SERVICE_PRINCIPAL_TENANT_ID') }}"
    clientId: "{{ secret('SERVICE_PRINCIPAL_CLIENT_ID') }}"
    clientSecret: "{{ secret('SERVICE_PRINCIPAL_CLIENT_SECRET') }}"

Properties

tenantId

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: ``

Tenant ID

clientId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: ``

Client ID

Client ID of the Azure service principal. If you don't have a service principal, refer to create a service principal with Azure CLI.

clientSecret

  • Type: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: ``

Client Secret

Service principal client secret. The tenantId, clientId and clientSecret of the service principal are required for this credential to acquire an access token.

pemCertificate

  • Type: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: ``

PEM Certificate

Your stored PEM certificate.

The tenantId, clientId and clientCertificate of the service principal are required for this credential to acquire an access token.

scopes

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: ["https://management.azure.com/.default"]

The Azure scopes to be used

Outputs

accessToken

An OAuth access token for the current user.

Definitions

io.kestra.plugin.azure.auth.OauthAccessToken-AccessTokenOutput

Properties

expirationTime
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
scopes
  • Type: array
  • SubType: string
  • Dynamic: ❓
  • Required: ❓
tokenValue

OAuth access token value

Will be automatically encrypted and decrypted in the outputs if encryption is configured

io.kestra.core.models.tasks.common.EncryptedString

Properties

type
  • Type: string
  • Dynamic: ❓
  • Required: ❓
value
  • Type: string
  • Dynamic: ❓
  • Required: ❓

Was this page helpful?