View Source Auth0 Management API v2 仕様差分一覧(AUTH0-00001)

改訂履歴

  • 第 2 版(調査レビュー第 1 回の差し戻しへの対応): 仕様・比較対象は第 1 版と同じ(SHA-256 同一)。変更点は次のとおり。
    1. 指摘 1: beta の件数を仕様どおり 24 件(Experimentation 23・GET /clients/search 1)に直し、advance-ramp(A-078、EA)の対象外理由を事実に基づく理由に書き換えた。Experimentation の各行から「製品全体がベータ」という仕様にない記述を削除した。EA 50 件の内訳を「対応方針の要点」と「検算」に明記した。
    2. 指摘 2: 新節「パラメータの扱い(計画 手順3-4)」を追加した。一致した操作のうち公開関数がある 285 操作について、クエリパラメータを操作ごとに全件(59 操作・221 個)、ボディのプロパティを操作ごとの件数(110 操作・663 個)で列挙し、「@doc 記載のみ」と「実装変更が必要」を分けた。この過程で、配列型のクエリ(6 操作)は複数値を送ると例外になることがわかったため、「追加」区分に A-192〜A-197 の 6 件を追加した(既存 ID を変えないよう末尾に置いた)。
    3. 指摘 3: Hooks / Rules(D-012〜D-025)の備考を、既存の @deprecated の実際の効き方(ファサードの list/2 にだけ付いている)に合わせて直した。
    4. 参考指摘 1: A-121(GET /guardian/factors/sms/providers/twilio)の description を再確認し、移行先の利用を明示的に求めていたため、対応方法を「手順5」から「対象外」に変えた(区分は「追加」のまま。理由は A-121 の行)。
    5. 参考指摘 2: D-028〜D-031 の注記先に get_connection・get_connections を含めた(理由は各行)。
  • 件数の変化: 追加 191 → 197(+6)、変更 16、非推奨・廃止 32、合計 239 → 245。対象外 31 → 32(A-121)。
  • 実装ノード(AUTH0-00001-06)による追記: 「追加」区分のうち実装した 153 項目(A-001〜A-005、A-017〜A-191 の手順5)の「対応する関数名」欄に、追加した Auth0.Api.Management の関数名を記入した。A-006〜A-016・A-192〜A-197 は既存の関数名のまま(新しいアリティ/オプション、Util.convert_to_query/1 の修正で対応)。仕様・件数・区分は変えていない。

基準とした仕様と比較対象

項目値
取得元 URLhttps://auth0.com/docs/oas/management/v2/management-api-oas.json
取得元の特定方法計画 手順2 の第一候補。公式リファレンス https://auth0.com/docs/api/management/v2 の HTML 内のナビゲーション定義(各ページの "openapi":"docs/oas/management/v2/management-api-oas.json GET /actions/actions" など)から仕様ファイルの URL を特定した。第二・第三候補は試していない(第一候補が採用基準を満たしたため)。
取得日時2026-09-24T10:07:46Z(JST 2026-09-24 19:07:46)。HTTP 応答の Date: Thu, 24 Sep 2026 10:07:47 GMT
サーバー側の Last-Modified / ETagWed, 23 Sep 2026 18:29:09 GMT / W/"xCHem21t1ickpSGm"
SHA-256df97a3b355e7519208a68d8ea7dc12041c98115a7f058449bda5d60d9d3cb3e9
サイズ6,500,789 バイト
形式・info.versionOpenAPI 3.1.0 / info.title "Auth0 Management API" / info.version "2.0"
servershttps://{tenantDomain}/api/v2
規模paths 258 件 / 操作(メソッド×パス)478 件
採用基準の判定openapi キーと paths を持つ JSON: 満たす。servers が /api/v2: 満たす。操作数 478 ≥ 現行実装のエンドポイント 302 種: 満たす。
仕様の保存先docs/management_api_openapi.json(作業ツリーに未追跡ファイルとして配置済み。SHA-256 同一)。以降の作業はこの時点の仕様に固定する。
比較対象(起点コミット)eef013e5df0dc0dd7f71c5ecf55df0e12e246c02(fix: security hardening for 2.4.0。ブランチ fix/auth0-00002-security-review)。git branch --contains eef013e はこのブランチのみで main に未マージ。計画 1-1 のとおり、実装ノードはこのコミットを起点に feature/auth0-00001-management-api-sync を作る。
現行実装の規模エンドポイントモジュール 308 個(lib/auth0/management/**、@endpoint 1 個ずつ)、ファサード 44 個、Auth0.Api.Management の公開関数 299 個

抽出と突き合わせの方法

  • 仕様側: paths の全操作について、operationId・deprecated・x-release-lifecycle・パラメータ(path/query/header、deprecated 含む)・リクエストボディのプロパティ・成功時(2xx)のステータスとレスポンス本文の有無を抽出した。非推奨は deprecated: true(8 件)と x-release-lifecycle: deprecated(43 件、前者 8 件を含む)を仕様全体(components 含む)から走査し、さらに操作・パラメータの description に「deprecated」とある箇所を全文検索した。操作レベルで deprecated: true の操作は 0 件で、操作の非推奨は description での明記のみ(Guardian の sms 系 5 操作)だった。
  • 実装側: 各エンドポイントモジュールの @endpoint・Http.get/post/patch/put/delete/multipart_post の呼び出し・{:ok, NNN, …} のマッチ・Util.convert_to_query/1 の有無・ボディ送信の有無を抽出し、ファサードの …execute( 呼び出しと Auth0.Api.Management の公開関数の呼び出しを alias 解決してたどり、公開関数 → ファサード → エンドポイントモジュールを対応づけた(299 関数すべてがちょうど 1 モジュールに対応)。
  • 突き合わせ: パスのパラメータ名を {} に正規化し (メソッド, パス) で照合した。一致した 290 操作については、成功ステータス、送れないクエリ/ヘッダ、仕様上本文がない成功レスポンスをデコードしていないかを機械的に確認した(DELETE のボディは Http.delete/3 で送れるため差分ではない)。
  • スクリプトはスクラッチ領域に置き、リポジトリには含めていない。
  • 区分の定義は計画 手順3-3 のとおり。「変更」には、パス・メソッド・成功ステータスの食い違いに加えて、仕様上本文のない成功レスポンスを Jason.decode! して例外になるものを含めた(成功時の扱いが仕様と食い違い、利用者の実行時エラーになるため。計画の区分「成功時のステータスコード({:ok, 200, body} などのマッチ)」の延長として扱う)。
  • 汎用 map で送れるクエリ/ボディのパラメータ(計画 手順3-4 の「対応済み(汎用 map で送信可)」)は差分項目に数えず、別節「パラメータの扱い(計画 手順3-4)」に操作ごとに列挙した。一致した 290 操作のうち、パラメータ面で実装変更が要るのは「追加」の 17 件(送れないクエリ 2 件・ヘッダ 9 件・配列クエリの複数値 6 件)である。
  • 操作の非推奨の確認では、description の「deprecated」に加えて「please use」「use it instead」「new endpoint is available」「legacy」「no longer supported」「will be removed」「superseded」も全操作で検索した(第 2 版で拡張)。新たに該当したのは 3 操作で、GET /guardian/factors/sms/providers/twilio は移行先の利用を求める記述(A-121 を対象外に変更)、PATCH /custom-domains/{id} の「The compatible TLS policy is no longer supported」と GET /email-templates/{templateName} の「supported for legacy scenarios」は値についての説明で、操作やパラメータの非推奨ではない。

件数と検算

区分件数内訳(対応手順)
追加197対象外: 27、手順5: 148、手順5(パラメータ追加): 17、手順5(公開 API の関数のみ追加): 5
変更16手順6: 16
非推奨・廃止32対象外: 5、手順7: 20、手順7(パラメータのみ・@doc 注記): 7
合計245対象外 32 件を含む

検算(スクリプトで確認済み):

  1. 区分の合計: 追加 197 + 変更 16 + 非推奨・廃止 32 = 245 件で、差分項目の総数と一致。各項目は区分 1 つ・対応手順 1 つ(手順5 / 手順6 / 手順7 / 対象外)だけを持つ。
  2. 仕様側の全件照合: 仕様の操作 478 件 = 差分なし 260 件 + 差分項目に載る操作 218 件(追加のエンドポイント 175 + 公開関数のみ欠落 5 + 送れないパラメータ 17(ヘッダ 9・クエリ 2・配列クエリの複数値 6) + 変更 16 + 仕様上非推奨の操作 5)。1 つの操作が 2 つの項目に重複して載ることはない。
  3. 実装側の全件照合: エンドポイントモジュール 308 個 = 差分項目に載るモジュール 56 個 + 差分なしで仕様と一致 248 個 + 重複・未使用 4 個(下の「参考所見」1・2)。公開関数 299 個 = 差分なしのモジュールの関数 248 個 + 差分項目に載るモジュールの関数 51 個(差分項目のうち 5 モジュールは公開関数がない)。仕様にない実装(パス正規化で不一致)12 モジュールは、変更 6(Verifiable Credentials 5・Sessions.Revoke 1)と非推奨・廃止 6(Blacklists 2・Risk Assessments 2・Supplemental Signals 2)に振り分けた。
  4. 仕様の非推奨フラグとの一致: 仕様内の非推奨の印 43 箇所(x-release-lifecycle: deprecated。deprecated: true の 8 箇所はこれに含まれる)は、すべて「非推奨・廃止」区分のパラメータ項目 6 件(D-026〜D-031)のどれか 1 つだけに割り当てた(未割り当て 0・重複 0)。description で非推奨と明記された操作 5 件と GET /logs の include_totals(D-032)も「非推奨・廃止」区分に入れた。逆に、仕様にフラグがないのに「非推奨・廃止」に入れた項目は 2 種類で、理由は次のとおり。
    • Hooks 9 関数・Rules 5 関数(14 件): Auth0 が Rules / Hooks の EOL を告知済みで、本ライブラリも README・CHANGELOG で非推奨を告知済み(ただしコード上の @deprecated はファサードの list/2 にしか効いていない。D-012〜D-025 の備考を参照)。計画 手順7-2 の方針どおり。
    • 仕様に存在しないエンドポイント 6 件(Blacklists・Risk Assessments・Supplemental Signals): 計画 手順3-3 の「仕様から消えているのに実装に残っているエンドポイント」に当たる。
  5. lifecycle の内訳: 仕様の操作 478 件の x-release-lifecycle は GA 397・EA 50・beta 24・記載なし 7。
    • beta 24 件 = Experimentation 23 + GET /clients/search 1。すべて「追加」区分・対象外。
    • EA 50 件 = 実装済みで差分なし 5 + 「追加」区分・手順5(追加対象)44 + 「追加」区分・対象外 1(A-078 advance-ramp)。
    • Experimentation の 24 操作 = beta 23 + EA 1(A-078)。
  6. 対象外の内訳: 対象外 32 件 = beta 24 + Experimentation の EA 1(A-078)+ SSE の GET /events 1(A-072)+ 移行先の利用を求められている GET /guardian/factors/sms/providers/twilio 1(A-121)+ 仕様上非推奨で未実装の Guardian sms 系 5(D-001〜D-005)。

対応方針の要点

  • 変更(16 件、手順6): C-016 を除き、どれも現状は実行時に失敗する(誤ったパス・メソッドで 404 など、または空本文のデコードで例外)ため、正しい挙動に直しても後方互換の問題は生じない。C-016(delete_organization_invitation)だけは現状でも成功時に {:ok, 204, ""} を返しており、{:ok, ""} に直すと戻り値の形が変わる。@spec と他の DELETE 系関数に合わせる不具合修正として扱い、CHANGELOG に明記する。C-016 以外は、公開関数の名前・アリティ・戻り値の形({:ok, map} / {:ok, ""} など)を変えない。修正前に現状を固定する Bypass テストを書く(計画 手順6)。
  • Verifiable Credentials(C の 5 件): 2.3.0(コミット 51ead16)で追加された 5 関数は、仕様に存在しない /api/v2/verifiable-credentials に送っている。仕様上の対応先は /api/v2/verifiable-credentials/verification/templates(CRUD 5 操作)で、1 対 1 に対応するため「変更(パス修正)」とした。関数名(get_verifiable_credentials など)は残し、@doc に「検証テンプレート(verification templates)を扱う」ことを書く。
  • Risk Assessments / Supplemental Signals(D の 4 件+A の 7 件): 2.3.0 で追加された 4 関数は仕様に存在しないエンドポイントに送っており、仕様上の操作(設定の取得・更新など)とは意味が 1 対 1 に対応しない。このため既存 4 関数は「非推奨・廃止」(@deprecated と移行先の案内、削除はしない)、仕様上の操作は「追加」とした。
  • Blacklists(D の 2 件): 仕様・公式ドキュメントから消えている。@deprecated を付け、削除は次のメジャーバージョンで行う。
  • 対象外(32 件): beta 24 件(Experimentation 23・GET /clients/search 1)、Experimentation の EA 1 件(A-078。前提となる experiments の操作がすべて beta で対象外のため単独では使えない)、SSE の GET /events 1 件、description で移行先の利用を求められている GET /guardian/factors/sms/providers/twilio 1 件(A-121)、仕様上非推奨で未実装の Guardian sms 系 5 件。理由は各行に書いた。
  • Early Access(EA): 仕様の EA 50 件 = 実装済み 5 + 追加対象 44 + 対象外 1(A-078)。追加対象の 44 件は、既存実装が EA のエンドポイント(User Attribute Profiles など)をすでに扱っている前例に合わせて対象に含め、@doc に EA であることを書く。
  • 配列クエリの複数値(A-192〜A-197、手順5): Util.convert_to_query/1 のリスト値の扱い 1 か所を直せば 6 件とも解消する。現状は例外になる入力だけが変わるため後方互換の問題はない。修正はクエリを送る全関数に効くので、Bypass テストでリスト値(複数値)と既存のスカラー値の両方を確認する。
  • パラメータの @doc 記載: 別節「パラメータの扱い(計画 手順3-4)」の方針に従う(クエリは全件を @doc に列挙、ボディは EA・beta のプロパティのみ名前を記載)。

変更(16 件)

IDメソッドパスoperationId区分対応方法対応する関数名備考・対象外理由
C-001PATCH/api/v2/hooks/{id}/secretspatch_secrets変更手順6update_hook_secrets実装は PATCH /api/v2/hooks/{id} に送っている(パス誤り)。/secrets を付けたパスに直す。成功ステータス 201 は仕様と一致。(モジュール Hooks.Secrets.Patch、lifecycle: GA)
C-002POST/api/v2/keys/encryption/rekeypost_encryption_rekey変更手順6rekey_encryption_key実装は POST /api/v2/keys/encryption(鍵の作成)に送っている(パス誤り)。/rekey を付けたパスに直す。成功ステータス 204 は仕様と一致。(モジュール Keys.Encryption.Rekey、lifecycle: GA)
C-003POST/api/v2/sessions/{id}/revokerevoke_session変更手順6revoke_session実装は DELETE で送っている(メソッド誤り)。POST に直す。成功ステータス 202 は仕様と一致。(モジュール Sessions.Revoke、lifecycle: GA)
C-004GET/api/v2/verifiable-credentials/verification/templatesget_vc_templates変更手順6get_verifiable_credentials実装は /api/v2/verifiable-credentials に送っている(仕様に存在しないパス。公式ドキュメントの参照先 URL も 404)。仕様のパス /api/v2/verifiable-credentials/verification/templates に直す。成功ステータス 実装 [200] / 仕様 [200]。(モジュール VerifiableCredentials.List、lifecycle: GA)
C-005POST/api/v2/verifiable-credentials/verification/templatespost_vc_templates変更手順6create_verifiable_credential実装は /api/v2/verifiable-credentials に送っている(仕様に存在しないパス。公式ドキュメントの参照先 URL も 404)。仕様のパス /api/v2/verifiable-credentials/verification/templates に直す。成功ステータス 実装 [201] / 仕様 [201]。(モジュール VerifiableCredentials.Create、lifecycle: GA)
C-006GET/api/v2/verifiable-credentials/verification/templates/{id}get_vc_templates_by_id変更手順6get_verifiable_credential実装は /api/v2/verifiable-credentials/{id} に送っている(仕様に存在しないパス。公式ドキュメントの参照先 URL も 404)。仕様のパス /api/v2/verifiable-credentials/verification/templates/{id} に直す。成功ステータス 実装 [200] / 仕様 [200]。(モジュール VerifiableCredentials.Get、lifecycle: GA)
C-007PATCH/api/v2/verifiable-credentials/verification/templates/{id}patch_vc_templates_by_id変更手順6update_verifiable_credential実装は /api/v2/verifiable-credentials/{id} に送っている(仕様に存在しないパス。公式ドキュメントの参照先 URL も 404)。仕様のパス /api/v2/verifiable-credentials/verification/templates/{id} に直す。成功ステータス 実装 [200] / 仕様 [200]。(モジュール VerifiableCredentials.Patch、lifecycle: GA)
C-008DELETE/api/v2/verifiable-credentials/verification/templates/{id}delete_vc_templates_by_id変更手順6delete_verifiable_credential実装は /api/v2/verifiable-credentials/{id} に送っている(仕様に存在しないパス。公式ドキュメントの参照先 URL も 404)。仕様のパス /api/v2/verifiable-credentials/verification/templates/{id} に直す。成功ステータス 実装 [204] / 仕様 [204]。(モジュール VerifiableCredentials.Delete、lifecycle: GA)
C-009DELETE/api/v2/branding/phone/providers/{id}delete_phone_provider変更手順6delete_branding_phone_provider成功時 204 は仕様上レスポンス本文なし(HTTP 204 は常に本文なし)だが、実装は Jason.decode!(body) しており空文字列で Jason.DecodeError が発生する。他の 204 の関数と同じく {:ok, ""} を返すよう直す(現状は例外なので後方互換の問題なし)。(モジュール Branding.Phone.Providers.Delete、lifecycle: GA)
C-010DELETE/api/v2/branding/phone/templates/{id}delete_phone_template変更手順6delete_branding_phone_template成功時 204 は仕様上レスポンス本文なし(HTTP 204 は常に本文なし)だが、実装は Jason.decode!(body) しており空文字列で Jason.DecodeError が発生する。他の 204 の関数と同じく {:ok, ""} を返すよう直す(現状は例外なので後方互換の問題なし)。(モジュール Branding.Phone.Templates.Delete、lifecycle: GA)
C-011DELETE/api/v2/self-service-profiles/{id}delete_self-service-profiles_by_id変更手順6delete_self_service_profile成功時 204 は仕様上レスポンス本文なし(HTTP 204 は常に本文なし)だが、実装は Jason.decode!(body) しており空文字列で Jason.DecodeError が発生する。他の 204 の関数と同じく {:ok, ""} を返すよう直す(現状は例外なので後方互換の問題なし)。(モジュール SelfServiceProfiles.Delete、lifecycle: GA)
C-012GET/api/v2/connections/{id}/statusget_status変更手順6get_connection_status成功時 200 は仕様上レスポンス本文なしだが、実装は Jason.decode!(body) しており空本文で例外になる。公開関数の @spec は {:ok, boolean} で、同じエンドポイント向けの未使用モジュール Connections.Status.Check(200 → {:ok, true}、404 → {:ok, false})が存在する。ファサードの呼び先を Status.Check に切り替えて @spec に合わせるか、本文が空のときだけ安全に扱うかを実装で決め、理由を書く。(モジュール Connections.Status、lifecycle: GA)なお、未使用だった Connections.Status.Check は AUTH0-00008 で削除した。
C-013POST/api/v2/hooks/{id}/secretspost_secrets変更手順6add_hook_secrets成功時 201 は仕様上レスポンス本文なしだが、実装は Jason.decode!(body) しており本文が空だと例外になる。本文が空のときは {:ok, ""}(または既存の Util.decode_json_or_string!/1 相当)を返し、本文がある場合は従来どおりデコードする(後方互換を保つ)。(モジュール Hooks.Secrets.Add、lifecycle: GA)
C-014POST/api/v2/network-aclspost_network-acls変更手順6create_network_acl成功時 201 は仕様上レスポンス本文なしだが、実装は Jason.decode!(body) しており本文が空だと例外になる。本文が空のときは {:ok, ""}(または既存の Util.decode_json_or_string!/1 相当)を返し、本文がある場合は従来どおりデコードする(後方互換を保つ)。(モジュール NetworkAcls.Create、lifecycle: GA)
C-015PATCH/api/v2/token-exchange-profiles/{id}patch_token-exchange-profiles_by_id変更手順6update_token_exchange_profile成功時 200 は仕様上レスポンス本文なしだが、実装は Jason.decode!(body) しており本文が空だと例外になる。本文が空のときは {:ok, ""}(または既存の Util.decode_json_or_string!/1 相当)を返し、本文がある場合は従来どおりデコードする(後方互換を保つ)。(モジュール TokenExchangeProfiles.Patch、lifecycle: GA)
C-016DELETE/api/v2/organizations/{id}/invitations/{invitation_id}delete_invitations_by_invitation_id変更手順6delete_organization_invitation成功ステータスのマッチが {:ok, 204}(2 要素のタプル)になっており、Http.delete/2 が返す {:ok, 204, body} に一致しない。その結果、成功時に error -> error の枝を通って {:ok, 204, ""} がそのまま返る(@spec の {:ok, …} | {:error, …} の形と異なり、他の DELETE 系 50 関数の {:ok, ""} とも異なる)。{:ok, 204, _body} -> {:ok, ""} に直す。実際の戻り値の形が変わるため、CHANGELOG に不具合修正として明記する。(モジュール Organizations.Invitations.Delete、lifecycle: GA)

非推奨・廃止(32 件)

IDメソッドパスoperationId区分対応方法対応する関数名備考・対象外理由
D-001PUT/api/v2/guardian/factors/sms/providers/twilioput_sms_twilio_factor_provider非推奨・廃止対象外—(未実装)仕様の description に「This endpoint has been deprecated」と明記。現行実装に対応する関数がないため注記の対象がなく、非推奨の操作を新たに追加もしない。移行先 PUT /guardian/factors/phone/providers/twilio は実装済み(update_guardian_twilio_phone_configuration)。
D-002GET/api/v2/guardian/factors/sms/selected-providerget_sms_providers非推奨・廃止対象外—(未実装)仕様の description に「This endpoint has been deprecated」と明記。現行実装に対応する関数がないため注記の対象がなく、非推奨の操作を新たに追加もしない。移行先 GET /guardian/factors/phone/selected-provider は実装済み(get_guardian_phone_configuration)。
D-003PUT/api/v2/guardian/factors/sms/selected-providerput_sms_providers非推奨・廃止対象外—(未実装)仕様の description に「This endpoint has been deprecated」と明記。現行実装に対応する関数がないため注記の対象がなく、非推奨の操作を新たに追加もしない。移行先 PUT /guardian/factors/phone/selected-provider は実装済み(update_guardian_phone_configuration)。
D-004GET/api/v2/guardian/factors/sms/templatesget_factor_sms_templates非推奨・廃止対象外—(未実装)仕様の description に「This endpoint has been deprecated」と明記。現行実装に対応する関数がないため注記の対象がなく、非推奨の操作を新たに追加もしない。移行先 GET /guardian/factors/phone/templates は実装済み(get_guardian_phone_template)。
D-005PUT/api/v2/guardian/factors/sms/templatesput_factor_sms_templates非推奨・廃止対象外—(未実装)仕様の description に「This endpoint has been deprecated」と明記。現行実装に対応する関数がないため注記の対象がなく、非推奨の操作を新たに追加もしない。移行先 PUT /guardian/factors/phone/templates は実装済み(update_guardian_phone_template)。
D-006GET/api/v2/blacklists/tokens—(仕様になし)非推奨・廃止手順7get_blacklisted_tokens仕様から消えている(または存在しない)のに実装に残っているエンドポイント。/blacklists/tokens は仕様から消えており、公式ドキュメントのページ(blacklists/get-tokens)も API リファレンスのトップへリダイレクトされる。移行先は仕様上なし(トークンの失効は POST /api/v2/refresh-tokens/revoke(EA)や POST /api/v2/sessions/{id}/revoke など用途別の API を案内)。
D-007POST/api/v2/blacklists/tokens—(仕様になし)非推奨・廃止手順7blacklist_token仕様から消えている(または存在しない)のに実装に残っているエンドポイント。同上(blacklists/post-tokens)。
D-008POST/api/v2/risk-assessments—(仕様になし)非推奨・廃止手順7create_risk_assessment仕様から消えている(または存在しない)のに実装に残っているエンドポイント。仕様に POST /api/v2/risk-assessments は存在せず、@doc の参照先 URL も 404。仕様にある Risk Assessments は設定系(/risk-assessments/settings・/settings/new-device)と POST /users/{id}/risk-assessments/clear のみで、これらは「追加」区分に入れた。
D-009GET/api/v2/risk-assessments/{id}—(仕様になし)非推奨・廃止手順7get_risk_assessment仕様から消えている(または存在しない)のに実装に残っているエンドポイント。仕様に GET /api/v2/risk-assessments/{id} は存在しない(参照先 URL 404)。移行先の候補は GET /api/v2/risk-assessments/settings(追加区分)。
D-010POST/api/v2/supplemental-signals—(仕様になし)非推奨・廃止手順7create_supplemental_signal仕様から消えている(または存在しない)のに実装に残っているエンドポイント。仕様に POST /api/v2/supplemental-signals は存在しない(参照先 URL 404)。仕様にあるのは GET / PATCH /api/v2/supplemental-signals(設定の取得・更新、EA)で、「追加」区分に入れた。
D-011GET/api/v2/supplemental-signals/{id}—(仕様になし)非推奨・廃止手順7get_supplemental_signal仕様から消えている(または存在しない)のに実装に残っているエンドポイント。仕様に GET /api/v2/supplemental-signals/{id} は存在しない。移行先の候補は GET /api/v2/supplemental-signals(追加区分)。
D-012GET/api/v2/hooksget_hooks非推奨・廃止手順7get_hooks仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-013POST/api/v2/hookspost_hooks非推奨・廃止手順7create_hook仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-014GET/api/v2/hooks/{id}get_hooks_by_id非推奨・廃止手順7get_hook仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-015DELETE/api/v2/hooks/{id}delete_hooks_by_id非推奨・廃止手順7delete_hook仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-016PATCH/api/v2/hooks/{id}patch_hooks_by_id非推奨・廃止手順7update_hook仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-017GET/api/v2/hooks/{id}/secretsget_secrets非推奨・廃止手順7get_hook_secrets仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-018DELETE/api/v2/hooks/{id}/secretsdelete_secrets非推奨・廃止手順7delete_hook_secrets仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-019PATCH/api/v2/hooks/{id}patch_hooks_by_id非推奨・廃止手順7update_hook_secrets仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。 この関数は「変更」区分にも別項目として載っている(修正は変更区分で数え、この項目は非推奨の注記のみ)。
D-020POST/api/v2/hooks/{id}/secretspost_secrets非推奨・廃止手順7add_hook_secrets仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/hooks.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Hooks.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。 この関数は「変更」区分にも別項目として載っている(修正は変更区分で数え、この項目は非推奨の注記のみ)。
D-021GET/api/v2/rulesget_rules非推奨・廃止手順7get_rules仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/rules.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Rules.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-022POST/api/v2/rulespost_rules非推奨・廃止手順7create_rule仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/rules.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Rules.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-023GET/api/v2/rules/{id}get_rules_by_id非推奨・廃止手順7get_rule仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/rules.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Rules.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-024DELETE/api/v2/rules/{id}delete_rules_by_id非推奨・廃止手順7delete_rule仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/rules.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Rules.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-025PATCH/api/v2/rules/{id}patch_rules_by_id非推奨・廃止手順7update_rule仕様上は deprecated フラグなし。Auth0 は Rules / Hooks の提供終了(EOL)を告知しており、本ライブラリも README の Deprecations と CHANGELOG 2.3.0(「Deprecate Rules and Hooks APIs」)で非推奨を告知済み。ただしコード上の @deprecated は lib/auth0/management/rules.ex の 2 行目にあり、Elixir では直後の関数定義(ファサード Auth0.Management.Rules.list/2)にしか付かない。モジュール全体も、この公開関数も、現状はコード上非推奨になっていない。計画 7-2 に従い、ファサードの @deprecated を @moduledoc の注記に移し、この公開関数に @deprecated(移行先 Actions)を付ける。
D-026POST/PATCH/GET/api/v2/connections, /api/v2/connections/{id}post_connections, patch_connections_by_id, get_connections_by_id非推奨・廃止手順7(パラメータのみ・@doc 注記)create_connection, update_connection, get_connectionConnection の enabled_clients プロパティ(リクエスト・レスポンス)が非推奨(x-release-lifecycle: deprecated)。移行先は GET / PATCH /api/v2/connections/{id}/clients(「追加」区分)。(仕様上の該当箇所 5 件)
D-027POST/PATCH/api/v2/clients, /api/v2/clients/{id}post_clients, patch_clients_by_id非推奨・廃止手順7(パラメータのみ・@doc 注記)create_client, update_clientClient の oidc_backchannel_logout が非推奨。移行先は oidc_logout(仕様の description に明記)。(仕様上の該当箇所 2 件)
D-028POST/PATCH/GET/api/v2/connections, /api/v2/connections/{id}post_connections, patch_connections_by_id, get_connections, get_connections_by_id非推奨・廃止手順7(パラメータのみ・@doc 注記)create_connection, update_connection, get_connection, get_connectionsstrategy=facebook の options の 8 項目(allow_context_profile_field, manage_notifications, publish_actions, read_mailbox, read_stream, user_groups, user_managed_groups, user_status)が非推奨(deprecated: true)。Facebook Graph API 側で廃止済みの権限で、移行先なし。(仕様上の該当箇所 8 件) 注記先: 該当の印は strategy 別の CreateConnectionRequestContent*・UpdateConnectionRequestContent*・ConnectionResponseContent* の各 schema にある。ただしこれらはどの操作からも参照されておらず、操作側の options は汎用の ConnectionOptions(additionalProperties: true)である。このため注記先は schema の参照関係ではなく意味で決め、値を送る作成・更新に加えて、既存の接続の options をそのまま返す取得(get_connection)と一覧(get_connections)の @doc にも注記する。
D-029POST/PATCH/GET/api/v2/connections, /api/v2/connections/{id}post_connections, patch_connections_by_id, get_connections, get_connections_by_id非推奨・廃止手順7(パラメータのみ・@doc 注記)create_connection, update_connection, get_connection, get_connectionsstrategy=sms の options の 10 項目(forward_req_info, from, gateway_authentication, gateway_url, messaging_service_sid, provider, syntax, template, twilio_sid, twilio_token)が非推奨(x-release-lifecycle: deprecated)。仕様に移行先の明記なし。(仕様上の該当箇所 10 件) 注記先: 該当の印は strategy 別の CreateConnectionRequestContent*・UpdateConnectionRequestContent*・ConnectionResponseContent* の各 schema にある。ただしこれらはどの操作からも参照されておらず、操作側の options は汎用の ConnectionOptions(additionalProperties: true)である。このため注記先は schema の参照関係ではなく意味で決め、値を送る作成・更新に加えて、既存の接続の options をそのまま返す取得(get_connection)と一覧(get_connections)の @doc にも注記する。
D-030POST/PATCH/GET/api/v2/connections, /api/v2/connections/{id}post_connections, patch_connections_by_id, get_connections, get_connections_by_id非推奨・廃止手順7(パラメータのみ・@doc 注記)create_connection, update_connection, get_connection, get_connectionsSAML 系接続の options.cert(.der 形式の署名証明書)が非推奨(x-release-lifecycle: deprecated)。(仕様上の該当箇所 1 件) 注記先: 該当の印は strategy 別の CreateConnectionRequestContent*・UpdateConnectionRequestContent*・ConnectionResponseContent* の各 schema にある。ただしこれらはどの操作からも参照されておらず、操作側の options は汎用の ConnectionOptions(additionalProperties: true)である。このため注記先は schema の参照関係ではなく意味で決め、値を送る作成・更新に加えて、既存の接続の options をそのまま返す取得(get_connection)と一覧(get_connections)の @doc にも注記する。
D-031POST/PATCH/GET/api/v2/connections, /api/v2/connections/{id}post_connections, patch_connections_by_id, get_connections, get_connections_by_id非推奨・廃止手順7(パラメータのみ・@doc 注記)create_connection, update_connection, get_connection, get_connectionsstrategy が ip / instagram / oauth1 / office365(作成のみ)/ sharepoint / soundcloud / untappd の接続が非推奨(各 schema が x-release-lifecycle: deprecated)。(仕様上の該当箇所 17 件) 注記先: 該当の印は strategy 別の CreateConnectionRequestContent*・UpdateConnectionRequestContent*・ConnectionResponseContent* の各 schema にある。ただしこれらはどの操作からも参照されておらず、操作側の options は汎用の ConnectionOptions(additionalProperties: true)である。このため注記先は schema の参照関係ではなく意味で決め、値を送る作成・更新に加えて、既存の接続の options をそのまま返す取得(get_connection)と一覧(get_connections)の @doc にも注記する。
D-032GET/api/v2/logsget_logs非推奨・廃止手順7(パラメータのみ・@doc 注記)get_log_eventsクエリ include_totals が非推奨(操作の description に「Deprecated: this field is deprecated」と明記。Log Search Engine v3 の破壊的変更による)。パラメータの定義自体にはフラグなし。

追加(197 件)

並びは「公開関数のみ欠落」→「送れないパラメータ」→「エンドポイント(仕様のパス順)」→「配列クエリの複数値(第 2 版で追加。既存 ID を変えないよう末尾に置いた)」。

IDメソッドパスoperationId区分対応方法対応する関数名備考・対象外理由
A-001GET/api/v2/attack-protection/bot-detectionget_bot-detection追加手順5(公開 API の関数のみ追加)get_attack_protection_bot_detectionエンドポイントモジュール AttackProtection.BotDetection.Get とファサードの関数は実装済みだが、Auth0.Api.Management に公開関数がなく利用者から呼べない。公開関数と Bypass テストを追加する。
A-002PATCH/api/v2/attack-protection/bot-detectionpatch_bot-detection追加手順5(公開 API の関数のみ追加)update_attack_protection_bot_detectionエンドポイントモジュール AttackProtection.BotDetection.Patch とファサードの関数は実装済みだが、Auth0.Api.Management に公開関数がなく利用者から呼べない。公開関数と Bypass テストを追加する。
A-003GET/api/v2/prompts/{prompt}/screen/{screen}/renderingget_rendering追加手順5(公開 API の関数のみ追加)get_prompt_renderingエンドポイントモジュール Prompts.Rendering.Get とファサードの関数は実装済みだが、Auth0.Api.Management に公開関数がなく利用者から呼べない。公開関数と Bypass テストを追加する。
A-004PATCH/api/v2/prompts/{prompt}/screen/{screen}/renderingpatch_rendering追加手順5(公開 API の関数のみ追加)update_prompt_renderingエンドポイントモジュール Prompts.Rendering.Patch とファサードの関数は実装済みだが、Auth0.Api.Management に公開関数がなく利用者から呼べない。公開関数と Bypass テストを追加する。
A-005PATCH/api/v2/sessions/{id}patch_sessions_by_id追加手順5(公開 API の関数のみ追加)update_sessionエンドポイントモジュール Sessions.Patch とファサードの関数は実装済みだが、Auth0.Api.Management に公開関数がなく利用者から呼べない。公開関数と Bypass テストを追加する。
A-006POST/api/v2/branding/phone/templates/{id}/trytry_phone_template追加手順5(パラメータ追加)test_branding_phone_templateヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-007GET/api/v2/custom-domainsget_custom-domains追加手順5(パラメータ追加)get_custom_domain_configurations仕様にあるクエリ take,from,q,fields,include_fields,sort を送れない(関数が params を受け取らない)。既存のアリティを残して params を受け取るアリティを追加する。
A-008POST/api/v2/guardian/enrollments/ticketpost_ticket追加手順5(パラメータ追加)create_guardian_enrollment_ticketヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-009POST/api/v2/jobs/verification-emailpost_verification-email追加手順5(パラメータ追加)send_job_verification_emailヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-010POST/api/v2/organizations/{id}/invitationspost_invitations追加手順5(パラメータ追加)create_organization_invitationヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-011POST/api/v2/self-service-profiles/{id}/sso-ticketpost_sso-ticket追加手順5(パラメータ追加)create_self_service_profile_sso_ticketヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-012GET/api/v2/stats/dailyget_daily追加手順5(パラメータ追加)get_daily_stats仕様にあるクエリ from,to を送れない(関数が params を受け取らない)。既存のアリティを残して params を受け取るアリティを追加する。
A-013POST/api/v2/tickets/email-verificationpost_email-verification追加手順5(パラメータ追加)create_email_verification_ticketヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-014POST/api/v2/tickets/password-changepost_password-change追加手順5(パラメータ追加)create_password_change_ticketヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-015POST/api/v2/userspost_users追加手順5(パラメータ追加)create_userヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-016PATCH/api/v2/users/{id}patch_users_by_id追加手順5(パラメータ追加)update_userヘッダ auth0-custom-domain(メール内リンク等に使うカスタムドメインの指定)を送る手段がない。任意指定のヘッダとして送れるよう、既存関数はそのままに新しいアリティ(またはオプション引数)を追加する。
A-017GET/api/v2/actions/modulesget_action_modules追加手順5get_action_moduleslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-018POST/api/v2/actions/modulespost_action_module追加手順5create_action_modulelifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-019GET/api/v2/actions/modules/{id}get_action_module追加手順5get_action_modulelifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-020PATCH/api/v2/actions/modules/{id}patch_action_module追加手順5update_action_modulelifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-021DELETE/api/v2/actions/modules/{id}delete_action_module追加手順5delete_action_modulelifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-022GET/api/v2/actions/modules/{id}/actionsget_action_module_actions追加手順5get_action_module_actionslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-023POST/api/v2/actions/modules/{id}/rollbackpost_action_module_rollback追加手順5rollback_action_modulelifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-024GET/api/v2/actions/modules/{id}/versionsget_action_module_versions追加手順5get_action_module_versionslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-025POST/api/v2/actions/modules/{id}/versionspost_action_module_version追加手順5create_action_module_versionlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-026GET/api/v2/actions/modules/{id}/versions/{versionId}get_action_module_version追加手順5get_action_module_versionlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-027GET/api/v2/agentsget_agents追加手順5get_agentslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-028POST/api/v2/agentspost_agent追加手順5create_agentlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-029GET/api/v2/agents/{id}get_agent追加手順5get_agentlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-030PATCH/api/v2/agents/{id}patch_agent追加手順5update_agentlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-031DELETE/api/v2/agents/{id}delete_agent追加手順5delete_agentlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-032GET/api/v2/attack-protection/captchaget_captcha追加手順5get_attack_protection_captchalifecycle: GA。
A-033PATCH/api/v2/attack-protection/captchapatch_captcha追加手順5update_attack_protection_captchalifecycle: GA。
A-034GET/api/v2/attack-protection/phone-provider-protectionget_phone-provider-protection追加手順5get_attack_protection_phone_provider_protectionlifecycle: GA。
A-035PATCH/api/v2/attack-protection/phone-provider-protectionpatch_phone-provider-protection追加手順5update_attack_protection_phone_provider_protectionlifecycle: GA。
A-036GET/api/v2/client-grants/{id}get_client-grant追加手順5get_client_grantlifecycle: GA。
A-037GET/api/v2/client-grants/{id}/organizationsget_client-grant-organizations追加手順5get_client_grant_organizationslifecycle: GA。
A-038POST/api/v2/clients/cimd/previewpost_clients_cimd_preview追加手順5preview_client_cimd_metadatalifecycle: GA。
A-039POST/api/v2/clients/cimd/registerpost_clients_cimd_register追加手順5register_cimd_clientlifecycle: GA。
A-040GET/api/v2/clients/searchget_clients_search追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-041GET/api/v2/clients/{id}/connectionsget_client_connections追加手順5get_client_connectionslifecycle: GA。
A-042POST/api/v2/connection-profilespost_connection-profiles追加手順5create_connection_profilelifecycle: 操作に記載なし(既存の connection-profiles と同じ扱い)。
A-043GET/api/v2/connection-profiles/templatesget_connection_profile_templates追加手順5get_connection_profile_templateslifecycle: 操作に記載なし(既存の connection-profiles と同じ扱い)。
A-044GET/api/v2/connection-profiles/templates/{id}get_connection_profile_template追加手順5get_connection_profile_templatelifecycle: 操作に記載なし(既存の connection-profiles と同じ扱い)。
A-045DELETE/api/v2/connection-profiles/{id}delete_connection-profiles_by_id追加手順5delete_connection_profilelifecycle: 操作に記載なし(既存の connection-profiles と同じ扱い)。
A-046GET/api/v2/connections-directory-provisioningsget_connections-directory-provisionings追加手順5get_connections_directory_provisioningslifecycle: GA。
A-047GET/api/v2/connections-scim-configurationsget_connections-scim-configurations追加手順5get_connections_scim_configurationslifecycle: GA。
A-048GET/api/v2/connections/{id}/clientsget_connection_clients追加手順5get_connection_clientslifecycle: GA。
A-049PATCH/api/v2/connections/{id}/clientspatch_clients追加手順5update_connection_clientslifecycle: GA。
A-050GET/api/v2/connections/{id}/directory-provisioningget_directory-provisioning追加手順5get_connection_directory_provisioninglifecycle: GA。
A-051POST/api/v2/connections/{id}/directory-provisioningpost_directory-provisioning追加手順5create_connection_directory_provisioninglifecycle: GA。
A-052PATCH/api/v2/connections/{id}/directory-provisioningpatch_directory-provisioning追加手順5update_connection_directory_provisioninglifecycle: GA。
A-053DELETE/api/v2/connections/{id}/directory-provisioningdelete_directory-provisioning追加手順5delete_connection_directory_provisioninglifecycle: GA。
A-054GET/api/v2/connections/{id}/directory-provisioning/default-mappingget_directory_provisioning_default_mapping追加手順5get_connection_directory_provisioning_default_mappinglifecycle: GA。
A-055POST/api/v2/connections/{id}/directory-provisioning/synchronizationspost_synchronizations追加手順5create_connection_directory_provisioning_synchronizationlifecycle: GA。
A-056GET/api/v2/connections/{id}/directory-provisioning/synchronized-groupsget_synchronized-groups追加手順5get_connection_directory_provisioning_synchronized_groupslifecycle: GA。
A-057POST/api/v2/connections/{id}/directory-provisioning/synchronized-groupspost_synchronized-groups追加手順5add_connection_directory_provisioning_synchronized_groupslifecycle: GA。
A-058PUT/api/v2/connections/{id}/directory-provisioning/synchronized-groupsput_synchronized-groups追加手順5set_connection_directory_provisioning_synchronized_groupslifecycle: GA。
A-059DELETE/api/v2/connections/{id}/directory-provisioning/synchronized-groupsdelete_synchronized-groups追加手順5delete_connection_directory_provisioning_synchronized_groupslifecycle: GA。
A-060GET/api/v2/connections/{id}/keysget_keys追加手順5get_connection_keyslifecycle: GA。
A-061POST/api/v2/connections/{id}/keyspost_keys追加手順5create_connection_keyslifecycle: GA。
A-062POST/api/v2/connections/{id}/keys/rotatepost_rotate追加手順5rotate_connection_keyslifecycle: GA。
A-063GET/api/v2/custom-domains/defaultget_default追加手順5get_default_custom_domainlifecycle: GA。
A-064PATCH/api/v2/custom-domains/defaultpatch_default追加手順5set_default_custom_domainlifecycle: GA。
A-065POST/api/v2/custom-domains/{id}/testpost_test_domain追加手順5test_custom_domainlifecycle: GA。
A-066DELETE/api/v2/emails/providerdelete_provider追加手順5delete_email_providerlifecycle: GA。
A-067GET/api/v2/event-streams/{id}/deliveriesget_event_deliveries追加手順5get_event_stream_deliverieslifecycle: GA。
A-068GET/api/v2/event-streams/{id}/deliveries/{event_id}get_deliveries_by_event_id追加手順5get_event_stream_deliverylifecycle: GA。
A-069POST/api/v2/event-streams/{id}/redeliverpost_redeliver追加手順5redeliver_event_stream_eventslifecycle: GA。
A-070POST/api/v2/event-streams/{id}/redeliver/{event_id}post_redeliver_by_event_id追加手順5redeliver_event_stream_eventlifecycle: GA。
A-071POST/api/v2/event-streams/{id}/testpost_test_event追加手順5test_event_streamlifecycle: GA。
A-072GET/api/v2/eventssubscribe_events追加対象外—(実装時に記入)lifecycle: GA。Server-Sent Events(text/event-stream)の購読 API で、本ライブラリの HTTP 層(HTTPoison の同期リクエストと JSON デコード)では扱えないため対象外とする。
A-073GET/api/v2/experimentation/experimentsget_experiments追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-074POST/api/v2/experimentation/experimentscreate_experiment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-075GET/api/v2/experimentation/experiments/{id}get_experiment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-076PATCH/api/v2/experimentation/experiments/{id}update_experiment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-077DELETE/api/v2/experimentation/experiments/{id}delete_experiment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-078POST/api/v2/experimentation/experiments/{id}/advance-rampadvance_experiment_ramp追加対象外—(実装時に記入)lifecycle: EA。操作自体は Early Access だが、前提となる experiments の作成・取得・一覧・更新(POST / GET /experimentation/experiments、GET / PATCH /experimentation/experiments/{id} など)を含む Experimentation の他の 23 操作がすべて beta で対象外のため、この操作だけを追加しても単独では使えない(対象の experiment を作成・参照する手段がない)。このため Experimentation の他の操作と合わせて対象外とする。
A-079POST/api/v2/experimentation/experiments/{id}/statusupdate_experiment_status追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-080POST/api/v2/experimentation/experiments/{id}/validatevalidate_experiment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-081GET/api/v2/experimentation/feature-flagsget_feature_flags追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-082POST/api/v2/experimentation/feature-flagscreate_feature_flag追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-083GET/api/v2/experimentation/feature-flags/{id}get_feature_flag追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-084PATCH/api/v2/experimentation/feature-flags/{id}update_feature_flag追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-085DELETE/api/v2/experimentation/feature-flags/{id}delete_feature_flag追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-086POST/api/v2/experimentation/feature-flags/{id}/statusupdate_feature_flag_status追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-087GET/api/v2/experimentation/feature-flags/{id}/variationsget_variations追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-088POST/api/v2/experimentation/feature-flags/{id}/variationscreate_variation追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-089GET/api/v2/experimentation/feature-flags/{id}/variations/{vid}get_variation追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-090PATCH/api/v2/experimentation/feature-flags/{id}/variations/{vid}update_variation追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-091DELETE/api/v2/experimentation/feature-flags/{id}/variations/{vid}delete_variation追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-092GET/api/v2/experimentation/segmentsget_segments追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-093POST/api/v2/experimentation/segmentscreate_segment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-094GET/api/v2/experimentation/segments/{id}get_segment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-095PATCH/api/v2/experimentation/segments/{id}update_segment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-096DELETE/api/v2/experimentation/segments/{id}delete_segment追加対象外—(実装時に記入)lifecycle: beta。仕様で x-release-lifecycle: beta の操作で、予告なく変わりうるため 2.5.0 の対象外とする(計画 手順3-5)。
A-097GET/api/v2/flows/vault/connectionsget_flows_vault_connections追加手順5get_flows_vault_connectionslifecycle: GA。
A-098POST/api/v2/flows/vault/connectionspost_flows_vault_connections追加手順5create_flows_vault_connectionlifecycle: GA。
A-099GET/api/v2/flows/vault/connections/{id}get_flows_vault_connections_by_id追加手順5get_flows_vault_connectionlifecycle: GA。
A-100PATCH/api/v2/flows/vault/connections/{id}patch_flows_vault_connections_by_id追加手順5update_flows_vault_connectionlifecycle: GA。
A-101DELETE/api/v2/flows/vault/connections/{id}delete_flows_vault_connections_by_id追加手順5delete_flows_vault_connectionlifecycle: GA。
A-102GET/api/v2/flows/{flow_id}/executionsget_flows_executions追加手順5get_flow_executionslifecycle: GA。
A-103GET/api/v2/flows/{flow_id}/executions/{execution_id}get_flows_executions_by_execution_id追加手順5get_flow_executionlifecycle: GA。
A-104DELETE/api/v2/flows/{flow_id}/executions/{execution_id}delete_flows_executions_by_execution_id追加手順5delete_flow_executionlifecycle: GA。
A-105DELETE/api/v2/flows/{id}delete_flows_by_id追加手順5delete_flowlifecycle: GA。
A-106DELETE/api/v2/forms/{id}delete_form追加手順5delete_formlifecycle: GA。
A-107GET/api/v2/groupsget_groups追加手順5get_groupslifecycle: GA。
A-108GET/api/v2/groups/{id}get_group追加手順5get_grouplifecycle: GA。
A-109DELETE/api/v2/groups/{id}delete_group追加手順5delete_grouplifecycle: GA。
A-110GET/api/v2/groups/{id}/membersget_group_members追加手順5get_group_memberslifecycle: GA。
A-111GET/api/v2/groups/{id}/rolesget_group_roles追加手順5get_group_roleslifecycle: GA。
A-112POST/api/v2/groups/{id}/rolespost_group_roles追加手順5assign_group_roleslifecycle: GA。
A-113DELETE/api/v2/groups/{id}/rolesdelete_group_roles追加手順5remove_group_roleslifecycle: GA。
A-114GET/api/v2/guardian/factors/duo/settingsget_factor_duo_settings追加手順5get_guardian_duo_settingslifecycle: GA。
A-115PUT/api/v2/guardian/factors/duo/settingsput_factor_duo_settings追加手順5update_guardian_duo_settingslifecycle: GA。
A-116PATCH/api/v2/guardian/factors/duo/settingspatch_factor_duo_settings追加手順5patch_guardian_duo_settingslifecycle: GA。
A-117GET/api/v2/guardian/factors/email/settingsget_email_factor_settings追加手順5get_guardian_email_settingslifecycle: GA。
A-118PUT/api/v2/guardian/factors/email/settingsset_email_factor_settings追加手順5update_guardian_email_settingslifecycle: GA。
A-119GET/api/v2/guardian/factors/phone/settingsget_phone_factor_settings追加手順5get_guardian_phone_settingslifecycle: GA。
A-120PUT/api/v2/guardian/factors/phone/settingsset_phone_factor_settings追加手順5update_guardian_phone_settingslifecycle: GA。
A-121GET/api/v2/guardian/factors/sms/providers/twilioget_sms_twilio_factor_provider追加対象外—(実装時に記入)lifecycle: GA。仕様にフラグはなく、description も「deprecated」とは書いていないが、「A new endpoint is available to retrieve the Twilio configuration related to phone factors (…). It has the same payload as this one. Please use it instead.」と、同じペイロードを返す移行先 GET /api/v2/guardian/factors/phone/providers/twilio の利用を明示的に求めている。移行先は実装済み(get_guardian_twilio_phone_configuration)で、対になる PUT を含む sms 系の他の 5 操作は description で非推奨と明記されている(D-001〜D-005、いずれも未実装・対象外)。利用を止めるよう案内されている旧パスに新しい公開関数を増やすと、追加直後から非推奨の注記が必要になるだけで利用者に得がないため、対象外とする(第 1 版では追加(手順5)としていたが、レビューの参考指摘を受けて description を再確認し変更した)。
A-122GET/api/v2/guardian/settingsget_guardian_settings追加手順5get_guardian_settingslifecycle: GA。
A-123PUT/api/v2/guardian/settingsset_guardian_settings追加手順5update_guardian_settingslifecycle: GA。
A-124GET/api/v2/keys/custom-signingget_custom_signing_keys追加手順5get_custom_signing_keyslifecycle: GA。
A-125PUT/api/v2/keys/custom-signingput_custom_signing_keys追加手順5set_custom_signing_keyslifecycle: GA。
A-126DELETE/api/v2/keys/custom-signingdelete_custom_signing_keys追加手順5delete_custom_signing_keyslifecycle: GA。
A-127GET/api/v2/keys/network-aclsget_all_keys_network_acls追加手順5get_network_acl_keyslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-128POST/api/v2/keys/network-aclscreate_keys_network_acls追加手順5create_network_acl_keylifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-129GET/api/v2/keys/network-acls/{id}get_keys_network_acls追加手順5get_network_acl_keylifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-130DELETE/api/v2/keys/network-acls/{id}delete_keys_network_acls追加手順5delete_network_acl_keylifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-131PUT/api/v2/network-acls/{id}put_network-acls_by_id追加手順5set_network_acllifecycle: GA。
A-132GET/api/v2/organizations/searchget_search追加手順5search_organizationslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-133GET/api/v2/organizations/{id}/client-grantsget_organization-client-grants追加手順5get_organization_client_grantslifecycle: GA。
A-134POST/api/v2/organizations/{id}/client-grantscreate_organization-client-grants追加手順5associate_organization_client_grantlifecycle: GA。
A-135DELETE/api/v2/organizations/{id}/client-grants/{grant_id}delete_client-grants_by_grant_id追加手順5delete_organization_client_grantlifecycle: GA。
A-136GET/api/v2/organizations/{id}/clientsget_organization_clients追加手順5get_organization_clientslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-137POST/api/v2/organizations/{id}/clientspost_organization_clients追加手順5add_organization_clientslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-138DELETE/api/v2/organizations/{id}/clientsdelete_organization_clients追加手順5delete_organization_clientslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-139GET/api/v2/organizations/{id}/clients/{client_id}get_organization_client追加手順5get_organization_clientlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-140PATCH/api/v2/organizations/{id}/clients/{client_id}patch_organization_client追加手順5update_organization_clientlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-141GET/api/v2/organizations/{id}/connectionsget_organization_connections追加手順5get_organization_associated_connectionslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-142POST/api/v2/organizations/{id}/connectionspost_organization_connection追加手順5add_organization_associated_connectionlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-143GET/api/v2/organizations/{id}/connections/{connection_id}get_organization_connection追加手順5get_organization_associated_connectionlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-144PATCH/api/v2/organizations/{id}/connections/{connection_id}patch_organization_connection追加手順5update_organization_associated_connectionlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-145DELETE/api/v2/organizations/{id}/connections/{connection_id}delete_organization_connection追加手順5delete_organization_associated_connectionlifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-146GET/api/v2/organizations/{id}/discovery-domainsget_discovery-domains追加手順5get_organization_discovery_domainslifecycle: GA。
A-147POST/api/v2/organizations/{id}/discovery-domainspost_discovery-domains追加手順5create_organization_discovery_domainlifecycle: GA。
A-148GET/api/v2/organizations/{id}/discovery-domains/name/{discovery_domain}get_name_by_discovery_domain追加手順5get_organization_discovery_domain_by_namelifecycle: GA。
A-149GET/api/v2/organizations/{id}/discovery-domains/{discovery_domain_id}get_discovery-domains_by_discovery_domain_id追加手順5get_organization_discovery_domainlifecycle: GA。
A-150PATCH/api/v2/organizations/{id}/discovery-domains/{discovery_domain_id}patch_discovery-domains_by_discovery_domain_id追加手順5update_organization_discovery_domainlifecycle: GA。
A-151DELETE/api/v2/organizations/{id}/discovery-domains/{discovery_domain_id}delete_discovery-domains_by_discovery_domain_id追加手順5delete_organization_discovery_domainlifecycle: GA。
A-152GET/api/v2/organizations/{id}/members/{user_id}/effective-rolesget_organization_member_effective_roles追加手順5get_organization_member_effective_roleslifecycle: GA。
A-153GET/api/v2/organizations/{id}/members/{user_id}/effective-roles/sources/groupsget_organization_member_role_source_groups追加手順5get_organization_member_effective_role_group_sourceslifecycle: GA。
A-154GET/api/v2/organizations/{id}/roles/{role_id}/membersget_organization_role_members追加手順5get_organization_role_memberslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-155GET/api/v2/organizations/{organization_id}/groupsget_organization_groups追加手順5get_organization_groupslifecycle: GA。
A-156GET/api/v2/organizations/{organization_id}/groups/{group_id}/rolesget_organization_group_roles追加手順5get_organization_group_roleslifecycle: GA。
A-157POST/api/v2/organizations/{organization_id}/groups/{group_id}/rolespost_organization_group_roles追加手順5assign_organization_group_roleslifecycle: GA。
A-158DELETE/api/v2/organizations/{organization_id}/groups/{group_id}/rolesdelete_organization_group_roles追加手順5remove_organization_group_roleslifecycle: GA。
A-159GET/api/v2/organizations/{organization_id}/roles/{role_id}/groupsget_organization_role_groups追加手順5get_organization_role_groupslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-160GET/api/v2/prompts/renderingget_all_rendering追加手順5get_prompt_renderingslifecycle: GA。
A-161PATCH/api/v2/prompts/renderingpatch_bulk_rendering追加手順5bulk_update_prompt_renderingslifecycle: GA。
A-162GET/api/v2/rate-limit-policiesget_rate-limit-policies追加手順5get_rate_limit_policieslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-163POST/api/v2/rate-limit-policiespost_rate-limit-policies追加手順5create_rate_limit_policylifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-164GET/api/v2/rate-limit-policies/{id}get_rate-limit-policies_by_id追加手順5get_rate_limit_policylifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-165PATCH/api/v2/rate-limit-policies/{id}patch_rate-limit-policies_by_id追加手順5update_rate_limit_policylifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-166DELETE/api/v2/rate-limit-policies/{id}delete_rate-limit-policies_by_id追加手順5delete_rate_limit_policylifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-167GET/api/v2/refresh-tokensget_refresh_tokens追加手順5get_refresh_tokenslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-168POST/api/v2/refresh-tokens/revokerevoke_refresh_tokens追加手順5revoke_refresh_tokenslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-169PATCH/api/v2/refresh-tokens/{id}patch_refresh-tokens_by_id追加手順5update_refresh_tokenlifecycle: GA。
A-170GET/api/v2/resource-servers/searchget_resource_servers_search追加手順5search_resource_serverslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-171GET/api/v2/risk-assessments/settingsget_risk_assessments_settings追加手順5get_risk_assessments_settingslifecycle: GA。
A-172PATCH/api/v2/risk-assessments/settingspatch_risk_assessments_settings追加手順5update_risk_assessments_settingslifecycle: GA。
A-173GET/api/v2/risk-assessments/settings/new-deviceget_new-device追加手順5get_risk_assessments_new_device_settingslifecycle: GA。
A-174PATCH/api/v2/risk-assessments/settings/new-devicepatch_new-device追加手順5update_risk_assessments_new_device_settingslifecycle: GA。
A-175GET/api/v2/roles/{id}/groupsget_role_groups追加手順5get_role_groupslifecycle: GA。
A-176POST/api/v2/roles/{id}/groupspost_role_groups追加手順5assign_role_groupslifecycle: GA。
A-177DELETE/api/v2/roles/{id}/groupsdelete_role_groups追加手順5remove_role_groupslifecycle: GA。
A-178GET/api/v2/self-service-profiles/{id}/custom-text/{language}/{page}get_self_service_profile_custom_text追加手順5get_self_service_profile_custom_textlifecycle: GA。
A-179PUT/api/v2/self-service-profiles/{id}/custom-text/{language}/{page}put_self_service_profile_custom_text追加手順5set_self_service_profile_custom_textlifecycle: GA。
A-180POST/api/v2/self-service-profiles/{profileId}/sso-ticket/{id}/revokepost_revoke追加手順5revoke_self_service_profile_sso_ticketlifecycle: GA。
A-181GET/api/v2/supplemental-signalsget_supplemental-signals追加手順5get_supplemental_signalslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-182PATCH/api/v2/supplemental-signalspatch_supplemental-signals追加手順5update_supplemental_signalslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-183GET/api/v2/user-attribute-profiles/templatesget_user_attribute_profile_templates追加手順5get_user_attribute_profile_templateslifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-184GET/api/v2/user-attribute-profiles/templates/{id}get_user_attribute_profile_template追加手順5get_user_attribute_profile_templatelifecycle: EA。Early Access だが、本ライブラリは既に EA のエンドポイント(User Attribute Profiles など)を実装しており、同じ扱いで対象に含める。@doc に EA であることを書く。
A-185GET/api/v2/users/{id}/connected-accountsget_connected-accounts追加手順5get_user_connected_accountslifecycle: GA。
A-186GET/api/v2/users/{id}/effective-permissionsget_user_effective_permissions追加手順5get_user_effective_permissionslifecycle: GA。
A-187GET/api/v2/users/{id}/effective-permissions/sources/effective-rolesget_user_effective_permission_role_sources追加手順5get_user_effective_permission_role_sourceslifecycle: GA。
A-188GET/api/v2/users/{id}/effective-rolesget_user_effective_roles追加手順5get_user_effective_roleslifecycle: GA。
A-189GET/api/v2/users/{id}/effective-roles/sources/groupsget_user_role_source_groups追加手順5get_user_effective_role_group_sourceslifecycle: GA。
A-190GET/api/v2/users/{id}/groupsget_user_groups追加手順5get_user_groupslifecycle: GA。
A-191POST/api/v2/users/{id}/risk-assessments/clearpost_clear_assessors追加手順5clear_user_risk_assessmentslifecycle: GA。
A-192GET/api/v2/connectionsget_connections追加手順5(パラメータ追加)get_connectionsクエリ strategy は仕様上 type: array(style: form・explode: true、?strategy=a&strategy=b の形)だが、値の 1 つは文字列で送れる一方、複数値をリストで渡すと Util.convert_to_query/1 内の URI.encode_query/2 が ArgumentError(values cannot be lists)を送出し、送れない。リストの値を同じキーの繰り返しに展開するよう Util.convert_to_query/1 を直す(現状は例外になる入力だけが変わるので後方互換の問題はない)。6 項目(A-192〜A-197)は同じ 1 か所の修正で解消する。第 2 版で追加した項目で、既存 ID を変えないよう末尾に置いた。
A-193GET/api/v2/flowsget_flows追加手順5(パラメータ追加)get_flowsクエリ hydrate は仕様上 type: array(style: form・explode: true、?hydrate=a&hydrate=b の形)だが、値の 1 つは文字列で送れる一方、複数値をリストで渡すと Util.convert_to_query/1 内の URI.encode_query/2 が ArgumentError(values cannot be lists)を送出し、送れない。リストの値を同じキーの繰り返しに展開するよう Util.convert_to_query/1 を直す(現状は例外になる入力だけが変わるので後方互換の問題はない)。6 項目(A-192〜A-197)は同じ 1 か所の修正で解消する。第 2 版で追加した項目で、既存 ID を変えないよう末尾に置いた。
A-194GET/api/v2/flows/{id}get_flows_by_id追加手順5(パラメータ追加)get_flowクエリ hydrate は仕様上 type: array(style: form・explode: true、?hydrate=a&hydrate=b の形)だが、値の 1 つは文字列で送れる一方、複数値をリストで渡すと Util.convert_to_query/1 内の URI.encode_query/2 が ArgumentError(values cannot be lists)を送出し、送れない。リストの値を同じキーの繰り返しに展開するよう Util.convert_to_query/1 を直す(現状は例外になる入力だけが変わるので後方互換の問題はない)。6 項目(A-192〜A-197)は同じ 1 か所の修正で解消する。第 2 版で追加した項目で、既存 ID を変えないよう末尾に置いた。
A-195GET/api/v2/formsget_forms追加手順5(パラメータ追加)get_formsクエリ hydrate は仕様上 type: array(style: form・explode: true、?hydrate=a&hydrate=b の形)だが、値の 1 つは文字列で送れる一方、複数値をリストで渡すと Util.convert_to_query/1 内の URI.encode_query/2 が ArgumentError(values cannot be lists)を送出し、送れない。リストの値を同じキーの繰り返しに展開するよう Util.convert_to_query/1 を直す(現状は例外になる入力だけが変わるので後方互換の問題はない)。6 項目(A-192〜A-197)は同じ 1 か所の修正で解消する。第 2 版で追加した項目で、既存 ID を変えないよう末尾に置いた。
A-196GET/api/v2/forms/{id}get_form追加手順5(パラメータ追加)get_formクエリ hydrate は仕様上 type: array(style: form・explode: true、?hydrate=a&hydrate=b の形)だが、値の 1 つは文字列で送れる一方、複数値をリストで渡すと Util.convert_to_query/1 内の URI.encode_query/2 が ArgumentError(values cannot be lists)を送出し、送れない。リストの値を同じキーの繰り返しに展開するよう Util.convert_to_query/1 を直す(現状は例外になる入力だけが変わるので後方互換の問題はない)。6 項目(A-192〜A-197)は同じ 1 か所の修正で解消する。第 2 版で追加した項目で、既存 ID を変えないよう末尾に置いた。
A-197GET/api/v2/resource-serversget_resource-servers追加手順5(パラメータ追加)get_resource_serversクエリ identifiers は仕様上 type: array(style: form・explode: true、?identifiers=a&identifiers=b の形)だが、値の 1 つは文字列で送れる一方、複数値をリストで渡すと Util.convert_to_query/1 内の URI.encode_query/2 が ArgumentError(values cannot be lists)を送出し、送れない。リストの値を同じキーの繰り返しに展開するよう Util.convert_to_query/1 を直す(現状は例外になる入力だけが変わるので後方互換の問題はない)。6 項目(A-192〜A-197)は同じ 1 か所の修正で解消する。第 2 版で追加した項目で、既存 ID を変えないよう末尾に置いた。

パラメータの扱い(計画 手順3-4。差分件数には含めない)

本ライブラリはクエリとボディを map() のまま渡す(クエリは Util.convert_to_query/1 → URI.encode_query/2、ボディは JSON にエンコード)。このため、仕様にあるクエリ/ボディのパラメータのほとんどは、実装を変えなくても送れる(計画 手順3-4 の「対応済み(汎用 map で送信可)」)。この節では、一致した 290 操作のうち公開関数がある 285 操作(公開関数のない 5 操作は A-001〜A-005 で扱う)について、送れるかどうかと @doc への記載の要否を分ける。

現行 @doc の状況

Auth0.Api.Management の公開関数 299 個の @doc は、すべて「操作の概要(英文)+ ## see に公式リファレンスの URL」という形で、パラメータを列挙しているものは 1 つもない(バッククォートで囲んだパラメータ名や、パラメータの節を持つ @doc は 0 件)。概要文に fields・strategy・email などの語が現れるもの(17 箇所)はあるが、説明文の一部であり、パラメータの記載ではない。したがって、下の表に挙げたパラメータは すべて「現行 @doc に記載なし」 である。旧版の仕様がないため「新しく増えたパラメータ」だけを取り出すことはできず、仕様にあるものを全件挙げた。

分類と対応方針

分類対象件数対応
@doc 記載のみ(汎用 map で送信可)クエリ(スカラー型)207 個実装変更なし。公開関数の @doc にパラメータ名を列挙する(下表)。EA のもの(5 個)は EA であることも書く。
@doc 記載のみ(汎用 map で送信可)ボディのプロパティ663 個(110 操作)実装変更なし。個々のプロパティは @doc に列挙しない(理由は下記)。EA 44 個・beta 1 個のプロパティだけ、名前と lifecycle を @doc に書く。deprecated の 1 個(enabled_clients)は D-026 で扱う。
実装変更が必要配列型クエリの複数値6 個(6 操作)A-192〜A-197(手順5)。修正後、@doc にリストで複数値を渡せることを書く。
実装変更が必要関数が params を受け取らない操作のクエリ8 個(2 操作)既存の差分項目(GET /custom-domains 6 個、GET /stats/daily 2 個)。アリティ追加後に @doc に列挙する。
実装変更が必要ヘッダ auth0-custom-domain9 操作既存の差分項目(A-006〜A-016 のうち 9 件)。
  • クエリは全件を @doc に列挙する: 対象は 59 関数・221 個と、ドキュメント更新で扱える量である。また、クエリは関数のシグネチャ(map())からは何を渡せるかが読み取れず、EA のクエリ(GET /roles の type・owner_id・from・take、GET /organizations の include_client_association_for)のように公式リファレンスを開かないと気づけないものがある。
  • ボディのプロパティは個別に列挙しない: 663 個と量が多く(POST /clients だけで数十個)、strategy 別に形が変わるもの(connections)もある。すべて汎用 map でそのまま送れ、各 @doc の ## see の公式リファレンスが正確で最新の一覧になる。@doc に写すと仕様の更新のたびに古くなるため、EA・beta のように利用者が注意すべきものだけを書く。
  • DELETE のボディ: 5 操作(DELETE /organizations/{id}/members・/organizations/{id}/members/{user_id}/roles・/roles/{id}/permissions・/users/{id}/permissions・/users/{id}/roles)はボディを持つ。いずれも実装が Http.delete(body, config) で送っており、送信可。
  • パス・ヘッダ: パスパラメータはすべて関数の引数で渡している(一致した操作で不足なし)。ヘッダは上表の auth0-custom-domain 以外に仕様上のパラメータはない。

クエリパラメータの一覧(59 操作・221 個)

表記: 「*」は必須、「[EA]」「[GA]」は仕様の x-release-lifecycle(パラメータに記載があるもののみ)、「[array]」は配列型。分類の欄が「@doc 記載のみ」でないものだけ、その理由を書いた。

操作operationId公開関数クエリパラメータ(すべて現行 @doc に記載なし)分類
GET /api/v2/actions/actionsget_actionsget_actionstriggerId, actionName, deployed, page, per_page, installed@doc 記載のみ
GET /api/v2/actions/actions/{actionId}/versionsget_action_versionsget_action_versionspage, per_page@doc 記載のみ
DELETE /api/v2/actions/actions/{id}delete_actiondelete_actionforce@doc 記載のみ
GET /api/v2/actions/triggers/{triggerId}/bindingsget_bindingsget_action_trigger_bindingspage, per_page@doc 記載のみ
GET /api/v2/branding/phone/providersget_branding_phone_providerslist_branding_phone_providersdisabled@doc 記載のみ
GET /api/v2/branding/phone/templatesget_phone_templateslist_branding_phone_templatesdisabled@doc 記載のみ
GET /api/v2/client-grantsget_client-grantsget_client_grantsper_page, page, include_totals, from, take, audience, client_id, allow_any_organization, subject_type, default_for [GA]@doc 記載のみ
GET /api/v2/clientsget_clientsget_clientsfields, include_fields, page, per_page, include_totals, from, take, is_global, is_first_party, app_type, external_client_id, q@doc 記載のみ
GET /api/v2/clients/{id}get_clients_by_idget_clientfields, include_fields@doc 記載のみ
GET /api/v2/connection-profilesget_connection-profilesget_connection_profilesfrom, take@doc 記載のみ
GET /api/v2/connectionsget_connectionsget_connectionsper_page, page, include_totals, from, take, strategy [array], name, fields, include_fields複数値は実装変更要(A-192〜A-197)(他は @doc 記載のみ)
GET /api/v2/connections/{id}get_connections_by_idget_connectionfields, include_fields@doc 記載のみ
DELETE /api/v2/connections/{id}/usersdelete_users_by_emaildelete_connection_usersemail*@doc 記載のみ
GET /api/v2/custom-domainsget_custom-domainsget_custom_domain_configurationstake, from, q, fields, include_fields, sort送れない(A-006〜A-016 の該当項目)
GET /api/v2/device-credentialsget_device-credentialsget_device_credentialspage, per_page, include_totals, fields, include_fields, user_id, client_id, type@doc 記載のみ
GET /api/v2/emails/providerget_providerget_email_providerfields, include_fields@doc 記載のみ
GET /api/v2/event-streamsget_event-streamsget_event_streamsfrom, take@doc 記載のみ
GET /api/v2/flowsget_flowsget_flowspage, per_page, include_totals, hydrate [array], synchronous複数値は実装変更要(A-192〜A-197)(他は @doc 記載のみ)
GET /api/v2/flows/{id}get_flows_by_idget_flowhydrate [array]複数値は実装変更要(A-192〜A-197)
GET /api/v2/formsget_formsget_formspage, per_page, include_totals, hydrate [array]複数値は実装変更要(A-192〜A-197)(他は @doc 記載のみ)
GET /api/v2/forms/{id}get_formget_formhydrate [array]複数値は実装変更要(A-192〜A-197)
GET /api/v2/grantsget_grantsget_grantsper_page, page, include_totals, user_id, client_id, audience@doc 記載のみ
DELETE /api/v2/grantsdelete_grants_by_user_iddelete_grant_by_user_iduser_id*@doc 記載のみ
GET /api/v2/hooksget_hooksget_hookspage, per_page, include_totals, enabled, fields, triggerId@doc 記載のみ
GET /api/v2/hooks/{id}get_hooks_by_idget_hookfields@doc 記載のみ
GET /api/v2/keys/encryptionget_encryption_keysget_encryption_keyspage, per_page, include_totals@doc 記載のみ
GET /api/v2/logsget_logsget_log_eventspage, per_page, sort, fields, include_fields, include_totals, from, take, search@doc 記載のみ
GET /api/v2/network-aclsget_network-aclsget_network_aclspage, per_page, include_totals@doc 記載のみ
GET /api/v2/organizationsget_organizationsget_organizationspage, per_page, include_totals, from, take, sort, include_client_association_for [EA]@doc 記載のみ
GET /api/v2/organizations/{id}/enabled_connectionsget_enabled_connectionsget_organization_connectionspage, per_page, include_totals@doc 記載のみ
GET /api/v2/organizations/{id}/invitationsget_invitationsget_organization_invitationspage, per_page, include_totals, fields, include_fields, sort@doc 記載のみ
GET /api/v2/organizations/{id}/invitations/{invitation_id}get_invitations_by_invitation_idget_organization_invitationfields, include_fields@doc 記載のみ
GET /api/v2/organizations/{id}/membersget_organization_membersget_organization_memberspage, per_page, include_totals, from, take, fields, include_fields@doc 記載のみ
GET /api/v2/organizations/{id}/members/{user_id}/rolesget_organization_member_rolesget_organization_rolespage, per_page, include_totals@doc 記載のみ
GET /api/v2/resource-serversget_resource-serversget_resource_serversidentifiers [array], page, per_page, include_totals, include_fields複数値は実装変更要(A-192〜A-197)(他は @doc 記載のみ)
GET /api/v2/resource-servers/{id}get_resource-servers_by_idget_resource_serverinclude_fields@doc 記載のみ
GET /api/v2/rolesget_rolesget_rolesper_page, page, include_totals, name_filter, type [EA], owner_id [EA], from [EA], take [EA]@doc 記載のみ
GET /api/v2/roles/{id}/permissionsget_role_permissionget_role_permissionsper_page, page, include_totals@doc 記載のみ
GET /api/v2/roles/{id}/usersget_role_userget_role_usersper_page, page, include_totals, from, take@doc 記載のみ
GET /api/v2/rulesget_rulesget_rulespage, per_page, include_totals, enabled, fields, include_fields@doc 記載のみ
GET /api/v2/rules/{id}get_rules_by_idget_rulefields, include_fields@doc 記載のみ
GET /api/v2/self-service-profilesget_self-service-profilesget_self_service_profilespage, per_page, include_totals@doc 記載のみ
GET /api/v2/stats/dailyget_dailyget_daily_statsfrom, to送れない(A-006〜A-016 の該当項目)
GET /api/v2/tenants/settingstenant_settings_routeget_tenant_settingfields, include_fields@doc 記載のみ
GET /api/v2/token-exchange-profilesget_token-exchange-profilesget_token_exchange_profilesfrom, take@doc 記載のみ
GET /api/v2/user-attribute-profiles(操作: EA)get_user-attribute-profilesget_user_attribute_profilesfrom, take@doc 記載のみ
GET /api/v2/user-blocksget_user-blocksget_user_blockidentifier*, consider_brute_force_enablement@doc 記載のみ
DELETE /api/v2/user-blocksdelete_user-blocksunblock_user_blockidentifier*@doc 記載のみ
GET /api/v2/user-blocks/{id}get_user-blocks_by_idget_user_block_by_user_idconsider_brute_force_enablement@doc 記載のみ
GET /api/v2/usersget_usersget_userspage, per_page, include_totals, sort, connection, fields, include_fields, q, search_engine, primary_order@doc 記載のみ
GET /api/v2/users-by-emailget_users-by-emailget_users_by_emailfields, include_fields, email*@doc 記載のみ
GET /api/v2/users/{id}get_users_by_idget_userfields, include_fields@doc 記載のみ
GET /api/v2/users/{id}/authentication-methodsget_authentication-methodslist_user_authentication_methodspage, per_page, include_totals@doc 記載のみ
GET /api/v2/users/{id}/logsget_logs_by_userget_user_logspage, per_page, sort, include_totals@doc 記載のみ
GET /api/v2/users/{id}/organizationsget_user_organizationsget_user_organizationspage, per_page, include_totals, from, take@doc 記載のみ
GET /api/v2/users/{id}/permissionsget_permissionsget_user_permissionsper_page, page, include_totals@doc 記載のみ
GET /api/v2/users/{id}/rolesget_user_rolesget_user_rolesper_page, page, include_totals@doc 記載のみ
GET /api/v2/users/{user_id}/refresh-tokensget_refresh_tokens_for_userget_user_refresh_tokensinclude_totals, from, take@doc 記載のみ
GET /api/v2/users/{user_id}/sessionsget_sessions_for_userget_user_sessionsinclude_totals, from, take@doc 記載のみ

ボディのプロパティ(110 操作・663 個)

プロパティ数は、リクエストボディの schema の最上位のプロパティ(allOf・oneOf・anyOf の各分岐を合わせたもの)。すべて汎用 map で送れる。「注意の要るプロパティ」の欄は、仕様で x-release-lifecycle が EA・beta・deprecated のもの。

操作operationId公開関数プロパティ数注意の要るプロパティ(@doc に記載する)
POST /api/v2/actions/actionspost_actioncreate_action8—
POST /api/v2/actions/actions/{actionId}/versions/{id}/deploypost_deploy_draft_versionrollback_action_version1—
PATCH /api/v2/actions/actions/{id}patch_actionupdate_action7—
POST /api/v2/actions/actions/{id}/testpost_test_actiontest_action1—
PATCH /api/v2/actions/triggers/{triggerId}/bindingspatch_bindingsupdate_action_trigger_bindings1—
PATCH /api/v2/attack-protection/breached-password-detectionpatch_breached-password-detectionupdate_attack_protection_breached_password_detection5—
PATCH /api/v2/attack-protection/brute-force-protectionpatch_brute-force-protectionupdate_attack_protection_brute_force_protection6form_submission_mode [beta]
PATCH /api/v2/attack-protection/suspicious-ip-throttlingpatch_suspicious-ip-throttlingupdate_attack_protection_suspicious_ip_throttling4—
PATCH /api/v2/brandingpatch_brandingupdate_branding4—
POST /api/v2/branding/phone/providerscreate_phone_providerconfigure_branding_phone_provider4—
PATCH /api/v2/branding/phone/providers/{id}update_phone_providerupdate_branding_phone_provider4—
POST /api/v2/branding/phone/providers/{id}/trytry_phone_providertest_branding_phone_provider2—
POST /api/v2/branding/phone/templatescreate_phone_templatecreate_branding_phone_template3—
PATCH /api/v2/branding/phone/templates/{id}update_phone_templateupdate_branding_phone_template2—
POST /api/v2/branding/phone/templates/{id}/trytry_phone_templatetest_branding_phone_template2—
PUT /api/v2/branding/templates/universal-loginput_universal-loginset_template_for_universal_login1—
POST /api/v2/branding/themespost_branding_themecreate_branding_theme7identifiers [EA]
PATCH /api/v2/branding/themes/{themeId}patch_branding_themeupdate_branding_theme7identifiers [EA]
POST /api/v2/client-grantspost_client-grantscreate_client_grant9—
PATCH /api/v2/client-grants/{id}patch_client-grants_by_idupdate_client_grant5—
POST /api/v2/clientspost_clientscreate_client58anonymous_sessions [EA], b2b_integration_configuration [EA], fedcm_login [EA], identity_assertion_authorization_grant [EA], my_organization_configuration [EA], organization_discovery_methods [EA], token_quota [EA], token_vault_privileged_access [EA]
POST /api/v2/clients/{client_id}/credentialspost_credentialscreate_credential8—
PATCH /api/v2/clients/{client_id}/credentials/{credential_id}patch_credentials_by_credential_idupdate_credential1—
PATCH /api/v2/clients/{id}patch_clients_by_idupdate_client58anonymous_sessions [EA], b2b_integration_configuration [EA], fedcm_login [EA], identity_assertion_authorization_grant [EA], my_organization_configuration [EA], organization_discovery_methods [EA], token_quota [EA], token_vault_privileged_access [EA]
PATCH /api/v2/connection-profiles/{id}patch_connection-profiles_by_idupdate_connection_profile8cross_app_access_resource_app [EA]
POST /api/v2/connectionspost_connectionscreate_connection13cross_app_access_requesting_app [EA], cross_app_access_resource_app [EA]
PATCH /api/v2/connections/{id}patch_connections_by_idupdate_connection11cross_app_access_requesting_app [EA], cross_app_access_resource_app [EA], enabled_clients [deprecated](deprecated は D-026)
POST /api/v2/connections/{id}/scim-configurationpost_scim-configurationcreate_connection_scim_configuration2—
PATCH /api/v2/connections/{id}/scim-configurationpatch_scim-configurationupdate_connection_scim_configuration2—
POST /api/v2/connections/{id}/scim-configuration/tokenspost_scim_tokencreate_connection_scim_configuration_tokens2—
POST /api/v2/custom-domainspost_custom-domainsconfigure_custom_domain7—
PATCH /api/v2/custom-domains/{id}patch_custom-domains_by_idupdate_custom_domain_configuration4—
POST /api/v2/device-credentialspost_device-credentialscreate_device_credential5—
POST /api/v2/email-templatespost_email-templatescreate_email_template9—
PUT /api/v2/email-templates/{templateName}put_email-templates_by_templateNameupdate_email_template9—
PATCH /api/v2/email-templates/{templateName}patch_email-templates_by_templateNamepatch_email_template9—
POST /api/v2/emails/providerpost_providerconfigure_email_provider5—
PATCH /api/v2/emails/providerpatch_providerupdate_email_provider5—
POST /api/v2/event-streamspost_event-streamscreate_event_stream4—
PATCH /api/v2/event-streams/{id}patch_event-streams_by_idupdate_event_stream4—
POST /api/v2/flowspost_flowscreate_flow2—
PATCH /api/v2/flows/{id}patch_flows_by_idupdate_flow2—
POST /api/v2/formscreate_formcreate_form8—
PATCH /api/v2/forms/{id}patch_formupdate_form8—
POST /api/v2/guardian/enrollments/ticketpost_ticketcreate_guardian_enrollment_ticket6—
PUT /api/v2/guardian/factors/phone/message-typesput_message-typesupdate_guardian_phone_factor1—
PUT /api/v2/guardian/factors/phone/providers/twilioput_twilioupdate_guardian_twilio_phone_configuration4—
PUT /api/v2/guardian/factors/phone/selected-providerput_phone_providersupdate_guardian_phone_configuration1—
PUT /api/v2/guardian/factors/phone/templatesput_factor_phone_templatesupdate_guardian_phone_template2—
PUT /api/v2/guardian/factors/push-notification/providers/apnsput_apnsupdate_guardian_apns_configuration3—
PATCH /api/v2/guardian/factors/push-notification/providers/apnspatch_apnspatch_guardian_apns_configuration3—
PUT /api/v2/guardian/factors/push-notification/providers/fcmput_fcmupdate_guardian_fcm_configuration1—
PATCH /api/v2/guardian/factors/push-notification/providers/fcmpatch_fcmpatch_guardian_fcm_configuration1—
PUT /api/v2/guardian/factors/push-notification/providers/fcmv1put_fcmv1update_guardian_fcmv1_configuration1—
PATCH /api/v2/guardian/factors/push-notification/providers/fcmv1patch_fcmv1patch_guardian_fcmv1_configuration1—
PUT /api/v2/guardian/factors/push-notification/providers/snsput_snsupdate_guardian_aws_sns_configuration5—
PATCH /api/v2/guardian/factors/push-notification/providers/snspatch_snspatch_guardian_aws_sns_configuration5—
PUT /api/v2/guardian/factors/push-notification/selected-providerput_pn_providersupdate_guardian_notification_provider1—
PUT /api/v2/guardian/factors/{name}put_factors_by_nameupdate_guardian_factor1—
POST /api/v2/hookspost_hookscreate_hook5—
PATCH /api/v2/hooks/{id}patch_hooks_by_idupdate_hook4—
POST /api/v2/jobs/users-exportspost_users-exportscreate_job_users_exports4—
POST /api/v2/jobs/users-importspost_users-importscreate_job_users_imports5—
POST /api/v2/jobs/verification-emailpost_verification-emailsend_job_verification_email4—
POST /api/v2/keys/encryptionpost_encryptioncreate_encryption_key1—
POST /api/v2/keys/encryption/{kid}post_encryption_keyimport_encryption_key1—
POST /api/v2/log-streamspost_log-streamscreate_log_stream7—
PATCH /api/v2/log-streams/{id}patch_log-streams_by_idupdate_log_stream6—
POST /api/v2/network-aclspost_network-aclscreate_network_acl4—
PATCH /api/v2/network-acls/{id}patch_network-acls_by_idupdate_network_acl4—
POST /api/v2/organizationspost_organizationscreate_organization8is_app_entitlement_active [EA], token_quota [EA]
PATCH /api/v2/organizations/{id}patch_organizations_by_idmodify_organization7is_app_entitlement_active [EA], token_quota [EA]
POST /api/v2/organizations/{id}/enabled_connectionspost_enabled_connectionsadd_organization_connection4—
PATCH /api/v2/organizations/{id}/enabled_connections/{connectionId}patch_enabled_connections_by_connectionIdmodify_organization_connection3—
POST /api/v2/organizations/{id}/invitationspost_invitationscreate_organization_invitation9—
POST /api/v2/organizations/{id}/memberspost_membersadd_organization_members1—
DELETE /api/v2/organizations/{id}/membersdelete_membersdelete_organization_members1—
POST /api/v2/organizations/{id}/members/{user_id}/rolespost_organization_member_rolesassign_organization_roles1—
DELETE /api/v2/organizations/{id}/members/{user_id}/rolesdelete_organization_member_rolesdelete_organization_roles1—
PATCH /api/v2/promptspatch_promptsupdate_prompt_setting3—
POST /api/v2/resource-serverspost_resource-serverscreate_resource_server21access_token [EA], authorization_policy [EA], require_consent_non_repudiation [EA], token_lifetime_for_anonymous_access_tokens [EA]
PATCH /api/v2/resource-servers/{id}patch_resource-servers_by_idupdate_resource_server20access_token [EA], authorization_policy [EA], require_consent_non_repudiation [EA], token_lifetime_for_anonymous_access_tokens [EA]
POST /api/v2/rolespost_rolescreate_role4owner_id [EA], type [EA]
PATCH /api/v2/roles/{id}patch_roles_by_idupdate_role2—
POST /api/v2/roles/{id}/permissionspost_role_permission_assignmentassociate_role_permissions1—
DELETE /api/v2/roles/{id}/permissionsdelete_role_permission_assignmentremove_role_permissions1—
POST /api/v2/roles/{id}/userspost_role_usersassign_role_users1—
POST /api/v2/rulespost_rulescreate_rule4—
PUT /api/v2/rules-configs/{key}put_rules-configs_by_keyset_rules_config1—
PATCH /api/v2/rules/{id}patch_rules_by_idupdate_rule4—
POST /api/v2/self-service-profilespost_self-service-profilescreate_self_service_profile6user_attribute_profile_id [EA]
PATCH /api/v2/self-service-profiles/{id}patch_self-service-profiles_by_idupdate_self_service_profile6user_attribute_profile_id [EA]
POST /api/v2/self-service-profiles/{id}/sso-ticketpost_sso-ticketcreate_self_service_profile_sso_ticket10—
PATCH /api/v2/tenants/settingspatch_settingsupdate_tenant_setting44access_token [EA], client_id_metadata_document_supported [EA], default_token_quota [EA], include_session_metadata_in_tenant_logs [EA]
POST /api/v2/tickets/email-verificationpost_email-verificationcreate_email_verification_ticket7—
POST /api/v2/tickets/password-changepost_password-changecreate_password_change_ticket10identity [EA]
POST /api/v2/token-exchange-profilespost_token-exchange-profilescreate_token_exchange_profile4—
PATCH /api/v2/token-exchange-profiles/{id}patch_token-exchange-profiles_by_idupdate_token_exchange_profile2—
POST /api/v2/user-attribute-profilespost_user-attribute-profilescreate_user_attribute_profile3—
PATCH /api/v2/user-attribute-profiles/{id}patch_user-attribute-profiles_by_idupdate_user_attribute_profile3—
POST /api/v2/userspost_userscreate_user17—
PATCH /api/v2/users/{id}patch_users_by_idupdate_user18—
POST /api/v2/users/{id}/authentication-methodspost_authentication-methodscreate_user_authentication_methods16—
PATCH /api/v2/users/{id}/authentication-methods/{authentication_method_id}patch_authentication-methods_by_authentication_method_idupdate_user_authentication_method2—
POST /api/v2/users/{id}/identitiespost_identitieslink_user_identities4—
POST /api/v2/users/{id}/permissionspost_permissionsassign_user_permissions1—
DELETE /api/v2/users/{id}/permissionsdelete_permissionsremove_user_permissions1—
POST /api/v2/users/{id}/revoke-accessuser_revoke_accessrevoke_user_selected_resources2—
POST /api/v2/users/{id}/rolespost_user_rolesassign_user_roles1—
DELETE /api/v2/users/{id}/rolesdelete_user_rolesremove_user_roles1—

参考所見(差分件数には含めない)

  1. 重複・未使用のモジュール(3 個): Auth0.Management.Guardian.AwsSns.Configuration.{Get,Patch,Put} は Guardian.Factors.PushNotification.Providers.Sns.{Get,Patch,Put} と同じエンドポイントを指し、どこからも呼ばれていない(公開関数 get/patch/update_guardian_aws_sns_configuration は後者を使う)。@moduledoc false の内部モジュールなので、削除しても公開 API は変わらない。整理するかどうかは実装ノードの判断とする(本チケットの完了条件には影響しない)。これら 3 個は AUTH0-00008 で削除した。
  2. 未使用のモジュール(1 個): Auth0.Management.Connections.Status.Check は未使用。C の get_connection_status の項目を参照。このモジュールは AUTH0-00008 で削除した。
  3. GET /api/v2/jobs/{id}/errors(get_job_error): 仕様は 204 にも application/json の本文を定義しているため差分には数えていないが、実装は 204 の本文を Jason.decode! しており、HTTP 204 の空本文では例外になる。C-009〜C-011 と同じ修正(204 は {:ok, ""})を勧める。
  4. GET /api/v2/stats/active-users(get_active_users_count): 仕様は JSON の数値を返すが、実装は本文の文字列をデコードせずに返している({:ok, "123"})。デコードすると戻り値の型が変わる(破壊的変更)ため、差分としては扱わず、@doc に戻り値が文字列であることを書く程度にとどめることを勧める。
  5. パスパラメータのエンコード: 既存の 211 箇所の String.replace("{…}", value) はパスパラメータを URI エンコードしていない(URI.encode_query/2 はクエリにだけ使われている)。計画 手順5 は新規エンドポイントも「既存と同じ方法でエンコード」するとしているが、既存の方法はエンコードなしである。値に /・?・# などを含む ID を渡すと別のパスに送られうる。本チケットの差分ではないが、新規コードでエンコードするかどうかを実装ノード(とセキュリティレビュー)で決めてほしい。
  6. Rules Configs(/api/v2/rules-configs、3 操作): Rules 専用の設定だが、仕様にフラグがなく、既存実装も非推奨扱いしていないため、非推奨にはしなかった。Rules と合わせて非推奨にする場合は、手順7 で D の Rules と同じ扱いにする。
  7. README / CHANGELOG: README の 2.3.0 の欄に「Add Verifiable Credentials / Risk Assessments / Supplemental Signals management endpoints」とある。C・D の対応に合わせ、ドキュメント更新ノードで訂正が必要。