Get User Attribute Profile

Retrieve details about a single User Attribute Profile specified by ID.

GET 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.GetAsync(
            "id"
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.userAttributeProfiles().get("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;

$client = new Management(
    token: '<token>',
);
$client->userAttributeProfiles->get(
    'id',
);

from auth0.management import ManagementClient

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

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

require "auth0"

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

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

curl --request GET \
  --url https://{tenantDomain}/api/v2/user-attribute-profiles/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string · 必須

ID of the user-attribute-profile to retrieve.

レスポンス

200

application/json

Record for existing user attribute profile.

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