Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Application Providers API

Update an Application Provider Link

Use this endpoint to update the permissions and settings of a provider linked to an application.

patch/v1/applications/{id}/providers/{providerId}

Path parameters

idstring required

The unique identifier of the application you want to retrieve.

providerIdstring required

The unique identifier of the provider.

Request body

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 link was successfully updated.

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.