Skip to main content

Oauth Clients

MCP tools for the Oauth Clients module. See the Oauth Clients module docs for permissions and data model.

list-oauth-clients​

List OAuth clients

Arguments​

ArgumentTypeRequiredDescription
project_idstringnoProject ID (required if not using project key auth)
limitnumbernoResults per page. Above the maximum it is clamped; below 1 or not an integer it is 400 VALIDATION_FAILED.
cursorstringnoThe previous page's next_cursor; omit it for the first page. Send it with the same filters as the request that returned it: a malformed cursor, or one sent with other filters, is 400 INVALID_CURSOR.

create-oauth-client​

Create an OAuth client

Arguments​

ArgumentTypeRequiredDescription
project_idstringnoProject ID (required if not using project key auth)
namestringyesA label for the client, such as the provider's name.
authorize_urlstringyesThe provider's authorization endpoint. Query parameters it already carries are kept.
token_urlstringyesThe provider's token endpoint.
revocation_urlstring | nullnoThe provider's RFC 7009 revocation endpoint, called when a connection is deleted. null skips revocation.
client_idstringyesYour app's client ID at the provider.
client_secretstring | nullnoA {{secret:sec_...}} reference to your app's client secret, never the value. null for a public client, which relies on PKCE.
scopesarray<string>yesThe scopes requested at authorization.
pkcebooleannoWhether the authorization uses PKCE (S256).
token_endpoint_auth_methodstringnoHow the client authenticates at the token endpoint.
redirect_uristring | nullnoThe callback the provider redirects to, as registered with the provider. Absent on create, or null, it is the deployment's OAUTH_DEFAULT_REDIRECT_URI when set, else stored null: this server's own {SOAT_BASE_URL}/api/v1/oauth-connections/callback. A front end that receives the redirect itself forwards code and state there.
authorize_paramsobject | nullnoExtra query parameters for the authorize URL, such as Google's access_type: offline and prompt: consent for a refresh token.

get-oauth-client​

Get an OAuth client

Arguments​

ArgumentTypeRequiredDescription
oauth_client_idstringyesOAuth client ID

update-oauth-client​

Update an OAuth client

Arguments​

ArgumentTypeRequiredDescription
oauth_client_idstringyesOAuth client ID
namestringnoA label for the client, such as the provider's name.
authorize_urlstringnoThe provider's authorization endpoint. Query parameters it already carries are kept.
token_urlstringnoThe provider's token endpoint.
revocation_urlstring | nullnoThe provider's RFC 7009 revocation endpoint, called when a connection is deleted. null skips revocation.
client_idstringnoYour app's client ID at the provider.
client_secretstring | nullnoA {{secret:sec_...}} reference to your app's client secret, never the value. null for a public client, which relies on PKCE.
scopesarray<string>noThe scopes requested at authorization.
pkcebooleannoWhether the authorization uses PKCE (S256).
token_endpoint_auth_methodstringnoHow the client authenticates at the token endpoint.
redirect_uristring | nullnoThe callback the provider redirects to, as registered with the provider. Absent on create, or null, it is the deployment's OAUTH_DEFAULT_REDIRECT_URI when set, else stored null: this server's own {SOAT_BASE_URL}/api/v1/oauth-connections/callback. A front end that receives the redirect itself forwards code and state there.
authorize_paramsobject | nullnoExtra query parameters for the authorize URL, such as Google's access_type: offline and prompt: consent for a refresh token.

delete-oauth-client​

Delete an OAuth client

Arguments​

ArgumentTypeRequiredDescription
oauth_client_idstringyesOAuth client ID