組織設定を取得

My Organization API の構成を取得します。返されるのは connection_deletion_behavior と allowed_strategies のみです。user_attribute_profile_id や connection_profile_id などの識別子属性は含まれません。この情報は頻繁に変更されないため、キャッシュしてください。

GET /config

My Organization APIの設定を取得する

cURL

curl --request GET \
  --url https://{tenantDomain}/my-org/v1/config \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/my-org/v1/config"

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

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

print(response.text)

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

fetch('https://{tenantDomain}/my-org/v1/config', 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}/my-org/v1/config",
  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}/my-org/v1/config"

	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}/my-org/v1/config")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/config")

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

{
  "allowed_strategies": [
    "adfs",
    "pingfederate"
  ],
  "connection_deletion_behavior": "allow"
}

{
  "detail": "No auth token provided.",
  "status": 401,
  "title": "Missing Token",
  "type": "https://auth0.com/api-errors#A0E-401-0002"
}

{
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint.",
  "status": 403,
  "title": "Insufficient Scope",
  "type": "https://auth0.com/api-errors#A0E-403-0002"
}

{
  "detail": "The organization does not exist.",
  "status": 404,
  "title": "Resource Not Found",
  "type": "https://auth0.com/api-errors#A0E-404-0002"
}

{
  "detail": "The endpoint request limit has been exceeded.",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "type": "https://auth0.com/api-errors#A0E-429-0003"
}

承認

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · 必須

The access token received from the authorization server in the OAuth 2.0 flow.

レスポンス

200

application/json

設定が正常に取得されました。

allowed_strategies · enum<string>[]

サポート対象のストラテジーの配列

IDプロバイダーの種類

利用可能なオプション: adfs, google-apps, oidc, okta, pingfederate, samlp, waad

connection_deletion_behavior · enum<string>

接続の削除を常に許可するか、その接続に関連付けられたユーザーが存在しない場合にのみ許可するかを指定します

利用可能なオプション: allow, allow_if_empty