Skip to main content
POST
/
v1
/
applications
/
{id}
/
providers
Link a Provider to an Application
curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/applications/{id}/providers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "providerId": "019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b",
  "canSignIn": true,
  "canSignUp": true,
  "canUnlink": false,
  "prompted": false
}
'
{
  "providerId": "019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b",
  "category": "Email",
  "type": "SendGrid",
  "canSignIn": true,
  "canSignUp": true,
  "canUnlink": false,
  "prompted": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The authorization token in the 'Bearer ' format.

Path Parameters

​
id
string
required

The unique identifier of the application you want to retrieve.

Body

application/json

Information required to link a provider to an application.

​
providerId
string
required

The unique identifier of the provider to link.

​
canSignIn
boolean
default:false

Whether users can sign in using this provider.

​
canSignUp
boolean
default:false

Whether new users can sign up using this provider.

​
canUnlink
boolean
default:false

Whether users can unlink this provider from their account.

​
prompted
boolean
default:false

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

Indicates that the provider was successfully linked to the application.

Information about a provider linked to an application.

​
providerId
string

Unique identifier of the linked provider.

​
category
enum<string>

Provider category.

Available options:
Email,
SMS
​
type
enum<string>

Provider implementation type.

Available options:
SendGrid,
Twilio
​
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.