Obtenir les connexions d’une organisation

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

Obtenir les connexions associées à une organisation

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
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

Identifiant de l’organisation.

Maximum string length: 50

Paramètres de requête

page · integer

Indice de la page de résultats à renvoyer. La première page est 0.

Plage requise: x >= 0

per_page · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

include_totals · boolean

Renvoyez les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau de résultats direct (false, par défaut).

is_enabled · boolean

Filtrer les connexions selon qu’elles sont activées ou non.

Réponse

200

application/json

Connexions récupérées avec succès.

object[]

object

connection_id · string<connection-id> · requis

Identifiant de la connexion.

Required string length: 1 - 50

assign_membership_on_login · boolean

Lorsque la valeur est true, tous les utilisateurs qui se connectent avec cette connexion se verront automatiquement accorder l’appartenance à l’organisation. Lorsque la valeur est false, les utilisateurs doivent se voir accorder l’appartenance à l’organisation avant de se connecter avec cette connexion.

connection · object

Show child attributes

is_enabled · boolean

Indique si la connexion est activée pour l’organisation.

is_signup_enabled · boolean

Détermine si l’inscription à l’organisation doit être activée pour cette connexion d’organisation. S’applique uniquement aux connexions de base de données. Valeur par défaut : false.

organization_access_level · enum<string>

Niveau d’accès pour l’organisation (p. ex., « none », « full »).

Options disponibles: none, readonly, limited, full

organization_connection_name · string

Nom de la connexion dans le contexte de cette organisation.

Required string length: 1 - 50

Pattern: ^[^]*$

show_as_button · boolean

Détermine si une connexion doit être affichée dans l’invite de connexion de cette organisation. S’applique uniquement aux connexions d’entreprise. Valeur par défaut : true.