Create a SCIM configuration

Create a scim configuration for a connection.

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Connections.ScimConfiguration.CreateAsync(
            id: "id",
            request: new CreateScimConfigurationRequestContent()
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateScimConfigurationRequestContent{}
    mgmt.Connections.ScimConfiguration.Create(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import java.util.Optional;

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

        client.connections().scimConfiguration().create(
            "id",
            Optional.empty()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Types\CreateScimConfigurationRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connections->scimConfiguration->create(
    'id',
    new CreateScimConfigurationRequestContent([]),
);

from auth0.management import ManagementClient, CreateScimConfigurationRequestContent

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.connections.scim_configuration.create(
    id="id",
    request=CreateScimConfigurationRequestContent(),
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.connections.scim_configuration.create(
  id: "id",
  request: {}
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.scimConfiguration.create("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.scimConfiguration.create("id", {});
}
main();

curl --request POST \
  --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>"
    }
  ]
}
'

201

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

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

Body

application/jsonapplication/x-www-form-urlencoded

user_id_attribute · string

User ID attribute for generating unique user ids

mapping · object[]

The mapping between auth0 and SCIM

Show child attributes

Response

201

application/json

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

connection_id · string · required

The connection's identifier

connection_name · string · required

The connection's name

strategy · string · required

The connection's strategy

tenant_name · string · required

The tenant's name

user_id_attribute · string · required

User ID attribute for generating unique user ids

mapping · object[] · required

The mapping between auth0 and SCIM

Show child attributes

created_at · string<date-time> · required

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

updated_on · string<date-time> · required

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