Passer au contenu principal
GET
https://{tenantDomain}/api/v2
/
organizations
/
{id}
/
connections
/
{connection_id}
Get a specific connection associated with an organization
curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id} \
  --header 'Authorization: Bearer <token>'
{
  "connection_id": "<string>",
  "organization_connection_name": "<string>",
  "assign_membership_on_login": true,
  "show_as_button": true,
  "is_signup_enabled": true,
  "organization_access_level": "none",
  "is_enabled": true,
  "connection": {
    "name": "<string>",
    "strategy": "<string>"
  }
}

Autorisations

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
connection_id
string
requis

Connection identifier.

Required string length: 1 - 50

Réponse

Connection successfully retrieved.

connection_id
string<connection-id>
requis

Connection identifier.

Required string length: 1 - 50
organization_connection_name
string

Name of the connection in the scope of this organization.

Required string length: 1 - 50
Pattern: ^[^]*$
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.

organization_access_level
enum<string>

Access level for the organization (e.g., "none", "full").

Options disponibles:
none,
readonly,
limited,
full
is_enabled
boolean

Whether the connection is enabled for the organization.

connection
object