Establecer el proveedor predeterminado de una aplicación

Utiliza este endpoint para establecer un proveedor como predeterminado para una aplicación. El proveedor predeterminado se utiliza cuando no se solicita un proveedor específico.

PATCH /v1/applications/{id}/providers/{providerId}/default

Establecer el proveedor predeterminado de una aplicación

cURL

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/applications/{id}/providers/{providerId}/default \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "providerId": "019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b",
  "category": "Email",
  "type": "SendGrid",
  "canSignIn": true,
  "canSignUp": true,
  "canUnlink": false,
  "prompted": false
}

Autorizaciones

Authorization · string · header · requerido

El token de autorización en formato 'Bearer '.

Parámetros de ruta

id · string · requerido

Identificador único de la aplicación que deseas consultar.

providerId · string · requerido

Identificador único del proveedor.

Respuesta

200

application/json

Indica que el proveedor se estableció correctamente como predeterminado.

Información sobre un proveedor vinculado a una aplicación.

providerId · string

Identificador único del proveedor vinculado.

category · enum<string>

Categoría del proveedor.

Opciones disponibles: Email, SMS

type · enum<string>

Tipo de implementación del proveedor.

Opciones disponibles: SendGrid, Twilio

canSignIn · boolean

Si los usuarios pueden iniciar sesión utilizando este proveedor.

canSignUp · boolean

Si los nuevos usuarios pueden registrarse utilizando este proveedor.

canUnlink · boolean

Si los usuarios pueden desvincular este proveedor de su cuenta.

prompted · boolean

Si se solicita a los usuarios vincular este proveedor al iniciar sesión.

alertType · string

Configuración del tipo de alerta para este vínculo de proveedor.

rule · string

Regla personalizada aplicada a este vínculo de proveedor.