Patch a connection's SCIM configuration

Update a scim configuration by its connectionId.

PATCH https://{tenantDomain}/api/v2/connections/{id}/scim-configuration

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    connections "github.com/auth0/go-auth0/management/management/connections"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &connections.UpdateScimConfigurationRequestContent{
        UserIdAttribute: "user_id_attribute",
        Mapping: []*management.ScimMappingItem{
            &management.ScimMappingItem{},
        },
    }
    client.Connections.ScimConfiguration.Update(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.connections.scimConfiguration.update("id", {
        userIdAttribute: "user_id_attribute",
        mapping: [
            {},
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.connections.scimConfiguration.update("id", {
        userIdAttribute: "user_id_attribute",
        mapping: [
            {},
        ],
    });
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/connections/{id}/scim-configuration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id_attribute": "<string>",
  "mapping": [
    {
      "auth0": "<string>",
      "scim": "<string>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/connections/{id}/scim-configuration"

payload = {
    "user_id_attribute": "<string>",
    "mapping": [
        {
            "auth0": "<string>",
            "scim": "<string>"
        }
    ]
}
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}/scim-configuration",
  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([
    'user_id_attribute' => '<string>',
    'mapping' => [
        [
                'auth0' => '<string>',
                'scim' => '<string>'
        ]
    ]
  ]),
  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}/scim-configuration")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id_attribute\": \"<string>\",\n  \"mapping\": [\n    {\n      \"auth0\": \"<string>\",\n      \"scim\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"user_id_attribute\": \"<string>\",\n  \"mapping\": [\n    {\n      \"auth0\": \"<string>\",\n      \"scim\": \"<string>\"\n    }\n  ]\n}"

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

200

{
  "connection_id": "<string>",
  "connection_name": "<string>",
  "strategy": "<string>",
  "tenant_name": "<string>",
  "user_id_attribute": "<string>",
  "mapping": [
    {
      "auth0": "<string>",
      "scim": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_on": "2023-11-07T05:31:56Z"
}

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 update its SCIM configuration

Corps

application/jsonapplication/x-www-form-urlencoded

user_id_attribute · string · requis

User ID attribute for generating unique user ids

mapping · object[] · requis

The mapping between auth0 and SCIM

Show child attributes

Réponse

200

application/json

The connection's SCIM configuration was updated. See Response Schemas for schema.

connection_id · string · requis

The connection's identifier

connection_name · string · requis

The connection's name

strategy · string · requis

The connection's strategy

tenant_name · string · requis

The tenant's name

user_id_attribute · string · requis

User ID attribute for generating unique user ids

mapping · object[] · requis

The mapping between auth0 and SCIM

Show child attributes

created_at · string<date-time> · requis

The ISO 8601 date and time the SCIM configuration was created at

updated_on · string<date-time> · requis

The ISO 8601 date and time the SCIM configuration was last updated on