Skip to main content

Oauth Client

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Registers an OAuth 2.0 client (your app at a provider) in the formation's project. A tool names it by ref in execute.auth.oauth_client_id.

Syntax​

type: oauth_client
properties:
name: String
authorize_url: String
token_url: String
revocation_url: String
client_id: String
client_secret: String
scopes: String[]
pkce: Boolean
token_endpoint_auth_method: String
redirect_uri: String
authorize_params: Object

Output​

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

some_field:
ref: MyOauthClient

Properties​

name

Display name

Required: Yes Type: String


authorize_url

The provider's authorization endpoint

Required: Yes Type: String


token_url

The provider's token endpoint

Required: Yes Type: String


revocation_url

The provider's RFC 7009 revocation endpoint

Required: No Type: String Nullable: Yes


client_id

Your app's client ID at the provider

Required: Yes Type: String


client_secret

A {{secret:sec_...}} reference to the client secret, never the value; for a template secret, { "sub": "{{secret:${MySecret}}}" }. Omit for a public client, which relies on PKCE.

Required: No Type: String Nullable: Yes


scopes

The scopes requested at authorization

Required: Yes Type: Array of String


pkce

Whether the authorization uses PKCE (S256); default true

Required: No Type: Boolean


token_endpoint_auth_method

How the client authenticates at the token endpoint

Required: No Type: String Allowed values: client_secret_basic, client_secret_post


redirect_uri

The callback registered with the provider. Omitted or null, the deployment's OAUTH_DEFAULT_REDIRECT_URI when set, else the server's own /api/v1/oauth-connections/callback.

Required: No Type: String Nullable: Yes


authorize_params

Extra query parameters for the authorize URL

Required: No Type: Object Nullable: Yes