Update enabled clients for a connection

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

C#

C#

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

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

        await client.Connections.Clients.UpdateAsync(
            id: "id",
            request: new List<UpdateEnabledClientConnectionsRequestContentItem>(){
                new UpdateEnabledClientConnectionsRequestContentItem {
                    ClientId = "client_id",
                    Status = true
                },
            }
        );
    }

}

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,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateEnabledClientConnectionsRequestContentItem;
import java.util.Arrays;

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

        client.connections().clients().update(
            "id",
            Arrays.asList(
                UpdateEnabledClientConnectionsRequestContentItem
                    .builder()
                    .clientId("client_id")
                    .status(true)
                    .build()
            )
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Types\UpdateEnabledClientConnectionsRequestContentItem;

$client = new Management(
    token: '<token>',
);
$client->connections->clients->update(
    'id',
    [
        new UpdateEnabledClientConnectionsRequestContentItem([
            'clientId' => 'client_id',
            'status' => true,
        ]),
    ],
);

from auth0.management import ManagementClient, UpdateEnabledClientConnectionsRequestContentItem

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

client.connections.clients.update(
    id="id",
    request=[
        UpdateEnabledClientConnectionsRequestContentItem(
            client_id="client_id",
            status=True,
        )
    ],
)

require "auth0"

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

client.connections.clients.update(
  id: "id",
  request: [{
    client_id: "client_id",
    status: true
  }]
)

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
  }
]
'

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

The id of the connection to modify

Body

application/jsonapplication/x-www-form-urlencoded

Minimum array length: 1

client_id · string<client-id> · required

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

status · boolean · required

Whether the connection is enabled or not for this client_id

Response

204

Success