---
title: "Link a Provider to an Application"
method: POST
path: "/v1/applications/{id}/providers"
tags: ["Application Providers API"]
---

# Link a Provider to an Application

`POST /v1/applications/{id}/providers`

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

## Path parameters

- `id` string, required

## Request body

- ProviderItemInput — Information required to link a provider to an application.
  - `providerId` string, required — The unique identifier of the provider to link.
  - `canSignIn` boolean — Whether users can sign in using this provider.
  - `canSignUp` boolean — Whether new users can sign up using this provider.
  - `canUnlink` boolean — Whether users can unlink this provider from their account.
  - `prompted` boolean — Whether users are prompted to link this provider on login.
  - `alertType` string — Alert type configuration for this provider link.
  - `rule` string — Custom rule applied to this provider link.

## Response `201`

Indicates that the provider was successfully linked to the application.

- ProviderItemResponse — Information about a provider linked to an application.
  - `providerId` string — Unique identifier of the linked provider.
  - `category` 'Email' | 'SMS' — Provider category.
  - `type` 'SendGrid' | 'Twilio' — Provider implementation type.
  - `canSignIn` boolean — Whether users can sign in using this provider.
  - `canSignUp` boolean — Whether new users can sign up using this provider.
  - `canUnlink` boolean — Whether users can unlink this provider from their account.
  - `prompted` boolean — Whether users are prompted to link this provider on login.
  - `alertType` string — Alert type configuration for this provider link.
  - `rule` string — Custom rule applied to this provider link.

## Other responses

- `400`
- `404`
- `409`
- `500`

---

[API](https://skmtc.net/lerian/apis/identity-plugin.md) · [All operations](https://skmtc.net/lerian/apis/identity-plugin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lerian/identity-plugin/versions/25daba385532/schema)
