Obtenir les connexions activées

Récupère les détails d’une connexion précise actuellement activée pour une organisation. Les renseignements renvoyés comprennent notamment l’ID de la connexion, son nom, sa stratégie et si la connexion accorde automatiquement l’adhésion lors de la connexion.

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.EnabledConnections.ListAsync(
            id: "id",
            request: new ListOrganizationConnectionsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true
            }
        );
    }

}

200

[
  {
    "assign_membership_on_login": true,
    "connection": {
      "name": "<string>",
      "strategy": "<string>"
    },
    "connection_id": "<string>",
    "is_signup_enabled": true,
    "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

Index 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

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

Réponse

200

application/json

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

object[]

object

assign_membership_on_login · boolean

Lorsque la valeur est true, tous les utilisateurs qui se connectent avec cette connexion deviennent automatiquement membres de l’organisation. Lorsque la valeur est false, les utilisateurs doivent d’abord se voir accorder l’adhésion à l’organisation avant de se connecter avec cette connexion.

connection · object

Show child attributes

connection_id · string

ID de la connexion.

is_signup_enabled · boolean

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

show_as_button · boolean

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