sso_tokens
Creates, updates, deletes, gets or lists a sso_tokens resource.
Overview
| Name | sso_tokens |
| Type | Resource |
| Id | vercel.marketplace.sso_tokens |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
exchange | exec | code, client_id, client_secret, grant_type, refresh_token | During the autorization process, Vercel sends the user to the provider [redirectLoginUrl](https://vercel.com/docs/integrations/create-integration/submit-integration#redirect-login-url), that includes the OAuth authorization code parameter. The provider then calls the SSO Token Exchange endpoint with the sent code and receives the OIDC token. They log the user in based on this token and redirects the user back to the Vercel account using deep-link parameters included the redirectLoginUrl. Providers should not persist the returned id_token in a database since the token will expire. See [Authentication with SSO](https://vercel.com/docs/integrations/create-integration/marketplace-api#authentication-with-sso) for more details. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|
Lifecycle Methods
EXEC variables use wire (API) names.
- exchange
During the autorization process, Vercel sends the user to the provider redirectLoginUrl, that includes the OAuth authorization code parameter. The provider then calls the SSO Token Exchange endpoint with the sent code and receives the OIDC token. They log the user in based on this token and redirects the user back to the Vercel account using deep-link parameters included the redirectLoginUrl. Providers should not persist the returned id_token in a database since the token will expire. See Authentication with SSO for more details.
EXEC vercel.marketplace.sso_tokens.exchange
@@json=
'{
"code": "{{ code }}",
"state": "{{ state }}",
"client_id": "{{ client_id }}",
"client_secret": "{{ client_secret }}",
"redirect_uri": "{{ redirect_uri }}",
"grant_type": "{{ grant_type }}",
"refresh_token": "{{ refresh_token }}"
}'
;