Crear conexión de organización

POST https://{tenantDomain}/api/v2/organizations/{id}/connections

Agregar una conexión a una organización

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "<string>",
  "assign_membership_on_login": true,
  "is_enabled": true,
  "is_signup_enabled": true,
  "organization_connection_name": "<string>",
  "show_as_button": true
}
'

201

{
  "connection_id": "<string>",
  "assign_membership_on_login": true,
  "connection": {
    "name": "<string>",
    "strategy": "<string>"
  },
  "is_enabled": true,
  "is_signup_enabled": true,
  "organization_connection_name": "<string>",
  "show_as_button": true
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

id · string · requerido

Identificador de la organización.

Maximum string length: 50

Cuerpo

application/jsonapplication/x-www-form-urlencoded

connection_id · string<connection-id> · requerido

Identificador de la conexión.

Required string length: 1 - 50

assign_membership_on_login · boolean

Cuando es true, a todos los usuarios que inicien sesión con esta conexión se les otorgará automáticamente membresía en la organización. Cuando es false, se debe otorgar membresía en la organización a los usuarios antes de que inicien sesión con esta conexión.

is_enabled · boolean

Indica si la conexión está habilitada para la organización.

is_signup_enabled · boolean

Determina si se debe habilitar el registro en la organización para esta conexión de la organización. Solo se aplica a las conexiones de base de datos. Valor predeterminado: false.

organization_access_level · enum<string>

Nivel de acceso para la organización (p. ej., "none", "full").

Opciones disponibles: none, readonly, limited, full

organization_connection_name · string

Nombre de la conexión dentro del ámbito de esta organización.

Required string length: 1 - 50

Pattern: ^[^]*$

show_as_button · boolean

Determina si una conexión debe mostrarse en la pantalla de inicio de sesión de esta organización. Solo se aplica a las conexiones empresariales. Valor predeterminado: true.

Respuesta

201

application/json

La conexión se creó correctamente.

connection_id · string<connection-id> · requerido

Identificador de la conexión.

Required string length: 1 - 50

assign_membership_on_login · boolean

Cuando es true, a todos los usuarios que inicien sesión con esta conexión se les otorgará automáticamente membresía en la organización. Cuando es false, se debe otorgar membresía en la organización a los usuarios antes de que inicien sesión con esta conexión.

connection · object

Show child attributes

is_enabled · boolean

Indica si la conexión está habilitada para la organización.

is_signup_enabled · boolean

Determina si se debe habilitar el registro en la organización para esta conexión de la organización. Solo se aplica a las conexiones de base de datos. Valor predeterminado: false.

organization_access_level · enum<string>

Nivel de acceso para la organización (p. ej., "none", "full").

Opciones disponibles: none, readonly, limited, full

organization_connection_name · string

Nombre de la conexión dentro del ámbito de esta organización.

Required string length: 1 - 50

Pattern: ^[^]*$

show_as_button · boolean

Determina si una conexión debe mostrarse en la pantalla de inicio de sesión de esta organización. Solo se aplica a las conexiones empresariales. Valor predeterminado: true.