Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Application Providers API

Link a Provider to an Application

Use this endpoint to link an existing provider to an application and configure its sign-in and sign-up permissions.

post/v1/applications/{id}/providers

Path parameters

idstring required

The unique identifier of the application you want to retrieve.

Request body

providerIdstring required

The unique identifier of the provider to link.

canSignInboolean

Whether users can sign in using this provider.

canSignUpboolean

Whether new users can sign up using this provider.

canUnlinkboolean

Whether users can unlink this provider from their account.

promptedboolean

Whether users are prompted to link this provider on login.

alertTypestring

Alert type configuration for this provider link.

rulestring

Custom rule applied to this provider link.

Response

Indicates that the provider was successfully linked to the application.

providerIdstring

Unique identifier of the linked provider.

category'Email' | 'SMS'

Provider category.

type'SendGrid' | 'Twilio'

Provider implementation type.

canSignInboolean

Whether users can sign in using this provider.

canSignUpboolean

Whether new users can sign up using this provider.

canUnlinkboolean

Whether users can unlink this provider from their account.

promptedboolean

Whether users are prompted to link this provider on login.

alertTypestring

Alert type configuration for this provider link.

rulestring

Custom rule applied to this provider link.