Modifier la connexion d’une organisation

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

Mettre à jour une connexion pour une organisation

cURL

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

import requests

url = "https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id}"

payload = {
    "assign_membership_on_login": True,
    "is_enabled": True,
    "is_signup_enabled": True,
    "organization_connection_name": "<string>",
    "show_as_button": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    assign_membership_on_login: true,
    is_enabled: true,
    is_signup_enabled: true,
    organization_connection_name: '<string>',
    show_as_button: true
  })
};

fetch('https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'assign_membership_on_login' => true,
    'is_enabled' => true,
    'is_signup_enabled' => true,
    'organization_connection_name' => '<string>',
    'show_as_button' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id}"

	payload := strings.NewReader("{\n  \"assign_membership_on_login\": true,\n  \"is_enabled\": true,\n  \"is_signup_enabled\": true,\n  \"organization_connection_name\": \"<string>\",\n  \"show_as_button\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assign_membership_on_login\": true,\n  \"is_enabled\": true,\n  \"is_signup_enabled\": true,\n  \"organization_connection_name\": \"<string>\",\n  \"show_as_button\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assign_membership_on_login\": true,\n  \"is_enabled\": true,\n  \"is_signup_enabled\": true,\n  \"organization_connection_name\": \"<string>\",\n  \"show_as_button\": true\n}"

response = http.request(request)
puts response.read_body

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

connection_id · string · requis

Identifiant de la connexion.

Required string length: 1 - 50

Corps

application/jsonapplication/x-www-form-urlencoded

assign_membership_on_login · boolean

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

is_enabled · boolean | null

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 de l’organisation. S’applique uniquement aux connexions de base de données. Par défaut : false.

organization_access_level · enum<string> | null

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

Options disponibles: none, readonly, limited, full, null

organization_connection_name · string | null

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. Par défaut : true.

Réponse

200

application/json

Connexion mise à jour avec succès.

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 une appartenance à l’organisation. Lorsque la valeur est false, les utilisateurs doivent obtenir une 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 de l’organisation. S’applique uniquement aux connexions de base de données. 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. Par défaut : true.