Update a connection for an organization

PATCH https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id}

Update a connection for an organization

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_connection_name": "<string>",
  "assign_membership_on_login": true,
  "show_as_button": true,
  "is_signup_enabled": true,
  "organization_access_level": "none",
  "is_enabled": true
}
'

200

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

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

Organization identifier.

Maximum string length: 50

connection_id · string · required

Connection identifier.

Required string length: 1 - 50

Body

application/jsonapplication/x-www-form-urlencoded

organization_connection_name · string | null

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> | null

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

Available options: none, readonly, limited, full, null

is_enabled · boolean | null

Whether the connection is enabled for the organization.

Response

200

application/json

Connection successfully updated.

connection_id · string<connection-id> · required

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").

Available options: none, readonly, limited, full

is_enabled · boolean

Whether the connection is enabled for the organization.

connection · object

Show child attributes