Update enabled clients for a connection

PATCH https://{tenantDomain}/api/v2/connections/{id}/clients

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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>",
        ),
    )
    request := []*management.UpdateEnabledClientConnectionsRequestContentItem{
        &management.UpdateEnabledClientConnectionsRequestContentItem{
            ClientId: "client_id",
            Status: true,
        },
    }
    client.Connections.Clients.Update(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.connections.clients.update("id", [
        {
            clientId: "client_id",
            status: true,
        },
    ]);
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.connections.clients.update("id", [
        {
            clientId: "client_id",
            status: true,
        },
    ]);
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/connections/{id}/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "client_id": "<string>",
    "status": true
  }
]
'

import requests

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

payload = [
    {
        "client_id": "<string>",
        "status": True
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/connections/{id}/clients",
  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([
    [
        'client_id' => '<string>',
        'status' => 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;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/connections/{id}/clients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"client_id\": \"<string>\",\n    \"status\": true\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

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

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  {\n    \"client_id\": \"<string>\",\n    \"status\": true\n  }\n]"

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

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

The id of the connection to modify

Corps

application/jsonapplication/x-www-form-urlencoded

Minimum array length: 1

client_id · string<client-id> · requis

The client_id of the client whose status will be changed. Note that the limit per PATCH request is 50 clients.

status · boolean · requis

Whether the connection is enabled or not for this client_id

Réponse

204

Success