Get User Attribute Profiles

Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination.

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

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.ListAsync(
            new ListUserAttributeProfileRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

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

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

        client.userAttributeProfiles().list(
            ListUserAttributeProfileRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

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

$client = new Management(
    token: '<token>',
);
$client->userAttributeProfiles->list(
    new ListUserAttributeProfileRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.user_attribute_profiles.list(
    from="from",
    take=1,
)

require "auth0"

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

client.user_attribute_profiles.list(
  from: "from",
  take: 1
)

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

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

fetch('https://{tenantDomain}/api/v2/user-attribute-profiles', 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"

	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

{
  "next": "<string>",
  "user_attribute_profiles": [
    {
      "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.

クエリパラメータ

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 5.

必須範囲: x >= 1

レスポンス

200

application/json

User Attribute Profiles successfully retrieved.

next · string

A cursor to be used as the "from" query parameter for the next page of results.

user_attribute_profiles · object[]

Show child attributes