Ligantic
Docs
Tutorials
How-to guides
Reference
Explanation
Login
Free Sign Up
Docs
/
Reference
/
Flows
/
Node types
/
Auth

Auth - OAuth Get Access Token

Type identifier: auth:oauth:getAccessToken Category: Auth Operations

Description

Gets an OAuth access token for a configured OAuth credential. The token is automatically refreshed when needed and returned as a wrapped secret value.

Input Handles

This node has no input handles.

Output Handles

Handle

Data Type

Description

accessToken

secretValue

OAuth access token wrapped as a secret value

Configuration Options

Property

Type

Required

Default

Description

label

string

Yes

"OAuth - Get Access Token"

Display label for the node

oauthCredentialId

string (CUID2)

Yes

""

OAuth credential to resolve and refresh

Behaviour

  1. Reads the OAuth credential selected in oauthCredentialId.
  2. Gets a valid access token for the credential, refreshing it if required.
  3. Emits the token on accessToken as a secret value.

Error Codes

Flow Error Code

Meaning

OAUTH_CREDENTIAL_NOT_FOUND

Credential does not exist or was removed

OAUTH_CREDENTIAL_NOT_AUTHORIZED

Credential is not authorised or is missing required data. Re-authorise the credential.

OAUTH_REFRESH_FAILED

Refresh token is invalid or expired, or the refresh failed. Re-authorise the credential.

OAUTH_GET_ACCESS_TOKEN_FAILED

Generic token retrieval failure

Example

{
  "type": "auth:oauth:getAccessToken",
  "data": {
    "label": "OAuth - Get Access Token",
    "oauthCredentialId": "cm123exampleoauthcredentialid"
  }
}

Related pages

Auth - Magic Link Generate
The Auth - Magic Link Generate node creates a secure, single-use authentication link that users can click to log in without a password. The link is typically sent via email and expires after a configurable period.
Auth - Space Identity Create
The Auth - Space Identity Create node creates a new Space Identity within a Space, allowing users to authenticate and access the Space's Experiences. It assigns a role to the Space Identity, determining the user's permissions.
Integration - HTTP
The Integration - HTTP node performs HTTP requests to external URLs, supporting all common HTTP methods, custom headers, query parameters, request bodies, and OAuth 1.0a authentication. It can return parsed responses matching a defined schema.
Secret - Unwrap
The Secret - Unwrap node extracts the plain text value from a wrapped secret. While most nodes that need secrets can accept wrapped values directly, this node is useful when you need the actual string value for custom processing.