認証
ユーザー管理
カスタマイズ
プラットフォームC#
using Auth0.ManagementApi;
using System.Threading.Tasks;
public partial class Examples
{
public async Task Example() {
var client = new ManagementApiClient(
token: "<token>",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.Connections.UpdateAsync(
id: "id",
request: new UpdateConnectionRequestContent()
);
}
}package example
import (
context "context"
management "github.com/auth0/go-auth0/v3/management"
client "github.com/auth0/go-auth0/v3/management/client"
option "github.com/auth0/go-auth0/v3/management/option"
)
func do() {
mgmt, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &management.UpdateConnectionRequestContent{}
mgmt.Connections.Update(
context.TODO(),
"id",
request,
)
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateConnectionRequestContent;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.connections().update(
"id",
UpdateConnectionRequestContent
.builder()
.build()
);
}
}<?php
namespace Example;
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Connections\Requests\UpdateConnectionRequestContent;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->connections->update(
'id',
new UpdateConnectionRequestContent([]),
);
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.connections.update(
id="id",
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.connections.update(id: "id")
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.connections.update("id", {});
}
main();
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.connections.update("id", {});
}
main();
curl --request PATCH \
--url https://{tenantDomain}/api/v2/connections/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cross_app_access_resource_app": {},
"display_name": "<string>",
"enabled_clients": [
"<string>"
],
"is_domain_connection": true,
"metadata": {},
"options": {
"api_enable_groups": true,
"api_enable_users": true,
"attributes": {
"email": {
"identifier": {
"active": true
},
"profile_required": true,
"signup": {
"verification": {
"active": true
}
},
"unique": true
},
"phone_number": {
"identifier": {
"active": true
},
"profile_required": true,
"signup": {
"verification": {
"active": true
}
}
},
"username": {
"identifier": {
"active": true
},
"profile_required": true,
"signup": {},
"validation": {
"allowed_types": {
"email": true,
"phone_number": true
},
"max_length": 64.5,
"min_length": 64.5
}
}
},
"authentication_methods": {
"email_otp": {
"enabled": true
},
"passkey": {
"enabled": true
},
"password": {
"enabled": true
},
"phone_otp": {
"enabled": true
}
},
"basic_profile": true,
"configuration": {},
"customScripts": {
"change_email": "<string>",
"change_password": "<string>",
"change_phone_number": "<string>",
"change_username": "<string>",
"create": "<string>",
"delete": "<string>",
"get_user": "<string>",
"login": "<string>",
"verify": "<string>"
},
"disable_self_service_change_password": true,
"discovery_url": "<string>",
"enable_script_context": true,
"enabledDatabaseCustomization": true,
"ext_admin": true,
"ext_agreed_terms": true,
"ext_assigned_plans": true,
"ext_groups": true,
"ext_is_suspended": true,
"ext_profile": true,
"gateway_authentication": {
"audience": "<string>",
"method": "<string>",
"secret": "<string>",
"secret_base64_encoded": true,
"subject": "<string>"
},
"id_token_session_expiry_supported": true,
"id_token_signed_response_algs": [],
"import_mode": true,
"non_persistent_attrs": [
"<string>"
],
"oidc_metadata": {
"acr_values_supported": [
"<string>"
],
"authorization_endpoint": "<string>",
"claim_types_supported": [
"<string>"
],
"claims_locales_supported": [
"<string>"
],
"claims_parameter_supported": true,
"claims_supported": [
"<string>"
],
"display_values_supported": [
"<string>"
],
"dpop_signing_alg_values_supported": [
"<string>"
],
"end_session_endpoint": "<string>",
"grant_types_supported": [
"<string>"
],
"id_token_encryption_alg_values_supported": [
"<string>"
],
"id_token_encryption_enc_values_supported": [
"<string>"
],
"id_token_signing_alg_values_supported": [
"<string>"
],
"issuer": "<string>",
"jwks_uri": "<string>",
"op_policy_uri": "<string>",
"op_tos_uri": "<string>",
"registration_endpoint": "<string>",
"request_object_encryption_alg_values_supported": [
"<string>"
],
"request_object_encryption_enc_values_supported": [
"<string>"
],
"request_object_signing_alg_values_supported": [
"<string>"
],
"request_parameter_supported": true,
"request_uri_parameter_supported": true,
"require_request_uri_registration": true,
"response_modes_supported": [
"<string>"
],
"response_types_supported": [
"<string>"
],
"scopes_supported": [
"<string>"
],
"service_documentation": "<string>",
"subject_types_supported": [
"<string>"
],
"token_endpoint": "<string>",
"token_endpoint_auth_methods_supported": [
"<string>"
],
"token_endpoint_auth_signing_alg_values_supported": [
"<string>"
],
"ui_locales_supported": [
"<string>"
],
"userinfo_encryption_alg_values_supported": [
"<string>"
],
"userinfo_encryption_enc_values_supported": [
"<string>"
],
"userinfo_endpoint": "<string>",
"userinfo_signing_alg_values_supported": [
"<string>"
]
},
"passkey_options": {
"local_enrollment_enabled": true,
"progressive_enrollment_enabled": true
},
"password_complexity_options": {
"min_length": 64
},
"password_dictionary": {
"enable": true,
"dictionary": [
"<string>"
]
},
"password_history": {
"enable": true,
"size": 12
},
"password_no_personal_info": {
"enable": true
},
"password_options": {
"complexity": {
"character_types": [],
"min_length": 36
},
"dictionary": {
"active": true,
"custom": [
"<string>"
]
},
"history": {
"active": true,
"size": 12
},
"profile_data": {
"active": true,
"blocked_fields": [
"<string>"
]
}
},
"precedence": [],
"set_user_root_attributes": "on_each_login",
"upstream_params": {},
"validation": {
"username": {
"max": 123,
"min": 2
}
}
},
"realms": [
"<string>"
],
"show_as_button": true
}
'{
"authentication": {
"active": true
},
"connected_accounts": {
"active": true,
"allow_missing_user_id": true,
"cross_app_access": true
},
"cross_app_access_requesting_app": {
"active": true
},
"cross_app_access_resource_app": {},
"display_name": "<string>",
"enabled_clients": [
"<string>"
],
"id": "con_0000000000000001",
"is_domain_connection": true,
"metadata": {},
"name": "My connection",
"options": {},
"realms": [
"<string>"
],
"show_as_button": true,
"strategy": "auth0"
}IDで接続を更新
特定の接続の詳細を更新します。これには、アイデンティティプロバイダーの構成用オプションのプロパティも含まれます。
注: options パラメーターを使用すると、options オブジェクト全体が上書きされます。データの欠落やその他の問題を避けるため、このオプションを使用する際は、すべてのパラメーターが含まれていることを確認してください。
PATCH
https://{tenantDomain}/api/v2
/
connections
/
{id}
C#
using Auth0.ManagementApi;
using System.Threading.Tasks;
public partial class Examples
{
public async Task Example() {
var client = new ManagementApiClient(
token: "<token>",
clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
);
await client.Connections.UpdateAsync(
id: "id",
request: new UpdateConnectionRequestContent()
);
}
}package example
import (
context "context"
management "github.com/auth0/go-auth0/v3/management"
client "github.com/auth0/go-auth0/v3/management/client"
option "github.com/auth0/go-auth0/v3/management/option"
)
func do() {
mgmt, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &management.UpdateConnectionRequestContent{}
mgmt.Connections.Update(
context.TODO(),
"id",
request,
)
}
package com.example.usage;
import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateConnectionRequestContent;
public class Example {
public static void main(String[] args) {
ManagementApi client = ManagementApi
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.connections().update(
"id",
UpdateConnectionRequestContent
.builder()
.build()
);
}
}<?php
namespace Example;
use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Connections\Requests\UpdateConnectionRequestContent;
$client = new ManagementClient(new ManagementClientOptions(
domain: '{YOUR_DOMAIN}',
token: '<token>',
));
$client->connections->update(
'id',
new UpdateConnectionRequestContent([]),
);
from auth0.management import ManagementClient
client = ManagementClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.connections.update(
id="id",
)
require "auth0"
client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")
client.connections.update(id: "id")
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.connections.update("id", {});
}
main();
import { ManagementClient } from "auth0";
async function main() {
const client = new ManagementClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.connections.update("id", {});
}
main();
curl --request PATCH \
--url https://{tenantDomain}/api/v2/connections/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cross_app_access_resource_app": {},
"display_name": "<string>",
"enabled_clients": [
"<string>"
],
"is_domain_connection": true,
"metadata": {},
"options": {
"api_enable_groups": true,
"api_enable_users": true,
"attributes": {
"email": {
"identifier": {
"active": true
},
"profile_required": true,
"signup": {
"verification": {
"active": true
}
},
"unique": true
},
"phone_number": {
"identifier": {
"active": true
},
"profile_required": true,
"signup": {
"verification": {
"active": true
}
}
},
"username": {
"identifier": {
"active": true
},
"profile_required": true,
"signup": {},
"validation": {
"allowed_types": {
"email": true,
"phone_number": true
},
"max_length": 64.5,
"min_length": 64.5
}
}
},
"authentication_methods": {
"email_otp": {
"enabled": true
},
"passkey": {
"enabled": true
},
"password": {
"enabled": true
},
"phone_otp": {
"enabled": true
}
},
"basic_profile": true,
"configuration": {},
"customScripts": {
"change_email": "<string>",
"change_password": "<string>",
"change_phone_number": "<string>",
"change_username": "<string>",
"create": "<string>",
"delete": "<string>",
"get_user": "<string>",
"login": "<string>",
"verify": "<string>"
},
"disable_self_service_change_password": true,
"discovery_url": "<string>",
"enable_script_context": true,
"enabledDatabaseCustomization": true,
"ext_admin": true,
"ext_agreed_terms": true,
"ext_assigned_plans": true,
"ext_groups": true,
"ext_is_suspended": true,
"ext_profile": true,
"gateway_authentication": {
"audience": "<string>",
"method": "<string>",
"secret": "<string>",
"secret_base64_encoded": true,
"subject": "<string>"
},
"id_token_session_expiry_supported": true,
"id_token_signed_response_algs": [],
"import_mode": true,
"non_persistent_attrs": [
"<string>"
],
"oidc_metadata": {
"acr_values_supported": [
"<string>"
],
"authorization_endpoint": "<string>",
"claim_types_supported": [
"<string>"
],
"claims_locales_supported": [
"<string>"
],
"claims_parameter_supported": true,
"claims_supported": [
"<string>"
],
"display_values_supported": [
"<string>"
],
"dpop_signing_alg_values_supported": [
"<string>"
],
"end_session_endpoint": "<string>",
"grant_types_supported": [
"<string>"
],
"id_token_encryption_alg_values_supported": [
"<string>"
],
"id_token_encryption_enc_values_supported": [
"<string>"
],
"id_token_signing_alg_values_supported": [
"<string>"
],
"issuer": "<string>",
"jwks_uri": "<string>",
"op_policy_uri": "<string>",
"op_tos_uri": "<string>",
"registration_endpoint": "<string>",
"request_object_encryption_alg_values_supported": [
"<string>"
],
"request_object_encryption_enc_values_supported": [
"<string>"
],
"request_object_signing_alg_values_supported": [
"<string>"
],
"request_parameter_supported": true,
"request_uri_parameter_supported": true,
"require_request_uri_registration": true,
"response_modes_supported": [
"<string>"
],
"response_types_supported": [
"<string>"
],
"scopes_supported": [
"<string>"
],
"service_documentation": "<string>",
"subject_types_supported": [
"<string>"
],
"token_endpoint": "<string>",
"token_endpoint_auth_methods_supported": [
"<string>"
],
"token_endpoint_auth_signing_alg_values_supported": [
"<string>"
],
"ui_locales_supported": [
"<string>"
],
"userinfo_encryption_alg_values_supported": [
"<string>"
],
"userinfo_encryption_enc_values_supported": [
"<string>"
],
"userinfo_endpoint": "<string>",
"userinfo_signing_alg_values_supported": [
"<string>"
]
},
"passkey_options": {
"local_enrollment_enabled": true,
"progressive_enrollment_enabled": true
},
"password_complexity_options": {
"min_length": 64
},
"password_dictionary": {
"enable": true,
"dictionary": [
"<string>"
]
},
"password_history": {
"enable": true,
"size": 12
},
"password_no_personal_info": {
"enable": true
},
"password_options": {
"complexity": {
"character_types": [],
"min_length": 36
},
"dictionary": {
"active": true,
"custom": [
"<string>"
]
},
"history": {
"active": true,
"size": 12
},
"profile_data": {
"active": true,
"blocked_fields": [
"<string>"
]
}
},
"precedence": [],
"set_user_root_attributes": "on_each_login",
"upstream_params": {},
"validation": {
"username": {
"max": 123,
"min": 2
}
}
},
"realms": [
"<string>"
],
"show_as_button": true
}
'{
"authentication": {
"active": true
},
"connected_accounts": {
"active": true,
"allow_missing_user_id": true,
"cross_app_access": true
},
"cross_app_access_requesting_app": {
"active": true
},
"cross_app_access_resource_app": {},
"display_name": "<string>",
"enabled_clients": [
"<string>"
],
"id": "con_0000000000000001",
"is_domain_connection": true,
"metadata": {},
"name": "My connection",
"options": {},
"realms": [
"<string>"
],
"show_as_button": true,
"strategy": "auth0"
}承認
bearerAuthoAuth2ClientCredentials
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
パスパラメータ
更新する接続の id
ボディ
application/jsonapplication/x-www-form-urlencoded
ログイン時の認証に使用する接続の目的を設定します。
Show child attributes
Show child attributes
接続済みアカウントおよび Token Vault で使用する接続の用途を設定します。
Show child attributes
Show child attributes
Cross App Access のリクエスト元アプリケーションとして使用する接続を設定します。
Show child attributes
Show child attributes
この接続に適用されるCross App Access - Resource Appの設定。
Show child attributes
Show child attributes
新しい Universal Login エクスペリエンスで使用される接続名です。リクエストに display_name が含まれていない場合、このフィールドは name の値で上書きされます。
Maximum string length:
128非推奨のプロパティです。任意のクライアントに対して接続を有効または無効にするには、PATCH /v2/connections/{id}/clients エンドポイントを使用してください。
接続を有効にする対象クライアントの client_id
true にすると、サードパーティアプリケーションが使用できるよう、ドメインレベルの接続に昇格されます。false の場合、接続は昇格されないため、接続が有効になっているファーストパーティアプリケーションのみが使用できます。（デフォルトは false です。）
接続に関連付けられたメタデータ。文字列値（最大255文字）を持つオブジェクト形式です。メタデータのプロパティは最大10個まで指定できます。
Show child attributes
Show child attributes
この接続のオプション（接続の strategy によって異なります）。これらのオプションを更新するには、update:connections_options scope が必要です。変更内容を確認するには、read:connections_options scope も含めてください。この scope を指定しない場合、更新後のオブジェクトを確認できません。
Show child attributes
Show child attributes
この接続で使用するレルム（例: メールドメイン）を定義します。配列が空、またはこのプロパティが指定されていない場合は、接続名がレルムとして追加されます。
この接続が属するレルム
ログインページにこの接続用のボタンを表示できるようにします（新しいエクスペリエンスのみ）。false の場合は、HRD でのみ使用できます。（デフォルトは false です。）
レスポンス
接続が更新されました。
ログイン時の認証に使用する接続の目的を設定します。
Show child attributes
Show child attributes
接続済みアカウントおよび Token Vault で使用する接続の用途を設定します。
Show child attributes
Show child attributes
Cross App Access のリクエスト元アプリケーションとして使用する接続を設定します。
Show child attributes
Show child attributes
この接続に適用される Cross App Access - Resource App の設定。
Show child attributes
Show child attributes
ログイン画面で使用される接続名
非推奨のプロパティです。接続が有効になっているクライアントの ID を取得するには、GET /connections/:id/clients endpoint を使用してください
クライアント ID
接続の識別子
接続がドメインレベルの場合は true
接続に関連付けられたメタデータ。文字列値（最大255文字）を持つオブジェクト形式です。メタデータのプロパティは最大10個まで指定できます。
Show child attributes
Show child attributes
接続名
レスポンスに options を含めるには、read:connections_options scope が含まれている必要があります
この接続が使用されるレルム（例: メールドメイン）を定義します。array が空、またはこのプロパティが指定されていない場合は、接続名がレルムとして追加されます。
この接続が属するレルム
ログインページにこの接続のボタンを表示するかどうかを指定します（新しいエクスペリエンスのみ）。false の場合は、HRD でのみ使用できます。
アイデンティティプロバイダーに関連付けられた接続の種類
⌘I