Obtener conexiones de una organización

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

Obtener las conexiones asociadas a una organización

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/connections \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "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

Parámetros de consulta

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

include_totals · boolean

Devuelve los resultados dentro de un objeto que contiene el recuento total de resultados (true) o como una matriz de resultados directa (false, valor predeterminado).

is_enabled · boolean

Filtra las conexiones por estado habilitado.

Respuesta

200

application/json

Las conexiones se recuperaron correctamente.

object[]

object

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 la membresía en la organización. Cuando es false, se debe otorgar la 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 organización. Solo se aplica a 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 Login de esta organización. Solo se aplica a conexiones empresariales. Valor predeterminado: true.