Get User Attribute Profile Template

Retrieve a User Attribute Profile Template.

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

Get User Attribute Profile Template

cURL

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

import requests

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

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/templates/{id}', 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/templates/{id}",
  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/templates/{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))

}

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

require 'uri'
require 'net/http'

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

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

{
  "id": "<string>",
  "display_name": "<string>",
  "template": {
    "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-template to retrieve.

レスポンス

200

application/json

User Attribute Profile Template successfully retrieved.

id · string

The id of the template.

display_name · string

The user-friendly name of the template displayed in the UI.

template · object

The structure of the template, which can be used as the payload for creating or updating a User Attribute Profile.

Show child attributes