Get an enabled connection for an organization

Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Organizations.EnabledConnections.GetAsync(
            "id",
            "connectionId"
        );
    }

}

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Organizations.EnabledConnections.Get(
        context.TODO(),
        "id",
        "connectionId",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.organizations().enabledConnections().get("id", "connectionId");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;

$client = new Management(
    token: '<token>',
);
$client->organizations->enabledConnections->get(
    'id',
    'connectionId',
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.organizations.enabled_connections.get(
    id="id",
    connection_id="connectionId",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.organizations.enabled_connections.get(
  id: "id",
  connection_id: "connectionId"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.get("id", "connectionId");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.enabledConnections.get("id", "connectionId");
}
main();

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

200

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

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

Organization identifier.

Maximum string length: 50

connectionId · string · requis

Connection identifier.

Required string length: 1 - 50

Réponse

200

application/json

Connection successfully retrieved.

connection_id · string

ID of the connection.

assign_membership_on_login · boolean

When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection.

show_as_button · boolean

Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true.

is_signup_enabled · boolean

Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.

connection · object

Show child attributes