Modify a user attribute profile

Update the details of a specific User attribute profile, such as name, user_id and user_attributes.

PATCH https://{tenantDomain}/api/v2/user-attribute-profiles/{id}

C#

C#

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

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

        await client.UserAttributeProfiles.UpdateAsync(
            id: "id",
            request: new UpdateUserAttributeProfileRequestContent()
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.userattributeprofiles.requests.UpdateUserAttributeProfileRequestContent;

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

        client.userAttributeProfiles().update(
            "id",
            UpdateUserAttributeProfileRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\UserAttributeProfiles\Requests\UpdateUserAttributeProfileRequestContent;

$client = new Management(
    token: '<token>',
);
$client->userAttributeProfiles->update(
    'id',
    new UpdateUserAttributeProfileRequestContent([]),
);

from auth0.management import ManagementClient

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

client.user_attribute_profiles.update(
    id="id",
)

require "auth0"

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

client.user_attribute_profiles.update(id: "id")

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/user-attribute-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "user_id": {
    "oidc_mapping": "sub",
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "pingfederate": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "ad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      }
    }
  },
  "user_attributes": {}
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    user_id: {
      oidc_mapping: 'sub',
      saml_mapping: ['<string>'],
      scim_mapping: '<string>',
      strategy_overrides: {
        pingfederate: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        ad: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        adfs: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        waad: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        'google-apps': {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        okta: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        oidc: {saml_mapping: ['<string>'], scim_mapping: '<string>'},
        samlp: {saml_mapping: ['<string>'], scim_mapping: '<string>'}
      }
    },
    user_attributes: {}
  })
};

fetch('https://{tenantDomain}/api/v2/user-attribute-profiles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://{tenantDomain}/api/v2/user-attribute-profiles/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"user_id\": {\n    \"oidc_mapping\": \"sub\",\n    \"saml_mapping\": [\n      \"<string>\"\n    ],\n    \"scim_mapping\": \"<string>\",\n    \"strategy_overrides\": {\n      \"pingfederate\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"ad\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"adfs\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"waad\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"google-apps\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"okta\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"oidc\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      },\n      \"samlp\": {\n        \"saml_mapping\": [\n          \"<string>\"\n        ],\n        \"scim_mapping\": \"<string>\"\n      }\n    }\n  },\n  \"user_attributes\": {}\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))

}

200

{
  "id": "<string>",
  "name": "<string>",
  "user_id": {
    "oidc_mapping": "sub",
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "pingfederate": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "ad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      }
    }
  },
  "user_attributes": {}
}

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

ID of the user attribute profile to update.

Body

application/jsonapplication/x-www-form-urlencoded

name · string

The name of the user attribute profile.

Required string length: 1 - 128

user_id · object | null

User ID mapping configuration

Show child attributes

user_attributes · object

User attributes configuration map. Keys are attribute names, values are the mapping configuration for each attribute.

Show child attributes

Response

200

application/json

User attribute profile successfully updated.

id · string<user-attribute-profile-id>

User Attribute Profile identifier.

name · string

The name of the user attribute profile.

Required string length: 1 - 128

user_id · object

User ID mapping configuration

Show child attributes

user_attributes · object

User attributes configuration map. Keys are attribute names, values are the mapping configuration for each attribute.

Show child attributes