メインコンテンツへスキップ
POST
https://{tenantDomain}/api/v2
/
clients
/
{id}
/
rotate-secret
Go
package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Clients.RotateSecret(
        context.TODO(),
        "id",
    )
}
{
  "addons": {
    "aws": {
      "lifetime_in_seconds": 22050,
      "principal": "<string>",
      "role": "<string>"
    },
    "azure_blob": {
      "accountName": "<string>",
      "blobName": "<string>",
      "blob_delete": true,
      "blob_read": true,
      "blob_write": true,
      "containerName": "<string>",
      "container_delete": true,
      "container_list": true,
      "container_read": true,
      "container_write": true,
      "expiration": 1,
      "signedIdentifier": "<string>",
      "storageAccessKey": "<string>"
    },
    "azure_sb": {
      "entityPath": "<string>",
      "expiration": 123,
      "namespace": "<string>",
      "sasKey": "<string>",
      "sasKeyName": "<string>"
    },
    "box": {},
    "cloudbees": {},
    "concur": {},
    "dropbox": {},
    "echosign": {
      "domain": "<string>"
    },
    "egnyte": {
      "domain": "<string>"
    },
    "firebase": {
      "client_email": "<string>",
      "lifetime_in_seconds": 123,
      "private_key": "<string>",
      "private_key_id": "<string>",
      "secret": "<string>"
    },
    "layer": {
      "keyId": "<string>",
      "privateKey": "<string>",
      "providerId": "<string>",
      "expiration": 1,
      "principal": "<string>"
    },
    "mscrm": {
      "url": "<string>"
    },
    "newrelic": {
      "account": "<string>"
    },
    "oag": {},
    "office365": {
      "connection": "<string>",
      "domain": "<string>"
    },
    "rms": {
      "url": "<string>"
    },
    "salesforce": {
      "entity_id": "<string>"
    },
    "salesforce_api": {
      "clientid": "<string>",
      "communityName": "<string>",
      "community_url_section": "<string>",
      "principal": "<string>"
    },
    "salesforce_sandbox_api": {
      "clientid": "<string>",
      "communityName": "<string>",
      "community_url_section": "<string>",
      "principal": "<string>"
    },
    "samlp": {
      "audience": "<string>",
      "authnContextClassRef": "<string>",
      "createUpnClaim": true,
      "destination": "<string>",
      "digestAlgorithm": "<string>",
      "issuer": "<string>",
      "lifetimeInSeconds": 123,
      "mapIdentities": true,
      "mapUnknownClaimsAsIs": true,
      "mappings": {},
      "nameIdentifierFormat": "<string>",
      "nameIdentifierProbes": [
        "<string>"
      ],
      "passthroughClaimsWithNoMapping": true,
      "recipient": "<string>",
      "signResponse": true,
      "signatureAlgorithm": "<string>"
    },
    "sap_api": {
      "clientid": "<string>",
      "nameIdentifierFormat": "<string>",
      "scope": "<string>",
      "servicePassword": "<string>",
      "tokenEndpointUrl": "<string>",
      "usernameAttribute": "<string>"
    },
    "sentry": {
      "base_url": "<string>",
      "org_slug": "<string>"
    },
    "sharepoint": {
      "external_url": [
        "<string>"
      ],
      "url": "<string>"
    },
    "slack": {
      "team": "<string>"
    },
    "springcm": {
      "acsurl": "<string>"
    },
    "sso_integration": {
      "name": "<string>",
      "version": "<string>"
    },
    "wams": {
      "masterkey": "<string>"
    },
    "wsfed": {},
    "zendesk": {
      "accountName": "<string>"
    },
    "zoom": {
      "account": "<string>"
    }
  },
  "allowed_clients": [
    "<string>"
  ],
  "allowed_logout_urls": [
    "<string>"
  ],
  "allowed_origins": [
    "<string>"
  ],
  "async_approval_notification_channels": [],
  "callbacks": [
    "<string>"
  ],
  "client_aliases": [
    "<string>"
  ],
  "client_authentication_methods": {
    "private_key_jwt": {
      "credentials": [
        {
          "id": "<string>"
        }
      ]
    },
    "self_signed_tls_client_auth": {
      "credentials": [
        {
          "id": "<string>"
        }
      ]
    },
    "tls_client_auth": {
      "credentials": [
        {
          "id": "<string>"
        }
      ]
    }
  },
  "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
  "client_metadata": {},
  "client_secret": "MG_TNT2ver-SylNat-_VeMmd-4m0Waba0jr1troztBniSChEw0glxEmgEi2Kw40H",
  "cross_origin_authentication": true,
  "cross_origin_loc": "<string>",
  "custom_login_page": "",
  "custom_login_page_on": true,
  "custom_login_page_preview": "",
  "default_organization": {
    "flows": [],
    "organization_id": "<string>"
  },
  "description": "",
  "encryption_key": {
    "cert": "<string>",
    "pub": "<string>",
    "subject": "<string>"
  },
  "express_configuration": {
    "admin_login_domain": "<string>",
    "connection_profile_id": "<string>",
    "enable_client": true,
    "enable_organization": true,
    "initiate_login_uri_template": "<string>",
    "okta_oin_client_id": "<string>",
    "user_attribute_profile_id": "<string>",
    "linked_clients": [
      {
        "client_id": "<string>"
      }
    ],
    "oin_submission_id": "<string>"
  },
  "external_client_id": "<string>",
  "fedcm_login": "<unknown>",
  "form_template": "",
  "global": false,
  "grant_types": [
    "<string>"
  ],
  "initiate_login_uri": "<string>",
  "is_first_party": false,
  "is_token_endpoint_ip_header_trusted": false,
  "jwks_uri": "<string>",
  "jwt_configuration": {
    "alg": "HS256",
    "lifetime_in_seconds": 36000,
    "scopes": {},
    "secret_encoded": true
  },
  "logo_uri": "<string>",
  "mobile": {
    "android": {
      "app_package_name": "",
      "sha256_cert_fingerprints": [
        "<string>"
      ]
    },
    "ios": {
      "app_bundle_identifier": "",
      "team_id": ""
    }
  },
  "my_organization_configuration": {
    "allowed_strategies": [],
    "connection_deletion_behavior": "allow",
    "connection_profile_id": "<string>",
    "user_attribute_profile_id": "<string>"
  },
  "name": "My application",
  "native_social_login": "<unknown>",
  "oidc_conformant": false,
  "oidc_logout": {
    "backchannel_logout_initiators": {
      "selected_initiators": []
    },
    "backchannel_logout_session_metadata": {
      "include": true
    },
    "backchannel_logout_urls": [
      "<string>"
    ]
  },
  "organization_discovery_methods": [],
  "organization_require_behavior": "no_prompt",
  "organization_usage": "deny",
  "par_request_expiry": 305,
  "refresh_token": {
    "expiration_type": "non-expiring",
    "rotation_type": "non-rotating",
    "idle_token_lifetime": 2,
    "infinite_idle_token_lifetime": false,
    "infinite_token_lifetime": true,
    "leeway": 0,
    "policies": [
      {
        "audience": "<string>",
        "scope": [
          "<string>"
        ]
      }
    ],
    "token_lifetime": 78894000
  },
  "require_proof_of_possession": false,
  "require_pushed_authorization_requests": false,
  "resource_server_identifier": "<string>",
  "session_transfer": {
    "allow_refresh_token": false,
    "allowed_authentication_methods": [],
    "can_create_session_transfer_token": false,
    "delegation": {
      "allow_delegated_access": false,
      "enforce_device_binding": "ip"
    },
    "enforce_cascade_revocation": true,
    "enforce_device_binding": "ip",
    "enforce_online_refresh_tokens": true
  },
  "signed_request_object": {
    "credentials": [
      {
        "id": "<string>"
      }
    ],
    "required": false
  },
  "signing_keys": [
    {
      "cert": "",
      "pkcs7": "",
      "subject": ""
    }
  ],
  "skip_non_verifiable_callback_uri_confirmation_prompt": true,
  "sso": false,
  "sso_disabled": false,
  "tenant": "",
  "token_endpoint_auth_method": "none",
  "token_exchange": {
    "allow_any_profile_of_type": []
  },
  "token_quota": {
    "client_credentials": {
      "enforce": true,
      "per_day": 1073741824,
      "per_hour": 1073741824
    }
  },
  "web_origins": [
    "<string>"
  ]
}

承認

Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id
string
必須

シークレットをローテーションするクライアントの ID。

レスポンス

シークレットが正常にローテーションされました。

addons
object

このクライアントで有効になっているアドオンと、それぞれに関連付けられた設定。

allowed_clients
string[]

デリゲーションリクエストを実行できるクライアントおよび API id の許可リスト。空の場合は、すべてのクライアントが許可されます。

allowed_logout_urls
string[]

Auth0 からログアウトした後のリダイレクト先として有効な URL のカンマ区切りリスト。サブドメインにはワイルドカードを使用できます。

allowed_origins
string[]

JavaScript から Auth0 API へのリクエスト送信を許可する URL のカンマ区切りリスト(通常は CORS で使用)。デフォルトでは、すべてのコールバック URL が許可されます。このフィールドでは、必要に応じて他のオリジンを入力できます。サブドメインレベルのワイルドカード(例: https://*.contoso.com)も使用できます。これらの URL の検証時には、クエリ文字列とハッシュ情報は考慮されません。

app_type
enum<string>

このクライアントが表すアプリケーションの種類

利用可能なオプション:
native,
spa,
regular_web,
non_interactive,
resource_server,
express_configuration,
rms,
box,
cloudbees,
concur,
dropbox,
mscrm,
echosign,
egnyte,
newrelic,
office365,
salesforce,
sentry,
sharepoint,
slack,
springcm,
zendesk,
zoom,
sso_integration,
oag
async_approval_notification_channels
enum<string>[]

承認が必要な場合にユーザーに通知するための通知チャネルの配列。有効な値は guardian-pushemail です。

Minimum array length: 1
利用可能なオプション:
guardian-push,
email
callbacks
string[]

認証後に Auth0 がクライアントへのコールバックに使用できるよう、許可リストに登録された URL のカンマ区切りリスト。

client_aliases
string[]

SAML プロトコル用のオーディエンス/レルムのリスト。wsfed アドオンで使用されます。

client_authentication_methods
object

クライアント認証方法を定義します。

client_id
string
デフォルト:AaiyAPdpYdesoKnqjj8HJqRn4T5titww

このクライアントのID。

client_metadata
object

クライアントに関連付けられたメタデータ。文字列値を持つオブジェクト形式です(最大255文字)。メタデータのプロパティは最大10件まで指定できます。フィールド名(最大255文字)は英数字で、使用できる特殊文字は次のとおりです: :,-+=_*?"/\()<>@\t[Tab] [Space]

client_secret
string
デフォルト:MG_TNT2ver-SylNat-_VeMmd-4m0Waba0jr1troztBniSChEw0glxEmgEi2Kw40H

クライアントシークレット(公開してはいけません)。

compliance_level
enum<string> | null

このクライアントの準拠レベルを定義します。これにより、機能が制限される場合があります。

利用可能なオプション:
none,
fapi1_adv_pkj_par,
fapi1_adv_mtls_par,
fapi2_sp_pkj_mtls,
fapi2_sp_mtls_mtls,
null
cross_origin_authentication
boolean

このクライアントがクロスオリジン認証リクエストを実行できる(true)か、そのようなリクエストの実行が許可されない(false)かを示します。

cross_origin_loc
string<url>

Auth0 のホスト型ログインページではなく独自ドメインで認証を実行する場合に、クロスオリジン認証フローでクロスオリジン検証を行うサイト上の URL です。

custom_login_page
string
デフォルト:""

カスタムログインページのコンテンツ(HTML、CSS、JS)。

custom_login_page_on
boolean
デフォルト:true

カスタムログインページを使用する(true)か、デフォルトのログインページを使用する(false)かを示します。

custom_login_page_preview
string
デフォルト:""

カスタムログインページのコンテンツ(HTML、CSS、JS)。(プレビューで使用)

default_organization
object

デフォルトの組織 ID とフローを定義します。

description
string
デフォルト:""

このクライアントの自由記述の説明(最大長: 140 文字)。

encryption_key
object

このクライアントの WsFed レスポンスで使用される暗号化。

express_configuration
object

OIN Express Configuration 機能で使用するアプリケーション固有の設定。

external_client_id
string<absolute-https-uri-or-empty>

認可フローで使用する代替クライアント識別子です。CIMD ベースのクライアント識別子のみをサポートします。

external_metadata_created_by
enum<string>

外部メタデータ クライアントを作成した主体を示します。値 admin は、クライアントが Management API 経由で登録されたことを示します。値 client は、クライアントが動的に登録されたことを示します。このフィールドは、external_metadata_type が設定されている場合にのみ存在します。

利用可能なオプション:
admin,
client
external_metadata_type
enum<string>

クライアントの登録に使用された外部メタデータの種類を示します。このフィールドは通常のクライアントでは省略されます。値 cimd は、Client ID Metadata Document 経由で登録されたクライアントを示します。値 dcr は、動的クライアント登録によって登録されたクライアントを示します。

利用可能なオプション:
cimd,
dcr
fedcm_login
any
form_template
string
デフォルト:""

WS-Federation で使用する HTML フォームテンプレート。

global
boolean
デフォルト:false

これが、レガシーなテナント設定を表すグローバルな「All Applications」クライアント(true)か、通常のクライアント(false)かどうか。

grant_types
string[]

このアプリケーションでサポート対象のグラントタイプのリスト。authorization_codeimplicitrefresh_tokenclient_credentialspasswordhttp://auth0.com/oauth/grant-type/password-realmhttp://auth0.com/oauth/grant-type/mfa-oobhttp://auth0.com/oauth/grant-type/mfa-otphttp://auth0.com/oauth/grant-type/mfa-recovery-codeurn:openid:params:grant-type:cibaurn:ietf:params:oauth:grant-type:device_codeurn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token を含めることができます。

initiate_login_uri
string<absolute-https-uri-with-placeholders-or-empty>

ログイン開始 URI。https である必要があります

is_first_party
boolean
デフォルト:false

このクライアントがファーストパーティクライアント(true)かどうか(false)。

is_token_endpoint_ip_header_trusted
boolean
デフォルト:false

true の場合、トークンエンドポイントのブルートフォース対策で、auth0-forwarded-for ヘッダーで指定された IP をエンドユーザーの IP として信頼します。

jwks_uri
string<absolute-https-uri-or-empty>

private_key_jwt 認証で使用される公開鍵を含む JSON Web Key Set(JWKS)の URL。private_key_jwt 認証を使用する CIMD クライアントにのみ存在します。

jwt_configuration
object

クライアントのJWTに関連する設定。

logo_uri
string

このクライアントに表示するロゴの URL。推奨サイズは 150x150 ピクセルです。

mobile
object

ネイティブモバイルアプリ向けの追加設定。

my_organization_configuration
object
EA

クライアントの My Organization Configuration に関連する設定。

name
string
デフォルト:My application

このクライアントの名前(最小長: 1 文字、< および > は使用できません)。

native_social_login
any
oidc_conformant
boolean
デフォルト:false

このクライアントが厳格な OIDC 仕様に準拠している(true)か、レガシー機能を使用している(false)かどうか。

oidc_logout
object

OIDC バックチャネルログアウトの設定

organization_discovery_methods
enum<string>[]
EA

pre_login_prompt での組織検出に使用できる方法を定義します。ユーザーは emailorganization_name、またはその両方で自分の組織を見つけることができます。

Minimum array length: 1

pre_login_prompt 中に組織を特定する方法。email では、ユーザーがメールアドレスを入力してドメイン照合を行うことで組織を見つけられます。一方、organization_name では、ユーザーが組織名を直接入力する必要があります。これらの方法は組み合わせて使用できます。

利用可能なオプション:
email,
organization_name
organization_require_behavior
enum<string>
デフォルト:no_prompt

client.organization_usage: 'require' の場合に、認証トランザクション中の処理方法を定義します。no_prompt(デフォルト)、pre_login_promptpost_login_prompt のいずれかを指定できます。post_login_prompt には oidc_conformant: true が必要です。

利用可能なオプション:
no_prompt,
pre_login_prompt,
post_login_prompt
organization_usage
enum<string>
デフォルト:deny

組織に関して、認証トランザクション中にどのように処理を進めるかを定義します。deny(デフォルト)、allowrequire のいずれかを指定できます。

利用可能なオプション:
deny,
allow,
require
par_request_expiry
integer | null

プッシュ型認可リクエスト URI が有効な期間を秒単位で指定します

必須範囲: 10 <= x <= 600
redirection_policy
enum<string>
GA

認証エラー時、またはメールアドレス確認フローで、Auth0 がユーザーをアプリケーションのコールバックURLにリダイレクトするかどうかを制御します。open_redirect_protection はリダイレクトの代わりにエラーページを表示し、メールテンプレートからコールバック ドメインを非表示にします。allow_always は標準のリダイレクト動作を有効にします。サードパーティ クライアントでは、デフォルトで open_redirect_protection が使用されます。これは is_first_partyfalse で、かつ third_party_security_modestrict の場合にのみ適用されます。詳細は、Redirect protection を参照してください。

利用可能なオプション:
allow_always,
open_redirect_protection
refresh_token
object

リフレッシュトークンの設定

require_proof_of_possession
boolean
デフォルト:false

このクライアントでは、所有証明の使用を必須にします

require_pushed_authorization_requests
boolean
デフォルト:false

このクライアントでは、プッシュ型認可リクエストの使用を必須にします

resource_server_identifier
string

このクライアントにリンクされているリソースサーバーの識別子です。

session_transfer
object

ネイティブから Web への SSO の設定

signed_request_object
object

JWT-Secured Authorization Requests(JAR)の設定。

signing_keys
object[] | null

このクライアントに関連付けられた署名証明書。

skip_non_verifiable_callback_uri_confirmation_prompt
boolean

リダイレクト URI に、検証不可能なコールバック URI(たとえば myapp:// のようなカスタム URI スキーマや localhost)が使用されている場合に、ログインフロー中に確認プロンプトを表示するかどうかを制御します。 true に設定すると、確認プロンプトは表示されません。悪意のあるアプリからの保護を強化するため、この設定は false にすることを推奨します。 詳細は https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation を参照してください。

sso
boolean
デフォルト:false

SSO クライアントにのみ適用され、Auth0 がシングルサインオンを処理するか(true)、IDプロバイダーが処理するか(false)を決定します。

sso_disabled
boolean
デフォルト:false

シングルサインオンが無効(true)か有効(true)かを示します。デフォルトは true です。

tenant
string
デフォルト:""

このクライアントが属するテナントの名前。

third_party_security_mode
enum<string>
GA

サードパーティクライアントのセキュリティモード。strict強化されたセキュリティ制御を適用します。これには、OAuth 2.1への準拠、明示的なAPI認可、サポート対象機能を厳選したセットが含まれます。permissive従来の動作を維持し、過去にサードパーティクライアントの使用実績があるテナントでのみ利用できます。作成時に設定し、後から変更することはできません。

利用可能なオプション:
strict,
permissive
token_endpoint_auth_method
enum<string>
デフォルト:none

トークンエンドポイントに対して要求する認証方法を定義します。none(クライアントシークレットを持たないパブリッククライアント)、client_secret_post(クライアントがHTTP POSTパラメーターを使用)、またはclient_secret_basic(クライアントがHTTP Basicを使用)を指定できます。

利用可能なオプション:
none,
client_secret_post,
client_secret_basic
token_exchange
object
GA

トークン交換の設定。

token_quota
object
EA
web_origins
string[]

クロスオリジン認証デバイスフロー、および web message response mode で使用する許可済みオリジンのリスト。