Get User Attribute Profiles

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

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

Get User Attribute Profiles

cURL

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/user-attribute-profiles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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))

}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/user-attribute-profiles")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/user-attribute-profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_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