diff --git a/main/config/navigation/api.authentication.en.json b/main/config/navigation/api.authentication.en.json new file mode 100644 index 0000000000..5e7866054d --- /dev/null +++ b/main/config/navigation/api.authentication.en.json @@ -0,0 +1,196 @@ +{ + "pages": [ + "docs/api/authentication", + { + "group": " ", + "pages": [ + { + "group": "Login", + "pages": [ + "docs/api/authentication/login/index", + "docs/api/authentication/login/authenticate-using-database", + "docs/api/authentication/login/enterprise-saml-and-others", + "docs/api/authentication/login/start-back-channel-login", + "docs/api/authentication/login/check-back-channel-login-status" + ] + }, + { + "group": "Logout", + "pages": [ + "docs/api/authentication/logout/auth-0-logout", + "docs/api/authentication/logout/oidc-logout", + "docs/api/authentication/logout/saml-logout", + "docs/api/authentication/logout/global-token-revocation" + ] + }, + { + "group": "Passwordless", + "pages": [ + "docs/api/authentication/passwordless/get-code-or-link", + "docs/api/authentication/passwordless/authenticate-user", + "docs/api/authentication/passwordless/verify" + ] + }, + { + "group": "Signup", + "pages": [ + "docs/api/authentication/signup/create-a-new-user" + ] + }, + { + "group": "Change Password", + "pages": [ + "docs/api/authentication/change-password/change-password" + ] + }, + { + "group": "User Profile", + "pages": [ + "docs/api/authentication/user-profile/get-user-info" + ] + }, + { + "group": "Multi Factor Authentication", + "pages": [ + "docs/api/authentication/multi-factor-authentication/request-mfa-challenge", + "docs/api/authentication/multi-factor-authentication/verify-mfa-with-otp", + "docs/api/authentication/multi-factor-authentication/verify-with-out-of-band", + "docs/api/authentication/multi-factor-authentication/verify-with-recovery-code", + "docs/api/authentication/multi-factor-authentication/add-an-authenticator", + "docs/api/authentication/multi-factor-authentication/list-authenticators", + "docs/api/authentication/multi-factor-authentication/delete-authenticator" + ] + }, + { + "group": "SAML", + "pages": [ + "docs/api/authentication/saml/accept-saml-request", + "docs/api/authentication/saml/get-saml-metadata", + "docs/api/authentication/saml/idp-initiated-sso" + ] + }, + { + "group": "WS Federation", + "pages": [ + "docs/api/authentication/ws-federation/accept-ws-federation-request", + "docs/api/authentication/ws-federation/get-ws-federation-metadata" + ] + }, + { + "group": "Dynamic Application (Client) Registration", + "pages": [ + "docs/api/authentication/dynamic-application-client-registration/dynamic-application-registration" + ] + }, + { + "group": "Authorization Code Flow", + "pages": [ + "docs/api/authentication/authorization-code-flow/authorize-application", + "docs/api/authentication/authorization-code-flow/get-token" + ] + }, + { + "group": "Authorization Code Flow with PKCE", + "pages": [ + "docs/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce", + "docs/api/authentication/authorization-code-flow-with-pkce/get-token-pkce" + ] + }, + { + "group": "Authorization Code Flow with Enhanced Privacy Protection", + "pages": [ + "docs/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests", + "docs/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize", + "docs/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token" + ] + }, + { + "group": "Client Credential Flow", + "pages": [ + "docs/api/authentication/client-credential-flow/get-token" + ] + }, + { + "group": "Implicit Flow", + "pages": [ + "docs/api/authentication/implicit-flow/authorize" + ] + }, + { + "group": "Custom Token Exchange", + "pages": [ + "docs/api/authentication/custom-token-exchange/get-token" + ] + }, + { + "group": "Resource Owner Password Flow", + "pages": [ + "docs/api/authentication/resource-owner-password-flow/get-token" + ] + }, + { + "group": "Device Authorization Flow", + "pages": [ + "docs/api/authentication/device-authorization-flow/authorize-device" + ] + }, + { + "group": "Refresh Token", + "pages": [ + "docs/api/authentication/refresh-token/refresh-token" + ] + }, + { + "group": "Revoke Refresh Token", + "pages": [ + "docs/api/authentication/revoke-refresh-token/revoke-refresh-token" + ] + }, + { + "group": "Token Exchange for Native Social", + "pages": [ + "docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social" + ] + }, + { + "group": "Login [Legacy]", + "pages": [ + "docs/api/authentication/login-legacy/social-with-providers-access-token", + "docs/api/authentication/login-legacy/database-ad-lapd-active" + ] + }, + { + "group": "User Profile [Legacy]", + "pages": [ + "docs/api/authentication/user-profile-legacy/get-token-info" + ] + }, + { + "group": "Account Linking [Legacy]", + "pages": [ + "docs/api/authentication/account-linking-legacy/link", + "docs/api/authentication/account-linking-legacy/unlink" + ] + }, + { + "group": "Delegation [Legacy]", + "pages": [ + "docs/api/authentication/delegation-legacy/delegation" + ] + }, + { + "group": "Impersonation [Legacy]", + "pages": [ + "docs/api/authentication/impersonation-legacy/impersonation" + ] + }, + { + "group": "Resource Owner [Legacy]", + "pages": [ + "docs/api/authentication/resource-owner-legacy/resource-owner-password-grant" + ] + } + ] + } + ] +} diff --git a/main/config/navigation/api.authentication.fr-ca.json b/main/config/navigation/api.authentication.fr-ca.json new file mode 100644 index 0000000000..092b61886e --- /dev/null +++ b/main/config/navigation/api.authentication.fr-ca.json @@ -0,0 +1,196 @@ +{ + "pages": [ + "docs/fr-ca/api/authentication", + { + "group": " ", + "pages": [ + { + "group": "Login", + "pages": [ + "docs/fr-ca/api/authentication/login/index", + "docs/fr-ca/api/authentication/login/authenticate-using-database", + "docs/fr-ca/api/authentication/login/enterprise-saml-and-others", + "docs/fr-ca/api/authentication/login/start-back-channel-login", + "docs/fr-ca/api/authentication/login/check-back-channel-login-status" + ] + }, + { + "group": "Logout", + "pages": [ + "docs/fr-ca/api/authentication/logout/auth-0-logout", + "docs/fr-ca/api/authentication/logout/oidc-logout", + "docs/fr-ca/api/authentication/logout/saml-logout", + "docs/fr-ca/api/authentication/logout/global-token-revocation" + ] + }, + { + "group": "Passwordless", + "pages": [ + "docs/fr-ca/api/authentication/passwordless/get-code-or-link", + "docs/fr-ca/api/authentication/passwordless/authenticate-user", + "docs/fr-ca/api/authentication/passwordless/verify" + ] + }, + { + "group": "Signup", + "pages": [ + "docs/fr-ca/api/authentication/signup/create-a-new-user" + ] + }, + { + "group": "Change Password", + "pages": [ + "docs/fr-ca/api/authentication/change-password/change-password" + ] + }, + { + "group": "User Profile", + "pages": [ + "docs/fr-ca/api/authentication/user-profile/get-user-info" + ] + }, + { + "group": "Multi Factor Authentication", + "pages": [ + "docs/fr-ca/api/authentication/multi-factor-authentication/request-mfa-challenge", + "docs/fr-ca/api/authentication/multi-factor-authentication/verify-mfa-with-otp", + "docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-out-of-band", + "docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-recovery-code", + "docs/fr-ca/api/authentication/multi-factor-authentication/add-an-authenticator", + "docs/fr-ca/api/authentication/multi-factor-authentication/list-authenticators", + "docs/fr-ca/api/authentication/multi-factor-authentication/delete-authenticator" + ] + }, + { + "group": "SAML", + "pages": [ + "docs/fr-ca/api/authentication/saml/accept-saml-request", + "docs/fr-ca/api/authentication/saml/get-saml-metadata", + "docs/fr-ca/api/authentication/saml/idp-initiated-sso" + ] + }, + { + "group": "WS Federation", + "pages": [ + "docs/fr-ca/api/authentication/ws-federation/accept-ws-federation-request", + "docs/fr-ca/api/authentication/ws-federation/get-ws-federation-metadata" + ] + }, + { + "group": "Dynamic Application (Client) Registration", + "pages": [ + "docs/fr-ca/api/authentication/dynamic-application-client-registration/dynamic-application-registration" + ] + }, + { + "group": "Authorization Code Flow", + "pages": [ + "docs/fr-ca/api/authentication/authorization-code-flow/authorize-application", + "docs/fr-ca/api/authentication/authorization-code-flow/get-token" + ] + }, + { + "group": "Authorization Code Flow with PKCE", + "pages": [ + "docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce", + "docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/get-token-pkce" + ] + }, + { + "group": "Authorization Code Flow with Enhanced Privacy Protection", + "pages": [ + "docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests", + "docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize", + "docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token" + ] + }, + { + "group": "Client Credential Flow", + "pages": [ + "docs/fr-ca/api/authentication/client-credential-flow/get-token" + ] + }, + { + "group": "Implicit Flow", + "pages": [ + "docs/fr-ca/api/authentication/implicit-flow/authorize" + ] + }, + { + "group": "Custom Token Exchange", + "pages": [ + "docs/fr-ca/api/authentication/custom-token-exchange/get-token" + ] + }, + { + "group": "Resource Owner Password Flow", + "pages": [ + "docs/fr-ca/api/authentication/resource-owner-password-flow/get-token" + ] + }, + { + "group": "Device Authorization Flow", + "pages": [ + "docs/fr-ca/api/authentication/device-authorization-flow/authorize-device" + ] + }, + { + "group": "Refresh Token", + "pages": [ + "docs/fr-ca/api/authentication/refresh-token/refresh-token" + ] + }, + { + "group": "Revoke Refresh Token", + "pages": [ + "docs/fr-ca/api/authentication/revoke-refresh-token/revoke-refresh-token" + ] + }, + { + "group": "Token Exchange for Native Social", + "pages": [ + "docs/fr-ca/api/authentication/token-exchange-for-native-social/token-exchange-native-social" + ] + }, + { + "group": "Login [Legacy]", + "pages": [ + "docs/fr-ca/api/authentication/login-legacy/social-with-providers-access-token", + "docs/fr-ca/api/authentication/login-legacy/database-ad-lapd-active" + ] + }, + { + "group": "User Profile [Legacy]", + "pages": [ + "docs/fr-ca/api/authentication/user-profile-legacy/get-token-info" + ] + }, + { + "group": "Account Linking [Legacy]", + "pages": [ + "docs/fr-ca/api/authentication/account-linking-legacy/link", + "docs/fr-ca/api/authentication/account-linking-legacy/unlink" + ] + }, + { + "group": "Delegation [Legacy]", + "pages": [ + "docs/fr-ca/api/authentication/delegation-legacy/delegation" + ] + }, + { + "group": "Impersonation [Legacy]", + "pages": [ + "docs/fr-ca/api/authentication/impersonation-legacy/impersonation" + ] + }, + { + "group": "Resource Owner [Legacy]", + "pages": [ + "docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-password-grant" + ] + } + ] + } + ] +} diff --git a/main/config/navigation/api.authentication.ja-jp.json b/main/config/navigation/api.authentication.ja-jp.json new file mode 100644 index 0000000000..f9ae0ea2f2 --- /dev/null +++ b/main/config/navigation/api.authentication.ja-jp.json @@ -0,0 +1,196 @@ +{ + "pages": [ + "docs/ja-jp/api/authentication", + { + "group": " ", + "pages": [ + { + "group": "Login", + "pages": [ + "docs/ja-jp/api/authentication/login/index", + "docs/ja-jp/api/authentication/login/authenticate-using-database", + "docs/ja-jp/api/authentication/login/enterprise-saml-and-others", + "docs/ja-jp/api/authentication/login/start-back-channel-login", + "docs/ja-jp/api/authentication/login/check-back-channel-login-status" + ] + }, + { + "group": "Logout", + "pages": [ + "docs/ja-jp/api/authentication/logout/auth-0-logout", + "docs/ja-jp/api/authentication/logout/oidc-logout", + "docs/ja-jp/api/authentication/logout/saml-logout", + "docs/ja-jp/api/authentication/logout/global-token-revocation" + ] + }, + { + "group": "Passwordless", + "pages": [ + "docs/ja-jp/api/authentication/passwordless/get-code-or-link", + "docs/ja-jp/api/authentication/passwordless/authenticate-user", + "docs/ja-jp/api/authentication/passwordless/verify" + ] + }, + { + "group": "Signup", + "pages": [ + "docs/ja-jp/api/authentication/signup/create-a-new-user" + ] + }, + { + "group": "Change Password", + "pages": [ + "docs/ja-jp/api/authentication/change-password/change-password" + ] + }, + { + "group": "User Profile", + "pages": [ + "docs/ja-jp/api/authentication/user-profile/get-user-info" + ] + }, + { + "group": "Multi Factor Authentication", + "pages": [ + "docs/ja-jp/api/authentication/multi-factor-authentication/request-mfa-challenge", + "docs/ja-jp/api/authentication/multi-factor-authentication/verify-mfa-with-otp", + "docs/ja-jp/api/authentication/multi-factor-authentication/verify-with-out-of-band", + "docs/ja-jp/api/authentication/multi-factor-authentication/verify-with-recovery-code", + "docs/ja-jp/api/authentication/multi-factor-authentication/add-an-authenticator", + "docs/ja-jp/api/authentication/multi-factor-authentication/list-authenticators", + "docs/ja-jp/api/authentication/multi-factor-authentication/delete-authenticator" + ] + }, + { + "group": "SAML", + "pages": [ + "docs/ja-jp/api/authentication/saml/accept-saml-request", + "docs/ja-jp/api/authentication/saml/get-saml-metadata", + "docs/ja-jp/api/authentication/saml/idp-initiated-sso" + ] + }, + { + "group": "WS Federation", + "pages": [ + "docs/ja-jp/api/authentication/ws-federation/accept-ws-federation-request", + "docs/ja-jp/api/authentication/ws-federation/get-ws-federation-metadata" + ] + }, + { + "group": "Dynamic Application (Client) Registration", + "pages": [ + "docs/ja-jp/api/authentication/dynamic-application-client-registration/dynamic-application-registration" + ] + }, + { + "group": "Authorization Code Flow", + "pages": [ + "docs/ja-jp/api/authentication/authorization-code-flow/authorize-application", + "docs/ja-jp/api/authentication/authorization-code-flow/get-token" + ] + }, + { + "group": "Authorization Code Flow with PKCE", + "pages": [ + "docs/ja-jp/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce", + "docs/ja-jp/api/authentication/authorization-code-flow-with-pkce/get-token-pkce" + ] + }, + { + "group": "Authorization Code Flow with Enhanced Privacy Protection", + "pages": [ + "docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests", + "docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize", + "docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token" + ] + }, + { + "group": "Client Credential Flow", + "pages": [ + "docs/ja-jp/api/authentication/client-credential-flow/get-token" + ] + }, + { + "group": "Implicit Flow", + "pages": [ + "docs/ja-jp/api/authentication/implicit-flow/authorize" + ] + }, + { + "group": "Custom Token Exchange", + "pages": [ + "docs/ja-jp/api/authentication/custom-token-exchange/get-token" + ] + }, + { + "group": "Resource Owner Password Flow", + "pages": [ + "docs/ja-jp/api/authentication/resource-owner-password-flow/get-token" + ] + }, + { + "group": "Device Authorization Flow", + "pages": [ + "docs/ja-jp/api/authentication/device-authorization-flow/authorize-device" + ] + }, + { + "group": "Refresh Token", + "pages": [ + "docs/ja-jp/api/authentication/refresh-token/refresh-token" + ] + }, + { + "group": "Revoke Refresh Token", + "pages": [ + "docs/ja-jp/api/authentication/revoke-refresh-token/revoke-refresh-token" + ] + }, + { + "group": "Token Exchange for Native Social", + "pages": [ + "docs/ja-jp/api/authentication/token-exchange-for-native-social/token-exchange-native-social" + ] + }, + { + "group": "Login [Legacy]", + "pages": [ + "docs/ja-jp/api/authentication/login-legacy/social-with-providers-access-token", + "docs/ja-jp/api/authentication/login-legacy/database-ad-lapd-active" + ] + }, + { + "group": "User Profile [Legacy]", + "pages": [ + "docs/ja-jp/api/authentication/user-profile-legacy/get-token-info" + ] + }, + { + "group": "Account Linking [Legacy]", + "pages": [ + "docs/ja-jp/api/authentication/account-linking-legacy/link", + "docs/ja-jp/api/authentication/account-linking-legacy/unlink" + ] + }, + { + "group": "Delegation [Legacy]", + "pages": [ + "docs/ja-jp/api/authentication/delegation-legacy/delegation" + ] + }, + { + "group": "Impersonation [Legacy]", + "pages": [ + "docs/ja-jp/api/authentication/impersonation-legacy/impersonation" + ] + }, + { + "group": "Resource Owner [Legacy]", + "pages": [ + "docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-password-grant" + ] + } + ] + } + ] +} diff --git a/main/config/navigation/en.json b/main/config/navigation/en.json index 13956d1b22..9a13371616 100644 --- a/main/config/navigation/en.json +++ b/main/config/navigation/en.json @@ -3,7 +3,9 @@ "tabs": [ { "tab": "Home", - "pages": ["docs/index"] + "pages": [ + "docs/index" + ] }, { "tab": "Documentation", @@ -568,7 +570,7 @@ "docs/authenticate/login/logout/log-users-out-of-saml-idps", "docs/authenticate/login/logout/redirect-users-after-logout", { - "group": "OIDC Back-Channel Logout", + "group": "OIDC Back-Channel Logout", "root": "docs/authenticate/login/logout/back-channel-logout", "pages": [ "docs/authenticate/login/logout/back-channel-logout/configure-back-channel-logout", @@ -2468,7 +2470,10 @@ "groups": [ { "group": " ", - "pages": ["docs/quickstarts", "docs/quickstart/agent-skills"] + "pages": [ + "docs/quickstarts", + "docs/quickstart/agent-skills" + ] }, { "group": "Single Page App", @@ -2551,7 +2556,9 @@ { "dropdown": "Auth0 API Reference Documentation", "icon": "book-open", - "pages": ["docs/api"] + "pages": [ + "docs/api" + ] }, { "dropdown": "My Account API", @@ -2571,7 +2578,7 @@ { "dropdown": "Authentication API", "icon": "list", - "$ref": "./generated/authentication.en.json" + "$ref": "./api.authentication.en.json" } ] }, @@ -2580,7 +2587,9 @@ "groups": [ { "group": " ", - "pages": ["docs/libraries"] + "pages": [ + "docs/libraries" + ] }, { "group": "auth0-acul-js", diff --git a/main/config/navigation/fr-ca.json b/main/config/navigation/fr-ca.json index d1a37585ba..1bd4427619 100644 --- a/main/config/navigation/fr-ca.json +++ b/main/config/navigation/fr-ca.json @@ -2355,7 +2355,7 @@ { "dropdown": "Authentication API", "icon": "list", - "$ref": "./generated/authentication.fr-ca.json" + "$ref": "./api.authentication.fr-ca.json" } ] }, diff --git a/main/config/navigation/generated/authentication.en.json b/main/config/navigation/generated/authentication.en.json deleted file mode 100644 index f5aa2aa753..0000000000 --- a/main/config/navigation/generated/authentication.en.json +++ /dev/null @@ -1,136 +0,0 @@ -{ - "pages": [ - "docs/api/authentication", - { - "group": " ", - "pages": [ - { - "group": "Authorization", - "pages": [ - "docs/api/authentication/authorization/authorization-endpoint", - "docs/api/authentication/authorization/back-channel-login" - ] - }, - { - "group": "Token Exchange", - "pages": [ - "docs/api/authentication/token-exchange/token-endpoint" - ] - }, - { - "group": "Multi Factor Authentication", - "pages": [ - "docs/api/authentication/multi-factor-authentication/request-mfa-challenge", - "docs/api/authentication/multi-factor-authentication/associate-mfa-authenticator", - "docs/api/authentication/multi-factor-authentication/list-mfa-authenticators", - "docs/api/authentication/multi-factor-authentication/delete-mfa-authenticator" - ] - }, - { - "group": "Passwordless", - "pages": [ - "docs/api/authentication/passwordless/start-passwordless-authentication", - "docs/api/authentication/passwordless/verify" - ] - }, - { - "group": "Device Authorization", - "pages": [ - "docs/api/authentication/device-authorization/request-device-code" - ] - }, - { - "group": "Token Management", - "pages": [ - "docs/api/authentication/token-management/revoke-refresh-token" - ] - }, - { - "group": "Pushed Authorization Requests", - "pages": [ - "docs/api/authentication/pushed-authorization-requests/pushed-authorization-request-par" - ] - }, - { - "group": "User Profile", - "pages": [ - "docs/api/authentication/user-profile/get-user-info" - ] - }, - { - "group": "Logout", - "pages": [ - "docs/api/authentication/logout/logout", - "docs/api/authentication/logout/oidc-rp-initiated-logout", - "docs/api/authentication/logout/saml-logout", - "docs/api/authentication/logout/global-token-revocation" - ] - }, - { - "group": "Database Connections", - "pages": [ - "docs/api/authentication/database-connections/sign-up-user", - "docs/api/authentication/database-connections/request-password-change" - ] - }, - { - "group": "Login Legacy", - "pages": [ - "docs/api/authentication/login-legacy/social-with-providers-access-token" - ] - }, - { - "group": "Resource Owner Legacy", - "pages": [ - "docs/api/authentication/resource-owner-legacy/resource-owner-legacy" - ] - }, - { - "group": "User Profile Legacy", - "pages": [ - "docs/api/authentication/user-profile-legacy/get-token-info-legacy" - ] - }, - { - "group": "Delegation Legacy", - "pages": [ - "docs/api/authentication/delegation-legacy/get-delegation-token-legacy" - ] - }, - { - "group": "Impersonation Legacy", - "pages": [ - "docs/api/authentication/impersonation-legacy/impersonate-a-user-legacy" - ] - }, - { - "group": "Dynamic Client Registration", - "pages": [ - "docs/api/authentication/dynamic-client-registration/dynamic-application-registration" - ] - }, - { - "group": "Saml", - "pages": [ - "docs/api/authentication/saml/accept-request", - "docs/api/authentication/saml/get-metadata", - "docs/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow" - ] - }, - { - "group": "Ws Federation", - "pages": [ - "docs/api/authentication/ws-federation/accept-ws-federation-request", - "docs/api/authentication/ws-federation/get-ws-federation-metadata" - ] - }, - { - "group": "Account Linking Legacy", - "pages": [ - "docs/api/authentication/account-linking-legacy/unlink" - ] - } - ] - } - ] -} diff --git a/main/config/navigation/generated/authentication.fr-ca.json b/main/config/navigation/generated/authentication.fr-ca.json deleted file mode 100644 index 63ccefe8ea..0000000000 --- a/main/config/navigation/generated/authentication.fr-ca.json +++ /dev/null @@ -1,136 +0,0 @@ -{ - "pages": [ - "docs/fr-ca/api/authentication", - { - "group": " ", - "pages": [ - { - "group": "Authorization", - "pages": [ - "docs/fr-ca/api/authentication/authorization/authorization-endpoint", - "docs/fr-ca/api/authentication/authorization/back-channel-login" - ] - }, - { - "group": "Token Exchange", - "pages": [ - "docs/fr-ca/api/authentication/token-exchange/token-endpoint" - ] - }, - { - "group": "Multi Factor Authentication", - "pages": [ - "docs/fr-ca/api/authentication/multi-factor-authentication/request-mfa-challenge", - "docs/fr-ca/api/authentication/multi-factor-authentication/associate-mfa-authenticator", - "docs/fr-ca/api/authentication/multi-factor-authentication/list-mfa-authenticators", - "docs/fr-ca/api/authentication/multi-factor-authentication/delete-mfa-authenticator" - ] - }, - { - "group": "Passwordless", - "pages": [ - "docs/fr-ca/api/authentication/passwordless/start-passwordless-authentication", - "docs/fr-ca/api/authentication/passwordless/verify" - ] - }, - { - "group": "Device Authorization", - "pages": [ - "docs/fr-ca/api/authentication/device-authorization/request-device-code" - ] - }, - { - "group": "Token Management", - "pages": [ - "docs/fr-ca/api/authentication/token-management/revoke-refresh-token" - ] - }, - { - "group": "Pushed Authorization Requests", - "pages": [ - "docs/fr-ca/api/authentication/pushed-authorization-requests/pushed-authorization-request-par" - ] - }, - { - "group": "User Profile", - "pages": [ - "docs/fr-ca/api/authentication/user-profile/get-user-info" - ] - }, - { - "group": "Logout", - "pages": [ - "docs/fr-ca/api/authentication/logout/logout", - "docs/fr-ca/api/authentication/logout/oidc-rp-initiated-logout", - "docs/fr-ca/api/authentication/logout/saml-logout", - "docs/fr-ca/api/authentication/logout/global-token-revocation" - ] - }, - { - "group": "Database Connections", - "pages": [ - "docs/fr-ca/api/authentication/database-connections/sign-up-user", - "docs/fr-ca/api/authentication/database-connections/request-password-change" - ] - }, - { - "group": "Login Legacy", - "pages": [ - "docs/fr-ca/api/authentication/login-legacy/social-with-providers-access-token" - ] - }, - { - "group": "Resource Owner Legacy", - "pages": [ - "docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-legacy" - ] - }, - { - "group": "User Profile Legacy", - "pages": [ - "docs/fr-ca/api/authentication/user-profile-legacy/get-token-info-legacy" - ] - }, - { - "group": "Delegation Legacy", - "pages": [ - "docs/fr-ca/api/authentication/delegation-legacy/get-delegation-token-legacy" - ] - }, - { - "group": "Impersonation Legacy", - "pages": [ - "docs/fr-ca/api/authentication/impersonation-legacy/impersonate-a-user-legacy" - ] - }, - { - "group": "Dynamic Client Registration", - "pages": [ - "docs/fr-ca/api/authentication/dynamic-client-registration/dynamic-application-registration" - ] - }, - { - "group": "Saml", - "pages": [ - "docs/fr-ca/api/authentication/saml/accept-request", - "docs/fr-ca/api/authentication/saml/get-metadata", - "docs/fr-ca/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow" - ] - }, - { - "group": "Ws Federation", - "pages": [ - "docs/fr-ca/api/authentication/ws-federation/accept-ws-federation-request", - "docs/fr-ca/api/authentication/ws-federation/get-ws-federation-metadata" - ] - }, - { - "group": "Account Linking Legacy", - "pages": [ - "docs/fr-ca/api/authentication/account-linking-legacy/unlink" - ] - } - ] - } - ] -} diff --git a/main/config/navigation/generated/authentication.ja-jp.json b/main/config/navigation/generated/authentication.ja-jp.json deleted file mode 100644 index 331560af18..0000000000 --- a/main/config/navigation/generated/authentication.ja-jp.json +++ /dev/null @@ -1,136 +0,0 @@ -{ - "pages": [ - "docs/ja-jp/api/authentication", - { - "group": " ", - "pages": [ - { - "group": "Authorization", - "pages": [ - "docs/ja-jp/api/authentication/authorization/authorization-endpoint", - "docs/ja-jp/api/authentication/authorization/back-channel-login" - ] - }, - { - "group": "Token Exchange", - "pages": [ - "docs/ja-jp/api/authentication/token-exchange/token-endpoint" - ] - }, - { - "group": "Multi Factor Authentication", - "pages": [ - "docs/ja-jp/api/authentication/multi-factor-authentication/request-mfa-challenge", - "docs/ja-jp/api/authentication/multi-factor-authentication/associate-mfa-authenticator", - "docs/ja-jp/api/authentication/multi-factor-authentication/list-mfa-authenticators", - "docs/ja-jp/api/authentication/multi-factor-authentication/delete-mfa-authenticator" - ] - }, - { - "group": "Passwordless", - "pages": [ - "docs/ja-jp/api/authentication/passwordless/start-passwordless-authentication", - "docs/ja-jp/api/authentication/passwordless/verify" - ] - }, - { - "group": "Device Authorization", - "pages": [ - "docs/ja-jp/api/authentication/device-authorization/request-device-code" - ] - }, - { - "group": "Token Management", - "pages": [ - "docs/ja-jp/api/authentication/token-management/revoke-refresh-token" - ] - }, - { - "group": "Pushed Authorization Requests", - "pages": [ - "docs/ja-jp/api/authentication/pushed-authorization-requests/pushed-authorization-request-par" - ] - }, - { - "group": "User Profile", - "pages": [ - "docs/ja-jp/api/authentication/user-profile/get-user-info" - ] - }, - { - "group": "Logout", - "pages": [ - "docs/ja-jp/api/authentication/logout/logout", - "docs/ja-jp/api/authentication/logout/oidc-rp-initiated-logout", - "docs/ja-jp/api/authentication/logout/saml-logout", - "docs/ja-jp/api/authentication/logout/global-token-revocation" - ] - }, - { - "group": "Database Connections", - "pages": [ - "docs/ja-jp/api/authentication/database-connections/sign-up-user", - "docs/ja-jp/api/authentication/database-connections/request-password-change" - ] - }, - { - "group": "Login Legacy", - "pages": [ - "docs/ja-jp/api/authentication/login-legacy/social-with-providers-access-token" - ] - }, - { - "group": "Resource Owner Legacy", - "pages": [ - "docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-legacy" - ] - }, - { - "group": "User Profile Legacy", - "pages": [ - "docs/ja-jp/api/authentication/user-profile-legacy/get-token-info-legacy" - ] - }, - { - "group": "Delegation Legacy", - "pages": [ - "docs/ja-jp/api/authentication/delegation-legacy/get-delegation-token-legacy" - ] - }, - { - "group": "Impersonation Legacy", - "pages": [ - "docs/ja-jp/api/authentication/impersonation-legacy/impersonate-a-user-legacy" - ] - }, - { - "group": "Dynamic Client Registration", - "pages": [ - "docs/ja-jp/api/authentication/dynamic-client-registration/dynamic-application-registration" - ] - }, - { - "group": "Saml", - "pages": [ - "docs/ja-jp/api/authentication/saml/accept-request", - "docs/ja-jp/api/authentication/saml/get-metadata", - "docs/ja-jp/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow" - ] - }, - { - "group": "Ws Federation", - "pages": [ - "docs/ja-jp/api/authentication/ws-federation/accept-ws-federation-request", - "docs/ja-jp/api/authentication/ws-federation/get-ws-federation-metadata" - ] - }, - { - "group": "Account Linking Legacy", - "pages": [ - "docs/ja-jp/api/authentication/account-linking-legacy/unlink" - ] - } - ] - } - ] -} diff --git a/main/config/navigation/ja-jp.json b/main/config/navigation/ja-jp.json index f3c144d32e..96ec27ad46 100644 --- a/main/config/navigation/ja-jp.json +++ b/main/config/navigation/ja-jp.json @@ -2355,7 +2355,7 @@ { "dropdown": "Authentication API", "icon": "list", - "$ref": "./generated/authentication.ja-jp.json" + "$ref": "./api.authentication.ja-jp.json" } ] }, diff --git a/main/config/redirects.json b/main/config/redirects.json index 19a11a8adc..ee1d62019f 100644 --- a/main/config/redirects.json +++ b/main/config/redirects.json @@ -22282,5 +22282,209 @@ { "source": "/docs/ja-jp/secure/mdl-verification/*", "destination": "/docs/ja-jp/secure" + }, + { + "source": "/docs/api/authentication/muti-factor-authentication/request-mfa-challenge", + "destination": "/docs/api/authentication/multi-factor-authentication/request-mfa-challenge" + }, + { + "source": "/docs/api/authentication/muti-factor-authentication/verify-mfa-with-otp", + "destination": "/docs/api/authentication/multi-factor-authentication/verify-mfa-with-otp" + }, + { + "source": "/docs/api/authentication/muti-factor-authentication/verify-with-out-of-band", + "destination": "/docs/api/authentication/multi-factor-authentication/verify-with-out-of-band" + }, + { + "source": "/docs/api/authentication/muti-factor-authentication/verify-with-recovery-code", + "destination": "/docs/api/authentication/multi-factor-authentication/verify-with-recovery-code" + }, + { + "source": "/docs/api/authentication/muti-factor-authentication/add-an-authenticator", + "destination": "/docs/api/authentication/multi-factor-authentication/add-an-authenticator" + }, + { + "source": "/docs/api/authentication/muti-factor-authentication/list-authenticators", + "destination": "/docs/api/authentication/multi-factor-authentication/list-authenticators" + }, + { + "source": "/docs/api/authentication/muti-factor-authentication/delete-authenticator", + "destination": "/docs/api/authentication/multi-factor-authentication/delete-authenticator" + }, + { + "source": "/docs/fr-ca/api/authentication/authorization/authorization-endpoint", + "destination": "/docs/fr-ca/api/authentication/authorization-code-flow/authorize-application" + }, + { + "source": "/docs/fr-ca/api/authentication/authorization/back-channel-login", + "destination": "/docs/fr-ca/api/authentication/login/start-back-channel-login" + }, + { + "source": "/docs/fr-ca/api/authentication/database-connections/sign-up-user", + "destination": "/docs/fr-ca/api/authentication/signup/create-a-new-user" + }, + { + "source": "/docs/fr-ca/api/authentication/database-connections/request-password-change", + "destination": "/docs/fr-ca/api/authentication/change-password/change-password" + }, + { + "source": "/docs/fr-ca/api/authentication/delegation-legacy/get-delegation-token-legacy", + "destination": "/docs/fr-ca/api/authentication/delegation-legacy/delegation" + }, + { + "source": "/docs/fr-ca/api/authentication/device-authorization/request-device-code", + "destination": "/docs/fr-ca/api/authentication/device-authorization-flow/authorize-device" + }, + { + "source": "/docs/fr-ca/api/authentication/dynamic-client-registration/dynamic-application-registration", + "destination": "/docs/fr-ca/api/authentication/dynamic-application-client-registration/dynamic-application-registration" + }, + { + "source": "/docs/fr-ca/api/authentication/impersonation-legacy/impersonate-a-user-legacy", + "destination": "/docs/fr-ca/api/authentication/impersonation-legacy/impersonation" + }, + { + "source": "/docs/fr-ca/api/authentication/logout/logout", + "destination": "/docs/fr-ca/api/authentication/logout/auth-0-logout" + }, + { + "source": "/docs/fr-ca/api/authentication/logout/oidc-rp-initiated-logout", + "destination": "/docs/fr-ca/api/authentication/logout/oidc-logout" + }, + { + "source": "/docs/fr-ca/api/authentication/multi-factor-authentication/associate-mfa-authenticator", + "destination": "/docs/fr-ca/api/authentication/multi-factor-authentication/add-an-authenticator" + }, + { + "source": "/docs/fr-ca/api/authentication/multi-factor-authentication/delete-mfa-authenticator", + "destination": "/docs/fr-ca/api/authentication/multi-factor-authentication/delete-authenticator" + }, + { + "source": "/docs/fr-ca/api/authentication/multi-factor-authentication/list-mfa-authenticators", + "destination": "/docs/fr-ca/api/authentication/multi-factor-authentication/list-authenticators" + }, + { + "source": "/docs/fr-ca/api/authentication/passwordless/start-passwordless-authentication", + "destination": "/docs/fr-ca/api/authentication/passwordless/get-code-or-link" + }, + { + "source": "/docs/fr-ca/api/authentication/pushed-authorization-requests/pushed-authorization-request-par", + "destination": "/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests" + }, + { + "source": "/docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-legacy", + "destination": "/docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-password-grant" + }, + { + "source": "/docs/fr-ca/api/authentication/saml/accept-request", + "destination": "/docs/fr-ca/api/authentication/saml/accept-saml-request" + }, + { + "source": "/docs/fr-ca/api/authentication/saml/get-metadata", + "destination": "/docs/fr-ca/api/authentication/saml/get-saml-metadata" + }, + { + "source": "/docs/fr-ca/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow", + "destination": "/docs/fr-ca/api/authentication/saml/idp-initiated-sso" + }, + { + "source": "/docs/fr-ca/api/authentication/token-exchange/token-endpoint", + "destination": "/docs/fr-ca/api/authentication/authorization-code-flow/get-token" + }, + { + "source": "/docs/fr-ca/api/authentication/token-management/revoke-refresh-token", + "destination": "/docs/fr-ca/api/authentication/revoke-refresh-token/revoke-refresh-token" + }, + { + "source": "/docs/fr-ca/api/authentication/user-profile-legacy/get-token-info-legacy", + "destination": "/docs/fr-ca/api/authentication/user-profile-legacy/get-token-info" + }, + { + "source": "/docs/ja-jp/api/authentication/authorization/authorization-endpoint", + "destination": "/docs/ja-jp/api/authentication/authorization-code-flow/authorize-application" + }, + { + "source": "/docs/ja-jp/api/authentication/authorization/back-channel-login", + "destination": "/docs/ja-jp/api/authentication/login/start-back-channel-login" + }, + { + "source": "/docs/ja-jp/api/authentication/database-connections/sign-up-user", + "destination": "/docs/ja-jp/api/authentication/signup/create-a-new-user" + }, + { + "source": "/docs/ja-jp/api/authentication/database-connections/request-password-change", + "destination": "/docs/ja-jp/api/authentication/change-password/change-password" + }, + { + "source": "/docs/ja-jp/api/authentication/delegation-legacy/get-delegation-token-legacy", + "destination": "/docs/ja-jp/api/authentication/delegation-legacy/delegation" + }, + { + "source": "/docs/ja-jp/api/authentication/device-authorization/request-device-code", + "destination": "/docs/ja-jp/api/authentication/device-authorization-flow/authorize-device" + }, + { + "source": "/docs/ja-jp/api/authentication/dynamic-client-registration/dynamic-application-registration", + "destination": "/docs/ja-jp/api/authentication/dynamic-application-client-registration/dynamic-application-registration" + }, + { + "source": "/docs/ja-jp/api/authentication/impersonation-legacy/impersonate-a-user-legacy", + "destination": "/docs/ja-jp/api/authentication/impersonation-legacy/impersonation" + }, + { + "source": "/docs/ja-jp/api/authentication/logout/logout", + "destination": "/docs/ja-jp/api/authentication/logout/auth-0-logout" + }, + { + "source": "/docs/ja-jp/api/authentication/logout/oidc-rp-initiated-logout", + "destination": "/docs/ja-jp/api/authentication/logout/oidc-logout" + }, + { + "source": "/docs/ja-jp/api/authentication/multi-factor-authentication/associate-mfa-authenticator", + "destination": "/docs/ja-jp/api/authentication/multi-factor-authentication/add-an-authenticator" + }, + { + "source": "/docs/ja-jp/api/authentication/multi-factor-authentication/delete-mfa-authenticator", + "destination": "/docs/ja-jp/api/authentication/multi-factor-authentication/delete-authenticator" + }, + { + "source": "/docs/ja-jp/api/authentication/multi-factor-authentication/list-mfa-authenticators", + "destination": "/docs/ja-jp/api/authentication/multi-factor-authentication/list-authenticators" + }, + { + "source": "/docs/ja-jp/api/authentication/passwordless/start-passwordless-authentication", + "destination": "/docs/ja-jp/api/authentication/passwordless/get-code-or-link" + }, + { + "source": "/docs/ja-jp/api/authentication/pushed-authorization-requests/pushed-authorization-request-par", + "destination": "/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests" + }, + { + "source": "/docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-legacy", + "destination": "/docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-password-grant" + }, + { + "source": "/docs/ja-jp/api/authentication/saml/accept-request", + "destination": "/docs/ja-jp/api/authentication/saml/accept-saml-request" + }, + { + "source": "/docs/ja-jp/api/authentication/saml/get-metadata", + "destination": "/docs/ja-jp/api/authentication/saml/get-saml-metadata" + }, + { + "source": "/docs/ja-jp/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow", + "destination": "/docs/ja-jp/api/authentication/saml/idp-initiated-sso" + }, + { + "source": "/docs/ja-jp/api/authentication/token-exchange/token-endpoint", + "destination": "/docs/ja-jp/api/authentication/authorization-code-flow/get-token" + }, + { + "source": "/docs/ja-jp/api/authentication/token-management/revoke-refresh-token", + "destination": "/docs/ja-jp/api/authentication/revoke-refresh-token/revoke-refresh-token" + }, + { + "source": "/docs/ja-jp/api/authentication/user-profile-legacy/get-token-info-legacy", + "destination": "/docs/ja-jp/api/authentication/user-profile-legacy/get-token-info" } ] diff --git a/main/docs/api/authentication/_metadata.json b/main/docs/api/authentication/_metadata.json deleted file mode 100644 index bbbe30d60c..0000000000 --- a/main/docs/api/authentication/_metadata.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "oasVersion": "v1", - "snippetVersion": "not found" -} diff --git a/main/docs/api/authentication/login/index.mdx b/main/docs/api/authentication/login/index.mdx index 3f4b5b2649..587ec32850 100644 --- a/main/docs/api/authentication/login/index.mdx +++ b/main/docs/api/authentication/login/index.mdx @@ -1,5 +1,6 @@ --- title: "Social" +sidebarTitle: "Social" description: "You can connect your Auth0 service to a social identity provider and allow your users to log in to your application via Facebook, Google, Apple, or other..." --- diff --git a/main/docs/api/authentication/muti-factor-authentication/add-an-authenticator.mdx b/main/docs/api/authentication/multi-factor-authentication/add-an-authenticator.mdx similarity index 97% rename from main/docs/api/authentication/muti-factor-authentication/add-an-authenticator.mdx rename to main/docs/api/authentication/multi-factor-authentication/add-an-authenticator.mdx index f38cefdae2..ff1b59fd2b 100644 --- a/main/docs/api/authentication/muti-factor-authentication/add-an-authenticator.mdx +++ b/main/docs/api/authentication/multi-factor-authentication/add-an-authenticator.mdx @@ -13,7 +13,7 @@ If the user has no active authenticators, you can use the `mfa_token` from the ` After an authenticator is added, it must be verified. To verify the authenticator, use the response values from the `/mfa/associate` request in place of the values returned from the `/mfa/challenge` endpoint and continue with the verification flow. -A `recovery_codes` field is included in the response the first time an authenticator is added. You can use `recovery_codes` to pass multi-factor authentication as shown on [Verify with recovery code](/muti-factor-authentication/verify-with-recovery-code) above. +A `recovery_codes` field is included in the response the first time an authenticator is added. You can use `recovery_codes` to pass multi-factor authentication as shown on [Verify with recovery code](/multi-factor-authentication/verify-with-recovery-code) above. To access this endpoint, you must set an Access Token at the Authorization header, with the following claims: - `scope`: `enroll` diff --git a/main/docs/api/authentication/muti-factor-authentication/delete-authenticator.mdx b/main/docs/api/authentication/multi-factor-authentication/delete-authenticator.mdx similarity index 100% rename from main/docs/api/authentication/muti-factor-authentication/delete-authenticator.mdx rename to main/docs/api/authentication/multi-factor-authentication/delete-authenticator.mdx diff --git a/main/docs/api/authentication/muti-factor-authentication/list-authenticators.mdx b/main/docs/api/authentication/multi-factor-authentication/list-authenticators.mdx similarity index 100% rename from main/docs/api/authentication/muti-factor-authentication/list-authenticators.mdx rename to main/docs/api/authentication/multi-factor-authentication/list-authenticators.mdx diff --git a/main/docs/api/authentication/muti-factor-authentication/request-mfa-challenge.mdx b/main/docs/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx similarity index 97% rename from main/docs/api/authentication/muti-factor-authentication/request-mfa-challenge.mdx rename to main/docs/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx index b1019e3f0d..67fa7b606a 100644 --- a/main/docs/api/authentication/muti-factor-authentication/request-mfa-challenge.mdx +++ b/main/docs/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx @@ -31,7 +31,7 @@ If OTP is supported by the user and you don't want to request a different factor - Auth0 chooses the challenge type based on the application's supported types and types the user is enrolled with. - An `unsupported_challenge_type` error is returned if your application does not support any of the challenge types the user has enrolled with. - An `unsupported_challenge_type` error is returned if the user is not enrolled. -- If the user is not enrolled, you will get an `association_required` error, indicating the user needs to enroll to use MFA. Read [Add an authenticator](/muti-factor-authentication/add-an-authenticator) below on how to proceed. +- If the user is not enrolled, you will get an `association_required` error, indicating the user needs to enroll to use MFA. Read [Add an authenticator](/multi-factor-authentication/add-an-authenticator) below on how to proceed. ### Learn More * [Authenticate With Resource Owner Password Grant and MFA](https://auth0.com/docs/secure/multi-factor-authentication/authenticate-using-ropg-flow-with-mfa) diff --git a/main/docs/api/authentication/muti-factor-authentication/verify-mfa-with-otp.mdx b/main/docs/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx similarity index 100% rename from main/docs/api/authentication/muti-factor-authentication/verify-mfa-with-otp.mdx rename to main/docs/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx diff --git a/main/docs/api/authentication/muti-factor-authentication/verify-with-out-of-band.mdx b/main/docs/api/authentication/multi-factor-authentication/verify-with-out-of-band.mdx similarity index 100% rename from main/docs/api/authentication/muti-factor-authentication/verify-with-out-of-band.mdx rename to main/docs/api/authentication/multi-factor-authentication/verify-with-out-of-band.mdx diff --git a/main/docs/api/authentication/muti-factor-authentication/verify-with-recovery-code.mdx b/main/docs/api/authentication/multi-factor-authentication/verify-with-recovery-code.mdx similarity index 100% rename from main/docs/api/authentication/muti-factor-authentication/verify-with-recovery-code.mdx rename to main/docs/api/authentication/multi-factor-authentication/verify-with-recovery-code.mdx diff --git a/main/docs/fr-ca/api/authentication.mdx b/main/docs/fr-ca/api/authentication.mdx index f560f36ced..ba09b1d5ef 100644 --- a/main/docs/fr-ca/api/authentication.mdx +++ b/main/docs/fr-ca/api/authentication.mdx @@ -1,4 +1,158 @@ --- -title: "Authentication API Reference" -description: "Documentation for Auth0's Authentication API" ---- \ No newline at end of file +title: "Authentication API" +description: "L'API d'authentification vous permet de gérer tous les aspects de l'identité de l'utilisateur lorsque vous utilisez Auth0. Elle propose des points de terminaison pour que vos utilisateurs puissent se connecter, s'inscrire, se déconnecter, accéder aux API, etc." +--- + +L'API d'authentification vous permet de gérer tous les aspects de l'identité de l'utilisateur lorsque vous utilisez Auth0. Elle propose des points de terminaison pour que vos utilisateurs puissent se connecter, s'inscrire, se déconnecter, accéder aux API, etc. + +L'API prend en charge divers protocoles d'identité, tels que [OpenID Connect](https://auth0.com/docs/authenticate/protocols/openid-connect-protocol), [Oauth 2.0](https://auth0.com/docs/authenticate/protocols/oauth), [FAPI](https://auth0.com/docs/secure/highly-regulated-identity#advanced-security-with-openid-connect-fapi-) et [SAML](https://auth0.com/docs/protocols/saml). + + +Cette API est conçue pour les personnes qui se sentent à l'aise avec l'intégration avec les API RESTful. Si vous préférez une approche plus guidée, veuillez consulter nos [Démarrages rapides](https://auth0.com/docs/quickstarts) ou nos [Bibliothèques](https://auth0.com/docs/libraries). + + +## Base URL + +L'API d'authentification est servie via HTTPS. Toutes les URL référencées dans la documentation ont la base suivante : `https://{yourDomain}` + +## Méthodes d'authentification + +Vous disposez de cinq options pour vous authentifier avec cette API : + +- OAuth2 Jeton d'accès +- ID client et assertion client (applications confidentielles) +- ID client et secret client (applications confidentielles) +- ID client (applications publiques) +- Authentification mTLS (applications confidentielles) + +### Jeton d'accès OAuth2 + +Envoyez un jeton d'accès valide dans l'en-tête `Authorization`, en utilisant le schéma d'authentification `Bearer`. + +Un exemple est le scénario [Obtenir le point de terminaison des informations utilisateur](/user-profile/get-user-info). Dans ce scénario, vous obtenez un jeton d'accès lorsque vous authentifiez un utilisateur, puis vous pouvez faire une demande [Obtenir le point de terminaison des informations utilisateur](/user-profile/get-user-info), en utilisant ce jeton dans l'en-tête `Authorization`, afin de récupérer le profil de l'utilisateur. + +### ID client et assertion client + +Génèrent une [assertion du client](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authenticate-with-private-key-jwt) contenant un jeton Web JSON signé (JWT) pour l'authentification. Dans le corps de la demande, incluez votre identifiant client, un paramètre `client_assertion_type` avec la valeur `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`, et un paramètre `client_assertion` avec votre assertion signée. Consultez [Clé privée JWT](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authenticate-with-private-key-jwt) pour des exemples. + +### ID client et secret client + +Envoyez l'ID client et le secret client. La méthode que vous pouvez utiliser pour envoyer ces données est déterminée par la [Méthode d'authentification du point de terminaison du jeton](https://auth0.com/docs/get-started/applications/confidential-and-public-applications/view-application-type) configurée pour votre application. + +Si vous utilisez **Post**, vous devez envoyer ces données dans le corps JSON de votre requête. + +Si vous utilisez **Basic**, vous devez envoyer ces données dans l'en-tête `Authorization`, en utilisant le schéma d'authentification `Basic`. Pour générer votre valeur d'identification, concaténez votre identifiant client et votre secret client, séparés par deux points (`:`), et encodez-les en Base64. + +Un exemple est le [point de terminaison Révoquer le jeton d'actualisation](https://auth0.com/docs/secure/tokens/refresh-tokens/revoke-refresh-tokens). Cette option est accessible uniquement aux applications confidentielles, c'est-à-dire celles capables de stocker les informations d'identification en toute sécurité sans les exposer à des tiers non autorisés. + +### ID client + +Envoyer l'ID client. Pour les applications publiques, celles qui ne peuvent pas stocker les informations d'identification en toute sécurité, comme les applications SPA ou mobiles, nous proposons des points de terminaison accessibles uniquement à l'aide de l'ID client. + +Un exemple est le [Flux d'autorisation implicite](/implicit-flow/authorize). + +### Authentification mTLS + +Générez un certificat, soit [auto-signé](https://auth0.com/docs/get-started/applications/configure-mtls/configure-mtls-for-a-client#self-signed-certificates) ou [signé par une autorité de certification](https://auth0.com/docs/get-started/applications/configure-mtls/configure-mtls-for-a-client#certificate-authority-signed-certificates). Ensuite, [configurez le réseau de périphérie client](https://auth0.com/docs/get-started/applications/configure-mtls/set-up-the-customer-edge) qui effectue l'établissement de liaison mTLS. + +Une fois que votre réseau périphérique a vérifié le certificat, transmettez la demande au réseau périphérique Auth0 avec les en-têtes suivants : + +- La clé API du domaine personnalisé comme en-tête `cname-api-key`. +- Le certificat client comme en-tête `client-certificate`. +- Le statut de vérification de l'autorité de certification du certificat client comme en-tête `client-certificate-ca-verified`. Pour plus d'informations, veuillez consulter [Transférer la demande](https://auth0.com/docs/get-started/applications/configure-mtls/set-up-the-customer-edge#forward-the-request-). + +Pour en savoir plus sur cette fonctionnalité, veuillez consulter [Authentifier avec mTLS](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authenticate-with-mtls). + +## Paramètres + +Pour les requêtes GET, tous les paramètres qui ne sont pas indiqués comme segments dans le chemin peuvent être transmis sous forme de paramètres dans la chaîne de requête HTTP : + +`GET https://{yourDomain}/some-endpoint?param=value¶m=value` + +Pour les requêtes POST, les paramètres non inclus dans l'URL doivent être codés en JSON avec un type de contenu de `application/json` : + +`curl --request POST --url 'https://{yourDomain}/some-endpoint' --header 'content-type: application/json' --data '{"param": "value", "param": "value"}'` + + +Une exception à cette règle est le [SAML IdP-Initiated Single Sign-on (SSO) Flow (Flux d'authentification unique (SSO) initié par l'IdP SAML)](#idp-initiated-sso-flow), qui utilise à la fois un paramètre de chaîne de requête et une valeur `x-www-form-urlencoded`. + + +## Exemples de code + +Pour chaque point de terminaison, des exemples d'extraits prêts à l'emploi vous sont proposés en trois formats différents : + +- Requête HTTP +- Commande curl +- JavaScript : en fonction du point de terminaison, chaque extrait peut utiliser la [Bibliothèque Auth0.js](https://auth0.com/docs/libraries/auth0js), code Node.js ou simplement JavaScript + +Chaque demande doit être envoyée avec un type de contenu de `application/json`. + +## Test + +Vous pouvez tester les points de terminaison à l'aide du [Débogueur Authentication API](https://auth0.com/docs/customize/extensions/authentication-api-debugger-extension). + +### Débogueur Authentication API + +Le [Débogueur Authentication API](https://auth0.com/docs/customize/extensions/authentication-api-debugger-extension) est une extension Auth0 que vous pouvez utiliser pour tester plusieurs points de terminaison d'Authentication API. + +Cliquez sur **Install Debugger (Installer le débogueur)** pour accéder à l'article qui explique le fonctionnement (vous n'avez à le faire qu'une seule fois). + +[Install Debugger (Installer le débogueur)](https://auth0.com/docs/customize/extensions/authentication-api-debugger-extension) + +**Si vous avez déjà installé l'extension, passez au débogueur d'Authentication API.** + +Le lien varie selon la région de votre locataire : Ouest des États-Unis, Europe centrale, ou Australie. Pour en savoir plus sur les régions de locataire, consultez [Créer des locataires](https://auth0.com/docs/get-started/auth0-overview/create-tenants#region-locality-and-sub-locality). + +### Configurer les connexions + +1. Dans l'onglet *Configuration*, définissez les champs **Application** (sélectionnez l'application que vous souhaitez utiliser pour le test) et **Connection (Connexion)** (le nom de la connexion sociale à utiliser). + +1. Copiez la **Callback URL** et définissez-la comme faisant partie des **Allowed Callback URLs (Callback URL autorisées)** dans vos [Application Settings (Paramètres d'application)](https://manage.auth0.com/dashboard/). + +1. Dans l'onglet *OAuth2 / OIDC*, sélectionnez **OAuth2 / OIDC Login (Connexion OAuth2 / OIDC)**. + +### Options de point de terminaison + +Configurez d'autres points de terminaison avec les options suivantes : + +- Sans mot de passe : Dans l'onglet *OAuth2 / OIDC* définissez **Username (Nom d'utilisateur)** sur le numéro de téléphone de l'utilisateur si `connection=sms`, ou sur le courriel de l'utilisateur si `connection=email`, et **Password (Mot de passe)** sur le code de vérification de l'utilisateur. Cliquez sur **Resource Owner Endpoint (Point de terminaison du propriétaire de la ressource)**. +- SAML SSO : Dans l'onglet *Other Flows (Autres flux)*, sélectionnez **SAML**. +- WS-Federation : Dans l'onglet *Other Flows (Autres flux)*, sélectionnez **WS-Federation**. +- Déconnexion : Dans l'onglet *Other Flows (Autres flux)*, sélectionnez **Logout (Déconnexion)**, ou **Logout (Federated) (Déconnexion [fédérée])** pour déconnecter également l'utilisateur du fournisseur d'identité. +- Connexion héritée : Dans l'onglet *OAuth2 / OIDC*, définissez les champs **ID Token (Jeton d'identification)**, **Refresh Token (Jeton d'actualisation)** et **Target Client ID (ID client cible)**. Cliquez sur **Delegation (Délégation)**. +- Délégation héritée : Dans l'onglet *OAuth2/ OIDC*, définissez **Username (Nom d'utilisateur)** et **Password (Mot de passe)**. Cliquez sur **Resource Owner Endpoint (Point de terminaison du propriétaire de la ressource)**. +- Propriétaire des ressources héritées : Dans l'onglet *OAuth2 / OIDC*, définissez **Username (Nom d'utilisateur)** et **Password (Mot de passe)**, puis sélectionnez **Resource Owner Endpoint (Point de terminaison du propriétaire de la ressource)**. + +### Flux d'authentification + +Configurez les flux d'authentification avec les options suivantes : + +- Flux de code d'autorisation : Dans l'onglet *OAuth2 / OIDC* définissez le champ **Authorization Code (Code d'autorisation)** sur le code que vous avez récupéré à partir de [Octroi de code d'autorisation](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authorization-code-flow), et le **Code Verifier (Vérificateur de code)** sur la clé. Cliquez sur **OAuth2 Code Exchange (Échange de codes OAuth2)**. +- Flux Code d'autorisation + PKCE : Dans l'onglet *OAuth2 / OIDC* définissez le champ **Authorization Code (Code d'autorisation)** sur le code que vous avez récupéré à partir de [Octroi de code d'autorisation](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authorization-code-flow-with-pkce), et le **Code Verifier (Vérificateur de code)** sur la clé. Cliquez sur **OAuth2 Code Exchange (Échange de codes OAuth2)**. +- Flux d'informations d'identification du client : Dans l'onglet *OAuth2 / OIDC*, sélectionnez **OAuth2 Client Credentials (Identifiants du client OAuth2)**. + +## Erreurs + +Lorsqu'une erreur se produit, vous recevrez un objet d'erreur. La majorité de ces objets d'erreur incluent un code et une description, permettant à vos applications d'identifier le problème avec davantage de précision. + +Si vous recevez un code de réponse HTTP `4xx`, vous pouvez en déduire qu'il s'agit d'une requête incorrecte de votre part. + +Les erreurs `5xx` indiquent qu'un problème existe du côté d'Auth0, donc dans ce cas, consultez la [page d'état Auth0](https://status.auth0.com/) et [@auth0status sur X](https://twitter.com/auth0status) pour déterminer l'état de vos systèmes. + +Dans tous les autres cas, vous pouvez utiliser [nos options d'assistance](#support). + +## Limite anti-attaques + +L'Authentication API est soumise à une limite anti-attaques. Les limites diffèrent en fonction du point de terminaison. + +Si vous dépassez la limite anti-attaques fournie pour un point de terminaison donné, vous recevrez la réponse `429 Too Many Requests` avec le message suivant : `Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.` + +Pour plus de détails sur la limitation anti-attaques, veuillez consulter la [Politique de limite anti-attaques de l'API Auth0](https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy). + +Veuillez noter que pour les connexions de bases de données Auth0 limite certains types de tentatives de connexion répétées selon l'adresse IP du compte utilisateur. Pour plus de détails, veuillez consulter [Limites anti-attaques pour l'authentification par utilisateur/mot de passe](https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy). + +## Assistance + +Si vous rencontrez des problèmes ou avez besoin d'aide concernant votre cas particulier, vous pouvez toujours contacter notre [Centre d'assistance](https://support.auth0.com/). + +Veuillez noter que si vous disposez d'un abonnement gratuit et que votre période d'essai de 22 jours est expirée, vous ne pourrez ni accéder ni soumettre de tickets au [Centre d'assistance](https://support.auth0.com/). Dans ce cas, vous pouvez demander de l'aide via [Communauté Auth0](https://community.auth0.com/). Pour plus d'informations sur notre programme d'assistance, veuillez consulter [Options d'assistance](https://auth0.com/docs/troubleshoot/customer-support). diff --git a/main/docs/fr-ca/api/authentication/_metadata.json b/main/docs/fr-ca/api/authentication/_metadata.json deleted file mode 100644 index bbbe30d60c..0000000000 --- a/main/docs/fr-ca/api/authentication/_metadata.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "oasVersion": "v1", - "snippetVersion": "not found" -} diff --git a/main/docs/fr-ca/api/authentication/account-linking-legacy/link.mdx b/main/docs/fr-ca/api/authentication/account-linking-legacy/link.mdx new file mode 100644 index 0000000000..73f8076e6c --- /dev/null +++ b/main/docs/fr-ca/api/authentication/account-linking-legacy/link.mdx @@ -0,0 +1,52 @@ +--- +title: "Lien" +description: "Ce point de terminaison est **déconseillé** pour l’association de compte. [POST..." +--- + +`GET /authorize` + + +Ce point de terminaison est **déconseillé** pour l’association de compte. [POST /api/v2/users//identities](/docs/fr-ca/api/authentication/api/management/v2#!/Users/post_identities) doit être utilisé à la place. Pour plus d’informations, veuillez consulter [Avis de migration](/docs/fr-ca/api/authentication/migrations/past-migrations#account-linking-removal). + + +Appelez ce point de terminaison lorsqu’un utilisateur souhaite associer une seconde méthode d’authentification, telle qu’une connexion via une base de données utilisateur/mot de passe, avec Facebook). + +Ce point de terminaison déclenchera le flux de connexion pour associer un compte existant à un nouveau. Cela renverra une redirection 302 vers la `connection` que l’utilisateur actuel souhaite ajouter. L’utilisateur est identifié par le jeton d’accès qui a été renvoyé lors de la connexion réussie. + +### Remarques[​](#remarques) + +- La valeur `redirect_uri` doit être indiquée comme une Callback URL valide dans les [paramètres de l’application](/docs/fr-ca/api/authentication/account-linking-legacy/${manage_url}/#/applications). + +### En savoir plus[​](#en-savoir-plus) + +- [Association de comptes utilisateurs](/docs/fr-ca/api/authentication/users/guides/link-user-accounts) +- [Scénario d’association de comptes utilisateurs initiés par les utilisateurs](/docs/fr-ca/api/authentication/users/references/link-accounts-user-initiated-scenario) +- [Scénario d’association de comptes utilisateurs côté serveur](/docs/fr-ca/api/authentication/users/references/link-accounts-server-side-scenario) + +## Parameters + + + Utilisez `code` pour les flux côté serveur et `token` pour les flux côté client. + + + + `client_id` de votre application. + + + + Le nom de la connexion configurée pour votre application. Si la valeur est « null », la redirection se fera vers la [page de connexion Auth0](https://auth0.com/#/login_page) et le gadget logiciel de connexion sera affiché avec la première connexion à la base de données. + + + + L’URL vers laquelle Auth0 redirigera le navigateur après avoir obtenu l’autorisation de l’utilisateur. + + + + Le jeton d’accès de l’utilisateur connecté. + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | Redirection vers la connexion pour associer les comptes | diff --git a/main/docs/fr-ca/api/authentication/account-linking-legacy/unlink.mdx b/main/docs/fr-ca/api/authentication/account-linking-legacy/unlink.mdx index 8271a6d408..2208c9f25a 100644 --- a/main/docs/fr-ca/api/authentication/account-linking-legacy/unlink.mdx +++ b/main/docs/fr-ca/api/authentication/account-linking-legacy/unlink.mdx @@ -1,11 +1,22 @@ --- -openapi: authentication-api-oas post /login/unlink -playground: simple -deprecated: true +title: "Dissocier" +description: "Ce point de terminaison est **déconseillé**. [DELETE..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /login/unlink` - - \ No newline at end of file + +Ce point de terminaison est **déconseillé**. [DELETE /api/v2/users/{id}/identities/{provider}/{user_id}](/docs/fr-ca/api/authentication/api/management/v2#!/Users/delete_user_identity_by_user_id) doit être utilisé à la place. + + +Étant donné le `access_token` et l’`user_id` de l’utilisateur connecté, ce point de terminaison dissociera le compte d’un utilisateur du fournisseur d’identité. + +### Pour en savoir plus[​](#pour-en-savoir-plus) + +- [Dissocier les comptes utilisateurs](/docs/fr-ca/api/authentication/users/guides/unlink-user-accounts) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réussite de la dissociation de comptes utilisateurs | diff --git a/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize.mdx b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize.mdx new file mode 100644 index 0000000000..63c5deea9d --- /dev/null +++ b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize.mdx @@ -0,0 +1,28 @@ +--- +title: "Autoriser" +description: "Après avoir appelé le point de terminaison `/oauth/par`, redirigez l’utilisateur final vers le point de terminaison `/authorize` à l’aide d’un appel `GET`." +--- + +`GET /authorize` + +Après avoir appelé le point de terminaison `/oauth/par`, redirigez l’utilisateur final vers le point de terminaison `/authorize` à l’aide d’un appel `GET`. + + +Le point de terminaison `/authorize` répondra en fonction des paramètres transmis au point de terminaison `/oauth/par`. Si vous demandez un `response_type`, vous devriez recevoir un code d’autorisation à utiliser au point de terminaison `/oauth/token`. + + +## Parameters + + + `client_id` de votre application. Obligatoire. + + + + La valeur `request_uri` reçue du point de terminaison `/oauth/par`. Obligatoire. + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | Redirige vers l’URI de redirection spécifié. | diff --git a/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token.mdx b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token.mdx new file mode 100644 index 0000000000..ab24173c8f --- /dev/null +++ b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token.mdx @@ -0,0 +1,44 @@ +--- +title: "Échanger le code d’autorisation pour le jeton" +description: "Lorsque les utilisateurs sont redirigés vers votre rappel, vous devez effectuer un appel `POST` au point de terminaison `oauth/token`, pour échanger un code..." +--- + +`POST /oauth/token` + +Lorsque les utilisateurs sont redirigés vers votre rappel, vous devez effectuer un appel `POST` au point de terminaison `oauth/token`, pour échanger un code d’autorisation contre un jeton d’accès et/ou d’identification. + +### Remarques[​](#remarques) + +Pour appeler le point de terminaison `/oauth/token`, vous devez : + +- Définir le type de contenu de la demande comme `application/x-www-form-urlencoded` +- Utiliser `strings` pour tous les paramètres passés +- Inclure un paramètre supplémentaire pour l’authentification de l’application dans la demande (p. ex., `client_secret`, ou `client_assertion` et `client_assertion_type` pour l’authentification du client JSON Web Token, ou passer un `client-certificate` et un en-tête `client-certificate-ca-verified` lors de l’utilisation de Mutual TLS). + +## Parameters + + + Indique le flux; utiliser ’authorization_code’ avec un code d’autorisation valide. + + + + Le code d’autorisation de l’appel `/authorize` initial. + + + + `client_id` de votre application. Obligatoire. + + + + Cette option est requise uniquement si elle a été définie au point de terminaison `GET` `/oauth/par`. + + + + Clé aléatoire cryptographique utilisée pour générer le `code_challenge`. Recommandé si `code_challenge` a été fourni. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réponse réussie contenant les jetons. | diff --git a/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests.mdx b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests.mdx new file mode 100644 index 0000000000..91140ad280 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests.mdx @@ -0,0 +1,83 @@ +--- +title: "Demandes d’autorisation poussées (PAR)" +description: "Pour utiliser les fonctionnalités Identité très réglementée (HRI), vous devez disposer d’un plan Entreprise avec le module complémentaire Identité très..." +--- + +`POST /oauth/par` + + +Pour utiliser les fonctionnalités Identité très réglementée (HRI), vous devez disposer d’un plan Entreprise avec le module complémentaire Identité très réglementée. Consultez [Tarification Auth0](https://auth0.com/pricing) pour les détails. + + +Le flux de code d’autorisation avec [demandes d’autorisation poussées (PAR)](/docs/fr-ca/api/authentication/get-started/authentication-and-authorization-flow/authorization-code-flow/authorization-code-flow-with-par) utilise le point de terminaison `/oauth/par` pour permettre aux applications d’envoyer les paramètres d’autorisation généralement envoyés dans une demande `GET` à `/authorize`. PAR utilise une méthode POST du programme dorsal pour sécuriser les valeurs des paramètres. Le point de terminaison `/oauth/par` accepte tous les paramètres d’autorisation qui peuvent être fournis à `/authorize`. En supposant que l’appel au point de terminaison `/oauth/par` est valide, Auth0 répondra avec une valeur `redirect_uri` qui peut être utilisée comme paramètre pour le point de terminaison `/authorize`. + +En supposant que l’appel au point de terminaison `/oauth/par` est valide, Auth0 répondra avec une valeur `redirect_uri` également utilisée comme paramètre pour le point de terminaison `/authorize`. Pour en savoir plus sur la configuration de PAR, lisez [Configurer les demandes d’autorisation poussées (PAR)](/docs/fr-ca/api/authentication/get-started/applications/configure-par). + +### Remarques[​](#remarques) + +Pour appeler le point de terminaison PAR, vous devez : +- Définir le type de contenu de la demande comme `application/x-www-form-urlencoded` +- Utiliser `strings` pour tous les paramètres passés +- Inclure un paramètre supplémentaire pour l’authentification de l’application dans la demande (p. ex., `client_secret`, ou `client_assertion` et `client_assertion_type` pour l’authentification du client JSON Web Token, ou passer un `client-certificate` et un en-tête `client-certificate-ca-verified` lors de l’utilisation de Mutual TLS). + +- Utiliser le `authorization_details` paramètre pour demander l’autorisation de chaque ressource. Par exemple, vous pouvez préciser un tableau d’objets JSON pour transmettre des informations détaillées sur l’autorisation. Chaque objet JSON doit contenir un attribut `type`. C’est à vous de définir le reste. + +## Parameters + + + Autorisations demandées pour chaque ressource, semblables aux permissions. + + + + L’identifiant unique de l’API cible à laquelle vous souhaitez accéder. + + + + Précise le type de jeton, par exemple ’code’ ou ’code id_token’. Obligatoire. + + + + `client_id` de votre application. Obligatoire. + + + + L’URL vers laquelle Auth0 redirigera après l’autorisation. Obligatoire. + + + + Une valeur opaque utilisée pour prévenir les attaques CSRF. Recommandé. + + + + Permissions OIDC et permissions API personnalisées. Recommandé. + + + + Défi-réponse généré par `code_verifier`. Recommandé. + + + + Méthode utilisée pour générer le défi-réponse, généralement ’S256’. Recommandé. + + + + Utilisé pour empêcher les attaques par réinsertion de jetons. Recommandé pour `response_type=id_token`. + + + + Le nom de la connexion configurée pour votre application. + + + + Utilisé pour forcer une invite particulière, par exemple, `prompt=consent`. + + + + Identifiant de l’organization à utiliser pour authentifier un utilisateur. + + +## Response + +| Status | Description | +|--------|-------------| +| 201 | Demande réussie; renvoie l’URI de la demande et le délai d’expiration. | diff --git a/main/docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce.mdx b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce.mdx new file mode 100644 index 0000000000..c081bd502d --- /dev/null +++ b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce.mdx @@ -0,0 +1,52 @@ +--- +title: "Autoriser" +description: "Il s'agit de la licence OAuth 2.0 que les applications mobiles utilisent pour accéder à une API." +--- + +`GET /authorize` + +Il s'agit de la licence OAuth 2.0 que les applications mobiles utilisent pour accéder à une API. Avant de commencer ce flux, vous devez générer et stocker un `code_verifier` et, à l'aide de celui-ci, générer un `code_challenge` qui sera envoyé dans la demande d'autorisation. + +## Paramètres + + + L'identifiant unique de l'API cible à laquelle vous souhaitez accéder. + + + + Indique le type de réponse attendu. Utilisez `code`. + + Valeurs autorisées : `code` + + + + Le `client_id` de votre application. + + + + La méthode utilisée pour générer le `code_challenge`. Utilisez `S256`. + + Valeurs autorisées : `S256` + + + + Le `code_challenge` généré à partir du `code_verifier`. + + + + L'URL vers laquelle Auth0 redirigera le navigateur après l'autorisation. + + + + Les permissions demandées. Utilisez des espaces pour séparer les valeurs. + + + + Valeur opaque pour prévenir les attaques CSRF. + + +## Réponse + +| Statut | Description | +|--------|-------------| +| 302 | Rediriger vers le `redirect_uri` indiqué après l'autorisation. | diff --git a/main/docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/get-token-pkce.mdx b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/get-token-pkce.mdx new file mode 100644 index 0000000000..19ea074eae --- /dev/null +++ b/main/docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/get-token-pkce.mdx @@ -0,0 +1,50 @@ +--- +title: "Obtenir un jeton" +description: "Il s’agit du flux que les applications mobiles utilisent pour accéder à une API. Utilisez ce point de terminaison pour échanger un code d’autorisation contre..." +--- + +`POST /oauth/token` + +Il s’agit du flux que les applications mobiles utilisent pour accéder à une API. Utilisez ce point de terminaison pour échanger un code d’autorisation contre un jeton. + +### Remarque[​](#remarque) + +- Afin d’améliorer la compatibilité des applications, Auth0 renvoie maintenant les informations de profil dans un format de demande structuré tel que défini par la spécification OIDC. Cela signifie que pour ajouter des demandes personnalisées aux jetons d’identification ou aux jetons d’accès, ils doivent être conformes à un format à espace de noms afin d’éviter les collisions possibles avec les demandes OIDC standard. +- Inclure `offline_access` au paramètre de demande `scope` pour obtenir un jeton d’actualisation à partir de POST /oauth/token. Assurez-vous que le champ Allow Offline Access (Autoriser l’accès hors connexion) est activé dans les paramètres de l’API. +- La valeur `redirect_uri` doit être indiquée comme étant une Callback URL valide dans les paramètres de votre application. +- L’authentification silencieuse vous permet ainsi d’exécuter un flux d’authentification où Auth0 répondra uniquement par des redirections, et jamais par une page de connexion. Lorsqu’un jeton d’accès a expiré, l’authentification silencieuse peut être utilisée pour en récupérer un nouveau sans interaction avec l’utilisateur, à condition que la session d’authentification unique (SSO) de l’utilisateur n’ait pas expiré. + +### En savoir plus[​](#en-savoir-plus) + +- [Flux de code d’autorisation avec Proof Key for Code Exchange (PKCE)](/docs/fr-ca/api/authentication/flows/concepts/auth-code-pkce) +- [Appeler l’API à l’aide du flux de code d’autorisation avec PKCE](/docs/fr-ca/api/authentication/flows/guides/auth-code-pkce/call-api-auth-code-pkce) +- [Authentification silencieuse](/docs/fr-ca/api/authentication/api-auth/tutorials/silent-authentication) + +## Parameters + + + Indique le flux que vous utilisez. Pour le code d’autorisation (PKCE), utilisez ’authorization_code’. + + + + L’identifiant client de votre application. + + + + Le code d’autorisation reçu de l’appel initial/d’autorisation. + + + + Clé aléatoire cryptographique utilisée pour générer le code code_challenge passé à /authorize. + + + + Cette option n’est requise que si elle a été définie au point de terminaison GET /authorize endpoint. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Échange de jetons réussi. | +| default | Erreur inattendue | diff --git a/main/docs/fr-ca/api/authentication/authorization-code-flow/authorize-application.mdx b/main/docs/fr-ca/api/authentication/authorization-code-flow/authorize-application.mdx new file mode 100644 index 0000000000..eb9e71ec97 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/authorization-code-flow/authorize-application.mdx @@ -0,0 +1,68 @@ +--- +title: "Autoriser l’application" +description: "Pour commencer un flux d’autorisation OAuth 2.0, votre application doit d’abord diriger l’utilisateur vers l’URL d’autorisation." +--- + +`GET /authorize` + +Pour commencer un flux d’autorisation OAuth 2.0, votre application doit d’abord diriger l’utilisateur vers l’URL d’autorisation. +Autoriser le point de terminaison[​](#autoriser-le-point-de-terminaison) +Le but de cet appel est d’obtenir le consentement de l’utilisateur pour invoquer l’API (indiquée dans `audience`) et faire certaines choses (indiquées dans `scope`) au nom de l’utilisateur. Auth0 authentifiera l’utilisateur et obtiendra son consentement, sauf si le consentement a été donné au préalable. Si vous modifiez la valeur dans `scope`, Auth0 exigera un nouveau consentement. + +Les flux OAuth 2.0 qui nécessitent une autorisation de l’utilisateur sont : + +- [Flux de code d’autorisation](/docs/fr-ca/api/authentication/flows/concepts/auth-code) +- [Flux de Code d’autorisation avec Proof Key for Code Exchange (PKCE)](/docs/fr-ca/api/authentication/flows/concepts/auth-code-pkce) +- [Flux implicite](/docs/fr-ca/api/authentication/flows/concepts/implicit) + +L’[autorisation par mot de passe du propriétaire de la ressource](/docs/fr-ca/api/authentication/api-auth/grant/password) et le [flux des identifiants client](/docs/fr-ca/api/authentication/flows/concepts/client-credentials) n’utilisent pas ce point de terminaison, car il n’y a aucune autorisation utilisateur. Au lieu de cela, ils appellent directement le point de terminaison `POST /oauth/token` pour récupérer un jeton d’accès . + +Selon le flux OAuth 2.0 que vous mettez en œuvre, les paramètres changent légèrement. Pour déterminer le flux qui convient le mieux à votre cas, consultez : [Quel flux OAuth 2.0 dois-je utiliser?](/docs/fr-ca/api/authentication/api-auth/which-oauth-flow-to-use). + +## Parameters + + + Identifiant unique facultatif de l’API cible pour les jetons d’accès. + + + + Les [permissions](/docs/fr-ca/api/authentication/scopes) pour lesquelles vous voulez demander l’autorisation. Elles doivent être séparées par un espace. Vous pouvez demander l’une des permissions [standard OpenID Connect (OIDC)](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) au sujet des utilisateurs, comme le `profile` et le `email`, [demandes personnalisées](/docs/fr-ca/api/authentication/authorization-code-flow/tokens/concepts/jwt-claims#custom-claims) conformes à un [format avec espace de noms](/docs/fr-ca/api/authentication/tokens/guides/create-namespaced-custom-claims), ou toute permission prise en charge par l’API cible (p. ex., `read:contacts`). Inclure `offline_access` pour obtenir un Jeton d’actualisation . + + + + Indique à Auth0 le flux OAuth 2.0 que vous souhaitez exécuter. Utiliser ’code’ pour le flux d’octroi de code d’autorisation. + + + + L’identifiant client de votre application. + + + + L’URL vers laquelle Auth0 redirigera après l’autorisation. Obligatoire. + + + + Une valeur opaque que l’application ajoute à la demande initiale et que le serveur d’autorisations inclut lorsqu’il redirige la demande vers l’application. Cette valeur doit être utilisée par l’application pour prévenir les attaques CSRF. + + + + Le nom de la base de données configurée pour votre client. + + + + Pour initier une demande d’authentification silencieuse, utilisez ’prompt=none’. + + + + ID de l’organisation à utiliser pour authentifier un utilisateur. Lorsqu’il n’est pas fourni, si votre application est configurée pour **Afficher l’invite de l’organisation**, l’utilisateur pourra entrer le nom de l’organisation lors de l’authentification. + + + + Identifiant de billet de l’invitation d’organisation. Au moment d'[inviter un membre à une organisation](/docs/fr-ca/api/authentication/organizations/invite-members), votre application doit traiter l’acceptation de l’invitation en transmettant les paires clé-valeur `invitation` et `organization` lorsque l’utilisateur accepte l’invitation. + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | Redirection avec code d’autorisation | diff --git a/main/docs/fr-ca/api/authentication/authorization-code-flow/get-token.mdx b/main/docs/fr-ca/api/authentication/authorization-code-flow/get-token.mdx new file mode 100644 index 0000000000..ae0b6323d4 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/authorization-code-flow/get-token.mdx @@ -0,0 +1,46 @@ +--- +title: "Obtenir un jeton" +description: "Pour l’authentification basée sur des jetons, utilisez le point de terminaison `oauth/token` pour obtenir un jeton d’accès pour que votre application effectue..." +--- + +`POST /oauth/token` + +Pour l’authentification basée sur des jetons, utilisez le point de terminaison `oauth/token` pour obtenir un jeton d’accès pour que votre application effectue des appels authentifiés à une API sécurisée. Vous pouvez également récupérer un jeton d’identification et un jeton d’actualisation. Les jetons d’ID contiennent des informations sur l’utilisateur sous forme de permissions que l’application peut extraire pour offrir une meilleure expérience utilisateur. Les jetons d’actualisation permettent à votre application de demander un nouveau jeton d’accès une fois que le jeton actuel expire sans interrompre l’expérience utilisateur. Pour en savoir plus, veuillez consulter [Jetons d’ID](https://auth0.com/docs/secure/tokens/id-tokens) et [Jetons d’actualisation](https://auth0.com/docs/secure/tokens/refresh-tokens). + +Notez que les seuls flux OAuth 2.0 qui peuvent récupérer un jeton d’actualisation sont : + +- [Flux de code d’autorisation (Code d’autorisation)](/docs/fr-ca/api/authentication/flows/concepts/auth-code) +- [Flux de code d’autorisation avec PKCE (Code d’autorisation avec PKCE)](/docs/fr-ca/api/authentication/flows/concepts/auth-code-pkce) +- [Mot de passe du propriétaire de la ressource](/docs/fr-ca/api/authentication/api-auth/grant/password) +- [Flux d’autorisation de l’appareil](/docs/fr-ca/api/authentication/flows/concepts/device-auth) +- Échange de jetons* + +C’est le flux que les applications Web utilisent pour accéder à une API. Utilisez ce point de terminaison pour échanger un code d’autorisation contre un jeton. + +## Parameters + + + Indique le flux que vous utilisez. Comme code d’autorisation, utilisez `authorization_code`. + + + + L’identifiant client de votre application. + + + + Le secret client de votre application. + + + + Le code d’autorisation reçu lors de l’appel initial `/authorize`. + + + + Cette option est requise uniquement si elle a été définie au point de terminaison [GET /authorize](#authorization-code-grant). Les valeurs de `/authorize` doivent correspondre à la valeur que vous avez définie à `/oauth/token`. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Récupération réussie du jeton | diff --git a/main/docs/fr-ca/api/authentication/authorization/authorization-endpoint.mdx b/main/docs/fr-ca/api/authentication/authorization/authorization-endpoint.mdx deleted file mode 100644 index 0dad1190c8..0000000000 --- a/main/docs/fr-ca/api/authentication/authorization/authorization-endpoint.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /authorize -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/authorization/back-channel-login.mdx b/main/docs/fr-ca/api/authentication/authorization/back-channel-login.mdx deleted file mode 100644 index 6d7948f9da..0000000000 --- a/main/docs/fr-ca/api/authentication/authorization/back-channel-login.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /bc-authorize -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/change-password/change-password.mdx b/main/docs/fr-ca/api/authentication/change-password/change-password.mdx new file mode 100644 index 0000000000..c2f1ff0cf1 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/change-password/change-password.mdx @@ -0,0 +1,53 @@ +--- +title: "Modifier le mot de passe" +description: "Envoyez un courriel de modification du mot de passe à l’adresse courriel fournie par l’utilisateur et à `connection`." +--- + +`POST /dbconnections/change_password` + +Envoyez un courriel de modification du mot de passe à l’adresse courriel fournie par l’utilisateur et à `connection`. + +Vous pouvez éventuellement fournir un identifiant d’organisation pour prendre en charge les variables propres à l’organisation dans les [modèles de courriel personnalisés](/docs/fr-ca/api/authentication/customize/email/email-templates#common-variables) et pour inclure les paramètres `organization_id` et `organization_name` dans l’URL **Rediriger vers** . + +**Remarque :** Ce point de terminaison fonctionne uniquement pour les connexions de base de données. + +### Remarques[​](#remarques) + +- Lorsque l’utilisateur clique sur le lien de modification de mot de passe, il est redirigé vers une page qui lui demande un nouveau mot de passe. +Ce point de terminaison renverra trois en-têtes de réponse HTTP, qui fournissent des données pertinentes sur ses limites anti-attaques : +- `X-RateLimit-Limit`: Nombre de requêtes autorisées par minute. +- `X-RateLimit-Remaining`: Nombre de requêtes disponibles. Chaque nouvelle requête réduit ce nombre de 1. Le nombre de requêtes est de nouveau augmenté après chaque minute qui passe, de sorte que ce nombre augmente de 1 à chaque fois. +- `X-RateLimit-Reset`: Temps restant avant la réinitialisation de la limite anti-attaques (`X-RateLimit-Limit`). La valeur est exprimée en [secondes au format UTC](https://en.wikipedia.org/wiki/Unix_time). + +### En savoir plus[​](#en-savoir-plus) + +- [Modification du mot de passe d’un utilisateur](/docs/fr-ca/api/authentication/connections/database/password-change) +- [Niveau de sécurité du mot de passe dans les connexions de base de données Auth0](/docs/fr-ca/api/authentication/connections/database/password-strength) +- [Options de mot de passe dans les connexions de base de données Auth0](/docs/fr-ca/api/authentication/connections/database/password-options) +- [Politique de limite anti-attaques de l’API Auth0](/docs/fr-ca/api/authentication/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations) + +## Parameters + + + Le `client_id` de votre client. + + + + L’adresse courriel de l’utilisateur. + + + + Nom de la connexion à la base de données configurée pour votre client. + + + + `organization_id` de l’organisation associée à l’utilisateur. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Un courriel de modification du mot de passe a été envoyé. | +| 400 | Mauvaise requête, paramètres manquants ou non valides. | +| 404 | Utilisateur introuvable. | diff --git a/main/docs/fr-ca/api/authentication/client-credential-flow/get-token.mdx b/main/docs/fr-ca/api/authentication/client-credential-flow/get-token.mdx new file mode 100644 index 0000000000..ac4bce1362 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/client-credential-flow/get-token.mdx @@ -0,0 +1,49 @@ +--- +title: "Obtenir un jeton" +description: "Il s’agit de l’autorisation OAuth 2.0 que les processus du serveur utilisent pour accéder à une API. Utilisez ce point de terminaison pour demander directement..." +--- + +`POST /oauth/token` + +Il s’agit de l’autorisation OAuth 2.0 que les processus du serveur utilisent pour accéder à une API. Utilisez ce point de terminaison pour demander directement un jeton d’accès à l’aide des informations d’identification de l’application (un ID client et un secret client). + +### Réponses[​](#réponses) + +#### 200[​](#200) + +Une réponse réussie renvoie un jeton d’accès. +{ "access_token":"eyJz93a...k4laUWw", "token_type":"Bearer", "expires_in":86400} +### En savoir plus[​](#en-savoir-plus) + +- [Flux des identifiants client](/docs/fr-ca/api/authentication/flows/concepts/client-credentials) +- [Appeler l’API en utilisant le flux des identifiants client](/docs/fr-ca/api/authentication/flows/guides/client-credentials/call-api-client-credentials) +- [Configuration d’un octroi client à l’aide de Management Dashboard](/docs/fr-ca/api/authentication/api-auth/config/using-the-auth0-dashboard) +- [Demande de jetons d’accès pour un octroi d’identifiants client](/docs/fr-ca/api/authentication/api-auth/config/asking-for-access-tokens) + +## Parameters + + + Indique le flux que vous utilisez. Pour les identifiants client, utiliser `client_credentials`. + + + + L’identifiant client de votre application. + + + + Le secret client de votre application. + + + + L’identifiant unique de l’API cible à laquelle vous souhaitez accéder. + + + + [Recommandé]L’organization ou l’identifiant auquel vous souhaitez associer la demande. Pour en savoir plus, consultez [Accès entre machines pour organizations](https://auth0.com/docs/manage-users/organizations/organizations-for-m2m-applications). + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réponse correcte | diff --git a/main/docs/fr-ca/api/authentication/custom-token-exchange/get-token.mdx b/main/docs/fr-ca/api/authentication/custom-token-exchange/get-token.mdx new file mode 100644 index 0000000000..d377d4b62a --- /dev/null +++ b/main/docs/fr-ca/api/authentication/custom-token-exchange/get-token.mdx @@ -0,0 +1,73 @@ +--- +title: "Get Token" +description: "Custom Token Exchange (CTE) provides a mechanism for applications to exchange pre-existing identity tokens for Auth0 tokens by invoking the /oauth/token endpoint." +--- + +`POST /oauth/token` + +Custom Token Exchange (CTE) provides a mechanism for applications to exchange pre-existing identity tokens for Auth0 tokens by invoking the `/oauth/token` endpoint, adhering to the specifications of [RFC 8693](https://datatracker.ietf.org/doc/html/rfc8693). This functionality is instrumental in addressing advanced integration requirements, such as exchanging existing Auth0 tokens to access another audience on behalf of the same user, facilitating the integration of external identity providers, or enabling seamless user migration into the Auth0 platform. The exchange process is fully governable, as developers can control its details using their custom logic running in a dedicated Auth0 Action for the associated use case. + + +Custom Token Exchange is currently available in Early Access. By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's `subject_token`. See the [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details. + + +### Remarks + - The scopes issued to the application may differ from the scopes requested. In this case, a scope parameter will be included in the response JSON. Scopes are filtered out as explained in [API Access Policies for Applications](https://auth0.com/docs/get-started/apis/api-access-policies-for-applications) + + - The `subject_token_type` must correspond to an existing Custom Token Exchange Profile and an associated [Action](https://auth0.com/docs/customize/actions). + + - For non-confidential applications that cannot keep the Client Secret safe (for example, native apps), the endpoint supports passing no Client Secret but the application itself must have the property `tokenEndpointAuthMethod` set to `none`. You can do this either from the UI (**Dashboard > Applications > Application Settings**) or using the Management API. + + - You have to [Enable Custom Token Exchange for your application](https://auth0.com/docs/authenticate/custom-token-exchange/configure-custom-token-exchange#enable-custom-token-exchange-for-your-application). To learn more, read the [Custom Token Exchange documentation](https://auth0.com/docs/authenticate/custom-token-exchange). + +## Parameters + + + A DPoP proof for the request. This is optional and only required if your application uses Demonstrating Proof-of-Possession. + + + + End-user IP as a string value. Set this if you want Suspicious IP Throttling protection to work in server-side scenarios. + + +## Request Body + + + Denotes the flow you are using. For Custom Token Exchange, use `urn:ietf:params:oauth:grant-type:token-exchange`. + + Allowed values: `urn:ietf:params:oauth:grant-type:token-exchange` + + + + The type of the subject token. For Custom Token Exchange, this can be any URI scoped under your own ownership, such as `http://acme.com/legacy-token` or `urn:acme:legacy-token`. The following namespaces are reserved and cannot be used: `http://auth0.com`, `https://auth0.com`, `http://okta.com`, `https://okta.com`, `urn:ietf`, `urn:auth0`, `urn:okta`. + + + + The subject token, which your action should validate and use to identify the user. + + + + Your application's Client ID. As for other grant types, you can also pass the client ID in the Authorization header using HTTP Basic Auth. + + + + Your application's Client Secret. As for other grant types, you can also pass the client secret in the Authorization header using HTTP Basic Auth. Because Custom Token Exchange can be used by public applications, read [Attack Protection](https://auth0.com/docs/authenticate/custom-token-exchange/cte-attack-protection) to implement additional security. + + + + The unique identifier of the target API you want to access. The default tenant audience will be used when not present, as configured in [Tenant Settings](https://auth0.com/docs/get-started/tenant-settings). + + + + The OAuth2 scope parameter. + + + + The organization or identifier with which you want the request to be associated. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Successful response | diff --git a/main/docs/fr-ca/api/authentication/database-connections/request-password-change.mdx b/main/docs/fr-ca/api/authentication/database-connections/request-password-change.mdx deleted file mode 100644 index e2e64ede96..0000000000 --- a/main/docs/fr-ca/api/authentication/database-connections/request-password-change.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /dbconnections/change_password -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/database-connections/sign-up-user.mdx b/main/docs/fr-ca/api/authentication/database-connections/sign-up-user.mdx deleted file mode 100644 index 60eb4cbb2c..0000000000 --- a/main/docs/fr-ca/api/authentication/database-connections/sign-up-user.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /dbconnections/signup -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/delegation-legacy/delegation.mdx b/main/docs/fr-ca/api/authentication/delegation-legacy/delegation.mdx new file mode 100644 index 0000000000..30ecb317fe --- /dev/null +++ b/main/docs/fr-ca/api/authentication/delegation-legacy/delegation.mdx @@ -0,0 +1,45 @@ +--- +title: "Délégation" +description: "Par défaut, cette fonctionnalité est désactivée pour les locataires sans module complémentaire en cours d’utilisation depuis le 8 juin 2017. Les anciens..." +--- + +`POST /delegation` + + +Par défaut, cette fonctionnalité est désactivée pour les locataires sans module complémentaire en cours d’utilisation depuis le 8 juin 2017. Les anciens locataires qui utilisent actuellement un module complémentaire nécessitant une délégation peuvent continuer à utiliser cette fonction. Si la fonctionnalité de délégation est modifiée ou supprimée à un moment donné, les clients qui l’utilisent seront informés à l’avance et disposeront d’un délai suffisant pour migrer. + + +Un jeton de délégation peut être généré et utilisé lorsqu’une application doit appeler l’API d’un module complémentaire, tel que Firebase ou SAP, enregistré et configuré dans Auth0 au sein du même locataire que l’application appelante. + +Si un jeton existe déjà, ce point de terminaison génère un nouveau jeton signé avec le secret de l’application `target`. Ce jeton est utilisé pour transmettre l’identité de l’utilisateur de l’application à une API. + +### Remarques[​](#remarques) + +- +La valeur de permission `profile` demande l’accès aux réclamations de profil par défaut de l’utilisateur final, qui sont : `name`, `family_name`, `given_name`, `middle_name`, `nickname`, `preferred_username`, `profile`, `picture`, `website`, `gender`, `birthdate`, `zoneinfo`, `locale` et `updated_at`. + +- +La valeur de permission `email` demande l’accès aux demandes `email` et `email_verified`. + +- +La délégation n’est **pas prise en charge** dans la version 8 de [auth0.js](/docs/fr-ca/api/authentication/libraries/auth0js). Pour un échantillon de la version 7 de la bibliothèque, veuillez consulter [Demande de jeton de délégation](/docs/fr-ca/api/authentication/libraries/auth0js/v7#delegation-token-request). + +- +Ce point de terminaison a une limite de 10 requêtes par minute provenant de la même adresse IP avec le même `user_id`. + +Ce point de terminaison renverra trois en-têtes de réponse HTTP, qui fournissent des données pertinentes sur ses limites anti-attaques : + +- `X-RateLimit-Limit` : Nombre de requêtes autorisées par minute. +- `X-RateLimit-Remaining` : Nombre de requêtes disponibles. Chaque nouvelle requête réduit ce nombre de 1. Le nombre de requêtes est de nouveau augmenté après chaque minute qui passe, de sorte que ce nombre augmente de 1 à chaque fois. +- `X-RateLimit-Reset` : Temps restant avant la réinitialisation de la limite anti-attaques (`X-RateLimit-Limit`). La valeur est exprimée en [secondes au format UTC](https://en.wikipedia.org/wiki/Unix_time). + +### En savoir plus[​](#en-savoir-plus) + +- [Jetons de délégation](/docs/fr-ca/api/authentication/tokens/delegation) +- [Politique de limite anti-attaques de l’API Auth0](/docs/fr-ca/api/authentication/policies/rate-limits) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réussite de la récupération du jeton de délégation | diff --git a/main/docs/fr-ca/api/authentication/delegation-legacy/get-delegation-token-legacy.mdx b/main/docs/fr-ca/api/authentication/delegation-legacy/get-delegation-token-legacy.mdx deleted file mode 100644 index 6c4b7a7298..0000000000 --- a/main/docs/fr-ca/api/authentication/delegation-legacy/get-delegation-token-legacy.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /delegation -playground: simple -deprecated: true ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/device-authorization-flow/authorize-device.mdx b/main/docs/fr-ca/api/authentication/device-authorization-flow/authorize-device.mdx new file mode 100644 index 0000000000..f968af0e92 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/device-authorization-flow/authorize-device.mdx @@ -0,0 +1,64 @@ +--- +title: "Autoriser l’appareil" +description: "Ce flux est conçu pour que les appareils à contraintes d’entrée puissent accéder à une API. Ce point de terminaison permet d’obtenir un code d’appareil qui..." +--- + +`POST /oauth/device/code` + +Ce flux est conçu pour que les appareils à contraintes d’entrée puissent accéder à une API. Ce point de terminaison permet d’obtenir un code d’appareil qui permet à l’utilisateur d’autoriser l’appareil. +Exemple de réponse[​](#exemple-de-réponse)POST https://${account.namespace}/oauth/device/codeContent-Type: application/x-www-form-urlencodedclient_id=${account.clientId}&scope=SCOPE&audience=API_IDENTIFIER +### Valeurs de réponse[​](#valeurs-de-réponse) +ValeurDescription`device_code`Le code unique de l’appareil.`user_code`Code que l’utilisateur doit saisir pour autoriser l’appareil.`verification_uri`URL que l’utilisateur doit visiter pour autoriser l’appareil.`verification_uri_complete`L’URL complète, y compris le code d’utilisateur, pour faciliter l’accès.`expires_in`La durée de vie des codes de l’appareil et de l’utilisateur en secondes.`interval`Intervalle d’interrogation en secondes pour demander un jeton. +### Remarques[​](#remarques) + +- Ajoutez `offline_access` à `scope` pour obtenir un jeton d’actualisation. +- Utilisez le code de l’appareil renvoyé pour demander un jeton d’accès au point de terminaison du jeton. + +### Exemple de demande de jeton[​](#exemple-de-demande-de-jeton) +POST https://${account.namespace}/oauth/tokenContent-Type: application/x-www-form-urlencodedclient_id=${account.clientId}&device_code=YOUR_DEVICE_CODE&grant_type=urn:ietf:params:oauth:grant-type:device_code +### Réponses[​](#réponses) + +#### 200[​](#200) + +Une demande réussie renvoie un jeton d’accès. +HTTP/1.1 200 OKContent-Type: application/json{ "access_token": "eyJz93a...k4laUWw", "id_token": "eyJ...0NE", "refresh_token": "eyJ...MoQ", "expires_in": 86400, "token_type": "Bearer"} +### Réponses d’erreur[​](#réponses-derreur) +HTTP/1.1 403 ForbiddenContent-Type: application/json{ "error": "authorization_pending", "error_description": "User has yet to authorize device code." }``````jsonHTTP/1.1 429 Too Many RequestsContent-Type: application/json{ "error": "slow_down", "error_description": "You are polling faster than the specified interval of 5 seconds." }``````jsonHTTP/1.1 403 ForbiddenContent-Type: application/json{ "error": "access_denied", "error_description": "User cancelled the confirmation prompt." } +### En savoir plus[​](#en-savoir-plus) + +- [Flux d’autorisation d’appareil](/docs/fr-ca/api/authentication/flows/concepts/device-auth) +- [Appel d’API en utilisant le flux d’autorisation d’appareil](/docs/fr-ca/api/authentication/flows/guides/device-auth/call-api-device-auth) +- [Configuration de l’octroi d’un code d’appareil à l’aide de Management Dashboard](/docs/fr-ca/api/authentication/api-auth/config/using-the-auth0-dashboard) + +Obtenir un jeton avec le code de l’appareil[​](#obtenir-un-jeton-avec-le-code-de-lappareil) +Il s’agit de l’autorisation OAuth 2.0 permettant aux appareils à contraintes d’entrée d’accéder à une API. Utilisez ce point de terminaison pour demander un jeton d’accès en utilisant le code de l’appareil obtenu précédemment. + +### Remarques[​](#remarques-1) + +- Étant donné que vous interrogerez ce point de terminaison (en utilisant l’`interval` de la réponse initiale pour déterminer la fréquence) en attendant que l’utilisateur accède à la vérification de l’URL et saisisse son code d’utilisateur, il est probable que vous obteniez au moins un échec avant de recevoir une réponse positive. Voir les exemples de réponses possibles. + +### En savoir plus[​](#en-savoir-plus-1) + +- [Flux d’autorisation d’appareil](/docs/fr-ca/api/authentication/flows/concepts/device-auth) +- [Appel d’API en utilisant le flux d’autorisation d’appareil](/docs/fr-ca/api/authentication/flows/guides/device-auth/call-api-device-auth) +- [Configuration de l’octroi d’un code d’appareil à l’aide du tableau de bord de gestion](/docs/fr-ca/api/authentication/api-auth/config/using-the-auth0-dashboard) + +## Parameters + + + L’ID de votre application. + + + + Les permissions pour lesquelles vous souhaitez demander une autorisation. + + + + L’identifiant unique de l’API cible à laquelle vous souhaitez accéder. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Renvoie les codes de l’appareil et de l’utilisateur. | diff --git a/main/docs/fr-ca/api/authentication/device-authorization/request-device-code.mdx b/main/docs/fr-ca/api/authentication/device-authorization/request-device-code.mdx deleted file mode 100644 index fb15b897d9..0000000000 --- a/main/docs/fr-ca/api/authentication/device-authorization/request-device-code.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/device/code -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/dynamic-application-client-registration/dynamic-application-registration.mdx b/main/docs/fr-ca/api/authentication/dynamic-application-client-registration/dynamic-application-registration.mdx new file mode 100644 index 0000000000..84508559da --- /dev/null +++ b/main/docs/fr-ca/api/authentication/dynamic-application-client-registration/dynamic-application-registration.mdx @@ -0,0 +1,28 @@ +--- +title: "Enregistrement dynamique des applications" +description: "Avec un nom et la Callback URL nécessaire, vous pouvez enregistrer dynamiquement un client avec Auth0. Aucun jeton n’est nécessaire pour cette demande." +--- + +`POST /oidc/register` + +Avec un nom et la Callback URL nécessaire, vous pouvez enregistrer dynamiquement un client avec Auth0. Aucun jeton n’est nécessaire pour cette demande. + +## Parameters + + + Le nom du client dynamique à créer. + + + + Un tableau des URLs que Auth0 jugera valides à la fin d’un flux d’authentification. + + + + Méthode utilisée pour l’authentification au point de terminaison du jeton. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réponse réussie avec les détails du client. | diff --git a/main/docs/fr-ca/api/authentication/dynamic-client-registration/dynamic-application-registration.mdx b/main/docs/fr-ca/api/authentication/dynamic-client-registration/dynamic-application-registration.mdx deleted file mode 100644 index 442703ec9c..0000000000 --- a/main/docs/fr-ca/api/authentication/dynamic-client-registration/dynamic-application-registration.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oidc/register -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/impersonation-legacy/impersonate-a-user-legacy.mdx b/main/docs/fr-ca/api/authentication/impersonation-legacy/impersonate-a-user-legacy.mdx deleted file mode 100644 index 917b2d9d00..0000000000 --- a/main/docs/fr-ca/api/authentication/impersonation-legacy/impersonate-a-user-legacy.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /users/{user_id}/impersonate -playground: simple -deprecated: true ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/impersonation-legacy/impersonation.mdx b/main/docs/fr-ca/api/authentication/impersonation-legacy/impersonation.mdx new file mode 100644 index 0000000000..a40aaec725 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/impersonation-legacy/impersonation.mdx @@ -0,0 +1,38 @@ +--- +title: "Usurpation d’identité" +description: "Utilisez ce point de terminaison pour obtenir une URL d’usurpation d’identité pour se connecter en tant qu’un autre utilisateur. Utile pour le dépannage." +--- + +`POST /users/{user_id}/impersonate` + +Utilisez ce point de terminaison pour obtenir une URL d’usurpation d’identité pour se connecter en tant qu’un autre utilisateur. Utile pour le dépannage. + +### Remarques[​](#remarques) + +- Ce point de terminaison ne peut être utilisé qu’avec les identifiants **Global Client**. +- Pour distinguer les connexions légitimes des tentatives d’usurpation d’identité, le profil de l’utilisateur usurpé inclura des attributs supplémentaires relatifs à l’usurpation et à l’usurpateur. Par exemple : `"impersonated": true, "impersonator": {"user_id": "auth0|...", "email": "admin@example.com"}`. +- Pour une application Web classique, vous devez définir les `additionalParameters` : définir le `response_type` qui doit être `code`, la `callback_url` qui doit être la fonction Callback URL vers laquelle Auth0 effectuera la redirection avec le code d’autorisation et la `scope` pour être les demandes JWT que vous souhaitez inclure dans le JWT. + +## Parameters + + + + + + + + + + + + + + + + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réussite de la récupération de URL d’usurpation d’identité | diff --git a/main/docs/fr-ca/api/authentication/implicit-flow/authorize.mdx b/main/docs/fr-ca/api/authentication/implicit-flow/authorize.mdx new file mode 100644 index 0000000000..ac2107233b --- /dev/null +++ b/main/docs/fr-ca/api/authentication/implicit-flow/authorize.mdx @@ -0,0 +1,69 @@ +--- +title: "Autoriser" +description: "Il s'agit de l'autorisation OAuth 2.0 que les applications Web utilisent pour accéder à une API." +--- + +`GET /authorize` + +Il s'agit de l'autorisation OAuth 2.0 que les applications Web utilisent pour accéder à une API. + +### Réponses + +#### 302 + +Si la demande réussit, l'utilisateur sera redirigé vers la Callback URL indiquée avec le jeton d'accès. + +`HTTP/1.1 302 Found Location: {yourCallbackUrl}#access_token=TOKEN&state=STATE&token_type=TYPE&expires_in=SECONDS` + +### Remarques + +- La valeur `redirect_uri` doit être indiquée comme Callback URL valide dans les paramètres de l'application. +- Si `response_type=token`, après l'authentification de l'utilisateur auprès du fournisseur, la redirection se fera vers la Callback URL de votre application en passant le `access_token` dans l'adresse `location.hash`. Cette méthode est utilisée pour les applications à page unique et pour les trousses SDK mobiles natives. +- L'autorisation implicite ne permet pas l'émission de jetons d'actualisation. Utilisez plutôt l'authentification silencieuse. +- Afin d'améliorer la compatibilité avec les applications, Auth0 renverra désormais les informations relatives au profil dans un format de demande structuré tel que défini par la spécification OIDC. Cela signifie que pour ajouter des demandes personnalisées à des jetons d'identification ou à des jetons d'accès, elles doivent se conformer à un format à espace de noms afin d'éviter d'éventuelles collisions avec les demandes standard OIDC. +- L'authentification silencieuse vous permet ainsi d'exécuter un flux d'authentification où Auth0 répondra uniquement par des redirections, et jamais par une page de connexion. Lorsqu'un jeton d'accès a expiré, l'authentification silencieuse peut être utilisée pour en récupérer un nouveau sans interaction avec l'utilisateur, à condition que la session d'authentification unique (SSO) de l'utilisateur n'ait pas expiré. + +### En savoir plus + +- [Flux implicite](https://auth0.com/docs/get-started/authentication-and-authorization-flow/implicit-flow-with-form-post) +- [Paramètre d'état](https://auth0.com/docs/secure/attack-protection/state-parameters) +- [Atténuer les attaques par relecture lors de l'utilisation de l'autorisation implicite](https://auth0.com/docs/secure/tokens/token-best-practices#mitigate-replay-attacks) +- [Authentification silencieuse](https://auth0.com/docs/authenticate/login/configure-silent-authentication) + +## Paramètres + + + Spécifie le type de jeton. + + Valeurs autorisées : `token`, `id_token`, `id_token token` + + + + Le `client_id` de votre application. + + + + Le nom de la connexion configurée pour votre application. + + + + L'URL vers laquelle Auth0 redirigera le navigateur après autorisation. + + + + Les permissions OIDC et API demandées. + + + + Valeur opaque pour prévenir les attaques CSRF. + + + + Valeur aléatoire pour prévenir les attaques par relecture. + + +## Réponse + +| Statut | Description | +|--------|-------------| +| 302 | Redirige vers la Callback URL indiquée avec le jeton d'accès. | diff --git a/main/docs/fr-ca/api/authentication/login-legacy/database-ad-lapd-active.mdx b/main/docs/fr-ca/api/authentication/login-legacy/database-ad-lapd-active.mdx new file mode 100644 index 0000000000..b1cad2a609 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/login-legacy/database-ad-lapd-active.mdx @@ -0,0 +1,63 @@ +--- +title: "Base de données/AD/LDAP (active)" +description: "Utilisez ce point de terminaison pour l'authentification basée sur l'API (active). Compte tenu des identifiants de l'utilisateur et de la connection indiquée, l'authentification s'effectue auprès du fournisseur et renvoie un JSON contenant le jeton d'accès et le jeton d'identification." +--- + +`POST /oauth/ro` + + +Ce point de terminaison fait partie du flux d'authentification hérité et a été remplacé par le flux d'autorisation par mot de passe. Pour plus d'informations sur le dernier pipeline d'authentification, veuillez consulter [Présentation de l'authentification conforme à OIDC](https://auth0.com/docs/authenticate/login/oidc-conformant-authentication). + + +Utilisez ce point de terminaison pour l'authentification basée sur l'API (active). Compte tenu des identifiants de l'utilisateur et de la `connection` indiquée, l'authentification s'effectue auprès du fournisseur et renvoie un JSON contenant le jeton d'accès et le jeton d'identification. + +### Remarques + +- Ce point de terminaison fonctionne uniquement pour les connexions de base de données, les connexions sans mot de passe, Active Directory/LDAP, Windows Entra ID et ADFS. + +- La principale différence entre l'authentification passive et l'authentification active est que la première se produit dans le navigateur via la page de connexion Auth0 et que la seconde peut être invoquée de n'importe où (un script, un serveur à un autre serveur, etc.). + +- L'exemple de script auth0.js emploie la version 8 de la bibliothèque. Si vous utilisez auth0.js version 7, veuillez consulter ce [guide de référence](https://auth0.com/docs/libraries/auth0js/v7). + +### Codes d'erreur + +Pour obtenir la référence complète des codes d'erreur pour ce point de terminaison, voir Erreurs > POST /oauth/ro. + +### En savoir plus + +- [Fournisseurs d'identité de base de données](https://auth0.com/docs/authenticate/database-connections) +- [Limites anti-attaques pour l'authentification par utilisateur/mot de passe](https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy) +- [Connecteur Active Directory/LDAP](https://auth0.com/docs/authenticate/identity-providers/enterprise-identity-providers/active-directory-ldap/ad-ldap-connector) + +## Paramètres + + + Le `client_id` de votre application. + + + + Le nom d'utilisateur. + + + + Le mot de passe de l'utilisateur. + + + + Le nom de la connexion configurée pour votre application. + + + + Les permissions demandées. + + + + Utilisez `password`. + + +## Réponse + +| Statut | Description | +|--------|-------------| +| 200 | Réponse d'authentification correcte | +| 400 | Mauvaise requête. | diff --git a/main/docs/fr-ca/api/authentication/login-legacy/social-with-providers-access-token.mdx b/main/docs/fr-ca/api/authentication/login-legacy/social-with-providers-access-token.mdx index 6819692c98..ce674efd16 100644 --- a/main/docs/fr-ca/api/authentication/login-legacy/social-with-providers-access-token.mdx +++ b/main/docs/fr-ca/api/authentication/login-legacy/social-with-providers-access-token.mdx @@ -1,11 +1,60 @@ --- -openapi: authentication-api-oas post /oauth/access_token -playground: simple -deprecated: true +title: "Réseau social à l’aide du jeton d’accès du fournisseur" +description: "Ce point de terminaison fait partie de l’ancien pipeline d’authentification. Nous vous recommandons d’ouvrir le navigateur pour procéder à l’authentification..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /oauth/access_token` - - \ No newline at end of file + +Ce point de terminaison fait partie de l’ancien pipeline d’authentification. Nous vous recommandons d’ouvrir le navigateur pour procéder à l’authentification via un réseau social, comme le [recommandent Google et Facebook](https://developers.googleblog.com/2016/08/modernizing-oauth-interactions-in-native-apps.html). Pour plus d’informations sur le dernier pipeline d’authentification, veuillez consulter [Présentation de l’authentification conforme à OIDC](/docs/fr-ca/api/authentication/api-auth/intro). + +Cette fonctionnalité est désactivée par défaut pour les nouveaux locataires depuis le 8 juin 2017. Voir [Types d’autorisation d’application](/docs/fr-ca/api/authentication/applications/concepts/application-grant-types) pour en savoir plus. + + +Avec le jeton d’accès du fournisseur social et le `connection`, ce point de terminaison authentifie l’utilisateur auprès du fournisseur et renvoie un JSON avec le jeton d’accès et, éventuellement, un jeton d’identification. Ce point de terminaison ne fonctionne que pour Facebook, Google, X et Weibo. + +### Remarques[​](#remarques) + +- +La valeur de permission `profile` demande l’accès aux réclamations de profil par défaut de l’utilisateur final, qui sont : `name`, `family_name`, `given_name`, `middle_name`, `nickname`, `preferred_username`, `profile`, `picture`, `website`, `gender`, `birthdate`, `zoneinfo`, `locale` et `updated_at`. + +- +La valeur de permission `email` demande l’accès aux demandes `email` et `email_verified`. + +### Codes d’erreur[​](#codes-derreur) + +Pour obtenir la référence complète des codes d’erreur pour ce point de terminaison, voir [Erreurs > POST /oauth/access_token](#post-oauth-access_token). + +### En savoir plus[​](#en-savoir-plus) + +- [Appeler une API IDP](/docs/fr-ca/api/authentication/tutorials/calling-an-external-idp-api) +- [Jetons d’accès de fournisseur d’identité](/docs/fr-ca/api/authentication/tokens/overview-idp-access-tokens) +- [Ajouter des permissions/autorisations pour appeler les API IDP](/docs/fr-ca/api/authentication/connections/adding-scopes-for-an-external-idp) + +## Parameters + + + `client_id` de votre application. + + + + Le jeton d’accès du fournisseur social. + + + + Le nom d’un fournisseur d’identité configuré pour votre application. + + + + Utilisez `openid` pour obtenir un jeton d’identification ou `openid profile email` pour inclure des informations sur l’utilisateur. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réponse d’authentification correcte | +| 400 | Mauvaise requête. | +| 401 | Non autorisé | +| 403 | Interdit | +| default | Erreur inattendue | diff --git a/main/docs/fr-ca/api/authentication/login/authenticate-using-database.mdx b/main/docs/fr-ca/api/authentication/login/authenticate-using-database.mdx new file mode 100644 index 0000000000..613557422b --- /dev/null +++ b/main/docs/fr-ca/api/authentication/login/authenticate-using-database.mdx @@ -0,0 +1,60 @@ +--- +title: "Base de données/AD/LDAP (Passive)" +description: "Utilisez le magasin d’utilisateurs Auth0 ou votre propre base de données pour stocker et gérer les identifiants de nom d’utilisateur et de mot de passe. Si..." +--- + +`GET /authorize` + +Utilisez le magasin d’utilisateurs Auth0 ou votre propre base de données pour stocker et gérer les identifiants de nom d’utilisateur et de mot de passe. Si vous disposez de votre propre base de données d’utilisateurs, vous pouvez l’utiliser comme fournisseur d’identité dans Auth0 pour authentifier des utilisateurs. Lorsque vous effectuez un appel `GET` au point de terminaison `/authorize` pour une authentification basée sur les navigateurs (passive), elle renvoie une redirection `302` vers la [page de connexion Auth0](https://${account.namespace}/login) qui affichera le gadget logiciel de connexion, dans lequel l’utilisateur pourra se connecter avec son adresse courriel et mot de passe. + + +L’authentification passive se produit via le navigateur et est initiée à partir de la [page de connexion Auth0](https://${account.namespace}/login), où l’utilisateur saisit ses identifiants. Elle ne nécessite aucun code personnalisé ni traitement dorsal comme l’authentification active. + + +### Remarques[​](#remarques) + +- Si `response_type=token`, après l’authentification de l’utilisateur, la redirection se fera vers la `callback URL` de votre application, en transférant le jeton d’accès et le jeton d’identification dans le `location.hash` de l’adresse. Cela est utilisé par les applications à page unique et les trousses SDK mobiles natives. +- La principale différence entre l’authentification passive et l’authentification active est que la première se produit dans le navigateur via la [page de connexion Auth0](https://${account.namespace}/login) et que la seconde peut être invoquée de n’importe où (un script, un serveur à un autre serveur, etc.). +- L’exemple de script auth0.js emploie la version 8 de la bibliothèque. Si vous utilisez auth0.js version 7, veuillez consulter ce [guide de référence](https://auth0.com/docs/libraries/auth0js/v7). + +### En savoir plus[​](#en-savoir-plus) + +- [Fournisseurs d’identité de base de données](/docs/fr-ca/api/authentication/connections/database) +- [Limites anti-attaques de l’authentification des utilisateurs/mots de passe](/docs/fr-ca/api/authentication/policies/rate-limit-policy/database-connections-rate-limits) +- [Connecteur Active Directory/LDAP](/docs/fr-ca/api/authentication/connector) +- [Paramètre d’état](/docs/fr-ca/api/authentication/protocols/oauth2/oauth-state) +- [Référence de la méthode Auth0.js/authorize](/docs/fr-ca/api/authentication/libraries/auth0js#webauth-authorize-) + +## Parameters + + + Spécifie le type de jeton. Utilisez `code` pour les flux côté serveur et `token` pour les flux côté application. + + + + `client_id` de votre application. + + + + Le nom de la connexion configurée pour votre application. Si null, la redirection se fera vers la [page de connexion Auth0](https://${account.namespace}/login) et affichera le gadget logiciel de connexion en utilisant la première connexion à la base de données. + + + + L’URL vers laquelle Auth0 redirigera le navigateur après avoir obtenu l’autorisation de l’utilisateur. Spécifiez le `redirect_uri` dans les [paramètres de votre application](/docs/fr-ca/api/authentication/login/${manage_url}/#/applications). + + + + Permissions OIDC et permissions API personnalisées. Par exemple : `openid read:timesheets`. Inclure `offline_access` pour obtenir un jeton d’actualisation. + + + + Une valeur opaque que l’application ajoute à la demande initiale et que le serveur d’autorisations inclut lorsqu’il redirige la demande vers l’application. Cette valeur doit être utilisée par l’application pour prévenir les attaques CSRF. + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | Rediriger vers la page de connexion | +| 400 | Demande incorrecte - Paramètres non valides | +| 500 | Erreur de serveur interne | diff --git a/main/docs/fr-ca/api/authentication/login/check-back-channel-login-status.mdx b/main/docs/fr-ca/api/authentication/login/check-back-channel-login-status.mdx new file mode 100644 index 0000000000..d3942cde72 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/login/check-back-channel-login-status.mdx @@ -0,0 +1,56 @@ +--- +title: "Flux de connexion Back-channel - Vérification de l’état" +description: "Pour vérifier l’état d’un flux de connexion Back-channel, interrogez le point de terminaison `/oauth/token` à intervalles réguliers en passant ce qui suit :" +--- + +`POST /oauth/token` + +Pour vérifier l’état d’un flux de connexion Back-channel, interrogez le point de terminaison `/oauth/token` à intervalles réguliers en passant ce qui suit : + +- `auth_req_id` renvoyé de l’appel à `/bc-authorize` +- type d’autorisation `urn:openid:params:grant-type:ciba` + +### Corps de la réponse[​](#corps-de-la-réponse) + +Si l’utilisateur autorisant n’a pas encore approuvé ou rejeté la demande, vous devriez recevoir une réponse semblable à celle-ci : +{ "error": "authorization_pending", "error_description": "The end-user authorization is pending"} +Si l’utilisateur autorisant rejette la demande, vous devriez recevoir une réponse semblable à celle-ci : +{ "error": "access_denied", "error_description": "The end-user denied the authorization request or it has been expired"} +Si vous interrogez trop rapidement (plus vite que la valeur d’intervalle renvoyée par `/bc-authorize`), vous devriez recevoir une réponse semblable à celle-ci : +{ "error": "slow_down", "error_description": "You are polling faster than allowed. Try again in 10 seconds."} +En outre, Auth0 ajoutera l’en-tête [Retry-After](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) à la réponse indiquant le nombre de secondes à attendre avant de tenter à nouveau d’interroger. Si vous interrogez régulièrement trop souvent, le nombre de secondes que vous devez attendre augmente. + +Si l’utilisateur autorisant a approuvé la notification poussée, l’appel renvoie le jeton d’identification et le jeton d’accès (et éventuellement un jeton d’actualisation) : +{ "access_token": "eyJh...", "id_token": "eyJh...", "expires_in": 86400, "scope": "openid"} +Une fois que vous avez échangé un `auth_req_id` contre un identifiant ou un jeton d’accès, il n’est plus utilisable. + +### Remarques[​](#remarques) + +Inclure un paramètre facultatif pour l’authentification de l’application dans la demande : + +- Secret client avec HTTP Basic Auth, auquel cas aucun paramètre n’est requis. `client_id` et `client_secret` sont transmis dans un en-tête. +- Post secret client, auquel cas `client_id` et `client_secret` sont requis. +- Jeton JWT de clé privée, où le type `client_id`, `client_assertion` et `client_assertion` sont requis. +- mTLS, où le paramètre `client_id` est requis, tout comme les en-têtes `client-certificate` et `client-certificate-ca-verified`. + +## Parameters + + + `client_id` de votre application. + + + + Le `auth_req_id` renvoyé du point de terminaison `/bc-authorize`. + + + + Doit être réglé sur `urn:openid:params:grant-type:ciba`. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Statut d’authentification renvoyé. | +| 400 | Demande incorrecte - Paramètres non valides | +| 500 | Erreur de serveur interne | diff --git a/main/docs/fr-ca/api/authentication/login/enterprise-saml-and-others.mdx b/main/docs/fr-ca/api/authentication/login/enterprise-saml-and-others.mdx new file mode 100644 index 0000000000..88192e97db --- /dev/null +++ b/main/docs/fr-ca/api/authentication/login/enterprise-saml-and-others.mdx @@ -0,0 +1,54 @@ +--- +title: "Enterprise (SAML et autres)" +description: "Vous pouvez connecter votre service Auth0 à un fournisseur d'identité d'entreprise et permettre à vos utilisateurs de se connecter à votre application via Microsoft Azure Active Directory, Google Workspace, Okta Workforce ou d'autres fournisseurs pris en charge." +--- + +`GET /authorize` + +Vous pouvez connecter votre service Auth0 à un fournisseur d'identité d'entreprise et permettre à vos utilisateurs de se connecter à votre application via Microsoft Azure Active Directory, Google Workspace, Okta Workforce ou d'autres fournisseurs pris en charge. Pour en savoir plus sur les fournisseurs pris en charge, visitez [Auth0 Marketplace](https://marketplace.auth0.com/features/enterprise-connections). + +Faites un appel `GET` au point de terminaison `/authorize` pour l'authentification passive. Il renvoie une redirection `302` vers le fournisseur SAML (ou Windows Azure AD et d'autres, selon la `connection` indiquée) pour saisir leurs identifiants. + +### Remarques + +- Si `response_type=token`, après l'authentification de l'utilisateur, le navigateur sera redirigé vers la `callback URL` de votre application avec le jeton d'accès et le jeton d'identification dans l'adresse `location.hash`. Cette méthode est couramment utilisée pour les applications à page unique (SPA) et les SDK mobiles natifs. +- Si aucune `connection` n'est fournie, l'utilisateur sera redirigé vers la [page de connexion Auth0](http://manage.auth0.com/login), où il pourra s'authentifier via la première connexion de base de données disponible. +- Ce flux est utilisé pour les applications qui nécessitent une authentification passive basée sur un navigateur. + +### En savoir plus +- [SAML](https://auth0.com/docs/authenticate/protocols/saml/saml-configuration) +- [Obtenir un identifiant client et une clé secrète client pour Microsoft Azure Active Directory](https://auth0.com/docs/authenticate/identity-providers/enterprise-identity-providers/azure-active-directory/v2) +- [Paramètre d'état](https://auth0.com/docs/secure/attack-protection/state-parameters) +- [Référence de la méthode Auth0.js /authorize](https://auth0.com/docs/libraries/auth0js#webauth-authorize-) + +## Paramètres + + + Spécifie le type de jeton. Utilisez `code` pour les flux côté serveur et `token` pour les flux côté client. + + Valeurs autorisées : `code`, `token` + + + + Le `client_id` de votre application. + + + + Le nom de la connexion d'entreprise configurée pour votre application. Si non fourni, il redirigera vers la [page de connexion Auth0](http://manage.auth0.com/login) et affichera le widget de connexion en utilisant la première connexion de base de données disponible. + + + + L'URL vers laquelle Auth0 redirigera le navigateur après que l'autorisation ait été accordée par l'utilisateur. Spécifiez le `redirect_uri` dans les [paramètres de votre application](https://manage.auth0.com/dashboard/#/applications). + + + + Une valeur opaque que l'application ajoute à la demande initiale et que le serveur d'autorisation inclut lors de la redirection vers l'application. Cette valeur doit être utilisée par l'application pour prévenir les attaques CSRF. + + +## Réponse + +| Statut | Description | +|--------|-------------| +| 302 | Redirection vers le fournisseur d'authentification. | +| 400 | Mauvaise requête - Paramètres invalides | +| 500 | Erreur interne du serveur | diff --git a/main/docs/fr-ca/api/authentication/login/index.mdx b/main/docs/fr-ca/api/authentication/login/index.mdx new file mode 100644 index 0000000000..3f92fbb990 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/login/index.mdx @@ -0,0 +1,59 @@ +--- +title: "Via réseau social" +description: "Vous pouvez connecter votre service Auth0 à un fournisseur d'identité sociale et permettre à vos utilisateurs de se connecter à votre application via Facebook, Google, Apple ou d'autres fournisseurs pris en charge." +--- + +`GET /authorize` + +## Via réseau social + +Vous pouvez connecter votre service Auth0 à un fournisseur d'identité sociale et permettre à vos utilisateurs de se connecter à votre application via Facebook, Google, Apple ou d'autres fournisseurs pris en charge. Pour en savoir plus sur les fournisseurs pris en charge, visitez [Marketplace](https://marketplace.auth0.com/features/social-connections). + +Pour authentifier des utilisateurs au moyen d'un fournisseur social, faites un appel `GET` au point de terminaison `/authorize`. Il renverra une redirection `302` vers le fournisseur social indiqué dans le paramètre `connection`. + + +Les connexions sociales ne prennent en charge que l'authentification basée sur les navigateurs (passive), car la plupart des fournisseurs d'identité sociale ne permettent pas la saisie de nom d'utilisateur et de mot de passe dans les applications dont ils ne sont pas propriétaires. Par conséquent, l'utilisateur sera redirigé vers la page de connexion du fournisseur. + + +### Remarques + +- Si `response_type=token`, après l'authentification de l'utilisateur auprès du fournisseur, la redirection se fera vers la `callback URL` de votre application, en transférant le jeton d'accès et le jeton d'identification dans le `location.hash` de l'adresse. Cela est utilisé par les applications à page unique et les trousses SDK mobiles natives. + +- L'exemple de script auth0.js emploie la version 8 de la bibliothèque. Si vous utilisez auth0.js version 7, veuillez consulter ce [guide de référence](https://auth0.com/docs/libraries/auth0js). + +### En savoir plus + +- [Fournisseurs d'identité sociale pris en charge](https://marketplace.auth0.com/features/social-connections) +- [Connexions personnalisées avec les réseaux sociaux](https://auth0.com/docs/authenticate/identity-providers/social-identity-providers/oauth2) +- [Paramètre d'état](https://auth0.com/docs/secure/attack-protection/state-parameters) +- [Référence de la méthode Auth0.js/authorize](https://auth0.com/docs/libraries/auth0js#webauth-authorize-) + +## Paramètres + + + Spécifie le type de jeton (code ou token) + + Valeurs autorisées : `code`, `token` + + + + Le `client_id` de votre application + + + + Le nom d'un fournisseur d'identité sociale configuré pour votre application + + + + L'URL vers laquelle Auth0 redirigera après autorisation + + + + Valeur opaque pour prévenir les attaques CSRF + + +## Réponse + +| Statut | Description | +|--------|-------------| +| 302 | Rediriger vers le fournisseur d'identité sociale | diff --git a/main/docs/fr-ca/api/authentication/login/start-back-channel-login.mdx b/main/docs/fr-ca/api/authentication/login/start-back-channel-login.mdx new file mode 100644 index 0000000000..085798c76e --- /dev/null +++ b/main/docs/fr-ca/api/authentication/login/start-back-channel-login.mdx @@ -0,0 +1,71 @@ +--- +title: "Connexion au Back-channel" +description: "Cette fonctionnalité est actuellement en accès anticipé. Pour demander l’accès, contactez votre Gestionnaire de compte technique." +--- + +`POST /bc-authorize` + + +Cette fonctionnalité est actuellement en accès anticipé. Pour demander l’accès, contactez votre Gestionnaire de compte technique. + + +Le point de terminaison de la connexion Back-channel permet aux applications d’envoyer une demande d’authentification au téléphone d’un utilisateur ou à l’appareil d’authentification, à condition qu’une application soit installée et qu’elle soit inscrite aux [notifications poussées à l’aide de la trousse SDK Guardian](/docs/fr-ca/api/authentication/secure/multi-factor-authentication/auth0-guardian#enroll-in-push-notifications). + +Utilisez le point de terminaison de la connexion Back-channel pour authentifier les utilisateurs pour les cas d’utilisation suivants : + +- Les utilisateurs ne sont pas devant l’application qui nécessite une authentification, par exemple lorsqu’ils téléphonent à un centre d’appels. +- L’appareil de consommation, ou l’appareil qui aide l’utilisateur à consommer un service, n’est pas sécurisé pour les opérations sensibles (p. ex., le navigateur web pour des transactions financières). +- L’appareil de consommation a une capacité interactive limitée (p. ex., vélos électriques ou trottinettes électriques). + +### Corps de la réponse[​](#corps-de-la-réponse) + +Vous recevrez une réponse semblable à celle qui suit si la requête réussit : +{ "auth_req_id": "eyJh...", "expires_in": 300, "interval": 5} +La valeur `auth_req_id` doit être conservée, car elle est utilisée plus tard dans le flux pour identifier la demande d’authentification. + +La valeur `expires_in` vous indique combien de secondes il reste avant l’expiration de la demande d’authentification. + +La valeur `interval` vous indique combien de secondes vous devez attendre entre les demandes de sondage. + +La demande doit être approuvée ou rejetée sur l’appareil d’authentification de l’utilisateur à l’aide de la trousse SDK Guardian. + +### Remarques[​](#remarques) + +- La valeur `login_hint` suit le format `iss_sub`. Par exemple : + +{ "format": "iss_sub", "iss": "https://[TENANT_DOMAIN]/", "sub": "auth0|[USER ID]" } +- L’authentification peut utiliser un secret client (via HTTP Basic Auth ou Post), un jeton JWT de clé privée ou mTLS. Reportez-vous aux exemples détaillés ci-dessus. + +## Parameters + + + `client_id` de votre application. + + + + Une chaîne lisible par l’utilisateur pour s’assurer qu’il approuve la bonne demande. + + + + Objet JSON contenant les détails de l’utilisateur pour l’authentification, au format `iss_sub`. + + + + Liste séparée par des espaces des permissions OIDC et API personnalisées, y compris `openid` au minimum. + + + + Identifiant unique facultatif de l’API cible pour les jetons d’accès. + + + + Délai d’expiration personnalisé de la demande en secondes (1-300). La valeur par défaut est 300 secondes. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Demande d’authentification initiée avec succès. | +| 400 | Demande incorrecte - Paramètres non valides | +| 500 | Erreur de serveur interne | diff --git a/main/docs/fr-ca/api/authentication/logout/auth-0-logout.mdx b/main/docs/fr-ca/api/authentication/logout/auth-0-logout.mdx new file mode 100644 index 0000000000..150dd9524a --- /dev/null +++ b/main/docs/fr-ca/api/authentication/logout/auth-0-logout.mdx @@ -0,0 +1,42 @@ +--- +title: "Déconnexion Auth0" +description: "Utilisez ce point de terminaison pour déconnecter un utilisateur. Si vous voulez rediriger l’utilisateur vers une URL précise après déconnexion, définissez..." +--- + +`GET /v2/logout` + +Utilisez ce point de terminaison pour déconnecter un utilisateur. Si vous voulez rediriger l’utilisateur vers une URL précise après déconnexion, définissez cette URL pour le paramètre `returnTo`. L’URL doit être incluse dans la liste des `Allowed Logout URLs` appropriées : + +- Si le paramètre `client_id` est inclus, l’URL `returnTo` doit faire partie de la liste des `Allowed Logout URLs` définies au niveau de l’application. Pour en savoir plus, consultez [Déconnecter les utilisateurs des applications](/docs/fr-ca/api/authentication/authenticate/login/logout/log-users-out-of-applications). +Si le paramètre `client_id` n’est PAS inclus, l’URL `returnTo` doit faire partie de la liste des `Allowed Logout URLs` définies au niveau du locataire. Pour en savoir plus, consultez [Déconnecter les utilisateurs d’Auth0](/docs/fr-ca/api/authentication/authenticate/login/logout/log-users-out-of-auth0). +Si le paramètre `client_id` est inclus et que l’URL `returnTo` n’est pas définie, le serveur redirige l’utilisateur vers les premières URL de déconnexion autorisées définies dans le tableau de bord. Pour en savoir plus, consultez [Déconnecter les utilisateurs des applications](/docs/fr-ca/api/authentication/authenticate/login/logout/log-users-out-of-applications). + +### Remarques[​](#remarques) + +- Déconnecter un utilisateur de son fournisseur d’identité n’est pas courant, réfléchissez donc à l’incidence sur l’expérience utilisateur avant d’utiliser le paramètre de chaîne de requête `federated`. +- L’exemple de script auth0.js emploie la version 8 de la bibliothèque. Si vous utilisez auth0.js version 7, veuillez consulter ce [guide de référence](/docs/fr-ca/api/authentication/libraries/auth0js/v7). + +### En savoir plus[​](#en-savoir-plus) + +- [Déconnexion](/docs/fr-ca/api/authentication/logout) + +## Parameters + + + `client_id` de votre application. + + + + URL vers laquelle rediriger l’utilisateur après déconnexion. + + + + Ajoutez ce paramètre de chaîne de requête à l’URL de déconnexion, pour déconnecter l’utilisateur de son fournisseur d’identité. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Déconnexion réussie | +| 400 | Requête incorrecte, peut-être due à des paramètres obligatoires manquants | diff --git a/main/docs/fr-ca/api/authentication/logout/global-token-revocation.mdx b/main/docs/fr-ca/api/authentication/logout/global-token-revocation.mdx index 1745aa6d32..fbf9358989 100644 --- a/main/docs/fr-ca/api/authentication/logout/global-token-revocation.mdx +++ b/main/docs/fr-ca/api/authentication/logout/global-token-revocation.mdx @@ -1,11 +1,39 @@ --- -openapi: authentication-api-oas post /oauth/global-token-revocation/connection/{connection_name} -playground: simple -deprecated: false +title: "Révocation globale des jetons" +description: "Utilisez ce point de terminaison avec [Déconnexion universelle de Okta Workforce Identity..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /oauth/global-token-revocation/connection/{connection_name}` - - \ No newline at end of file +Utilisez ce point de terminaison avec [Déconnexion universelle de Okta Workforce Identity Cloud](https://developer.okta.com/docs/guides/oin-universal-logout-overview/) pour déconnecter les utilisateurs de vos applications. Une demande adressée à ce point de terminaison révoque les témoins de session et les jetons d’actualisation, mais pas les jetons d’accès. Pour en savoir plus, consultez [Connexion universelle] ([https://auth0.com/docs/authenticate/login/logout/universal-logout](https://auth0.com/docs/authenticate/login/logout/universal-logout)). La demande doit être authentifiée avant de révoquer les sessions utilisateur. Vérifier [l’authentification du point de terminaison](https://developer.okta.com/docs/guides/oin-universal-logout-overview/#endpoint-authentication). + +## Parameters + + + Le nom de la connexion pour laquelle vous souhaitez révoquer la session de l’utilisateur. + + + + L’émetteur URL (généralement l’URL de votre serveur d’autorisations). + + + + + + + + L’émetteur URL (généralement l’URL de votre serveur d’autorisations). + + + + L’identifiant du sujet (généralement l’identifiant de l’utilisateur). + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Les témoins de session et les jetons d’actualisation ont été révoqués avec succès. | +| 400 | Requête incorrecte, peut-être due à un format `subject` non valide ou à une authentification absente. | +| 401 | Non autorisé, échec de l’authentification. | +| 500 | Erreur de serveur interne. | diff --git a/main/docs/fr-ca/api/authentication/logout/logout.mdx b/main/docs/fr-ca/api/authentication/logout/logout.mdx deleted file mode 100644 index 0b2f41a730..0000000000 --- a/main/docs/fr-ca/api/authentication/logout/logout.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /v2/logout -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/logout/oidc-logout.mdx b/main/docs/fr-ca/api/authentication/logout/oidc-logout.mdx new file mode 100644 index 0000000000..f69cda8086 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/logout/oidc-logout.mdx @@ -0,0 +1,71 @@ +--- +title: "Déconnexion OIDC" +description: "Utilisez ce point de terminaison pour déconnecter un utilisateur. Si vous voulez rediriger l’utilisateur vers une URL précise après déconnexion, définissez..." +--- + +`GET /oidc/logout` + +Utilisez ce point de terminaison pour déconnecter un utilisateur. Si vous voulez rediriger l’utilisateur vers une URL précise après déconnexion, définissez cette URL pour le paramètre `post_logout_redirect_uri`. L’URL doit être incluse dans la liste des `Allowed Logout URLs` appropriées : + +Si le paramètre `id_token_hint` est inclus : +- Lorsque le paramètre `client_id` est inclus, le serveur utilise l’URL de la demande `aud` dans le `id_token_hint` pour sélectionner une des `Allowed Logout URLs` à utiliser à partir de l’application indiquée par l’`client_id`. +- Lorsque le paramètre `client_id` n’est PAS inclus, le serveur utilise l’URL de la demande `aud` dans le `id_token_hint` pour sélectionner une des `Allowed Logout URLs` à utiliser au niveau du locataire. + +Si le paramètre `id_token_hint` n’est pas inclus : +- Si le paramètre `client_id` est inclus, l’URL `post_logout_redirect_uri` doit faire partie de la liste des `Allowed Logout URLs` définies au niveau de l’application. +Si le paramètre `client_id` n’est PAS inclus, l’URL `post_logout_redirect_uri` doit faire partie de la liste des `Allowed Logout URLs` définies au niveau du locataire. +Si le paramètre `client_id` est inclus et que l’URL `post_logout_redirect_uri` n’est PAS définie, le serveur redirige l’utilisateur vers les premières `Allowed Logout URLs` définies dans Auth0 Dashboard. + +Pour en savoir plus, consultez [Déconnecter les utilisateurs d’Auth0 avec le point de terminaison OIDC](/docs/fr-ca/api/authentication/authenticate/login/logout/log-users-out-of-auth0). + +### Remarques[​](#remarques) + +- Déconnecter un utilisateur de son fournisseur d’identité sociale n’est pas courant, réfléchissez donc à l’incidence sur l’expérience utilisateur avant d’utiliser le paramètre de chaîne de requête `federated` avec les fournisseurs d’identités sociales. +- Si vous fournissez à la fois `id_token_hint` et `logout_hint`, la valeur `logout_hint` doit correspondre à la demande `sid` du id_token_hint. +- Si vous fournissez à la fois `id_token_hint` et `client_id`, la valeur `client_id` doit correspondre à la demande `aud` du `id_token_hint`. +- Si `id_token_hint` n’est pas fourni, l’utilisateur sera invité à donner son consentement, à moins qu’un `logout_hint` correspondant à l’identifiant de session de l’utilisateur ne soit fourni. +- La méthode `POST` HTTP est également acceptée pour cette requête. Si vous utilisez `POST`, les paramètres de la requête doivent être fournis dans le corps de la requête en tant que paramètres de formulaire au lieu de la chaîne de requête. Le paramètre fédéré attend une valeur `true` ou `false`. +- Cela est conforme à la [spécification de déconnexion initiée par OIDC RP](https://openid.net/specs/openid-connect-rpinitiated-1_0.html). + +### En savoir plus[​](#en-savoir-plus) + +- [Déconnexion](/docs/fr-ca/api/authentication/logout) +- [Utiliser le point de terminaison OIDC pour déconnecter les utilisateurs d’Auth0](/docs/fr-ca/api/authentication/logout/log-users-out-of-auth0) +- [Spécification de déconnexion initiée par OIDC RP](https://openid.net/specs/openid-connect-rpinitiated-1_0.html) + +## Parameters + + + [Recommandé] Jeton d’identification précédemment émis pour l’utilisateur. Indique quel utilisateur déconnecter. + + + + Facultatif `sid` (ID de session) valeur qui indique quel utilisateur déconnecter. Doit être fourni lorsque `id_token_hint` n’est pas connu. + + + + URL vers laquelle rediriger l’utilisateur après déconnexion. + + + + `client_id` de votre application. + + + + Ajoutez ce paramètre de chaîne de requête pour déconnecter l’utilisateur de son fournisseur d’identité : `https://YOUR_DOMAIN/oidc/logout?federated`. + + + + Une valeur opaque que l’application ajoute à la demande initiale et que le serveur d’autorisation inclut lorsqu’il redirige la demande vers l’`post_logout_redirect_uri`. + + + + Liste délimitée par des espaces des paramètres locaux utilisés pour restreindre la liste des langues de la requête. La première locale de la liste doit correspondre à la locale activée dans votre locataire. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Déconnexion réussie | +| 400 | Requête incorrecte, peut-être due à des paramètres obligatoires manquants | diff --git a/main/docs/fr-ca/api/authentication/logout/oidc-rp-initiated-logout.mdx b/main/docs/fr-ca/api/authentication/logout/oidc-rp-initiated-logout.mdx deleted file mode 100644 index 3eef58c6a3..0000000000 --- a/main/docs/fr-ca/api/authentication/logout/oidc-rp-initiated-logout.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /oidc/logout -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/logout/saml-logout.mdx b/main/docs/fr-ca/api/authentication/logout/saml-logout.mdx index d5dd1d950a..50c2163198 100644 --- a/main/docs/fr-ca/api/authentication/logout/saml-logout.mdx +++ b/main/docs/fr-ca/api/authentication/logout/saml-logout.mdx @@ -1,11 +1,30 @@ --- -openapi: authentication-api-oas post /samlp/{client_id}/logout -playground: simple -deprecated: false +title: "Déconnexion SAML" +description: "Utilisez ce point de terminaison pour déconnecter un utilisateur d’un locataire Auth0 configuré en tant que fournisseur d’identité (IdP) SAML. Le comportement..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /samlp/{client_id}/logout` - - \ No newline at end of file +Utilisez ce point de terminaison pour déconnecter un utilisateur d’un locataire Auth0 configuré en tant que fournisseur d’identité (IdP) SAML. Le comportement de déconnexion est déterminé par la configuration du module complémentaire de l’application Web SAML2 pour l’application sur le locataire Auth0 agissant en tant qu’IdP SAML. Pour en savoir plus, consultez [Déconnecter les utilisateurs de fournisseurs d’identité SAML](https://auth0.com/docs/authenticate/login/logout/log-users-out-of-saml-idps#configure-slo-when-auth0-is-the-saml-idp). + +### Remarques[​](#remarques) + +- Le corps POST doit contenir un message `` SAML valide. Pour en savoir plus, consultez [Assertions et protocoles pour OASIS Security Assertion Markup Language (SAML) V2.0 sur Oasis](https://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf). + +### En savoir plus[​](#en-savoir-plus) + +- [Déconnexion](/docs/fr-ca/api/authentication/logout) +- [Déconnecter des utilisateurs de fournisseurs d’identité SAML](https://auth0.com/docs/authenticate/login/logout/log-users-out-of-saml-idps) + +## Parameters + + + Identifiant client de votre application configuré avec le [module complémentaire de l’application Web SAML2](https://auth0.com/docs/authenticate/protocols/saml/saml-sso-integrations/enable-saml2-web-app-addon). + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Déconnexion réussie | +| 400 | Requête incorrecte, peut-être due à un message SAML non valide | diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/add-an-authenticator.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/add-an-authenticator.mdx new file mode 100644 index 0000000000..801b0342a3 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/multi-factor-authentication/add-an-authenticator.mdx @@ -0,0 +1,58 @@ +--- +title: "Add an Authenticator" +description: "Associates or adds a new authenticator for multi-factor authentication (MFA)." +--- + +`POST /mfa/associate` + +Associates or adds a new authenticator for multi-factor authentication (MFA). + +If the user has active authenticators, an Access Token with the `enroll` scope and the `audience` set to `https://{yourDomain}/mfa/` is required to use this endpoint. + +If the user has no active authenticators, you can use the `mfa_token` from the `mfa_required` error in place of an Access Token for this request. + +After an authenticator is added, it must be verified. To verify the authenticator, use the response values from the `/mfa/associate` request in place of the values returned from the `/mfa/challenge` endpoint and continue with the verification flow. + +A `recovery_codes` field is included in the response the first time an authenticator is added. You can use `recovery_codes` to pass multi-factor authentication as shown on [Verify with recovery code](/multi-factor-authentication/verify-with-recovery-code) above. + +To access this endpoint, you must set an Access Token at the Authorization header, with the following claims: +- `scope`: `enroll` +- `audience`: `https://{yourDomain}/mfa/` + +## Parameters + + + Your application's Client ID. + + + + A JWT containing a signed assertion with your application credentials. Required when Private Key JWT is your application authentication method. + + + + The value is `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. Required when Private Key JWT is the application authentication method. + + + + Your application's Client Secret. Required when the Token Endpoint Authentication Method field in your Application Settings is `Post` or `Basic`. + + + + Value is an array with values 'otp' or 'oob'. + + + + Required if `authenticator_types` include `oob`. + + + + The phone number to use for SMS or Voice. Required if `oob_channels` includes `sms` or `voice`. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Successful response for adding an authenticator. | +| 400 | Bad request due to missing or invalid parameters. | +| 401 | Unauthorized, invalid access token or mfa_token. | \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/associate-mfa-authenticator.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/associate-mfa-authenticator.mdx deleted file mode 100644 index 1bad114315..0000000000 --- a/main/docs/fr-ca/api/authentication/multi-factor-authentication/associate-mfa-authenticator.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /mfa/associate -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/delete-authenticator.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/delete-authenticator.mdx new file mode 100644 index 0000000000..71263be4a0 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/multi-factor-authentication/delete-authenticator.mdx @@ -0,0 +1,30 @@ +--- +title: "Delete an Authenticator" +description: "Deletes an associated authenticator using its ID. You can get authenticator IDs by listing the authenticators." +--- + +`DELETE /mfa/authenticators/{AUTHENTICATOR_ID}` + +Deletes an associated authenticator using its ID. You can get authenticator IDs by listing the authenticators. + +To access this endpoint, you must set an Access Token in the Authorization header, with the following claims: +- `scope`: `remove:authenticators` +- `audience`: `https://{yourDomain}/mfa/` + +## Parameters + + + The ID of the authenticator to delete. + + + + The Access Token obtained during login. + + +## Response + +| Status | Description | +|--------|-------------| +| 204 | Authenticator deleted successfully. | +| 401 | Unauthorized - Invalid access token. | +| 404 | Authenticator not found. | \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/delete-mfa-authenticator.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/delete-mfa-authenticator.mdx deleted file mode 100644 index 621290800c..0000000000 --- a/main/docs/fr-ca/api/authentication/multi-factor-authentication/delete-mfa-authenticator.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas delete /mfa/authenticators/{id} -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/list-authenticators.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/list-authenticators.mdx new file mode 100644 index 0000000000..a3934f3465 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/multi-factor-authentication/list-authenticators.mdx @@ -0,0 +1,24 @@ +--- +title: "List Authenticators" +description: "Returns a list of authenticators associated with your application." +--- + +`GET /mfa/authenticators` + +Returns a list of authenticators associated with your application. + +To access this endpoint, you must set an Access Token at the Authorization header, with the following claims: +- `scope`: `read:authenticators` +- `audience`: `https://{yourDomain}/mfa/` + +## Parameters + + + Bearer ACCESS_TOKEN + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | A list of authenticators. | \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/list-mfa-authenticators.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/list-mfa-authenticators.mdx deleted file mode 100644 index b6ec4e0389..0000000000 --- a/main/docs/fr-ca/api/authentication/multi-factor-authentication/list-mfa-authenticators.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /mfa/authenticators -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx index 3c174b58d4..1639d8f0fe 100644 --- a/main/docs/fr-ca/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx +++ b/main/docs/fr-ca/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx @@ -1,11 +1,77 @@ --- -openapi: authentication-api-oas post /mfa/challenge -playground: simple -deprecated: false +title: "Challenge Request" +description: "The Multi-factor Authentication (MFA) API endpoints allow you to enforce MFA when users interact with the Token endpoints, as well as enroll and manage user authenticators." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /mfa/challenge` - - \ No newline at end of file +The Multi-factor Authentication (MFA) API endpoints allow you to enforce MFA when users interact with [the Token endpoints](#get-token), as well as enroll and manage user authenticators. + +First, request a challenge based on the challenge types supported by the application and user. If you know that one-time password (OTP) is supported, you can skip the challenge request. + +Next, verify the multi-factor authentication using the `/oauth/token` endpoint and the specified challenge type: a one-time password (OTP), a recovery code, or an out-of-band (OOB) challenge. + +To learn more, read: +- [Multi-factor Authentication and Resource Owner Password](https://auth0.com/docs/secure/multi-factor-authentication/authenticate-using-ropg-flow-with-mfa) +- [Multi-factor Authentication API](https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-developer-resources/mfa-api) +- [Multi-factor Authentication in Auth0](https://auth0.com/docs/secure/multi-factor-authentication) + +## Challenge Request + +Request a challenge for multi-factor authentication (MFA) based on the challenge types supported by the application and user. + +The `challenge_type` is how the user will get the challenge and prove possession. Supported challenge types include: +- `otp`: for one-time password (OTP) +- `oob`: for SMS/Voice messages or out-of-band (OOB) + +If OTP is supported by the user and you don't want to request a different factor, you can skip the challenge request and [verify the multi-factor authentication with a one-time password](#verify-with-one-time-password-otp-). + +### Remarks +- This endpoint does not support enrollment; the user must be enrolled with the preferred method before requesting a challenge. +- Auth0 chooses the challenge type based on the application's supported types and types the user is enrolled with. +- An `unsupported_challenge_type` error is returned if your application does not support any of the challenge types the user has enrolled with. +- An `unsupported_challenge_type` error is returned if the user is not enrolled. +- If the user is not enrolled, you will get an `association_required` error, indicating the user needs to enroll to use MFA. Read [Add an authenticator](/multi-factor-authentication/add-an-authenticator) below on how to proceed. + +### Learn More +* [Authenticate With Resource Owner Password Grant and MFA](https://auth0.com/docs/secure/multi-factor-authentication/authenticate-using-ropg-flow-with-mfa) +* [Manage Authenticator Factors using the MFA API](https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authenticator-factors-mfa-api) + +## Parameters + + + The token received from mfa_required error. + + + + Your application's Client ID. + + + + Your application's Client Secret. + + + + A whitespace-separated list of challenge types accepted by your application. + + Allowed values: `oob`, `otp` + + + + A JWT containing a signed assertion with your application credentials. + + + + The value is urn:ietf:params:oauth:client-assertion-type:jwt-bearer. + + + + The ID of the authenticator to challenge. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Challenge request successful | +| 400 | Invalid request, such as unsupported challenge type or missing enrollment. | \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx new file mode 100644 index 0000000000..ca86bb7e4d --- /dev/null +++ b/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx @@ -0,0 +1,55 @@ +--- +title: "Verify multi-factor authentication with one-time password (OTP)" +description: "Verifies multi-factor authentication (MFA) using a one-time password (OTP)." +--- + +`POST /oauth/token` + +Verifies multi-factor authentication (MFA) using a one-time password (OTP). To verify MFA with an OTP, prompt the user to get the OTP code, then make a request to the /oauth/token endpoint. The request must have the OTP code, the mfa_token you received (from the mfa_required error), and the grant_type set to http://auth0.com/oauth/grant-type/mfa-otp. The response is the same as responses for password or http://auth0.com/oauth/grant-type/password-realm grant types. Learn more at [Associate OTP Authenticators](https://auth0.com/docs/mfa/guides/mfa-api/otp). + +### Learn More + +- [Associate OTP Authenticators](https://auth0.com/docs/mfa/guides/mfa-api/otp) + +## Parameters + + + A DPoP proof for the request. This is optional and only required if your application uses Demonstrating Proof-of-Possession. + + +## Request Body + + + Denotes the flow you are using. For OTP MFA use `http://auth0.com/oauth/grant-type/mfa-otp`. + + + + Your application's Client ID. + + + + Your application's Client Secret. + + + + The `mfa_token` you received from `mfa_required` error. + + + + OTP Code provided by the user. + + + + A JWT containing a signed assertion with your application credentials. + + + + The value is `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | OTP verification successful. | +| 400 | Invalid request, such as missing parameters or invalid OTP. | diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-out-of-band.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-out-of-band.mdx new file mode 100644 index 0000000000..a8b372f450 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-out-of-band.mdx @@ -0,0 +1,71 @@ +--- +title: "Verify with Out-of-Band (OOB)" +description: "Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either Push notification, SMS, or Voice)." +--- + +`POST /oauth/token` + +Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either Push notification, SMS, or Voice). To verify MFA using an OOB challenge, your application must make a request to `/oauth/token` with `grant_type=http://auth0.com/oauth/grant-type/mfa-oob`. Include the `oob_code` you received from the challenge response, as well as the `mfa_token` you received as part of `mfa_required` error. + +The response to this request depends on the status of the underlying challenge verification: +- If the challenge has been accepted and verified, it will be the same as `password` or `http://auth0.com/oauth/grant-type/password-realm` grant types. +- If the challenge has been rejected, you will get an `invalid_grant` error, meaning that the challenge was rejected by the user. At this point you should stop polling, as this response is final. +- If the challenge verification is still pending (meaning it has not been accepted nor rejected), you will get an `authorization_pending` error, meaning that you must retry the same request a few seconds later. If you request too frequently, you will get a `slow_down` error. + +When the challenge response includes a `binding_method: prompt`, your app needs to prompt the user for the `binding_code` and send it as part of the request. The `binding_code` is usually a 6-digit number (similar to an OTP) included as part of the challenge. No `binding_code` is necessary if the challenge response did not include a `binding_method`. In this scenario, the response will be immediate; you will receive an `invalid_grant` or an `access_token` as response. + +### Learn More + +- [Associate Out-of-Band Authenticators](https://auth0.com/docs/secure/multi-factor-authentication/authenticate-using-ropg-flow-with-mfa/enroll-challenge-sms-voice-authenticators) + +## Parameters + + + A DPoP proof for the request. This is optional and only required if your application uses Demonstrating Proof-of-Possession. + + +## Request Body + + + Denotes the flow you are using. For OTP MFA, use `http://auth0.com/oauth/grant-type/mfa-oob`. + + Allowed values: `http://auth0.com/oauth/grant-type/mfa-oob` + + + + Your application's Client ID. + + + + A JWT containing a signed assertion with your application credentials. + + + + The value is `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. + + Allowed values: `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` + + + + Your application's Client Secret. + + + + The `mfa_token` you received from `mfa_required` error. + + + + The oob code received from the challenge request. + + + + A code used to bind the side channel with the main channel you are using to authenticate. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Successful response for OOB verification. | +| 400 | Bad request due to missing or invalid parameters. | +| 401 | Unauthorized, invalid mfa_token or oob_code. | diff --git a/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-recovery-code.mdx b/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-recovery-code.mdx new file mode 100644 index 0000000000..a8dd895186 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-recovery-code.mdx @@ -0,0 +1,58 @@ +--- +title: "Verify with Recovery Code" +description: "Verifies multi-factor authentication (MFA) using a recovery code." +--- + +`POST /oauth/token` + +Verifies multi-factor authentication (MFA) using a recovery code. Some multi-factor authentication (MFA) providers (such as Guardian) support using a recovery code to login. Use this method to authenticate when the user's enrolled device is unavailable, or the user cannot receive the challenge or accept it due to connectivity issues. + +To verify MFA using a recovery code your app must prompt the user for the recovery code, and then make a request to `/oauth/token` with `grant_type=http://auth0.com/oauth/grant-type/mfa-recovery-code`. Include the collected recovery code and the `mfa_token` from the `mfa_required` error. If the recovery code is accepted, the response will be the same as for `password` or `http://auth0.com/oauth/grant-type/password-realm` grant types. It might also include a `recovery_code` field, which the application must display to the end-user to be stored securely for future use. + +## Parameters + + + A DPoP proof for the request. This is optional and only required if your application uses Demonstrating Proof-of-Possession. + + +## Request Body + + + Denotes the flow you are using. For recovery code use `http://auth0.com/oauth/grant-type/mfa-recovery-code`. + + Allowed values: `http://auth0.com/oauth/grant-type/mfa-recovery-code` + + + + Your application's Client ID. + + + + A JWT containing a signed assertion with your application credentials. + + + + The value is `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. + + Allowed values: `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` + + + + Your application's Client Secret. + + + + The `mfa_token` you received from `mfa_required` error. + + + + Recovery code provided by the end-user. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Successful response for recovery code verification. | +| 400 | Bad request due to missing or invalid parameters. | +| 401 | Unauthorized, invalid mfa_token or recovery_code. | diff --git a/main/docs/fr-ca/api/authentication/passwordless/authenticate-user.mdx b/main/docs/fr-ca/api/authentication/passwordless/authenticate-user.mdx new file mode 100644 index 0000000000..0a1e4440df --- /dev/null +++ b/main/docs/fr-ca/api/authentication/passwordless/authenticate-user.mdx @@ -0,0 +1,71 @@ +--- +title: "Authentifier l’utilisateur" +description: "Après avoir obtenu un code de vérification, utilisez ce point de terminaison pour connecter l’utilisateur avec son numéro de téléphone/courriel et code de..." +--- + +`POST /oauth/token` + +Après avoir obtenu un code de vérification, utilisez ce point de terminaison pour connecter l’utilisateur avec son numéro de téléphone/courriel et code de vérification. + +### Remarques[​](#remarques) + +- Le `grant_type` devrait être `http://auth0.com/oauth/grant-type/passwordless/otp`. +- Le `client_id` de votre application est requis. +- Le `username` est soit le numéro de téléphone de l’utilisateur (si `realm=sms`), soit le courriel de l’utilisateur (si `realm=email`). +- Le `realm` doit être soit `sms`, soit `email`, correspondant à la demande [POST /passwordless/start](#get-code-or-link). +- `otp` doit être le code de vérification de l’utilisateur. +- `redirect_uri` est une URL de rappel obligatoire qui doit être enregistrée dans les **Callback URL autorisées** de votre application. + +### Codes d’erreur[​](#codes-derreur) + +Pour une référence complète sur les codes d’erreur pour ce point de terminaison, reportez-vous à [Réponses d’erreur standard](#standard-error-responses). + +### En savoir plus[​](#en-savoir-plus) + +- [Authentification sans mot de passe](/docs/fr-ca/api/authentication/connections/passwordless) + +## Parameters + + + Doit être [http://auth0.com/oauth/grant-type/passwordless/otp](http://auth0.com/oauth/grant-type/passwordless/otp). + + + + Le client_id de votre application. + + + + Client_secret de votre application. Obligatoire uniquement pour les applications Web classiques. + + + + Code de vérification de l’utilisateur. + + + + Doit correspondre à la connexion utilisée. + + + + Numéro de téléphone ou courriel de l’utilisateur. + + + + Identifiant API de l’API pour laquelle vous voulez un jeton d’accès. + + + + Utilisez openid pour obtenir un jeton d’identification. + + + + Une Callback URL qui a été enregistrée avec les Callback URL autorisées de votre application. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Utilisateur authentifié. | +| 400 | Demande incorrecte. Paramètres non valides. | +| 401 | Non autorisé. Identifiants non valides. | diff --git a/main/docs/fr-ca/api/authentication/passwordless/get-code-or-link.mdx b/main/docs/fr-ca/api/authentication/passwordless/get-code-or-link.mdx new file mode 100644 index 0000000000..dcfffb0507 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/passwordless/get-code-or-link.mdx @@ -0,0 +1,83 @@ +--- +title: "Obtenir un code ou un lien" +description: "Les connexions sans mot de passe permettent à l’utilisateur de ne pas avoir à se souvenir d’un mot de passe. En effet, un autre mécanisme est utilisé pour..." +--- + +`POST /passwordless/start` + +Les connexions sans mot de passe permettent à l’utilisateur de ne pas avoir à se souvenir d’un mot de passe. En effet, un autre mécanisme est utilisé pour prouver l’identité, par exemple un code à usage unique envoyé par courriel ou SMS chaque fois que l’utilisateur se connecte. + +Vous avez trois options pour l’[authentification sans mot de passe](/docs/fr-ca/api/authentication/connections/passwordless) : + +- Envoyer un code de vérification par courriel. +- Envoyer un lien par courriel. +- Envoyer un code de vérification par SMS. + +### Remarques[​](#remarques) + +- Si vous avez envoyé un code de vérification par courriel ou par SMS, vous devez, après avoir obtenu le code, authentifier l’utilisateur avec le code [/passwordless/verify endpoint](#authenticate-user), en utilisant `email` ou `phone_number` comme `username`, et le code de vérification comme `password`. +- Ce point de terminaison est conçu pour être appelé du côté client et est sujet à une [limite anti-attaques](/docs/fr-ca/api/authentication/policies/rate-limit-policy/authentication-api-endpoint-rate-limits). +- L’exemple de script auth0.js emploie la version 8 de la bibliothèque. Si vous utilisez auth0.js version 7, veuillez consulter ce [guide de référence](/docs/fr-ca/api/authentication/libraries/auth0js/v7). + +### Codes d’erreur[​](#codes-derreur) + +Pour une référence complète des codes d’erreur pour ce point de terminaison, reportez-vous à [Erreurs > POST /passwordless/start](#post-passwordless-start). + +### En savoir plus[​](#en-savoir-plus) + +- [Authentification sans mot de passe](/docs/fr-ca/api/authentication/connections/passwordless) +- [Meilleures pratiques de l’authentification sans mot de passe](/docs/fr-ca/api/authentication/connections/passwordless/best-practices) + +## Parameters + + + `client_id` de votre application. + + + + Un JWT contenant une assertion signée avec les identifiants de votre application. Obligatoire lorsque la méthode d’authentification de l’application est un JWT signé par clé privée. + + + + Utilisez la valeur `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. Obligatoire lorsque la méthode d’authentification de l’application est un JWT signé par clé privée. + + + + `client_secret` de votre application. Obligatoire **uniquement** pour les applications Web classiques. + + + + Comment envoyer le code/lien à l’utilisateur. Utiliser `email` pour envoyer par courriel, ou `sms` pour envoyer par SMS. + + + + Définir ce champ comme étant l’adresse courriel de l’utilisateur, lorsque `connection=email`. + + + + Définir ce champ comme étant le numéro de téléphone de l’utilisateur, lorsque `connection=sms`. + + + + Utiliser `link` pour envoyer un lien ou `code` pour envoyer un code de vérification. Un lien sera envoyé si la valeur est « null ». + + + + Tout paramètre d’authentification que vous souhaitez ajouter, comme `scope`, `state`, `redirect_uri`, etc. + + + + Permissions OAuth. + + + + Paramètre d’état pour conserver l’état entre la requête et le rappel. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réussite de l’envoi du code ou du lien. | +| 400 | Demande incorrecte. Paramètres non valides. | +| 401 | Non autorisé. Identifiants du client non valides. | diff --git a/main/docs/fr-ca/api/authentication/passwordless/start-passwordless-authentication.mdx b/main/docs/fr-ca/api/authentication/passwordless/start-passwordless-authentication.mdx deleted file mode 100644 index 219cbd934d..0000000000 --- a/main/docs/fr-ca/api/authentication/passwordless/start-passwordless-authentication.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /passwordless/start -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/passwordless/verify.mdx b/main/docs/fr-ca/api/authentication/passwordless/verify.mdx index 1a13bc7dee..4656bd639e 100644 --- a/main/docs/fr-ca/api/authentication/passwordless/verify.mdx +++ b/main/docs/fr-ca/api/authentication/passwordless/verify.mdx @@ -1,11 +1,66 @@ --- -openapi: authentication-api-oas post /passwordless/verify -playground: simple -deprecated: false +title: "Vérification" +description: "Cette fonctionnalité est désactivée par défaut pour les nouveaux locataires depuis le 8 juin 2017. Voir [Types d’autorisation..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /passwordless/verify` - - \ No newline at end of file + +Cette fonctionnalité est désactivée par défaut pour les nouveaux locataires depuis le 8 juin 2017. Voir [Types d’autorisation d’application](/docs/fr-ca/api/authentication/applications/concepts/application-grant-types) pour en savoir plus. + + +Après avoir obtenu un code de vérification, utilisez ce point de terminaison pour connecter l’utilisateur avec son numéro de téléphone/courriel et code de vérification. Il s’agit d’une authentification active, donc l’utilisateur doit saisir le code dans votre application. + +### Remarques[​](#remarques) + +- La valeur de la permission `profile` demande l’accès aux demandes de profil par défaut de l’utilisateur final, qui sont : `name`, `family_name`, `given_name`, `middle_name`, `nickname`, `preferred_username`, `profile`, `picture`, `website`, `gender`, `birthdate`, `zoneinfo`, `locale` et `updated_at`. +- La valeur de permission `email` demande l’accès aux demandes `email` et `email_verified`. +- L’exemple de script auth0.js emploie la version 8 de la bibliothèque. Si vous utilisez auth0.js version 7, veuillez consulter ce [guide de référence](/docs/fr-ca/api/authentication/libraries/auth0js/v7). + +### Codes d’erreur[​](#codes-derreur) + +Pour une référence complète des codes d’erreur pour ce point de terminaison, reportez-vous à [Erreurs > POST /passwordless/verify](#post-passwordless-verify). + +### En savoir plus[​](#en-savoir-plus) + +- [Meilleures pratiques de l’authentification sans mot de passe](/docs/fr-ca/api/authentication/connections/passwordless/best-practices) + +## Parameters + + + Le type d’autorisation, qui doit être `password`. + + + + `client_id` de votre application. + + + + Utilisez `sms` ou `email` (doit être le même que [POST /passwordless/start](#get-code-or-link)). + + + + Le numéro de téléphone de l’utilisateur si `connection=sms`, ou l’adresse courriel de l’utilisateur si `connection=email`. + + + + Code de vérification de l’utilisateur. + + + + Utiliser `openid` pour obtenir un jeton d’identification ou `openid profile email` pour inclure des informations de profil utilisateur dans le jeton d’identification. + + + + Une Callback URL qui a été enregistrée avec les Callback URL autorisées de votre application. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Utilisateur authentifié. | +| 400 | Demande incorrecte. Paramètres non valides. | +| 401 | Non autorisé. Identifiants non valides. | +| 403 | Interdit. Authentification client requise. | +| 500 | Erreur de serveur interne. | diff --git a/main/docs/fr-ca/api/authentication/pushed-authorization-requests/pushed-authorization-request-par.mdx b/main/docs/fr-ca/api/authentication/pushed-authorization-requests/pushed-authorization-request-par.mdx deleted file mode 100644 index 142c9425d8..0000000000 --- a/main/docs/fr-ca/api/authentication/pushed-authorization-requests/pushed-authorization-request-par.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/par -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/refresh-token/refresh-token.mdx b/main/docs/fr-ca/api/authentication/refresh-token/refresh-token.mdx new file mode 100644 index 0000000000..07fb151784 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/refresh-token/refresh-token.mdx @@ -0,0 +1,41 @@ +--- +title: "Actualiser le jeton d’accès" +description: "Utilisez ce point de terminaison pour actualiser un jeton d’accès à l’aide du jeton d’actualisation que vous avez obtenu lors de l’autorisation." +--- + +`POST /oauth/token` + +Utilisez ce point de terminaison pour actualiser un jeton d’accès à l’aide du jeton d’actualisation que vous avez obtenu lors de l’autorisation. +En savoir plus[​](#en-savoir-plus) +- [Jetons d’actualisation](/docs/fr-ca/api/authentication/tokens/concepts/refresh-tokens) + +## Parameters + + + Spécifie le flux utilisé. Pour actualiser un jeton d’accès, cette valeur doit être définie sur `refresh_token`. + + + + L’identifiant client de votre application, qui identifie l’application à l’origine de la demande. + + + + Le secret client de votre application. Obligatoire lorsque la méthode d’authentification du point de terminaison du jeton est définie sur `Post` ou `Basic`. + + + + Le jeton d’actualisation précédemment émis au client. Ce jeton est utilisé pour obtenir un nouveau jeton d’accès. + + + + Une liste (délimitée par des espaces) des autorisations demandées pour la permission. En cas d’omission, les permissions d’origine seront utilisées; sinon, vous pouvez demander un ensemble réduit de permissions. Notez que cela doit être encodé en URL. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Le jeton d’accès a été actualisé. | +| 400 | Demande incorrecte. La requête ne comporte pas les paramètres requis ou est mal formée. | +| 401 | Non autorisé. Les identifiants du client ne sont pas valides ou le jeton d’actualisation n’est pas valide. | +| 403 | Interdit. Le jeton d’actualisation n’est pas valide ou a expiré. | diff --git a/main/docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-legacy.mdx b/main/docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-legacy.mdx deleted file mode 100644 index 13fe4961c2..0000000000 --- a/main/docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-legacy.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/ro -playground: simple -deprecated: true ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-password-grant.mdx b/main/docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-password-grant.mdx new file mode 100644 index 0000000000..671620bc38 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-password-grant.mdx @@ -0,0 +1,71 @@ +--- +title: "Autorisation par mot de passe du propriétaire de la ressource" +description: "En fonction des identifiants de l’utilisateur, ce point de terminaison effectuera l’authentification auprès du fournisseur et renverra un objet JSON contenant..." +--- + +`POST /oauth/ro` + +En fonction des identifiants de l’utilisateur, ce point de terminaison effectuera l’authentification auprès du fournisseur et renverra un objet JSON contenant le jeton d’accès ainsi qu’un jeton d’identification. + + +Ce point de terminaison fait partie du flux d’authentification hérité et a été remplacé par le [flux d’autorisation par mot de passe](#resource-owner-password). Pour plus d’informations sur le dernier pipeline d’authentification, veuillez consulter [Présentation de l’authentification conforme à OIDC](/docs/fr-ca/api/authentication/api-auth/intro). + + +### Remarques[​](#remarques) + +- Ce point de terminaison fonctionne uniquement pour les connexions de base de données, les connexions sans mot de passe, Active Directory/LDAP, Windows Entra ID et ADFS. +- La valeur de permission `profile` demande l’accès aux demandes de profil par défaut de l’utilisateur final, qui incluent `name`, `family_name`, `given_name` et d’autres. +- La valeur de permission `email` demande l’accès au `email` et aux demandes `email_verified`. + +### Codes d’erreur[​](#codes-derreur) + +Pour obtenir la référence complète des codes d’erreur pour ce point de terminaison, reportez-vous à [Erreurs > POST /oauth/ro](#post-oauth-ro). + +### En savoir plus[​](#en-savoir-plus) + +- [Appel d’API à partir d’applications hautement fiables](/docs/fr-ca/api/authentication/api-auth/grant/password) + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Authentification réussie | +| 400 | Mauvaise requête. | +| 401 | Non autorisé | +| 403 | Interdit | +| 429 | Trop de requêtes | +| default | Erreur inattendue | diff --git a/main/docs/fr-ca/api/authentication/resource-owner-password-flow/get-token.mdx b/main/docs/fr-ca/api/authentication/resource-owner-password-flow/get-token.mdx new file mode 100644 index 0000000000..b847eab179 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/resource-owner-password-flow/get-token.mdx @@ -0,0 +1,73 @@ +--- +title: "Obtenir un jeton" +description: "Ce flux ne doit être utilisé qu’à partir d’applications hautement fiables qui ne peuvent **pas effectuer de redirections**. Si vous pouvez utiliser des flux..." +--- + +`POST /oauth/token` + + +Ce flux ne doit être utilisé qu’à partir d’applications hautement fiables qui ne peuvent **pas effectuer de redirections**. Si vous pouvez utiliser des flux basés sur des redirections à partir de votre application, nous vous recommandons d’utiliser le [flux de code d’autorisation](#regular-web-app-login-flow) à la place. + + +Il s’agit de l’autorisation OAuth 2.0 que les applications hautement fiables utilisent pour accéder à une API. Dans ce flux, on demande à l’utilisateur final de renseigner ses identifiants (nom d’utilisateur/mot de passe), typiquement en utilisant un formulaire interactif dans l’agent utilisateur (navigateur). Cette information est envoyée au système dorsal, et de là à Auth0. Il est donc impératif de pouvoir faire confiance à l’application. + +### En-têtes de la demande[​](#en-têtes-de-la-demande) +ParamètreDescription`auth0-forwarded-for`IP de l’utilisateur final sous forme de valeur de chaîne. Définissez ce paramètre si vous souhaitez que la protection contre les attaques de force brute fonctionne dans les scénarios côté serveur. +### Réponses[​](#réponses) + +#### 200[​](#200) + +Une réponse réussie renvoie un jeton d’accès. +HTTP/1.1 200 OKContent-Type: application/json{ "access_token":"eyJz93a...k4laUWw", "token_type":"Bearer", "expires_in":86400} +### Remarques[​](#remarques) + +- Les permissions accordées à l’application peuvent être différentes des permissions demandées. Dans ce cas, un paramètre `scope` sera inclus dans la réponse JSON. +- Si vous ne demandez pas de permissions particulières, toutes les permissions définies pour le public seront renvoyées en raison de la confiance implicite accordée à l’application dans le cadre de cette autorisation. +- Pour ajouter la prise en charge des partitions, définissez `grant_type` comme `http://auth0.com/oauth/grant-type/password-realm`, et `realm` comme la partition à laquelle l’utilisateur appartient. Cela correspond à une connexion dans Auth0. +- Outre le nom d’utilisateur et le mot de passe, Auth0 peut demander à l’utilisateur final de fournir un facteur supplémentaire comme preuve d’identité. La demande peut renvoyer une erreur `mfa_required` accompagnée d’un `mfa_token` pour l’authentification multifacteur. + +### En savoir plus[​](#en-savoir-plus) + +- [Appel d’API à partir d’applications hautement fiables](/docs/fr-ca/api/authentication/api-auth/grant/password) +- [Exécution de l’octroi par mot de passe du propriétaire de la ressource](/docs/fr-ca/api/authentication/api-auth/tutorials/password-grant) +- [Authentification multifacteur et mot de passe du propriétaire de la ressource](/docs/fr-ca/api/authentication/mfa/guides/mfa-api/multifactor-resource-owner-password) + +## Parameters + + + Indique le flux que vous utilisez. Pour le mot de passe du propriétaire de la ressource, utilisez `password`. + + + + Identifiant du propriétaire de la ressource, tel que le nom d’utilisateur ou l’adresse courriel. + + + + Secret du propriétaire de la ressource. + + + + L’identifiant unique de l’API cible à laquelle vous souhaitez accéder. + + + + Valeur de chaîne des différentes permissions demandées par l’application. + + + + L’identifiant client de votre application. + + + + Le secret client de votre application. + + + + Valeur de chaîne de la partition à laquelle l’utilisateur appartient. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Renvoie le jeton d’accès. | diff --git a/main/docs/fr-ca/api/authentication/revoke-refresh-token/revoke-refresh-token.mdx b/main/docs/fr-ca/api/authentication/revoke-refresh-token/revoke-refresh-token.mdx new file mode 100644 index 0000000000..270f1edec2 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/revoke-refresh-token/revoke-refresh-token.mdx @@ -0,0 +1,50 @@ +--- +title: "Révoquer un jeton d’actualisation" +description: "Ce point de terminaison permet d’invalider un jeton d’actualisation s’il a été compromis." +--- + +`POST /oauth/revoke` + +Ce point de terminaison permet d’invalider un jeton d’actualisation s’il a été compromis. + +Le comportement de ce point de terminaison dépend de l’état du bouton [Refresh Token Revocation Deletes Grant (La révocation du jeton d’actualisation supprime l’autorisation)](https://auth0.com/docs/tokens/refresh-tokens/revoke-refresh-tokens#refresh-tokens-and-grants). +Si ce bouton est activé, chaque demande de révocation invalide non seulement le jeton en question, mais aussi tous les autres jetons basés sur le même octroi d’autorisation. Cela signifie que tous les **jetons d’actualisation qui ont été émis pour le même utilisateur, la même application et le même public seront révoqués**. +Si ce bouton est désactivé, seul le jeton d’actualisation est révoqué, tandis que l’octroi reste intact. +Remarques[​](#remarques) +- Pour les applications non confidentielles qui ne peuvent pas conserver le secret client (par exemple, les applications natives), le point de terminaison permet de ne pas transmettre de secret client, mais l’application elle-même doit avoir la propriété `tokenEndpointAuthMethod` définie sur `none`. Vous pouvez le faire à partir de l’interface utilisateur ([Dashboard > Applications > Application Settings (Paramètres de l’application)](/docs/fr-ca/api/authentication/revoke-refresh-token/${manage_url}/#/applications)) ou à l’aide de [Management API](/docs/fr-ca/api/authentication/api/management/v2#!/Applications/patch_applications_by_id). + +Codes d’erreur[​](#codes-derreur) +Pour obtenir la référence complète des codes d’erreur pour ce point de terminaison, voir [Erreurs > POST /oauth/revoke](#post-oauth-revoke). +En savoir plus[​](#en-savoir-plus) +- [Jetons d’actualisation](/docs/fr-ca/api/authentication/tokens/concepts/refresh-tokens) + +## Parameters + + + `client_id` de votre application. + + + + Un JWT contenant une assertion signée avec les informations d’identification de votre application. Obligatoire lorsque la méthode d’authentification de l’application est un JWT signé par clé privée. + + + + La valeur est `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. Obligatoire lorsque la méthode d’authentification de l’application est un JWT signé par clé privée. + + + + `client_secret` de votre application. Obligatoire lorsque la méthode d’authentification de l’application est par secret client de base ou par secret client postérieur. Obligatoire pour les applications Web classiques **uniquement**. + + + + Le jeton d’actualisation que vous souhaitez révoquer. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | (empty-response-body) | +| 400 | Mauvaise requête. | +| 401 | Non autorisé | +| default | Erreur inattendue | diff --git a/main/docs/fr-ca/api/authentication/saml/accept-request.mdx b/main/docs/fr-ca/api/authentication/saml/accept-request.mdx deleted file mode 100644 index de95d365e5..0000000000 --- a/main/docs/fr-ca/api/authentication/saml/accept-request.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /samlp/{clientId} -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/saml/accept-saml-request.mdx b/main/docs/fr-ca/api/authentication/saml/accept-saml-request.mdx new file mode 100644 index 0000000000..226054b71e --- /dev/null +++ b/main/docs/fr-ca/api/authentication/saml/accept-saml-request.mdx @@ -0,0 +1,32 @@ +--- +title: "Requête d’accès" +description: "Utilisez ce point de terminaison pour accepter une requête SAML pour initier une connexion." +--- + +`GET /samlp/{clientId}` + +Utilisez ce point de terminaison pour accepter une requête SAML pour initier une connexion. + +Vous pouvez éventuellement inclure un paramètre `connection` pour vous connecter à un fournisseur spécifique. Si aucune connexion n’est spécifiée, la [page de connexion Auth0](/docs/fr-ca/api/authentication/authenticate/login/auth0-universal-login) s’affiche. + +En option, les requêtes de connexion initiées par le fournisseur de services (SP) peuvent inclure un paramètre `organization` pour authentifier les utilisateurs dans le contexte d’une organisation. Pour en savoir plus, consultez la section [Organisations](/docs/fr-ca/api/authentication/organizations) + +## Parameters + + + Identifiant client de votre application. + + + + Connexion à utiliser lors de la connexion. + + + + Identifiant de l’organization, si l’authentification est effectuée dans le contexte d’une organization. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Acceptation de la requête SAML réussie. | diff --git a/main/docs/fr-ca/api/authentication/saml/get-metadata.mdx b/main/docs/fr-ca/api/authentication/saml/get-metadata.mdx deleted file mode 100644 index 625890b5e8..0000000000 --- a/main/docs/fr-ca/api/authentication/saml/get-metadata.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /samlp/metadata/{clientId} -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/saml/get-saml-metadata.mdx b/main/docs/fr-ca/api/authentication/saml/get-saml-metadata.mdx new file mode 100644 index 0000000000..988b303cf4 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/saml/get-saml-metadata.mdx @@ -0,0 +1,24 @@ +--- +title: "Obtenir des métadonnées" +description: "Ce point de terminaison renvoie les métadonnées SAML 2.0." +--- + +`GET /samlp/metadata/{clientId}` + +Ce point de terminaison renvoie les métadonnées SAML 2.0. + +### En savoir plus[​](#en-savoir-plus) + +- [SAML](/docs/fr-ca/api/authentication/protocols/saml) + +## Parameters + + + Le client_id de votre application. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Récupération réussie des métadonnées SAML. | diff --git a/main/docs/fr-ca/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow.mdx b/main/docs/fr-ca/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow.mdx deleted file mode 100644 index df437df5ab..0000000000 --- a/main/docs/fr-ca/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /login/callback -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/saml/idp-initiated-sso.mdx b/main/docs/fr-ca/api/authentication/saml/idp-initiated-sso.mdx new file mode 100644 index 0000000000..8abc371467 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/saml/idp-initiated-sso.mdx @@ -0,0 +1,22 @@ +--- +title: "Flux d’authentification unique (SSO) initiée par IdP" +description: "Ce point de terminaison accepte une connexion initiée par un fournisseur d’identité SAML sur SAMLResponse. La connexion correspondant au fournisseur d’identité..." +--- + +`POST /login/callback` + +Ce point de terminaison accepte une connexion initiée par un fournisseur d’identité SAML sur SAMLResponse. La connexion correspondant au fournisseur d’identité est indiquée dans la chaîne de requête. L’utilisateur sera redirigé vers l’application indiquée dans la section Connexion initiée par l’IdP du fournisseur SAML. + +### En savoir plus[​](#en-savoir-plus) + +- [SAML](/docs/fr-ca/api/authentication/protocols/saml) + +## Parameters + + + Le nom d’un fournisseur d’identité configuré pour votre application. + + + + Une assertion SAML initiée par un IdP. + diff --git a/main/docs/fr-ca/api/authentication/signup/create-a-new-user.mdx b/main/docs/fr-ca/api/authentication/signup/create-a-new-user.mdx new file mode 100644 index 0000000000..398e431a74 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/signup/create-a-new-user.mdx @@ -0,0 +1,75 @@ +--- +title: "Créer un nouveau utilisateur" +description: "Selon les identifiants et la connection d'un utilisateur, ce point de terminaison crée un nouvel utilisateur." +--- + +`POST /dbconnections/signup` + +Selon les identifiants et la `connection` d'un utilisateur, ce point de terminaison crée un nouvel utilisateur. + +Ce point de terminaison ne fonctionne que pour les connexions de base de données. + +### Remarques + +- L'exemple de script auth0.js emploie la version 8 de la bibliothèque. Si vous utilisez auth0.js version 7, veuillez consulter ce [guide de référence](https://auth0.com/docs/libraries/auth0js/v7). + +### En savoir plus + +- [Force du mot de passe dans les connexions de base de données Auth0](https://auth0.com/docs/authenticate/database-connections/password-strength) +- [Options de mot de passe dans les connexions de base de données Auth0](https://auth0.com/docs/authenticate/database-connections/password-options) +- [Ajout de nom d'utilisateur pour les connexions de base de données](https://auth0.com/docs/manage-users/user-accounts/identify-users#username) +- [Présentation des métadonnées](https://auth0.com/docs/manage-users/user-accounts/metadata) + +## Paramètres + + + Le `client_id` de votre application. + + + + L'adresse courriel de l'utilisateur. + + + + Le mot de passe de l'utilisateur. + + + + Le nom de la connexion de base de données configurée pour votre application. + + + + Le nom d'utilisateur (si la connexion est configurée pour l'exiger). + + + + Le prénom de l'utilisateur. + + + + Le nom de famille de l'utilisateur. + + + + Le nom complet de l'utilisateur. + + + + Le surnom de l'utilisateur. + + + + L'URL de la photo de profil de l'utilisateur. + + + + Les métadonnées supplémentaires de l'utilisateur. + + +## Réponse + +| Statut | Description | +|--------|-------------| +| 200 | Utilisateur créé | +| 400 | Mauvaise requête, paramètres manquants ou non valides. | +| 409 | Conflit, l'utilisateur existe déjà. | \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/token-exchange-for-native-social/token-exchange-native-social.mdx b/main/docs/fr-ca/api/authentication/token-exchange-for-native-social/token-exchange-native-social.mdx new file mode 100644 index 0000000000..da09a80111 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/token-exchange-for-native-social/token-exchange-native-social.mdx @@ -0,0 +1,64 @@ +--- +title: "Échange de jetons pour l'authentification native via réseau social" +description: "Ce flux est destiné à être utilisé uniquement avec les interactions natives via réseau social." +--- + +`POST /oauth/token` + + +Ce flux est destiné à être utilisé uniquement avec les interactions natives via réseau social. L'utilisation de ce flux en dehors d'un cadre natif via réseau social est fortement déconseillée. + + +Lorsqu'une solution non basée sur un navigateur (telle que la trousse SDK d'une plateforme mobile) authentifie l'utilisateur, l'authentification se traduit généralement par des artefacts renvoyés au code de l'application. En pareil cas, ce type d'autorisation permet à la plateforme Auth0 d'accepter des artefacts provenant de sources fiables et d'émettre des jetons en réponse. De cette manière, les applications qui utilisent des mécanismes d'authentification non basés sur le navigateur (comme c'est souvent le cas dans les applications natives) peuvent toujours récupérer les jetons Auth0 sans demander d'interaction supplémentaire de la part de l'utilisateur. + +Les artefacts renvoyés par ce flux (et leur contenu) seront déterminés par le `subject_token_type` et les paramètres de configuration du locataire. + +### Remarques + +- Les permissions accordées à l'application peuvent être différentes des autorisations demandées. Dans ce cas, un paramètre `scope` sera inclus dans la réponse JSON. +- Si vous ne demandez pas de permissions particulières, toutes les permissions définies pour le public seront renvoyées en raison de la confiance implicite accordée à l'application dans le cadre de cette autorisation. Vous pouvez personnaliser les permissions renvoyées dans une règle. Pour en savoir plus, lisez [Appel d'API à partir d'applications hautement fiables](https://auth0.com/docs/secure/tokens/access-tokens). + +### En savoir plus + +- [Ajouter une connexion avec Apple aux application iOS natives](https://auth0.com/docs/authenticate/identity-providers/social-identity-providers/apple-native) +- [iOS Swift - Se connecter avec le démarrage rapide d'Apple](https://auth0.com/docs/quickstart/native/ios-swift/interactive) + +## Paramètres + + + L'adresse IP de l'utilisateur final sous forme de chaîne de caractères. + + + + Le type d'autorisation. Utilisez `urn:ietf:params:oauth:grant-type:token-exchange`. + + + + Le jeton de sujet provenant du fournisseur d'identité. + + + + Le type de jeton de sujet. + + + + Le `client_id` de votre application. + + + + L'identifiant unique de l'API cible. + + + + Valeur de chaîne des différentes permissions demandées par l'application. Utilisez des espaces blancs pour séparer les différentes permissions. + + + + Le profil utilisateur à utiliser. + + +## Réponse + +| Statut | Description | +|--------|-------------| +| 200 | Réponse correcte | diff --git a/main/docs/fr-ca/api/authentication/token-exchange/token-endpoint.mdx b/main/docs/fr-ca/api/authentication/token-exchange/token-endpoint.mdx deleted file mode 100644 index 19023bfe2a..0000000000 --- a/main/docs/fr-ca/api/authentication/token-exchange/token-endpoint.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/token -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/token-management/revoke-refresh-token.mdx b/main/docs/fr-ca/api/authentication/token-management/revoke-refresh-token.mdx deleted file mode 100644 index c620ed0473..0000000000 --- a/main/docs/fr-ca/api/authentication/token-management/revoke-refresh-token.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/revoke -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/user-profile-legacy/get-token-info-legacy.mdx b/main/docs/fr-ca/api/authentication/user-profile-legacy/get-token-info-legacy.mdx deleted file mode 100644 index 85104e425f..0000000000 --- a/main/docs/fr-ca/api/authentication/user-profile-legacy/get-token-info-legacy.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /tokeninfo -playground: simple -deprecated: true ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/fr-ca/api/authentication/user-profile-legacy/get-token-info.mdx b/main/docs/fr-ca/api/authentication/user-profile-legacy/get-token-info.mdx new file mode 100644 index 0000000000..b23a931a76 --- /dev/null +++ b/main/docs/fr-ca/api/authentication/user-profile-legacy/get-token-info.mdx @@ -0,0 +1,30 @@ +--- +title: "Obtenir des informations sur les jetons" +description: "Ce point de terminaison appartient à l’ancien pipeline d’authentification et sera désactivé pour les utilisateurs de notre nouveau pipeline conforme à OIDC...." +--- + +`POST /tokeninfo` + + +Ce point de terminaison appartient à l’ancien pipeline d’authentification et sera désactivé pour les utilisateurs de notre nouveau pipeline conforme à OIDC. Nous encourageons l’utilisation de [/userinfo endpoint](#get-user-info) à la place. Pour plus d’informations sur le dernier pipeline d’authentification, veuillez consulter [Présentation de l’authentification conforme à OIDC](/docs/fr-ca/api/authentication/api-auth/intro). + + +Ce point de terminaison valide un jeton Web JSON (JWT) (signature et expiration) et renvoie les informations utilisateur associées à la propriété `sub` de l’ID utilisateur du jeton. + +### Remarques[​](#remarques) + +Ce point de terminaison renverra trois en-têtes de réponse HTTP, qui fournissent des données pertinentes sur ses limites anti-attaques : +- `X-RateLimit-Limit` : Nombre de requêtes autorisées par minute. +- `X-RateLimit-Remaining` : Nombre de requêtes disponibles. Chaque nouvelle requête réduit ce nombre de 1. Le nombre de requêtes est de nouveau augmenté après chaque minute qui passe, de sorte que ce nombre augmente de 1 à chaque fois. +- `X-RateLimit-Reset` : Temps restant avant la réinitialisation de la limite anti-attaques (`X-RateLimit-Limit`). La valeur est exprimée en [secondes au format UTC](https://en.wikipedia.org/wiki/Unix_time). + +### En savoir plus[​](#en-savoir-plus) + +- [Structure du profil utilisateur](/docs/fr-ca/api/authentication/users/references/user-profile-structure) +- [Politique de limite anti-attaques de l’API Auth0](/docs/fr-ca/api/authentication/policies/rate-limits) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réussite de la réponse avec les informations de l’utilisateur | diff --git a/main/docs/fr-ca/api/authentication/user-profile/get-user-info.mdx b/main/docs/fr-ca/api/authentication/user-profile/get-user-info.mdx index 43e7adcc9c..8b1beb232e 100644 --- a/main/docs/fr-ca/api/authentication/user-profile/get-user-info.mdx +++ b/main/docs/fr-ca/api/authentication/user-profile/get-user-info.mdx @@ -1,11 +1,36 @@ --- -openapi: authentication-api-oas get /userinfo -playground: simple -deprecated: false +title: "Obtenir les informations de l’utilisateur" +description: "Suite au jeton d’accès Auth0 obtenu lors de la connexion, ce point de terminaison renvoie le profil d’un utilisateur. Ce point de terminaison fonctionnera..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`GET /userinfo` - - \ No newline at end of file +Suite au jeton d’accès Auth0 obtenu lors de la connexion, ce point de terminaison renvoie le profil d’un utilisateur. Ce point de terminaison fonctionnera uniquement si `openid` a été accordé comme permission pour le jeton d’accès. Les informations de profil utilisateur incluses dans la réponse dépendent des permissions demandées. Par exemple, une simple permission `openid` pourrait renvoyer moins d’informations qu’une permission `openid profile email`. + +### Remarques[​](#remarques) + +- L’exemple de script auth0.js emploie la version 8 de la bibliothèque. Si vous utilisez auth0.js version 7, veuillez consulter ce [guide de référence](/docs/fr-ca/api/authentication/libraries/auth0js/v7). +- La méthode `parseHash` du script auth0.js nécessite que vos jetons soient signés avec `RS256`, plutôt que `HS256`. +- Pour renvoyer `user_metadata` ou d’autres informations personnalisées à partir de ce point de terminaison, ajoutez une demande personnalisée au jeton d’identification avec une [action](/docs/fr-ca/api/authentication/secure/tokens/json-web-tokens/create-custom-claims#create-custom-claims). Pour plus d’informations, reportez-vous à la section [Demandes et permissions du profil utilisateur](/docs/fr-ca/api/authentication/api-auth/tutorials/adoption/scope-custom-claims). +Ce point de terminaison retournera trois en-têtes de réponse HTTP, qui fournissent des données pertinentes sur sa limite anti-attaques : +- `X-RateLimit-Limit` : Nombre de requêtes autorisées par minute. +- `X-RateLimit-Remaining` : Nombre de requêtes disponibles. Chaque nouvelle requête réduit ce nombre de 1. Le nombre de requêtes est de nouveau augmenté après chaque minute qui passe, de sorte que ce nombre augmente de 1 à chaque fois. +- `X-RateLimit-Reset` : Temps restant avant la réinitialisation de la limite anti-attaques (`X-RateLimit-Limit`). La valeur est exprimée en [secondes au format UTC](https://en.wikipedia.org/wiki/Unix_time). + +- La demande `Email` renvoie un instantané du courriel au moment de la connexion. +- Les demandes standard (autres que `email`) renvoient la dernière valeur (sauf si la valeur provient d’un IdP externe). +- Les demandes personnalisées renvoient toujours la dernière valeur de la demande. +- Pour accéder aux valeurs les plus récentes pour le champ `email` ou pour des demandes personnalisées, vous devez obtenir de nouveaux jetons. Vous pouvez vous connecter à l’aide de l’authentification silencieuse (où le paramètre `prompt` de votre appel au point de terminaison [`authorize`](/docs/fr-ca/api/authentication/api/authentication#authorization-code-grant) est égal à `none`). +- Pour accéder aux valeurs les plus à jour pour les demandes standard qui ont été modifiées à l’aide d’un IdP externe (par exemple, l’utilisateur a changé son adresse courriel dans Facebook), vous devez obtenir de nouveaux jetons. Connectez-vous à nouveau à l’aide de l’IdP externe, mais *pas* avec une authentification silencieuse. + +### En savoir plus[​](#en-savoir-plus) + +- [Référence Auth0.js v8 : Extraire l’objet authResult et obtenir les informations utilisateur](/docs/fr-ca/api/authentication/libraries/auth0js#extract-the-authresult-and-get-user-info) +- [Politique de limite anti-attaques de l’API Auth0](/docs/fr-ca/api/authentication/policies/rate-limits) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Profil utilisateur récupéré avec succès. | +| 401 | Jeton d’accès non autorisé, non valide ou manquant. | diff --git a/main/docs/fr-ca/api/authentication/ws-federation/accept-ws-federation-request.mdx b/main/docs/fr-ca/api/authentication/ws-federation/accept-ws-federation-request.mdx index 2fa57f881b..dcd77ffdd3 100644 --- a/main/docs/fr-ca/api/authentication/ws-federation/accept-ws-federation-request.mdx +++ b/main/docs/fr-ca/api/authentication/ws-federation/accept-ws-federation-request.mdx @@ -1,11 +1,48 @@ --- -openapi: authentication-api-oas get /wsfed/{clientId} -playground: simple -deprecated: false +title: "Accepter WS-Federation Request" +description: "Ce terminal accepte une demande WS-Federation pour initier une connexion." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`GET /wsfed/{clientId}` - - \ No newline at end of file +Ce terminal accepte une demande WS-Federation pour initier une connexion. + +### Remarques[​](#remarques) + +Le paramètre `wtrealm` doit être dans l’un des formats suivants : +- `urn:clientID` (par exemple, urn:${account.clientId}) +- Si ce paramètre ne commence pas par urn, le tableau `client.clientAliases` est utilisé pour la recherche. Cela ne peut être défini qu’avec Management API [/api/v2/clients](/docs/fr-ca/api/authentication/api/management/v2#!/Clients/get_clients). + +- Le paramètre `whr` est mappé à la connexion comme ceci : `urn:CONNECTION_NAME`. Par exemple, `urn:google-oauth2` indique la connexion avec Google. Si aucun paramètre `whr` n’est inclus, l’utilisateur sera dirigé vers la [page de connexion Auth0](/docs/fr-ca/api/authentication/login_page). + +### En savoir plus[​](#en-savoir-plus) + +- [WS-Federation](/docs/fr-ca/api/authentication/protocols/ws-fed) + +## Parameters + + + `client-id` de votre application. + + + + Peut être utilisé à la place de `client-id`. + + + + Le nom de la connexion (utilisé pour ignorer la page de connexion). + + + + État de votre application. + + + + La Callback URL. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réponse réussie pour la demande de WS-Federation. | diff --git a/main/docs/fr-ca/api/authentication/ws-federation/get-ws-federation-metadata.mdx b/main/docs/fr-ca/api/authentication/ws-federation/get-ws-federation-metadata.mdx index e52084a4e7..0db9b4807b 100644 --- a/main/docs/fr-ca/api/authentication/ws-federation/get-ws-federation-metadata.mdx +++ b/main/docs/fr-ca/api/authentication/ws-federation/get-ws-federation-metadata.mdx @@ -1,11 +1,18 @@ --- -openapi: authentication-api-oas get /wsfed/FederationMetadata/2007-06/FederationMetadata.xml -playground: simple -deprecated: false +title: "Obtenir les métadonnées WS-Federation" +description: "Ce point de terminaison renvoie les métadonnées WS-Federation." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`GET /wsfed/FederationMetadata/2007-06/FederationMetadata.xml` - - \ No newline at end of file +Ce point de terminaison renvoie les métadonnées WS-Federation. + +### En savoir plus[​](#en-savoir-plus) + +- [WS-Federation](/docs/fr-ca/api/authentication/protocols/ws-fed) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Réponse réussie avec les métadonnées WS-Federation. | diff --git a/main/docs/ja-jp/api/authentication.mdx b/main/docs/ja-jp/api/authentication.mdx index f560f36ced..0ece89f729 100644 --- a/main/docs/ja-jp/api/authentication.mdx +++ b/main/docs/ja-jp/api/authentication.mdx @@ -1,4 +1,156 @@ --- -title: "Authentication API Reference" -description: "Documentation for Auth0's Authentication API" ---- \ No newline at end of file +title: "認証API" +description: "認証APIは、Auth0を使用する際に、ユーザーのアイデンティティのあらゆる側面を管理できるようにします。エンドポイントを提供するため、ユーザーはログイン、サインアップ、ログアウト、APIへのアクセスなどを行うことができます。" +--- + +認証APIは、Auth0を使用する際に、ユーザーのアイデンティティのあらゆる側面を管理できるようにします。エンドポイントを提供するため、ユーザーはログイン、サインアップ、ログアウト、APIへのアクセスなどを行うことができます。 + +APIは、[OpenID Connect](https://auth0.com/docs/authenticate/protocols/openid-connect-protocol)、[OAuth 2.0](https://auth0.com/docs/authenticate/protocols/oauth)、[FAPI](https://auth0.com/docs/secure/highly-regulated-identity#advanced-security-with-openid-connect-fapi-)や[SAML](https://auth0.com/docs/protocols/saml)など、各種のアイデンティティプロトコルに対応しています。 + + +このAPIは、RESTful APIとの統合に慣れている人を対象に設計されています。ガイドが便利だと思われる方は、[クイックスタート](https://auth0.com/docs/ja-jp/quickstarts)や[ライブラリー](https://auth0.com/docs/ja-jp/libraries)を試してみてください。 + + +## ベースURL + +認証APIはHTTPSを使用します。このドキュメントで参照されているURLはすべて次のベースに従っています：`https://{yourDomain}` + +## 認証方法 + +このAPIを使用した認証には、5つのオプションがあります： + +- OAuth2 アクセストークン +- クライアントIDとクライアントアサーション（機密アプリケーション） +- クライアントIDとクライアントシークレット（機密アプリケーション） +- クライアントID（公開アプリケーション） +- mTLS認証（機密アプリケーション） + +### OAuth2アクセストークン + +`Bearer`認証スキームを使用して、有効なアクセストークンを`Authorization`ヘッダーに含めて送信します。 + +たとえば、[ユーザー情報取得エンドポイント](/user-profile/get-user-info)などです。このシナリオでユーザーのプロファイルを取得するには、ユーザーの認証時にアクセストークンを取得し、そのトークンを`Authorization`ヘッダーに含めて[ユーザー情報取得エンドポイント](/user-profile/get-user-info)に要求を送信します。 + +### クライアントIDとクライアントアサーション + +認証するために、署名済みのJSON Web Token（JWT）を含む[クライアントアサーション](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authenticate-with-private-key-jwt)を生成します。要求本文には、クライアントID、`urn:ietf:params:oauth:client-assertion-type:jwt-bearer`の値を持つ`client_assertion_type`パラメーター、署名済みのアサーションを指定する`client_assertion`パラメーターを含めます。例については、「[秘密鍵JWT](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authenticate-with-private-key-jwt)」を参照してください。 + +### クライアントIDとクライアントシークレット + +クライアントIDとクライアントシークレットを送信します。このデータの送信に使用できるメソッドは、アプリケーションに構成されている[トークンエンドポイントの認証方法](https://auth0.com/docs/ja-jp/get-started/applications/confidential-and-public-applications/view-application-type)により決定されます。 + +**Post**を使用している場合には、このデータを要求のJSON本文に含めて送信する必要があります。 + +**Basic**を使用している場合には、`Basic`認証スキームを使用して、このデータを`Authorization`ヘッダーに含めて送信する必要があります。資格情報の値を生成する際には、クライアントIDとクライアントシークレットをコロン（`:`）で区切って連結し、Base64でエンコードします。 + +たとえば、[リフレッシュトークン取り消しエンドポイント](https://auth0.com/docs/ja-jp/secure/tokens/refresh-tokens/revoke-refresh-tokens)などです。このオプションの使用は、機密アプリケーション（資格情報を認可されていないサードパーティーに公開することなく、安全に保持できるアプリケーションなど）のみに限定されます。 + +### クライアントID + +クライアントIDを送信します。公開アプリケーション（SPAやモバイルアプリなど、資格情報を安全に保持できないアプリケーション）については、クライアントIDのみでアクセス可能なエンドポイントをいくつか提供しています。 + +たとえば、[暗黙的付与](/implicit-flow/authorize)などです。 + +### mTLS認証 + +[自己署名](https://auth0.com/docs/get-started/applications/configure-mtls/configure-mtls-for-a-client#self-signed-certificates)または[認証局署名](https://auth0.com/docs/get-started/applications/configure-mtls/configure-mtls-for-a-client#certificate-authority-signed-certificates)の証明書を生成します。そして、mTLSハンドシェイクを行う[カスタマーエッジネットワークをセットアップ](https://auth0.com/docs/get-started/applications/configure-mtls/set-up-the-customer-edge)します。 + +エッジネットワークが証明書を検証すると、次のヘッダーを使用して、要求がAuth0のエッジネットワークに転送されます： + +- カスタムドメインのAPIキーを`cname-api-key`ヘッダーに含める +- クライアント証明書を`client-certificate`ヘッダーに含める +- クライアント証明書のCA検証ステータスを`client-certificate-ca-verified`ヘッダーに含める。詳細については、「[要求を転送する](https://auth0.com/docs/get-started/applications/configure-mtls/set-up-the-customer-edge#forward-the-request-)」を参照してください。 + +詳しい説明については、「[mTLSで認証する](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authenticate-with-mtls)」をお読みください。 + +## パラメーター + +GET要求では、パスでセグメントとして指定しないパラメーターはすべて、HTTPクエリ文字列パラメーターとして渡すことができます。 + +`GET https://{yourDomain}/some-endpoint?param=value¶m=value` + +POST要求では、URLに含めないパラメーターは、コンテンツタイプが`application/json`のJSONとしてエンコードする必要があります。 + +`curl --request POST --url 'https://{yourDomain}/some-endpoint' --header 'content-type: application/json' --data '{"param": "value", "param": "value"}'` + + +この例外は[SAML IdP起点のシングルサインオン（SSO）フロー](#idp-initiated-sso-flow)で、クエリ文字列パラメーターと`x-www-form-urlencoded`値の両方が使用されます。 + + +## サンプルコード + +それぞれのエンドポイントには、次の3つの形式でサンプルのスニペットが提供されています： + +- HTTP要求 +- Curlコマンド +- JavaScript：エンドポイントによって、スニペットには[Auth0.jsライブラリー](https://auth0.com/docs/ja-jp/libraries/auth0js)、Node.jsコードまたは簡素なJavaScriptが使用されます + +要求はそれぞれ、`application/json`のコンテンツタイプで送信する必要があります。 + +## テスト + +エンドポイントは[Authentication API Debugger](https://auth0.com/docs/customize/extensions/authentication-api-debugger-extension)を使用してテストすることができます。 + +### Authentication API Debugger + +[Authentication API Debugger](https://auth0.com/docs/ja-jp/customize/extensions/authentication-api-debugger-extension)はAuth0の拡張機能で、使用すると、認証APIにあるいくつかのエンドポイントをテストすることができます。 + +[デバッガーをインストール](https://auth0.com/docs/ja-jp/customize/extensions/authentication-api-debugger-extension) + +**この拡張機能がすでにインストールされている場合には、スキップして、Authentication API Debuggerへ進んでください。** + +このリンクはテナントの地域に応じて異なります：米国西部、中央ヨーロッパまたはオーストラリア。テナントの地域の詳細については、「[テナントの作成](https://auth0.com/docs/ja-jp/get-started/auth0-overview/create-tenants#region-locality-and-sub-locality)」を参照してください。 + +### 接続を構成する + +1. *［構成］*タブで、**［アプリケーション］**フィールド（テストに使用するアプリケーションを選択）と**［接続］**（使用するソーシャル接続の名前）を設定します。 + +1. **Callback URL**をコピーして、[アプリケーションの設定](https://manage.auth0.com/dashboard/)にある**［許可されているコールバックURL］**に追加します。 + +1. *［OAuth2 / OIDC］*タブで、**［OAuth2 / OIDCログイン］**を選択します。 + +### エンドポイントのオプション + +他のエンドポイントを次のオプションで構成します： + +- パスワードレス：*［OAuth2 / OIDC］*タブで、**［ユーザー名］**に`connection=sms`の場合にはユーザーの電話番号、`connection=email`の場合にはユーザーのメールを設定し、**［パスワード］**にユーザーの確認コードを設定します。**［リソース所有者エンドポイント］**をクリックします。 +- SAML SSO：*［他のフロー］*タブで、**［SAML］**を選択します。 +- WS-Federation：*［他のフロー］*タブで、**［WS-Federation］**を選択します。 +- ログアウト：*［他のフロー］*タブで、**［ログアウト］**を選択するか、IDプロバイダーからもログアウトさせる場合には**［ログアウト（フェデレーション）］**を選択します。 +- レガシーログイン：*［OAuth2 / OIDC］*タブで、**［IDトークン］**、**［リフレッシュトークン］**、**［対象クライアントID］**を設定します。**［委任］**をクリックします。 +- レガシーの委任：*［OAuth2 / OIDC］*タブで、**［ユーザー名］**と**［パスワード］**を設定します。**［リソース所有者エンドポイント］**をクリックします。 +- レガシーのリソース所有者：*［OAuth2 / OIDC］*タブで、**［ユーザー名］**と**［パスワード］**を設定してから、**［リソース所有者エンドポイント］**を選択します。 + +### 認証フロー + +認証フローを次のオプションで構成します： + +- 認可コードフロー：*［OAuth2 / OIDC］*タブで、**［認可コード］**フィールドに[認可コード付与](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authorization-code-flow)で取得したコードを設定し、**［コード検証］**にキーを設定します。**［OAuth2コード交換］**をクリックします。 +- 認可コードフロー＋PKCE：*［OAuth2 / OIDC］*タブで、**［認可コード］**フィールドに[認可コード付与](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authorization-code-flow-with-pkce)で取得したコードを設定し、**［コード検証］**にキーを設定します。**［OAuth2コード交換］**をクリックします。 +- クライアント資格情報フロー：*［OAuth2 / OIDC］*タブで、**［OAuth2クライアント資格情報］**を選択します。 + +## エラー + +エラーが発生すると、エラーオブジェクトを受け取ります。ほとんどのエラーオブジェクトにはエラーコードとエラーの説明が含まれているため、アプリケーションは効率よく問題を特定することができます。 + +`4xx` HTTP応答コードを受け取った場合には、送信した要求が不正であったと考えて間違いありません。 + +`5xx`エラーはAuth0側での問題を示唆しているため、[Auth0のステータスページ](https://status.auth0.com/)や[Twitterの@auth0status](https://twitter.com/auth0status)でシステムの状態を確認してください。 + +その他の場合には、[Auth0サポートのオプション](#サポート)を使用することができます。 + +## レート制限 + +認証APIはレート制限の対象になります。制限はエンドポイントによって異なります。 + +エンドポイントで指定のレート制限を超過すると、次のメッセージを含む`429 Too Many Requests`（要求が多すぎます）応答を受け取ります：`Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.` + +レート制限の詳細については、「[Auth0 APIのレート制限ポリシー](https://auth0.com/docs/ja-jp/troubleshoot/customer-support/operational-policies/rate-limit-policy)」を参照してください。 + +データベース接続の場合、ユーザーアカウントやIPアドレスによっては、ある種のログイン試行の反復が制限されます。詳細については、「[ユーザー/パスワード認証でのレート制限](https://auth0.com/docs/ja-jp/troubleshoot/customer-support/operational-policies/rate-limit-policy)」を参照してください。 + +## サポート + +問題が発生したり、何かでお困りの場合には、[サポート](https://support.auth0.com/)に問い合わせることができます。 + +22日間のトライアル期間以外の無料サブスクリプションプランでは、[サポートセンター](https://support.auth0.com/)の使用やチケットの作成はご利用いただけません。その場合には、[Auth0 Community](https://community.auth0.com/)にご質問ください。サポートプログラムの詳細については、「[サポートのオプション](https://auth0.com/docs/ja-jp/troubleshoot/customer-support)」を参照してください。 diff --git a/main/docs/ja-jp/api/authentication/_metadata.json b/main/docs/ja-jp/api/authentication/_metadata.json deleted file mode 100644 index bbbe30d60c..0000000000 --- a/main/docs/ja-jp/api/authentication/_metadata.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "oasVersion": "v1", - "snippetVersion": "not found" -} diff --git a/main/docs/ja-jp/api/authentication/account-linking-legacy/link.mdx b/main/docs/ja-jp/api/authentication/account-linking-legacy/link.mdx new file mode 100644 index 0000000000..818edf858b --- /dev/null +++ b/main/docs/ja-jp/api/authentication/account-linking-legacy/link.mdx @@ -0,0 +1,51 @@ +--- +title: "リンク" +description: "note" +--- + +`GET /authorize` + +note +このエンドポイントはアカウントリンクで**廃止**されています。この代わりに、[POST /api/v2/users/{id}/identities](/docs/ja-jp/api/authentication/api/management/v2#!/Users/post_identities)を使用してください。詳細については、「[移行のお知らせ](/docs/ja-jp/api/authentication/migrations/past-migrations#account-linking-removal)」を参照してください。 + +ユーザーが第二の認証方法（たとえば、ユーザー/パスワードを用いたデータベース接続に加えて、Facebookでの認証など）をリンクさせたい場合には、このエンドポイントを呼び出します。 + +このエンドポイントはログインフローをトリガーして、既存のアカウントと新しいアカウントをリンクさせます。ユーザーが追加を希望する`connection`への302リダイレクトが返されます。ユーザーは、ログイン成功で返されたアクセストークンによって識別されます。 + +### 備考[​](#備考) + +- `redirect_uri`の値は、[アプリケーション設定](https://manage.auth0.com/dashboard)で有効なCallback URLとして指定される必要があります。 + +### 詳しい情報[​](#詳しい情報) + +- [ユーザーアカウントをリンクする](https://auth0.com/docs/ja-jp/manage-users/user-accounts/user-account-linking/link-user-accounts) +- [ユーザーシナリオによって開始されたユーザーアカウントのリンク処理](http://auth0.com/docs/ja-jp/users/references/link-accounts-user-initiated-scenario) +- [ユーザーアカウントのリンクに関するサーバー側のシナリオ](https://auth0.com/docs/ja-jp/manage-users/user-accounts/user-account-linking/suggested-account-linking-server-side-implementation) + +## Parameters + + + サーバー側のフローには`code`、クライアント側のフローには`token`を使用します。 + + + + アプリケーションの`client_id`です。 + + + + アプリケーションに構成されている接続の名前です。nullの場合には、最初のデータベース接続を使用して[Auth0のログインページ](https://auth0.com/#/login_page)にリダイレクトし、ログインウィジェットを表示します。 + + + + ユーザーを認可した後、Auth0がブラウザーをリダイレクトするURLです。 + + + + ログインしたユーザーのアクセストークンです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | アカウントのリンクで接続にリダイレクト | diff --git a/main/docs/ja-jp/api/authentication/account-linking-legacy/unlink.mdx b/main/docs/ja-jp/api/authentication/account-linking-legacy/unlink.mdx index 8271a6d408..e826be600d 100644 --- a/main/docs/ja-jp/api/authentication/account-linking-legacy/unlink.mdx +++ b/main/docs/ja-jp/api/authentication/account-linking-legacy/unlink.mdx @@ -1,11 +1,21 @@ --- -openapi: authentication-api-oas post /login/unlink -playground: simple -deprecated: true +title: "リンク解除" +description: "note" --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /login/unlink` - - \ No newline at end of file +note +このエンドポイントは**廃止**されています。この代わりに、[DELETE /api/v2/users/{id}/identities/{provider}/{user_id}](/docs/ja-jp/api/authentication/api/management/v2#!/Users/delete_user_identity_by_user_id)を使用してください。 + +ログインしたユーザーの`access_token`と`user_id`が渡されると、このエンドポイントはIDプロバイダーでユーザーのアカウントをリンク解除します。 + +### 詳しく学ぶ[​](#詳しく学ぶ) + +[ユーザーアカウントのリンクを解除する](https://auth0.com/docs/ja-jp/manage-users/user-accounts/user-account-linking/unlink-user-accounts) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | ユーザーアカウントが正常にリンク解除されました | diff --git a/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize.mdx b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize.mdx new file mode 100644 index 0000000000..d10f057204 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize.mdx @@ -0,0 +1,26 @@ +--- +title: "認可" +description: "`/oauth/par`エンドポイントを呼び出した後、`GET`呼び出しを使ってエンドユーザーを`/authorize`エンドポイントにリダイレクトします。" +--- + +`GET /authorize` + +`/oauth/par`エンドポイントを呼び出した後、`GET`呼び出しを使ってエンドユーザーを`/authorize`エンドポイントにリダイレクトします。 +note +`/authorize`エンドポイントは`/oauth/par`エンドポイントに渡されたパラメーターに基づいて応答します。`response_type`を要求した場合は、`/oauth/token`エンドポイントで使う認可コードを受け取ります。 + +## Parameters + + + アプリケーションの`client_id`です。必須です。 + + + + `/oauth/par`エンドポイントから受け取った`request_uri`値です。必須です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | 指定したリダイレクトURIにリダイレクトします。 | diff --git a/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token.mdx b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token.mdx new file mode 100644 index 0000000000..49c2b3e35c --- /dev/null +++ b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token.mdx @@ -0,0 +1,44 @@ +--- +title: "認可コードをトークンと交換" +description: "ユーザーがリダイレクトされてコールバックに戻る際、`oauth/token`エンドポイントで`POST`を呼び出して、認可コードをアクセスおよび/またはIDトークンと交換する必要があります。" +--- + +`POST /oauth/token` + +ユーザーがリダイレクトされてコールバックに戻る際、`oauth/token`エンドポイントで`POST`を呼び出して、認可コードをアクセスおよび/またはIDトークンと交換する必要があります。 + +### 備考[​](#備考) + +`/oauth/token`エンドポイントに呼び出しを行うには、以下を実行する必要があります。 + +- 要求のコンテンツタイプを`application/x-www-form-urlencoded`に設定します +- 渡されたパラメーターではすべて`strings`を使用します +- 要求にアプリケーション認証の追加パラメーターを含めます（例：`client_secret`またはJSON Web Tokenのクライアント認証用`client_assertion`と`client_assertion_type`、もしくは相互TLS認証の場合は`client-certificate`および`client-certificate-ca-verified`ヘッダー）。 + +## Parameters + + + フローを示します。有効な認可コードと'authorization_code'を使います。 + + + + 最初の`/authorize`呼び出しからの認可コードです。 + + + + アプリケーションの`client_id`です。必須です。 + + + + `GET` `/oauth/par`エンドポイントで設定されている場合のみ必須。 + + + + `code_challenge`を生成するために使用される暗号的にランダムなキー。`code_challenge`が提供された場合は推奨。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | トークンを含む成功レスポンスです。 | diff --git a/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests.mdx b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests.mdx new file mode 100644 index 0000000000..8c83b521e2 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests.mdx @@ -0,0 +1,82 @@ +--- +title: "プッシュ認可リクエスト（PAR）" +description: "note" +--- + +`POST /oauth/par` + +note +ハイリーレギュレーテッドアイデンティティ機能を使用するには、エンタープライズプランとハイリーレギュレーテッドアイデンティティのアドオンが必要です。詳細については、「[Auth0の価格設定](https://auth0.com/pricing)」を参照してください。 + +[プッシュ認可要求（PAR）]を使った認可コードフロー([https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authorization-code-flow/authorization-code-flow-with-par)では、`/oauth/par`エンドポイントを使って、通常`/authorize`への`GET`要求で送られる認可パラメーターをアプリケーションが送信できるようにします。PARではバックエンドからPOSTメソッドを使ってパラメーター値のセキュリティを維持します。`/oauth/par`エンドポイントは`/authorize`に提供できる認可パラメーターをすべて受け入れます。`/oauth/par`エンドポインへの呼び出しが有効であれば、Auth0は`/authorize`エンドポイントのパラメーターとして使える`redirect_uri`値で応答します。](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authorization-code-flow/authorization-code-flow-with-par)%E3%81%A7%E3%81%AF%E3%80%81%60/oauth/par%60%E3%82%A8%E3%83%B3%E3%83%89%E3%83%9D%E3%82%A4%E3%83%B3%E3%83%88%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6%E3%80%81%E9%80%9A%E5%B8%B8%60/authorize%60%E3%81%B8%E3%81%AE%60GET%60%E8%A6%81%E6%B1%82%E3%81%A7%E9%80%81%E3%82%89%E3%82%8C%E3%82%8B%E8%AA%8D%E5%8F%AF%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF%E3%83%BC%E3%82%92%E3%82%A2%E3%83%97%E3%83%AA%E3%82%B1%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%8C%E9%80%81%E4%BF%A1%E3%81%A7%E3%81%8D%E3%82%8B%E3%82%88%E3%81%86%E3%81%AB%E3%81%97%E3%81%BE%E3%81%99%E3%80%82PAR%E3%81%A7%E3%81%AF%E3%83%90%E3%83%83%E3%82%AF%E3%82%A8%E3%83%B3%E3%83%89%E3%81%8B%E3%82%89POST%E3%83%A1%E3%82%BD%E3%83%83%E3%83%89%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF%E3%83%BC%E5%80%A4%E3%81%AE%E3%82%BB%E3%82%AD%E3%83%A5%E3%83%AA%E3%83%86%E3%82%A3%E3%82%92%E7%B6%AD%E6%8C%81%E3%81%97%E3%81%BE%E3%81%99%E3%80%82%60/oauth/par%60%E3%82%A8%E3%83%B3%E3%83%89%E3%83%9D%E3%82%A4%E3%83%B3%E3%83%88%E3%81%AF%60/authorize%60%E3%81%AB%E6%8F%90%E4%BE%9B%E3%81%A7%E3%81%8D%E3%82%8B%E8%AA%8D%E5%8F%AF%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF%E3%83%BC%E3%82%92%E3%81%99%E3%81%B9%E3%81%A6%E5%8F%97%E3%81%91%E5%85%A5%E3%82%8C%E3%81%BE%E3%81%99%E3%80%82%60/oauth/par%60%E3%82%A8%E3%83%B3%E3%83%89%E3%83%9D%E3%82%A4%E3%83%B3%E3%81%B8%E3%81%AE%E5%91%BC%E3%81%B3%E5%87%BA%E3%81%97%E3%81%8C%E6%9C%89%E5%8A%B9%E3%81%A7%E3%81%82%E3%82%8C%E3%81%B0%E3%80%81Auth0%E3%81%AF%60/authorize%60%E3%82%A8%E3%83%B3%E3%83%89%E3%83%9D%E3%82%A4%E3%83%B3%E3%83%88%E3%81%AE%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF%E3%83%BC%E3%81%A8%E3%81%97%E3%81%A6%E4%BD%BF%E3%81%88%E3%82%8B%60redirect_uri%60%E5%80%A4%E3%81%A7%E5%BF%9C%E7%AD%94%E3%81%97%E3%81%BE%E3%81%99%E3%80%82) + +`/oauth/par`エンドポインへの呼び出しが有効であれば、Auth0は`/authorize`エンドポイントのパラメーターとしても使える`redirect_uri`値を含めて応答します。PARの構成について詳細は、「[プッシュ認可要求（PAR）の構成](https://auth0.com/docs/ja-jp/get-started/applications/configure-par)」を参照してください。 + +### 備考[​](#備考) + +PARエンドポイントを呼び出すには、以下を行う必要があります： +- 要求のコンテンツタイプを`application/x-www-form-urlencoded`に設定します +- 渡されたパラメーターではすべて`strings`を使います +- 要求にアプリケーション認証の追加パラメーターを含めます（例：`client_secret`またはJSON Web Tokenのクライアント認証用`client_assertion`と`client_assertion_type`、もしくは相互TLS認証の場合は`client-certificate`および`client-certificate-ca-verified`のヘッダー）。 + +- 各リソースの権限を要求するには`authorization_details`パラメーターを使います。たとえば、認可において粒度の細かい情報を伝えるためにJSONオブジェクトの配列を指定できます。各JSONオブジェクトには`type`属性を含める必要があります。その他は自由に定義できます。 + +## Parameters + + + 各リソース用に要求した権限、スコープのようなものです。 + + + + アクセスしたいターゲットAPIの一意の識別子です。 + + + + 'code'や'code id_token'などのトークンタイプを指定します。必須です。 + + + + アプリケーションの`client_id`です。必須です。 + + + + 認可された後にAuth0がリダイレクトする先のURLです。必須です。 + + + + CSRF攻撃を防ぐために使う不透明な値です。推奨。 + + + + OIDCスコープとカスタムAPIスコープです。推奨。 + + + + `code_verifier`から生成されたチャレンジです。推奨。 + + + + チャレンジを生成するために使われるメソッド、通常は'S256'です。推奨。 + + + + トークンリプレイ攻撃を防ぐために使用されます。`response_type=id_token`に推奨。 + + + + アプリケーションに構成されている接続の名前です。 + + + + 特定のプロンプト（例：`prompt=consent`）を強制するために使用されます。 + + + + ユーザーを認証する際に使う組織のIDです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 201 | 要求が成功。要求URIと有効期限が返されます。 | diff --git a/main/docs/ja-jp/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce.mdx b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce.mdx new file mode 100644 index 0000000000..3b74d5513e --- /dev/null +++ b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce.mdx @@ -0,0 +1,65 @@ +--- +title: "認可" +description: "これは、モバイルアプリがAPIにアクセスするために使うOAuth 2.0付与です。このフローを開始する前に、`code_verifier`を生成して保存し、それを使って、認可要求で送信される`code_challenge`を生成する必要があります。" +--- + +`GET /authorize` + +これは、モバイルアプリがAPIにアクセスするために使うOAuth 2.0付与です。このフローを開始する前に、`code_verifier`を生成して保存し、それを使って、認可要求で送信される`code_challenge`を生成する必要があります。 + +## Parameters + + + アクセスしたいターゲットAPIの一意の識別子です。 + + + + 認可を要求するスコープです。スペースで区切る必要があります。標準的なOpenID Connect（OIDC）スコープ、カスタムクレーム、その他ターゲットAPIが対応するスコープを要求できます。リフレッシュトークンを取得するには'offline_access'を含めます。 + + + + OAuth 2.0フローを実行するAuth0を示します。認可コード付与（PKCE）フローの'code'を使います。 + + + + アプリケーションのクライアントIDです。 + + + + Auth0がリダイレクトしてクライアントに戻る際に含まれ、クライアントが初期要求に追加する不透明な値です。クライアントは、CSRF攻撃を防ぐためにこの値を使用する必要があります。 + + + + ユーザーを認可した後、Auth0がブラウザーをリダイレクトするURLです。 + + + + チャレンジを生成するために使われるメソッドです。Auth0が対応するのは’S256’のみのため、そのメソッドを使います。 + + + + 'code_verifier'から生成されたチャレンジです。 + + + + アプリケーションに構成されている接続の名前です。 + + + + サイレント認証要求を開始するには、'prompt=none'を使います。 + + + + ユーザーを認証する際に使う組織のIDです。 + + + + 組織の招待のチケットIDです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | 認可後に指定したredirect_uriにリダイレクトします。 | +| default | 予期しないエラー | diff --git a/main/docs/ja-jp/api/authentication/authorization-code-flow-with-pkce/get-token-pkce.mdx b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-pkce/get-token-pkce.mdx new file mode 100644 index 0000000000..f3f0c46015 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/authorization-code-flow-with-pkce/get-token-pkce.mdx @@ -0,0 +1,56 @@ +--- +title: "トークンの取得" +description: "これはモバイルアプリが API にアクセスするために使用するフローです。このエンドポイントを使用して、認可コードをトークンと交換します。" +--- + +`POST /oauth/token` + +これはモバイルアプリが API にアクセスするために使用するフローです。このエンドポイントを使用して、認可コードをトークンと交換します。 + +### 備考 +- アプリケーションの互換性を向上させるため、Auth0 は OIDC 仕様で定義されている構造化クレーム形式でプロフィール情報を返すようになりました。つまり、ID トークンまたはアクセストークンにカスタムクレームを追加するには、標準 OIDC クレームとの潜在的な衝突を避けるため、名前空間形式に準拠している必要があります。 +- POST /oauth/token から更新トークンを取得するには、`scope` リクエストパラメーターに `offline_access` を含めます。API 設定で [オフラインアクセスを許可] フィールドが有効になっていることを確認してください。 +- `redirect_uri` 値は、アプリケーション設定の下で有効なコールバック URL として指定する必要があります。 +- サイレント認証を使用すると、Auth0 がリダイレクトでのみ応答し、ログインページで応答しない認証フローを実行できます。アクセストークンの有効期限が切れた場合、ユーザーのシングルサインオン（SSO）セッションの有効期限が切れていないと仮定すると、サイレント認証を使用してユーザーインタラクションなしで新しいトークンを取得できます。 + +### 詳しく学ぶ +- [Proof Key for Code Exchange（PKCE）を使用した認可コードフロー](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authorization-code-flow-with-pkce) +- [PKCE を使用した認可コードフローで API を呼び出す](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authorization-code-flow-with-pkce/call-your-api-using-the-authorization-code-flow-with-pkce) +- [サイレント認証](https://auth0.com/docs/ja-jp/authenticate/login/configure-silent-authentication) + +## Parameters + + + リクエストの DPoP 証明。これはオプションであり、アプリケーションが Proof-of-Possession の実証を使用している場合にのみ必要です。 + + +## Request Body + + + 使用するフローを示します。認可コード（PKCE）の場合は `authorization_code` を使用します。 + + 許可される値: `authorization_code` + + + + アプリケーションのクライアント ID です。 + + + + 最初の `/authorize` 呼び出しから受け取った認可コードです。 + + + + `/authorize` に渡された `code_challenge` を生成するために使用された暗号的にランダムなキーです。 + + + + これは、`GET` `/authorize` エンドポイントで設定されていた場合のみ必須です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | トークン交換の成功 | +| default | 予期しないエラー | diff --git a/main/docs/ja-jp/api/authentication/authorization-code-flow/authorize-application.mdx b/main/docs/ja-jp/api/authentication/authorization-code-flow/authorize-application.mdx new file mode 100644 index 0000000000..55a127299e --- /dev/null +++ b/main/docs/ja-jp/api/authentication/authorization-code-flow/authorize-application.mdx @@ -0,0 +1,78 @@ +--- +title: "アプリケーションを認可する" +description: "OAuth 2.0認可フローを開始するには、ユーザーを認可URLに送信して同意を得て認可コードを取得します。" +--- + +`GET /authorize` + +OAuth 2.0認可フローを開始するには、アプリケーションはまずユーザーを認可URLに送信する必要があります。 + +## 認可エンドポイント + +このリクエストの目的は、API（`audience`で指定）を呼び出し、特定の操作（`scope`で指定）をユーザーの代わりに実行することについて、ユーザーから同意を得ることです。Auth0はユーザーを認証し、以前に同意が与えられていない限り、同意を得ます。`scope`の値を変更した場合、Auth0は再度同意を要求します。 + +ユーザー認可が必要なOAuth 2.0フローは以下の通りです。 + +- [認可コードフロー](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authorization-code-flow) +- [認可コードフロー（PKCE付き）](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authorization-code-flow-with-pkce) +- [インプリシットフロー](https://auth0.com/docs/get-started/authentication-and-authorization-flow/implicit-flow-with-form-post) + +[リソース所有者パスワードグラント](https://auth0.com/docs/get-started/authentication-and-authorization-flow/resource-owner-password-flow)および[クライアント認証情報フロー](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow)はユーザー認可を伴わないため、このエンドポイントを使用しません。代わりに、`POST /oauth/token`エンドポイントを直接呼び出してアクセストークンを取得します。 + +実装しているOAuth 2.0フローに基づいて、パラメーターが若干異なります。どのフローが適切かを確認するには、以下を参照してください：[どのOAuth 2.0フローを使用する必要があるのか](https://auth0.com/docs/get-started/authentication-and-authorization-flow/which-oauth-2-0-flow-should-i-use)。 + +## パラメーター + + + アクセスしたいターゲットAPIの一意の識別子 + + + + アクセスしたいターゲットAPI（リソースサーバー）の識別子。Auth0テナントに登録されているAPIの識別子と一致する必要があります。テナントの[リソースパラメーター互換性プロフィール](https://auth0.com/docs/get-started/tenant-settings#settings-advanced)が`compatibility`に設定されている場合は`audience`の代わりに使用されます。 + + + + 認可をリクエストするスコープ。スペースで区切る必要があります。標準のOpenID Connect（OIDC）スコープ、カスタムクレーム、またはターゲットAPIがサポートするスコープをリクエストできます。リフレッシュトークンを取得するには`offline_access`を含めてください。 + + + + 実行したいOAuth 2.0フローをAuth0に示します。認可コード付与フローの場合は'code'を使用してください。 + + + + アプリケーションのID + + + + ユーザーが認可を付与した後、Auth0がブラウザをリダイレクトするURL。 + + + + アプリケーションが初期リクエストに追加し、Auth0が応答時に含める不透明な値。この値はアプリケーションがCSRF攻撃を防ぐために使用する必要があります。 + + + + アプリケーションに構成されている接続の名前 + + + + [サイレント認証](https://auth0.com/docs/authenticate/login/configure-silent-authentication)リクエストを開始するには、'prompt=none'を使用してください。 + + + + ユーザーを認証する際に使用する組織のID。指定されていない場合、アプリケーションが**組織プロンプト表示**に構成されている場合、ユーザーは認証時に組織名を入力できます。 + + + + 組織への招待のチケットID。[組織にメンバーを招待する](/organizations/invite-members)場合、ユーザーが招待を受け入れるとき、アプリケーションは招待と組織キーと値のペアを転送して招待受け入れを処理する必要があります。 + + + + SHA-256ハッシュ関数を使用したProof-of-Possession（DPoP）公開鍵のJWKサムプリント [RFC7638]。DPoP（Demonstrating Proof-of-Possession）を使用する場合のみ。 + + +## レスポンス + +| ステータス | 説明 | +|--------|------| +| 302 | 認可コード付きのリダイレクト | diff --git a/main/docs/ja-jp/api/authentication/authorization-code-flow/get-token.mdx b/main/docs/ja-jp/api/authentication/authorization-code-flow/get-token.mdx new file mode 100644 index 0000000000..b30e5fab80 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/authorization-code-flow/get-token.mdx @@ -0,0 +1,46 @@ +--- +title: "トークンの取得" +description: "..." +--- + +`POST /oauth/token` + +トークンベースの認証では、`oauth/token`エンドポイントを使ってアプリケーション用のアクセストークンを取得し、セキュアなAPIに認証された呼び出しを行います。あるいは、IDトークンとリフレッシュトークンを取得することもできます。IDトークンには、ユーザーエクスペリエンスを向上させるため、アプリケーションがスコープの形式で抽出できるユーザー情報が含まれています。リフレッシュトークンは、現在のトークンの有効期限が切れてもユーザーエクスペリエンスを中断することなくアプリケーションが新たなアクセストークンを要求できるようにします。詳細については、「[IDトークン](https://auth0.com/docs/ja-jp/secure/tokens/id-tokens)」と「[リフレッシュトークン](https://auth0.com/docs/ja-jp/secure/tokens/refresh-tokens)」を参照してください。 + +リフレッシュトークンを取得できるOAuth 2.0フローは以下に限るので注意してください： + +- [認可コードフロー（認可コード）](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authorization-code-flow) +- [PKCEを使った認可コードフロー（PKCEを伴う認可コード）](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/authorization-code-flow-with-pkce) +- [リソース所有者のパスワード](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/resource-owner-password-flow) +- [デバイス認可フロー](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/device-authorization-flow) +- トークンの交換* + +これは、APIへのアクセスに通常のWebアプリが使うフローです。このエンドポイントを使って認可コードをトークンと交換します。 + +## Parameters + + + 使用するフローを示します。認可コードには`authorization_code`を使用します。 + + + + アプリケーションのクライアントIDです。 + + + + アプリケーションのクライアントシークレットです。 + + + + 最初の`/authorize`呼び出しから受け取った認可コードです。 + + + + これは、[GET /authorize](#authorization-code-grant)エンドポイントで設定されていた場合のみ必要です。`/authorize`からの値は`/oauth/token`で設定した値と一致する必要があります。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | トークン取得の成功 | diff --git a/main/docs/ja-jp/api/authentication/authorization/authorization-endpoint.mdx b/main/docs/ja-jp/api/authentication/authorization/authorization-endpoint.mdx deleted file mode 100644 index 0dad1190c8..0000000000 --- a/main/docs/ja-jp/api/authentication/authorization/authorization-endpoint.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /authorize -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/authorization/back-channel-login.mdx b/main/docs/ja-jp/api/authentication/authorization/back-channel-login.mdx deleted file mode 100644 index 6d7948f9da..0000000000 --- a/main/docs/ja-jp/api/authentication/authorization/back-channel-login.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /bc-authorize -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/change-password/change-password.mdx b/main/docs/ja-jp/api/authentication/change-password/change-password.mdx new file mode 100644 index 0000000000..4ad73f3711 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/change-password/change-password.mdx @@ -0,0 +1,53 @@ +--- +title: "パスワードの変更" +description: "パスワード変更メールをユーザーの指定したメールアドレスと`connection`に送信します。" +--- + +`POST /dbconnections/change_password` + +パスワード変更メールをユーザーの指定したメールアドレスと`connection`に送信します。 + +任意で、Organization固有の変数をサポートするためにOrganization IDを[カスタマイズされたメールテンプレート](https://auth0.com/docs/ja-jp/customize/email/email-templates#common-variables)に提供し、**リダイレクト先**URLに`organization_id`と`organization_name`のパラメーターを含めることができます。 + +**注意：**このエンドポイントはデータベース接続のみで機能します。 + +### 備考[​](#備考) + +- ユーザーがパスワード変更リンクをクリックすると、新しいパスワードの入力を求めるページにリダイレクトされます。 +このエンドポイントは3つのHTTP応答ヘッダーを返して、レート制限に関するデータを提供します。 +`X-RateLimit-Limit`: 1分間に許可される要求の数です。 +`X-RateLimit-Remaining`: 現在のレート制限枠に残っている要求の数です。新しい要求のたびに、この数が1つ減少します。1分が経過するごとに、要求数が戻され、この数が1ずつ加算されます。 +*`X-RateLimit-Reset`: レート制限（`X-RateLimit-Limit`）がリセットされるまでの残り時間です。この値は[UTCエポック秒](https://en.wikipedia.org/wiki/Unix_time)単位です。 + +### 詳しい情報[​](#詳しい情報) + +- [ユーザーのパスワードを変更する](https://auth0.com/docs/ja-jp/authenticate/database-connections/password-change) +- [Auth0データベース接続でのパスワードの強度](https://auth0.com/docs/ja-jp/authenticate/database-connections/password-strength) +- [Auth0データベース接続でのパスワードオプション](https://auth0.com/docs/ja-jp/authenticate/database-connections/password-options) +- [Auth0 APIのレート制限ポリシー](https://auth0.com/docs/ja-jp/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations) + +## Parameters + + + クライアントの`client_id`です。 + + + + ユーザーのメールアドレスです。 + + + + クライアントに構成されているデータベース接続の名前です。 + + + + ユーザーに紐づけられたOrganizationの`organization_id`です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | パスワード変更メールが送信されました。 | +| 400 | 不正な要求です。パラメーターが欠けているか無効です。 | +| 404 | ユーザーが見つかりません。 | diff --git a/main/docs/ja-jp/api/authentication/client-credential-flow/get-token.mdx b/main/docs/ja-jp/api/authentication/client-credential-flow/get-token.mdx new file mode 100644 index 0000000000..aa551e666d --- /dev/null +++ b/main/docs/ja-jp/api/authentication/client-credential-flow/get-token.mdx @@ -0,0 +1,49 @@ +--- +title: "トークンの取得" +description: "これはサーバープロセスがAPIへのアクセス時に使用するOAuth 2.0権限付与です。アプリケーションの資格情報（クライアントIDとクライアントシークレット）を使用して、アクセストークンを直接要求するためにこのエンドポイントを使用します。" +--- + +`POST /oauth/token` + +これはサーバープロセスがAPIへのアクセス時に使用するOAuth 2.0権限付与です。アプリケーションの資格情報（クライアントIDとクライアントシークレット）を使用して、アクセストークンを直接要求するためにこのエンドポイントを使用します。 + +### 応答[​](#応答) + +#### 200[​](#200) + +成功応答ではアクセストークンが返されます。 +{ "access_token":"eyJz93a...k4laUWw", "token_type":"Bearer", "expires_in":86400} +### 詳しく学ぶ[​](#詳しく学ぶ) + +- [クライアントの資格情報フロー](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/client-credentials-flow) +- [クライアントの資格情報フローを使用してAPIを呼び出す](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/client-credentials-flow/call-your-api-using-the-client-credentials-flow) +- [Management Dashboardを使用してクライアント付与を設定する](https://auth0.com/docs/ja-jp/get-started/applications/update-grant-types) +- [クライアント資格情報付与をアクセストークンに要求する](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/client-credentials-flow/call-your-api-using-the-client-credentials-flow) + +## Parameters + + + 使用するフローを示します。クライアント資格情報については、`client_credentials`を使用。 + + + + アプリケーションのクライアントIDです。 + + + + アプリケーションのクライアントシークレットです。 + + + + アクセスしたいターゲットAPIの一意の識別子です。 + + + + [推奨]要求を関連付けたい組織または識別子です。詳細については、「[Organizationsのマシンツーマシンアクセス](https://auth0.com/docs/ja-jp/manage-users/organizations/organizations-for-m2m-applications)をお読みください。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 成功レスポンス | diff --git a/main/docs/ja-jp/api/authentication/custom-token-exchange/get-token.mdx b/main/docs/ja-jp/api/authentication/custom-token-exchange/get-token.mdx new file mode 100644 index 0000000000..13990f0815 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/custom-token-exchange/get-token.mdx @@ -0,0 +1,77 @@ +--- +title: "トークンの取得" +description: "カスタムトークン交換（CTE）は、アプリケーションが `/oauth/token` エンドポイントを呼び出すことで既存のアイデンティティトークンを Auth0 トークンと交換するメカニズムを提供します。RFC 8693の仕様に準拠しています。" +--- + +`POST /oauth/token` + +カスタムトークン交換（CTE）は、アプリケーションが `/oauth/token` エンドポイントを呼び出すことで既存のアイデンティティトークンを Auth0 トークンと交換するメカニズムを提供します。[RFC 8693](https://datatracker.ietf.org/doc/html/rfc8693) の仕様に準拠しています。この機能は、既存の Auth0 トークンを同じユーザーの別のオーディエンスにアクセスするために交換する、外部 ID プロバイダーの統合を容易にする、または Auth0 プラットフォームへのシームレスなユーザー移行を有効にするなど、高度な統合要件に対応するために不可欠です。交換プロセスは完全に管理可能で、開発者は関連する Auth0 アクションで実行されるカスタムロジックを使用してその詳細を制御できます。 + + +カスタムトークン交換は現在アーリーアクセス中です。この機能を使用することにより、[Okta マスターサブスクリプション契約](https://www.okta.com/legal/)の適用される無料試用版条件に同意するものとします。ユーザーの `subject_token` を安全に検証することはお客様の責任です。詳細については、[ユーザーガイド](https://auth0.com/docs/ja-jp/authenticate/custom-token-exchange)を参照してください。 + + +### 備考 +- アプリケーションに発行されたスコープは、要求されるスコープとは異なる場合があります。この場合、`scope` パラメーターが応答 JSON に含まれます。スコープは、[アプリケーションの API アクセスポリシー](https://auth0.com/docs/ja-jp/get-started/apis/api-access-policies-for-applications)で説明されているようにフィルタリングされます。 + +- `subject_token_type` は、既存のカスタムトークン交換プロフィールと関連する[アクション](https://auth0.com/docs/ja-jp/customize/actions)に対応している必要があります。 + +- クライアントシークレットを安全に保つことができない非機密アプリケーション（ネイティブアプリなど）の場合、エンドポイントはクライアントシークレットを渡さないことをサポートしていますが、アプリケーション自体は `tokenEndpointAuthMethod` プロパティを `none` に設定する必要があります。これは UI (**ダッシュボード > アプリケーション > アプリケーション設定**) から、または管理 API を使用して実行できます。 + +- [アプリケーションのカスタムトークン交換を有効にする](https://auth0.com/docs/authenticate/custom-token-exchange/configure-custom-token-exchange#enable-custom-token-exchange-for-your-application)必要があります。詳細については、[カスタムトークン交換ドキュメント](https://auth0.com/docs/ja-jp/authenticate/custom-token-exchange)を参照してください。 + +## Parameters + + + リクエストの DPoP 証明。これはオプションであり、アプリケーションが Proof-of-Possession の実証を使用している場合にのみ必要です。 + + + + エンドユーザーの IP を文字列値として指定します。サーバー側のシナリオで疑わしい IP スロットリング保護を機能させたい場合は、これを設定してください。 + + +## Request Body + + + 使用するフローを示します。カスタムトークン交換の場合は、`urn:ietf:params:oauth:grant-type:token-exchange` を使用します。 + + 許可される値: `urn:ietf:params:oauth:grant-type:token-exchange` + + + + サブジェクトトークンの種類です。カスタムトークン交換の場合、これは `http://acme.com/legacy-token` や `urn:acme:legacy-token` など、ユーザー独自の所有権の下にスコープされた任意の URI です。次の名前空間は予約されており、使用できません: `http://auth0.com`、`https://auth0.com`、`http://okta.com`、`https://okta.com`、`urn:ietf`、`urn:auth0`、`urn:okta`。 + + + + サブジェクトトークン。アクションはこれを検証して、ユーザーを特定するために使用する必要があります。 + + + + アプリケーションのクライアント ID です。他のグrant タイプと同様に、HTTP Basic Auth を使用して Authorization ヘッダーでクライアント ID を渡すこともできます。 + + + + （オプション）アプリケーションのクライアントシークレットです。他のグrant タイプと同様に、HTTP Basic Auth を使用して Authorization ヘッダーでクライアントシークレットを渡すこともできます。他の代替案も[Auth0 認証 API リファレンスドキュメント](https://auth0.com/docs/api/authentication#authentication-methods)で説明されています。カスタムトークン交換はパブリックアプリケーションで使用できるため、[攻撃保護](https://auth0.com/docs/ja-jp/authenticate/custom-token-exchange/cte-attack-protection)を読んで追加のセキュリティを実装してください。 + + + + （オプション）アクセスしたいターゲット API の一意の識別子です。存在しない場合、[テナント設定](https://auth0.com/docs/ja-jp/get-started/tenant-settings)で設定されているデフォルトのテナントオーディエンスが使用されます。 + + + + （オプション）アクセスしたいターゲット API（リソースサーバー）の識別子です。Auth0 テナントに登録されている API 識別子と一致する必要があります。テナントの[リソースパラメータ互換性プロフィール](https://auth0.com/docs/ja-jp/get-started/tenant-settings#settings-advanced)が `compatibility` に設定されている場合、`audience` の代わりとして使用されます。 + + + + （オプション）OAuth2 スコープパラメーター。 + + + + （オプション）リクエストを関連付けたい組織または識別子です。または、[認証 API で組織名を使用する](https://auth0.com/docs/ja-jp/manage-users/organizations/configure-organizations/use-org-name-authentication-api)が指定されている場合は、組織名を指定することもできます。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 成功レスポンス | diff --git a/main/docs/ja-jp/api/authentication/database-connections/request-password-change.mdx b/main/docs/ja-jp/api/authentication/database-connections/request-password-change.mdx deleted file mode 100644 index e2e64ede96..0000000000 --- a/main/docs/ja-jp/api/authentication/database-connections/request-password-change.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /dbconnections/change_password -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/database-connections/sign-up-user.mdx b/main/docs/ja-jp/api/authentication/database-connections/sign-up-user.mdx deleted file mode 100644 index 60eb4cbb2c..0000000000 --- a/main/docs/ja-jp/api/authentication/database-connections/sign-up-user.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /dbconnections/signup -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/delegation-legacy/delegation.mdx b/main/docs/ja-jp/api/authentication/delegation-legacy/delegation.mdx new file mode 100644 index 0000000000..993d2087b2 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/delegation-legacy/delegation.mdx @@ -0,0 +1,44 @@ +--- +title: "廃止" +description: "note" +--- + +`POST /delegation` + +note +2017年6月8日より、アドオンを使用していないテナントでは、デフォルトでこの機能が無効になりました。委任を必要とするアドオンを使用中のレガシーテナントは、引き続きこの機能を使用できます。今後、委任機能が変更されるか、サービスから削除されることがあれば、使用中のお客様が余裕を持って移行できるよう、あらかじめお知らせします。 + +委任トークンは、アプリケーションがFirebaseやSAPなどのアプリケーションアドオンのAPIを呼び出す必要があるときに取得して使用することができます。その場合、アドオンはAuth0で登録と構成が済まされ、呼び出しているプログラムと同じテナントになければなりません。 + +既存のトークンが渡されると、このエンドポイントは、`target`アプリのシークレットで署名されたトークンを新たに生成します。これは、ユーザーのIDをアプリケーションからAPIに渡すために使用されます。 + +### 備考[​](#備考) + +- +`profile`スコープ値は、エンドユーザーのデフォルトのプロファイルクレームである`name`、`family_name`、`given_name`、`middle_name`、`nickname`、`preferred_username`、`profile`、`picture`、`website`、`gender`、`birthdate`、`zoneinfo`、`locale`、`updated_at`へのアクセスを要求します。 + +- +`email`スコープ値は`email`と`email_verified`クレームへのアクセスを要求します。 + +- +委任は[auth0.js](http://auth0.com/libraries/auth0js)バージョン8では**非対応**です。バージョン7のライブラリーを使用しているサンプルについては、「[委任トークン要求](https://auth0.com/ja-jp/docs/libraries/auth0js#delegation-token-request)」を参照してください。 + +- +このエンドポイントでは、1つの`user_id`で同じIPアドレスからの要求が1分間に10までに制限されます。 + +このエンドポイントは3つのHTTP応答ヘッダーを返して、レート制限に関するデータを提供します。 + +- `X-RateLimit-Limit`：1分間に許可される要求の数です。 +- `X-RateLimit-Remaining`：現在のレート制限枠に残っている要求の数です。新しい要求のたびに、この数が1つ減少します。1分が経過するごとに、要求数が戻され、この数が1ずつ加算されます。 +- `X-RateLimit-Reset`：レート制限（`X-RateLimit-Limit`）がリセットされるまでの残り時間です。この値は[UTCエポック秒](https://en.wikipedia.org/wiki/Unix_time)単位です。 + +### 詳しい情報[​](#詳しい情報) + +- [委任トークン](https://auth0.com/docs/ja-jp/secure/tokens/delegation-tokens) +- [Auth0 APIのレート制限ポリシー](https://auth0.com/docs/ja-jp/troubleshoot/customer-support/operational-policies/rate-limit-policy) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 委任トークンを正常に取得しました | diff --git a/main/docs/ja-jp/api/authentication/delegation-legacy/get-delegation-token-legacy.mdx b/main/docs/ja-jp/api/authentication/delegation-legacy/get-delegation-token-legacy.mdx deleted file mode 100644 index 6c4b7a7298..0000000000 --- a/main/docs/ja-jp/api/authentication/delegation-legacy/get-delegation-token-legacy.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /delegation -playground: simple -deprecated: true ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/device-authorization-flow/authorize-device.mdx b/main/docs/ja-jp/api/authentication/device-authorization-flow/authorize-device.mdx new file mode 100644 index 0000000000..42b9597ceb --- /dev/null +++ b/main/docs/ja-jp/api/authentication/device-authorization-flow/authorize-device.mdx @@ -0,0 +1,106 @@ +--- +title: "デバイスを認可する" +description: "このフローは、入力制限されたデバイスがAPIにアクセスするためにデザインされています。このエンドポイントを使用して、ユーザーがデバイスを認可できるようにするデバイスコードを取得します。" +--- + +`POST /oauth/device/code` + +このフローは、入力制限されたデバイスがAPIにアクセスするためにデザインされています。このエンドポイントを使用して、ユーザーがデバイスを認可できるようにするデバイスコードを取得します。 + +## 要求例 + +``` +POST https://${account.namespace}/oauth/device/code +Content-Type: application/x-www-form-urlencoded + +client_id=${account.clientId}&scope=SCOPE&audience=API_IDENTIFIER +``` + +### 応答値 + +| 値 | 説明 | +| --- | --- | +| `device_code` | デバイスの一意のコード。 | +| `user_code` | デバイスを認可するためにユーザーが入力しなければならないコード。| +| `verification_uri` | デバイスを認可するためにユーザーがアクセスすべきURL。| +| `verification_uri_complete` | 簡単にアクセスできるようユーザーコードを含む完全なURL。| +| `expires_in` | デバイスおよびユーザーコードの有効期間の秒数。| +| `interval` | トークンを要求するポーリング間隔の秒数。| + +### 備考 + +- リフレッシュトークンを取得するために`offline_access`を`scope`に含めます。 +- 返されたデバイスコードを使用して、トークンエンドポイントからのアクセストークンを要求します。 + +### トークン要求の例 + +``` +POST https://${account.namespace}/oauth/token +Content-Type: application/x-www-form-urlencoded + +client_id=${account.clientId}&device_code=YOUR_DEVICE_CODE&grant_type=urn:ietf:params:oauth:grant-type:device_code +``` + +### 応答 + +#### 200 + +要求が成功するとアクセストークンを返します。 + +``` +HTTP/1.1 200 OK +Content-Type: application/json +{ + "access_token": "eyJz93a...k4laUWw", + "id_token": "eyJ...0NE", + "refresh_token": "eyJ...MoQ", + "expires_in": 86400, + "token_type": "Bearer" +} +``` + +### エラー応答 + +``` +HTTP/1.1 403 Forbidden +Content-Type: application/json +{ "error": "authorization_pending", "error_description": "User has yet to authorize device code." } +``` + +``` +HTTP/1.1 429 Too Many Requests +Content-Type: application/json +{ "error": "slow_down", "error_description": "You are polling faster than the specified interval of 5 seconds." } +``` + +``` +HTTP/1.1 403 Forbidden +Content-Type: application/json +{ "error": "access_denied", "error_description": "User cancelled the confirmation prompt." } +``` + +### 詳しく学ぶ + +- [デバイス認可フロー](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/device-authorization-flow) +- [デバイス認可フローを使用してAPIを呼び出す](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/device-authorization-flow/call-your-api-using-the-device-authorization-flow) +- [Management Dashboardを使用してデバイスコード付与を設定する](https://auth0.com/docs/ja-jp/get-started/applications/update-grant-types) + +## Parameters + + + アプリケーションのIDです。 + + + + 認可を要求するスコープです。 + + + + アクセスしたいターゲットAPIの一意の識別子です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | デバイスおよびユーザーコードを返します。 | diff --git a/main/docs/ja-jp/api/authentication/device-authorization/request-device-code.mdx b/main/docs/ja-jp/api/authentication/device-authorization/request-device-code.mdx deleted file mode 100644 index fb15b897d9..0000000000 --- a/main/docs/ja-jp/api/authentication/device-authorization/request-device-code.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/device/code -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/dynamic-application-client-registration/dynamic-application-registration.mdx b/main/docs/ja-jp/api/authentication/dynamic-application-client-registration/dynamic-application-registration.mdx new file mode 100644 index 0000000000..06d46654ff --- /dev/null +++ b/main/docs/ja-jp/api/authentication/dynamic-application-client-registration/dynamic-application-registration.mdx @@ -0,0 +1,28 @@ +--- +title: "動的なアプリケーション登録" +description: "名前と必要なCallback URLがあれば、クライアントをAuth0に動的に登録できます。この要求にトークンは不要です。" +--- + +`POST /oidc/register` + +名前と必要なCallback URLがあれば、クライアントをAuth0に動的に登録できます。この要求にトークンは不要です。 + +## Parameters + + + 作成する動的クライアントの名前です。 + + + + Auth0が認証フローの終了時に呼び出すのに有効であるとみなすURLの配列です。 + + + + トークンエンドポイントにおける認証に使われるメソッドです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | クライアントの詳細を含む正常な応答です。 | diff --git a/main/docs/ja-jp/api/authentication/dynamic-client-registration/dynamic-application-registration.mdx b/main/docs/ja-jp/api/authentication/dynamic-client-registration/dynamic-application-registration.mdx deleted file mode 100644 index 442703ec9c..0000000000 --- a/main/docs/ja-jp/api/authentication/dynamic-client-registration/dynamic-application-registration.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oidc/register -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/impersonation-legacy/impersonate-a-user-legacy.mdx b/main/docs/ja-jp/api/authentication/impersonation-legacy/impersonate-a-user-legacy.mdx deleted file mode 100644 index 917b2d9d00..0000000000 --- a/main/docs/ja-jp/api/authentication/impersonation-legacy/impersonate-a-user-legacy.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /users/{user_id}/impersonate -playground: simple -deprecated: true ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/impersonation-legacy/impersonation.mdx b/main/docs/ja-jp/api/authentication/impersonation-legacy/impersonation.mdx new file mode 100644 index 0000000000..b692cda079 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/impersonation-legacy/impersonation.mdx @@ -0,0 +1,38 @@ +--- +title: "偽装" +description: "このエンドポイントは、別のユーザーとしてログインするために、偽装URLを取得するのに使用します。トラブルシューティングの際に役立ちます。" +--- + +`POST /users/{user_id}/impersonate` + +このエンドポイントは、別のユーザーとしてログインするために、偽装URLを取得するのに使用します。トラブルシューティングの際に役立ちます。 + +### 備考[​](#備考) + +- このエンドポイントは**グローバルクライアント**資格情報でのみ使用できます。 +- 本物と偽装のログインを区別するために、偽装ユーザーのプロファイルには偽装される人と偽装する人のプロパティが追加で含まれます。例：`"impersonated": true, "impersonator": {"user_id": "auth0|...", "email": "admin@example.com"}`。 +- 通常のWebアプリには、`additionalParameters`を設定します。その際に、`response_type`には`code`、`callback_url`にはAuth0が認可コードと一緒にリダイレクトするCallback URL、`scope`にはJWTに含めたいJWTクレームを設定します。 + +## Parameters + + + + + + + + + + + + + + + + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 偽装URLを正常に取得しました | diff --git a/main/docs/ja-jp/api/authentication/implicit-flow/authorize.mdx b/main/docs/ja-jp/api/authentication/implicit-flow/authorize.mdx new file mode 100644 index 0000000000..fa0d2b433c --- /dev/null +++ b/main/docs/ja-jp/api/authentication/implicit-flow/authorize.mdx @@ -0,0 +1,81 @@ +--- +title: "認可" +description: "これはAPIにアクセスするためにWebアプリが使用するOAuth 2.0権限付与です。" +--- + +`GET /authorize` + +これはAPIにアクセスするためにWebアプリが使用するOAuth 2.0権限付与です。 + +### 応答[​](#応答) + +#### 302[​](#302) + +要求が成功すると、ユーザーが指定されたCallback URLにアクセストークンと一緒にリダイレクトされます。 +HTTP/1.1 302 FoundLocation: ${account.callback}#access_token=TOKEN&state=STATE&token_type=TYPE&expires_in=SECONDS +### 備考[​](#備考) + +- `redirect_uri`の値は、[アプリケーションの設定](https://manage.auth0.com/dashboard)で有効なCallback URLとして指定される必要があります。 +- `response_type=token`の場合は、ユーザーがプロバイダーで認証すると、ユーザーがアプリケーションのCallback URLにリダイレクトされ、その際にアドレス内の`location.hash`で`access_token`が渡されます。これは、シングルページアプリおよびネイティブモバイルSDKに使用されます。 +- 暗黙的付与は、リフレッシュトークンの発行をサポートしません。代わりに[サイレント認証](https://auth0.com/docs/ja-jp/authenticate/login/configure-silent-authentication)を使用します。 +- アプリケーションの互換性を高めるために、Auth0は[OIDC仕様が定義する構造化されたクレームの形式](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims)で、プロファイル情報を返します。そのため、IDトークンまたはアクセストークンにカスタムクレームを追加するためには、標準のOIDCクレームとの衝突を避けるために、[名前空間形式](https://auth0.com/docs/ja-jp/secure/tokens/json-web-tokens/create-custom-claims)に従わなければなりません。 +- サイレント認証は認証フローを実行できるようにします。そのフローではAuth0はリダイレクトでのみ応答し、ログインページでは応答しません。アクセストークンの有効期限が切れていて、ユーザーのシングルサインオン（SSO）セッションの有効期限が切れていない場合、サイレント認証を使用して、ユーザーと対話することなく、新しいアクセストークンを取得できます。 + +### 詳しく学ぶ[​](#詳しく学ぶ) + +- [暗黙フロー](/docs/ja-jp/api/authentication/flows/concepts/implicit) +- [状態パラメーター](/docs/ja-jp/api/authentication/protocols/oauth2/oauth-state) +- [暗黙的付与使用時のリプレイ攻撃を緩和する](/docs/ja-jp/api/authentication/api-auth/tutorials/nonce) +- [サイレント認証](https://auth0.com/docs/ja-jp/authenticate/login/configure-silent-authentication) + +## Parameters + + + アクセスしたいターゲットAPIの一意の識別子です。 + + + + 認可を要求するスコープ。スペースで区切る必要があります。 + + + + これで、フローの終了時に受け取るトークンの種類が指定されます。アクセストークンのみを取得するために`token`を、IDトークンのみを取得するために`id_token`を、両方のトークンを取得するために`id_token token`を使用します。 + + + + アプリケーションのIDです。 + + + + CSRF攻撃を防止する不透明な値です。 + + + + 認可後にAuth0がブラウザーをリダイレクトする先のURLです。 + + + + トークンのリプレイ攻撃を防止するためにIDトークンレスポンスに含まれる文字列値です。 + + + + アプリケーションに構成されている接続の名前です。 + + + + サイレント認証の要求を開始するには、`prompt=none`を使用します。 + + + + ユーザーを認証する際に使う組織のIDです。 + + + + 組織の招待のチケットIDです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | 指定されたCallback URLにアクセストークンと一緒にリダイレクトします。 | diff --git a/main/docs/ja-jp/api/authentication/login-legacy/database-ad-lapd-active.mdx b/main/docs/ja-jp/api/authentication/login-legacy/database-ad-lapd-active.mdx new file mode 100644 index 0000000000..58b008c929 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/login-legacy/database-ad-lapd-active.mdx @@ -0,0 +1,69 @@ +--- +title: "データベース/AD/LDAP（アクティブ）" +description: "note" +--- + +`POST /oauth/ro` + +note +このエンドポイントはレガシー認証パイプラインの一部で、現在は[パスワード付与](#resource-owner-password)に置き換えられています。最新の認証パイプラインについては、「[OIDC準拠の認証を導入する](/docs/ja-jp/api/authentication/api-auth/intro)」を参照してください。 + +APIベース（アクティブ）の認証には、このエンドポイントを使用します。ユーザーの資格情報が渡され、`connection`が指定されると、このエンドポイントはプロバイダーで認証し、アクセストークンとIDトークンを含むJSON応答を返します。 + +### 備考[​](#備考) + +- +このエンドポイントは、データベース接続、パスワードレス接続、Active Directory/LDAP、Microsoft Entra ID、ADFSにのみ利用できます。 + +- +パッシブ認証とアクティブ認証の主な違いは、パッシブ認証がブラウザーで[Auth0のログインページ](http://manage.auth0.com/login)を通して行われるのに対し、アクティブ認証は（スクリプト、サーバー間など）どこからでも実行できるところにあります。 + +- +サンプルのauth0.jsスクリプトは、バージョン8のライブラリーを使用しています。auth0.jsバージョン7を使用している場合には、こちらの[リファレンスガイド](https://auth0.com/docs/ja-jp/libraries/auth0js/v7)を参照してください。 + +### 詳しい情報[​](#詳しい情報) + +- [データベースIDプロバイダー](https://auth0.com/docs/ja-jp/authenticate/database-connections) +- [ユーザー/パスワード認証でのレート制限](https://auth0.com/docs/ja-jp/troubleshoot/customer-support/operational-policies/rate-limit-policy) +- [Active Directory/LDAP接続](https://auth0.com/docs/ja-jp/authenticate/identity-providers/enterprise-identity-providers/active-directory-ldap/ad-ldap-connector) + +## Parameters + + + アプリケーションの`client_id`です。 + + + + ユーザーがログインに使用するユーザー名またはメールアドレスです。 + + + + ユーザーがログインに使用するパスワードです。 + + + + ログインに使用する接続の名前です。 + + + + IDトークンも取得するには、`openid`に設定します。 + + + + `password`または`urn:ietf:params:oauth:grant-type:jwt-bearer`に設定します。 + + + + `grant_type`が`urn:ietf:params:oauth:grant-type:jwt-bearer`の場合には必須です。 + + + + `grant_type`が`urn:ietf:params:oauth:grant-type:jwt-bearer`の場合には必須です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 正常な認証応答 | +| 400 | 不正なリクエスト | diff --git a/main/docs/ja-jp/api/authentication/login-legacy/social-with-providers-access-token.mdx b/main/docs/ja-jp/api/authentication/login-legacy/social-with-providers-access-token.mdx index 6819692c98..c107c9b2cc 100644 --- a/main/docs/ja-jp/api/authentication/login-legacy/social-with-providers-access-token.mdx +++ b/main/docs/ja-jp/api/authentication/login-legacy/social-with-providers-access-token.mdx @@ -1,11 +1,55 @@ --- -openapi: authentication-api-oas post /oauth/access_token -playground: simple -deprecated: true +title: "プロバイダーアクセストークン付きソーシャル" +description: "note" --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /oauth/access_token` - - \ No newline at end of file +note +このエンドポイントはレガシー認証パイプラインの一部です。この代わりに、ブラウザーを開いてソーシャル認証を行うことをお勧めします。これは、[GoogleとFacebookからも推奨](https://developers.googleblog.com/2016/08/modernizing-oauth-interactions-in-native-apps.html)されています。最新の認証パイプラインについては、「[OIDC準拠の認証を導入する](/docs/ja-jp/api/authentication/api-auth/intro)」を参照してください。 + +2017年6月8日以降、新規テナントではこの機能がデフォルトで無効になりました。詳細については、「[アプリケーションの付与タイプ](/docs/ja-jp/api/authentication/applications/concepts/application-grant-types)」を参照してください。 + +ソーシャルプロバイダーのアクセストークンと`connection`が渡されると、このエンドポイントはユーザーをプロバイダーで認証し、アクセストークンとIDトークン（任意）を含むJSON応答を返します。このエンドポイントは、Facebook、Google、Twitter、Weiboにのみ利用できます。 + +### 備考[​](#備考) + +- +`profile`スコープ値は、エンドユーザーのデフォルトのプロファイルクレームである`name`、`family_name`、`given_name`、`middle_name`、`nickname`、`preferred_username`、`profile`、`picture`、`website`、`gender`、`birthdate`、`zoneinfo`、`locale`、`updated_at`へのアクセスを要求します。 + +- +`email`スコープ値は`email`と`email_verified`クレームへのアクセスを要求します。 + +### 詳しい情報[​](#詳しい情報) + +- [IDプロバイダーのAPIを呼び出す](https://auth0.com/docs/ja-jp/authenticate/identity-providers/calling-an-external-idp-api) +- [IDプロバイダーのアクセストークン](https://auth0.com/docs/ja-jp/secure/tokens/access-tokens/identity-provider-access-tokens) +- [IDプロバイダーのAPIにスコープ/権限を追加する](https://auth0.com/docs/ja-jp/authenticate/identity-providers/adding-scopes-for-an-external-idp) + +## Parameters + + + アプリケーションの`client_id`です。 + + + + ソーシャルプロバイダーのアクセストークンです。 + + + + アプリに構成されているIDプロバイダーの名前です。 + + + + `openid`を使用してIDトークンを取得するか、`openid profile email`を使用してIDトークンにユーザー情報を含めます。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 正常な認証応答 | +| 400 | 不正なリクエスト | +| 401 | 未認可 | +| 403 | 閲覧禁止 | +| default | 予期しないエラー | diff --git a/main/docs/ja-jp/api/authentication/login/authenticate-using-database.mdx b/main/docs/ja-jp/api/authentication/login/authenticate-using-database.mdx new file mode 100644 index 0000000000..ffbc44c156 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/login/authenticate-using-database.mdx @@ -0,0 +1,62 @@ +--- +title: "Database/AD/LDAP（パッシブ）" +description: "Auth0ユーザーストアまたは独自のデータベースを使用してユーザー名とパスワードの認証情報を保存および管理します。独自のユーザーデータベースがある場合、Auth0でそれをアイデンティティプロバイダーとして使用できます。" +--- + +`GET /authorize` + +Auth0ユーザーストアまたは独自のデータベースを使用してユーザー名とパスワードの認証情報を保存および管理できます。独自のユーザーデータベースがある場合、Auth0でそれをアイデンティティプロバイダーとして使用してユーザーを認証できます。ブラウザベース（パッシブ）認証のために`/authorize`エンドポイントに`GET`リクエストを送信すると、[Auth0ログインページ](http://manage.auth0.com/login)への`302`リダイレクトが返され、ユーザーがメールとパスワードでログインできるログインウィジェットが表示されます。 + + +パッシブ認証はブラウザを通じて行われ、[Auth0ログインページ](http://manage.auth0.com/login)から開始されます。ユーザーは認証情報を入力します。アクティブ認証のようなカスタムコードまたはバックエンド処理は必要ありません。 + + +### 注記 + +- `response_type=token`の場合、ユーザーが認証した後、アプリケーションの`callback URL`にリダイレクトされ、アクセストークンとIDトークンがアドレスの`location.hash`で渡されます。これはシングルページアプリケーション（SPA）およびネイティブモバイルSDKで使用されます。 +- パッシブ認証とアクティブ認証の主な違いは、前者が[Auth0ログインページ](http://manage.auth0.com/login)を通じてブラウザで行われ、後者はどこからでも（スクリプト、サーバー間通信など）呼び出せることです。 +- サンプルauth0.jsスクリプトはライブラリバージョン8を使用しています。auth0.jsバージョン7を使用している場合は、この[リファレンスガイド](https://auth0.com/docs/libraries/auth0js/v7)を参照してください。 + +### 詳細について + +- [データベースアイデンティティプロバイダー](https://auth0.com/docs/authenticate/database-connections) +- [ユーザー/パスワード認証でのレート制限](https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy) +- [Active Directory/LDAPコネクター](https://auth0.com/docs/authenticate/identity-providers/enterprise-identity-providers/active-directory-ldap/ad-ldap-connector) +- [状態パラメーター](https://auth0.com/docs/secure/attack-protection/state-parameters) +- [Auth0.js /authorize メソッドリファレンス](https://auth0.com/docs/libraries/auth0js#webauth-authorize-) + +## パラメーター + + + トークンタイプを指定します。サーバーサイドフローの場合は`code`、アプリケーションサイドフローの場合は`token`を使用します。 + + 許可される値: `code`, `token` + + + + アプリケーションの`client_id` + + + + アプリケーションに構成されている接続の名前。nullの場合、[Auth0ログインページ](http://manage.auth0.com/login)にリダイレクトされ、最初のデータベース接続を使用するログインウィジェットが表示されます。 + + + + ユーザーが認可を付与した後、Auth0がブラウザをリダイレクトするURL。`redirect_uri`は[アプリケーション設定](https://manage.auth0.com/dashboard/#/applications)で指定してください。 + + + + OIDCスコープとカスタムAPIスコープ。例：`openid read:timesheets`。リフレッシュトークンを取得するには`offline_access`を含めてください。 + + + + アプリケーションが初期リクエストに追加し、認可サーバーが応答時に含める不透明な値。この値はアプリケーションがCSRF攻撃を防ぐために使用する必要があります。 + + +## レスポンス + +| ステータス | 説明 | +|--------|------| +| 302 | ログインページへのリダイレクト | +| 400 | Bad Request - 無効なパラメーター | +| 500 | Internal Server Error | diff --git a/main/docs/ja-jp/api/authentication/login/check-back-channel-login-status.mdx b/main/docs/ja-jp/api/authentication/login/check-back-channel-login-status.mdx new file mode 100644 index 0000000000..2db5e3f03c --- /dev/null +++ b/main/docs/ja-jp/api/authentication/login/check-back-channel-login-status.mdx @@ -0,0 +1,56 @@ +--- +title: "バックチャネルログインフロー - ステータス確認" +description: "バックチャネルログインフローのステータスを確認するには、以下を渡して、`/oauth/token`エンドポイントを一定の間隔でポーリングします。" +--- + +`POST /oauth/token` + +バックチャネルログインフローのステータスを確認するには、以下を渡して、`/oauth/token`エンドポイントを一定の間隔でポーリングします。 + +- `/bc-authorize`の呼び出しで返された`auth_req_id` +- `urn:openid:params:grant-type:ciba`の付与タイプ + +### 要求本文[​](#要求本文) + +認可しているユーザーがまだ要求の承認や拒否を行っていない場合は、以下のような応答を受け取ります。 +{ "error": "authorization_pending", "error_description": "The end-user authorization is pending"} +認可しているユーザーが要求を拒否した場合は、以下のような応答を受け取ります。 +{ "error": "access_denied", "error_description": "The end-user denied the authorization request or it has been expired"} +ポーリングが早すぎる（`/bc-authorize`から返された間隔値よりも少ない）場合は、以下のような応答を受け取ります。 +{ "error": "slow_down", "error_description": "You are polling faster than allowed. Try again in 10 seconds."} +また、Auth0は応答に[Retry-After](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After)ヘッダーを追加して、必要なポーリングの待機時間を秒単位で示します。ポーリングの頻度が多すぎるまま続くと、秒単位のポーリング待機時間が増加します。 + +認可しているユーザーがプッシュ通知を承認すると、呼び出しがIDトークンとアクセストークン（場合によってはリフレッシュトークンも含む）を返します。 +{ "access_token": "eyJh...", "id_token": "eyJh...", "expires_in": 86400, "scope": "openid"} +IDトークンまたはアクセストークンと交換した`auth_req_id`は、それ以降使用できなくなります。 + +### 備考[​](#備考) + +要求にアプリケーション認証の任意のパラメーターを含めます。 + +- HTTP Basic認証でのクライアントシークレット：パラメーターは必要ありません。`client_id`と`client_secret`がヘッダーで渡されます。 +- クライアントシークレットのPost：`client_id`と`client_secret`が必要です。 +- 秘密鍵JWT：`client_id`、`client_assertion`と`client_assertion`のタイプが必要です。 +- mTLS：`client_id`パラメーター、`client-certificate`と`client-certificate-ca-verified`のヘッダーが必要です。 + +## Parameters + + + アプリケーションの`client_id`です。 + + + + `/bc-authorize`エンドポイントから返された`auth_req_id`です。 + + + + `urn:openid:params:grant-type:ciba`に設定する必要があります。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 認証ステータスが返されました。 | +| 400 | 不正な要求 - 無効なパラメーターです | +| 500 | 内部サーバーエラーです | diff --git a/main/docs/ja-jp/api/authentication/login/enterprise-saml-and-others.mdx b/main/docs/ja-jp/api/authentication/login/enterprise-saml-and-others.mdx new file mode 100644 index 0000000000..bc1438c803 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/login/enterprise-saml-and-others.mdx @@ -0,0 +1,53 @@ +--- +title: "エンタープライズ（SAMLまたはその他）" +description: "Auth0サービスをエンタープライズIDプロバイダーに接続して、Microsoft Azure Active DirectoryやGoogle Workspace、Okta..." +--- + +`GET /authorize` + +Auth0サービスをエンタープライズIDプロバイダーに接続して、Microsoft Azure Active DirectoryやGoogle Workspace、Okta Workforce、その他の対応プロバイダーを通してユーザーがアプリケーションにログインできるようにします。対応しているプロバイダーの詳細は、[Auth0 Marketplace](https://marketplace.auth0.com/features/enterprise-connections)でご覧ください。 + +パッシブ認証のため`/authorize`エンドポイントに`GET`呼び出しを行います。これにより、資格情報を入力するSAMLプロバイダー（またはMicrosoft Entra IDなど`connection`で指定されたプロバイダー）への`302`リダイレクトが返されます。 + +### 備考[​](#備考) + +- `response_type=token`の場合、ユーザーの認証後、アプリケーションの`callback URL`にリダイレクトし、アドレスの`location.hash`でアクセストークンとIDトークンを渡します。これは一般的に、シングルページアプリ（SPA）とネイティブモバイルのSDKに使用されます。 +- `connection`が提供されない場合、ユーザーは[Auth0のログインページ](http://manage.auth0.com/login)にリダイレクトされ、利用できる最優先のデータベース接続を使用して認証できます。 +- このフローは、ブラウザーベースのパッシブ認証が必要なアプリケーションに使用されます。 + +### 詳しい情報[​](#詳しい情報) + +- [SAML](https://auth0.com/docs/ja-jp/authenticate/protocols/saml/saml-configuration) +- [Microsoft Entra IDのクライアントIDとクライアントシークレットを取得する](https://auth0.com/docs/ja-jp/authenticate/identity-providers/enterprise-identity-providers/azure-active-directory/v2) +- [状態パラメーター](https://auth0.com/docs/ja-jp/secure/attack-protection/state-parameters) +- [Auth0.js /authorizeメソッドのリファレンス](https://auth0.com/docs/ja-jp/libraries/auth0js#webauth-authorize-) + +## Parameters + + + トークンの種類を指定します。サーバー側のフローには`code`、クライアント側のフローには`token`を使用します。 + + + + アプリケーションの`client_id`です。 + + + + アプリケーションに構成されているエンタープライズ接続の名前です。指定されない場合には、最も優先されるデータベース接続を使用して[Auth0のログインページ](http://manage.auth0.com/login)にリダイレクトし、ログインウィジェットを表示します。 + + + + ユーザーを認可した後、Auth0がブラウザーをリダイレクトするURLです。[アプリケーションの設定](/docs/ja-jp/api/authentication/login/${manage_url}/#/applications)で`redirect_uri`を指定します。 + + + + [推奨]認可サーバーがアプリケーションへのリダイレクトに含める初期要求に対してアプリケーションが追加する不透明な値です。この値は、CSRF攻撃を防ぐためににアプリケーションで使用される必要があります。 + + +## Response + +| Status | Description | +|--------|-------------| +| 302 | 認証プロバイダーにリダイレクトします | +| 400 | 不正な要求 - 無効なパラメーターです | +| 500 | 内部サーバーエラーです | diff --git a/main/docs/ja-jp/api/authentication/login/index.mdx b/main/docs/ja-jp/api/authentication/login/index.mdx new file mode 100644 index 0000000000..6b98215b34 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/login/index.mdx @@ -0,0 +1,59 @@ +--- +title: "ソーシャル" +description: "Auth0サービスをソーシャルアイデンティティプロバイダーに接続し、ユーザーがFacebook、Google、Apple、その他のサポートされているプロバイダーを通じてアプリケーションにログインできるようにします。" +--- + +`GET /authorize` + +## ソーシャル + +Auth0サービスをソーシャルアイデンティティプロバイダーに接続し、ユーザーがFacebook、Google、Apple、その他のサポートされているプロバイダーを通じてアプリケーションにログインできるようにします。サポートされているプロバイダーの詳細については、[マーケットプレイス](https://marketplace.auth0.com/features/social-connections)を参照してください。 + +ソーシャルプロバイダーでユーザーを認証するには、`/authorize`エンドポイントに`GET`リクエストを送信します。`connection`パラメーターで指定されたソーシャルプロバイダーへ`302`リダイレクトが返されます。 + + +ほとんどのソーシャルプロバイダーは、自社以外が所有するアプリケーションにユーザー名とパスワードを入力することを許可していないため、ソーシャル接続はブラウザベース（パッシブ）認証のみに対応しています。したがって、ユーザーはプロバイダーのサインインページにリダイレクトされます。 + + +### 注記 + +- `response_type=token`の場合、ユーザーがプロバイダーで認証した後、アプリケーションの`callback URL`にリダイレクトされ、アクセストークンとIDトークンがアドレスの`location.hash`で渡されます。これはシングルページアプリケーション（SPA）およびネイティブモバイルSDKで使用されます。 + +- サンプルauth0.jsスクリプトはライブラリバージョン8を使用しています。auth0.jsバージョン7を使用している場合は、この[リファレンスガイド](https://auth0.com/docs/libraries/auth0js)を参照してください。 + +### 詳細について + +- [サポートされているソーシャルアイデンティティプロバイダー](https://marketplace.auth0.com/features/social-connections) +- [カスタムソーシャル接続](https://auth0.com/docs/authenticate/identity-providers/social-identity-providers/oauth2) +- [状態パラメーター](https://auth0.com/docs/secure/attack-protection/state-parameters) +- [Auth0.js /authorize メソッドリファレンス](https://auth0.com/docs/libraries/auth0js#webauth-authorize-) + +## パラメーター + + + トークンタイプを指定します（codeまたはtoken） + + 許可される値: `code`, `token` + + + + アプリケーションのclient_id + + + + アプリケーションに構成されたソーシャルアイデンティティプロバイダーの名前 + + + + 認可後、Auth0がリダイレクトするURL + + + + CSRF攻撃を防ぐための不透明な値 + + +## レスポンス + +| ステータス | 説明 | +|--------|------| +| 302 | ソーシャルアイデンティティプロバイダーへのリダイレクト | diff --git a/main/docs/ja-jp/api/authentication/login/start-back-channel-login.mdx b/main/docs/ja-jp/api/authentication/login/start-back-channel-login.mdx new file mode 100644 index 0000000000..b8b331f2c3 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/login/start-back-channel-login.mdx @@ -0,0 +1,70 @@ +--- +title: "バックチャネルログイン" +description: "note" +--- + +`POST /bc-authorize` + +note +この機能は現在、早期アクセスです。アクセスをリクエストするには、担当の技術アカウント管理者までご連絡ください。 + +バックチャネルログインエンドポイントは、アプリケーションがユーザーの電話または認証デバイスに認証要求を送信できるようにします。その場合、アプリがインストール済みで、ユーザーが[Guardian SDKを使用したプッシュ通知](https://auth0.com/docs/ja-jp/secure/multi-factor-authentication/auth0-guardian#enroll-in-push-notifications)に登録済みでなければなりません。 + +ユーザーを以下のユースケースで認証するには、バックチャネルログインエンドポイントを使用します。 + +- ユーザーがコールセンターに電話中など、認証に必要なアプリケーションが前景にない +- 使用するデバイス、またはユーザーがサービスを使用できるようにするデバイスが、機密操作（Webブラウザーで金融取引を行うなど）を安全に実行できない +- 使用するデバイスの対話機能が限られている（電動自転車や電動スクーターなど） + +### 要求本文[​](#要求本文) + +要求に成功すると、以下のような応答を受け取ります。 +{ "auth_req_id": "eyJh...", "expires_in": 300, "interval": 5} +`auth_req_id`値は後でフローが認証要求の識別に使用するため、そのまま維持されなければなりません。 + +`expires_in`値は認証要求の有効期間を秒単位で示します。 + +`interval`値はポーリング要求の待機時間を秒単位で示します。 + +要求はGuardian SDKを使用して、ユーザーの認証デバイスで承認または拒否されなければなりません。 + +### 備考[​](#備考) + +- `login_hint`値は`iss_sub`の形式に従います。例： + +{ "format": "iss_sub", "iss": "https://[TENANT_DOMAIN]/", "sub": "auth0|[USER ID]" } +- 認証にはクライアントシークレット（HTTP BasicまたはPost認証）、秘密鍵JWT、またはmTLSが使用されます。上にある例の詳細を参照してください。 + +## Parameters + + + アプリケーションの`client_id`です。 + + + + 人間に読める文字列で、ユーザーが正しい要求を承認できるようにします。 + + + + 認証に使用されるユーザー詳細を含む`iss_sub`形式のJSONオブジェクトです。 + + + + 少なくとも`openid`を含む、スペース区切りのOIDCおよびAPIスコープのリストです。 + + + + アクセストークンの対象APIが持つ任意の一意の識別子です。 + + + + 要求にカスタムの有効期限を秒単位で指定します（1～300）。デフォルトは300秒です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 認証要求が正常に開始されました。 | +| 400 | 不正な要求 - 無効なパラメーターです | +| 500 | 内部サーバーエラーです | diff --git a/main/docs/ja-jp/api/authentication/logout/auth-0-logout.mdx b/main/docs/ja-jp/api/authentication/logout/auth-0-logout.mdx new file mode 100644 index 0000000000..72c45467b9 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/logout/auth-0-logout.mdx @@ -0,0 +1,42 @@ +--- +title: "Auth0ログアウト" +description: "このエンドポイントを使用してユーザーをログアウトします。ユーザーをログアウト後に特定のURLにナビゲートしたい場合は、そのURLを`returnTo`パラメーターに設定します。URLは適切な`Allowed Logout URLs`リストに含む必要があります。" +--- + +`GET /v2/logout` + +このエンドポイントを使用してユーザーをログアウトします。ユーザーをログアウト後に特定のURLにナビゲートしたい場合は、そのURLを`returnTo`パラメーターに設定します。URLは適切な`Allowed Logout URLs`リストに含む必要があります。 + +- `client_id`パラメーターが含まれる場合、`returnTo` URLは、アプリケーションレベルで設定された`Allowed Logout URLs`にリストされなければなりません。詳しい説明については、「[ユーザーをアプリケーションからログアウトさせる](https://auth0.com/docs/ja-jp/authenticate/login/logout/log-users-out-of-applications)」をお読みください。 +- `client_id`パラメーターが含まれない場合、`returnTo` URLは、テナントレベルで設定された`Allowed Logout URLs`にリストされなければなりません。詳しい説明については、「[ユーザーをAuth0からログアウトする](https://auth0.com/docs/ja-jp/authenticate/login/logout/log-users-out-of-auth0)」をお読みください。 +- `client_id`パラメーターが含まれていて、`returnTo` URLが設定されていない場合、サーバーはDashboardに最初に設定されている、許可されているログアウトURLにユーザーをリダイレクトします。詳しい説明については、「[ユーザーをアプリケーションからログアウトさせる](https://auth0.com/docs/ja-jp/authenticate/login/logout/log-users-out-of-applications)」をお読みください。 + +### 備考[​](#備考) + +- ユーザーをIDプロバイダーからログアウトさせることは一般的ではないため、`federated`クエリ文字列パラメーターを使う前に、ユーザーエクスペリエンスを考慮してください。 +- サンプルのauth0.jsスクリプトは、バージョン8のライブラリーを使用しています。auth0.jsバージョン7を使用している場合には、こちらの[リファレンスガイド](https://auth0.com/docs/ja-jp/libraries/auth0js)を参照してください。 + +### 詳しい情報[​](#詳しい情報) + +- [ログアウト](https://auth0.com/docs/ja-jp/authenticate/login/logout) + +## Parameters + + + アプリケーションの`client_id`です。 + + + + ユーザーをログアウト後にリダイレクトするURLです。 + + + + ユーザーをIDプロバイダーからログアウトするために、このクエリ文字列パラメーターをログアウトURLに追加します。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 正常にログアウトされました | +| 400 | 不正な要求です。必要なパラメーターが欠けている可能性があります | diff --git a/main/docs/ja-jp/api/authentication/logout/global-token-revocation.mdx b/main/docs/ja-jp/api/authentication/logout/global-token-revocation.mdx index 1745aa6d32..756984e068 100644 --- a/main/docs/ja-jp/api/authentication/logout/global-token-revocation.mdx +++ b/main/docs/ja-jp/api/authentication/logout/global-token-revocation.mdx @@ -1,11 +1,39 @@ --- -openapi: authentication-api-oas post /oauth/global-token-revocation/connection/{connection_name} -playground: simple -deprecated: false +title: "グローバルトークンを取り消す" +description: "このエンドポイントを[Okta Workforce Identity Cloud Universal..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /oauth/global-token-revocation/connection/{connection_name}` - - \ No newline at end of file +このエンドポイントを[Okta Workforce Identity Cloud Universal Logout](https://developer.okta.com/docs/guides/oin-universal-logout-overview/)で使用して、ユーザーをアプリケーションからログアウトさせます。このエンドポイントへの要求は、セッションクッキーとリフレッシュトークンを取り消しますが、アクセストークンは取り消しません。詳細については、「[ユニバーサルログアウト](https://auth0.com/docs/ja-jp/authenticate/login/logout/universal-logout)」をお読みください。要求はユーザーセッションを取り消す前に認証されなければなりません。「[エンドポイント認証](https://developer.okta.com/docs/guides/oin-universal-logout-overview/#endpoint-authentication)」を参照してください。 + +## Parameters + + + ユーザーのセッションを取り消したい接続の名前です。 + + + + 発行者のURL（通常は認可サーバーのURL）です。 + + + + + + + + 発行者のURL（通常は認可サーバーのURL）です。 + + + + 主題識別子（通常はユーザーの識別子）です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | セッションクッキーとリフレッシュトークンが正常に取り消されました。 | +| 400 | 不正な要求です。無効な`subject`形式、または認証がない可能性があります | +| 401 | 認可されていません。認証に失敗しました。 | +| 500 | 内部サーバーエラーです。 | diff --git a/main/docs/ja-jp/api/authentication/logout/logout.mdx b/main/docs/ja-jp/api/authentication/logout/logout.mdx deleted file mode 100644 index 0b2f41a730..0000000000 --- a/main/docs/ja-jp/api/authentication/logout/logout.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /v2/logout -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/logout/oidc-logout.mdx b/main/docs/ja-jp/api/authentication/logout/oidc-logout.mdx new file mode 100644 index 0000000000..5dc8c1ffa7 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/logout/oidc-logout.mdx @@ -0,0 +1,71 @@ +--- +title: "OIDCログアウト" +description: "このエンドポイントを使用してユーザーをログアウトします。ユーザーをログアウト後に特定のURLにナビゲートしたい場合は、そのURLを`post_logout_redirect_uri`パラメーターに設定します。URLは適切な`Allowed Logout URLs`リストに含む必要があります。" +--- + +`GET /oidc/logout` + +このエンドポイントを使用してユーザーをログアウトします。ユーザーをログアウト後に特定のURLにナビゲートしたい場合は、そのURLを`post_logout_redirect_uri`パラメーターに設定します。URLは適切な`Allowed Logout URLs`リストに含む必要があります。 + +`id_token_hint`パラメーターが含まれる場合： +- `client_id`パラメーターが含まれる場合、サーバーは`id_token_hint`にある`aud`クレームのURLを使用して、`client_id`で指定されたアプリケーションから使用する`Allowed Logout URLs`を選択します。 +- `client_id`パラメーターが含まれない場合、サーバーは`id_token_hint`にある`aud`クレームのURLを使用して、使用するテナントレベルの`Allowed Logout URLs`を選択します。 + +`id_token_hint`パラメーターが含まれない場合： +- `client_id`パラメーターが含まれる場合、`post_logout_redirect_uri` URLは、アプリケーションレベルで設定された`Allowed Logout URLs`にリストされなければなりません。 +- `client_id`パラメーターが含まれない場合、`post_logout_redirect_uri` URLは、テナントレベルで設定された`Allowed Logout URLs`にリストされなければなりません。 +- `client_id`パラメーターが含まれていて、`post_logout_redirect_uri` URLが設定されていない場合は、サーバーは、Dashboardに最初に設定されている`Allowed Logout URLs`にユーザーをリダイレクトします。 + +詳細については、「[OIDCエンドポイントを使用してユーザーをAuth0からログアウトする](https://auth0.com/docs/ja-jp/authenticate/login/logout/log-users-out-of-auth0)」をお読みください。 + +### 備考[​](#備考) + +- ユーザーをソーシャルIDプロバイダーからログアウトさせることは一般的ではないため、ソーシャルIDプロバイダーに`federated`クエリ文字列パラメーターを使う前に、ユーザーエクスペリエンスを考慮してください。 +- `id_token_hint`と`logout_hint`を両方提供する場合は、`logout_hint`値がid_token_hintの`sid`クレームと一致しなければなりません。 +- `id_token_hint`と`client_id`を両方提供する場合は、`client_id`値が`id_token_hint`の`aud`クレームと一致しなければなりません。 +- `id_token_hint`が提供されない場合は、ユーザーのセッションIDと一致する`logout_hint`が提供されない限り、ユーザーに同意が求められます。 +- `POST` HTTPメソッドもこの要求でサポートされています。`POST`を使用する際は、要求パラメーターは要求のボディーで、クエリ文字列ではなくフォームパラメーターとして提供される必要があります。フェデレーテッドパラメーターには`true`または`false`の値が必要です。 +- これは[OIDC RP起点ログアウトの仕様](https://openid.net/specs/openid-connect-rpinitiated-1_0.html)に準拠しています。 + +### 詳しい情報[​](#詳しい情報) + +- [ログアウト](https://auth0.com/docs/ja-jp/authenticate/login/logout) +- [OIDCエンドポイントを使用してユーザーをAuth0からログアウトする](https://auth0.com/docs/ja-jp/authenticate/login/logout/log-users-out-of-auth0) +- [OIDC RP起点ログアウトの仕様](https://openid.net/specs/openid-connect-rpinitiated-1_0.html) + +## Parameters + + + [推奨]以前ユーザーに発行されたIDトークンです。これはログアウトするユーザーを示すために使用されます。 + + + + ログアウトするユーザーを示す、任意の`sid`（セッションID）値です。`id_token_hint`が使用不可のときに提供する必要があります。 + + + + ユーザーをログアウト後にリダイレクトするURLです。 + + + + アプリケーションの`client_id`です。 + + + + ユーザーをIDプロバイダーからログアウトするためにこのクエリ文字列パラメーターを追加します：`https://YOUR_DOMAIN/oidc/logout?federated`。 + + + + 認可サーバーが`post_logout_redirect_uri`へのリダイレクトに含める初期要求に対してアプリケーションが追加する不透明な値です。 + + + + 要求の言語リストを制限するために使用されるスペースで区切りのロケールのリストです。リストの最初のロケールはテナントで有効になっているロケールと一致する必要があります。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 正常にログアウトされました | +| 400 | 不正な要求です。必要なパラメーターが欠けている可能性があります | diff --git a/main/docs/ja-jp/api/authentication/logout/oidc-rp-initiated-logout.mdx b/main/docs/ja-jp/api/authentication/logout/oidc-rp-initiated-logout.mdx deleted file mode 100644 index 3eef58c6a3..0000000000 --- a/main/docs/ja-jp/api/authentication/logout/oidc-rp-initiated-logout.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /oidc/logout -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/logout/saml-logout.mdx b/main/docs/ja-jp/api/authentication/logout/saml-logout.mdx index d5dd1d950a..71f899b96c 100644 --- a/main/docs/ja-jp/api/authentication/logout/saml-logout.mdx +++ b/main/docs/ja-jp/api/authentication/logout/saml-logout.mdx @@ -1,11 +1,30 @@ --- -openapi: authentication-api-oas post /samlp/{client_id}/logout -playground: simple -deprecated: false +title: "SAMLログアウト" +description: "このエンドポイントを使用してSAML IDプロバイダー（IdP）として構成されたAuth0テナントからユーザーをログアウトします。ログアウトの動作は、SAML IdPとして振る舞うAuth0テナントのアプリケーション用のSAML2..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /samlp/{client_id}/logout` - - \ No newline at end of file +このエンドポイントを使用してSAML IDプロバイダー（IdP）として構成されたAuth0テナントからユーザーをログアウトします。ログアウトの動作は、SAML IdPとして振る舞うAuth0テナントのアプリケーション用のSAML2 Webアプリアドオンの構成によって決定されます。詳しい説明については、「[ユーザーをSAML IDプロバイダーからログアウトする](https://auth0.com/docs/ja-jp/authenticate/login/logout/log-users-out-of-saml-idps#configure-slo-when-auth0-is-the-saml-idp)」をお読みください。 + +### 備考[​](#備考) + +- POST本文には有効なSAMLの``メッセージが含まれなくてはなりません。詳しい説明については、「[OasisのOASIS Security Assertion Markup Language（SAML）V2.0のアサーションとプロトコル](https://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf)」をお読みください。 + +### 詳しい情報[​](#詳しい情報) + +- [ログアウト](https://auth0.com/docs/ja-jp/authenticate/login/logout) +- [ユーザーをSAML IDプロバイダーからログアウトする](https://auth0.com/docs/ja-jp/authenticate/login/logout/log-users-out-of-saml-idps) + +## Parameters + + + [SAML2 Webアプリアドオン](https://auth0.com/docs/ja-jp/authenticate/protocols/saml/saml-sso-integrations/enable-saml2-web-app-addon)で構成されたアプリケーションのクライアントIDです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 正常にログアウトされました | +| 400 | 不正な要求です。無効なSAMLメッセージの可能性があります | diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/add-an-authenticator.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/add-an-authenticator.mdx new file mode 100644 index 0000000000..ff1b59fd2b --- /dev/null +++ b/main/docs/ja-jp/api/authentication/multi-factor-authentication/add-an-authenticator.mdx @@ -0,0 +1,58 @@ +--- +title: "Add an Authenticator" +description: "Associates or adds a new authenticator for multi-factor authentication (MFA)." +--- + +`POST /mfa/associate` + +Associates or adds a new authenticator for multi-factor authentication (MFA). + +If the user has active authenticators, an Access Token with the `enroll` scope and the `audience` set to `https://{yourDomain}/mfa/` is required to use this endpoint. + +If the user has no active authenticators, you can use the `mfa_token` from the `mfa_required` error in place of an Access Token for this request. + +After an authenticator is added, it must be verified. To verify the authenticator, use the response values from the `/mfa/associate` request in place of the values returned from the `/mfa/challenge` endpoint and continue with the verification flow. + +A `recovery_codes` field is included in the response the first time an authenticator is added. You can use `recovery_codes` to pass multi-factor authentication as shown on [Verify with recovery code](/multi-factor-authentication/verify-with-recovery-code) above. + +To access this endpoint, you must set an Access Token at the Authorization header, with the following claims: +- `scope`: `enroll` +- `audience`: `https://{yourDomain}/mfa/` + +## Parameters + + + Your application's Client ID. + + + + A JWT containing a signed assertion with your application credentials. Required when Private Key JWT is your application authentication method. + + + + The value is `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. Required when Private Key JWT is the application authentication method. + + + + Your application's Client Secret. Required when the Token Endpoint Authentication Method field in your Application Settings is `Post` or `Basic`. + + + + Value is an array with values 'otp' or 'oob'. + + + + Required if `authenticator_types` include `oob`. + + + + The phone number to use for SMS or Voice. Required if `oob_channels` includes `sms` or `voice`. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Successful response for adding an authenticator. | +| 400 | Bad request due to missing or invalid parameters. | +| 401 | Unauthorized, invalid access token or mfa_token. | diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/associate-mfa-authenticator.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/associate-mfa-authenticator.mdx deleted file mode 100644 index 1bad114315..0000000000 --- a/main/docs/ja-jp/api/authentication/multi-factor-authentication/associate-mfa-authenticator.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /mfa/associate -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/delete-authenticator.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/delete-authenticator.mdx new file mode 100644 index 0000000000..ba883d1639 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/multi-factor-authentication/delete-authenticator.mdx @@ -0,0 +1,30 @@ +--- +title: "Delete an Authenticator" +description: "Deletes an associated authenticator using its ID. You can get authenticator IDs by listing the authenticators." +--- + +`DELETE /mfa/authenticators/{AUTHENTICATOR_ID}` + +Deletes an associated authenticator using its ID. You can get authenticator IDs by listing the authenticators. + +To access this endpoint, you must set an Access Token in the Authorization header, with the following claims: +- `scope`: `remove:authenticators` +- `audience`: `https://{yourDomain}/mfa/` + +## Parameters + + + The ID of the authenticator to delete. + + + + The Access Token obtained during login. + + +## Response + +| Status | Description | +|--------|-------------| +| 204 | Authenticator deleted successfully. | +| 401 | Unauthorized - Invalid access token. | +| 404 | Authenticator not found. | diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/delete-mfa-authenticator.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/delete-mfa-authenticator.mdx deleted file mode 100644 index 621290800c..0000000000 --- a/main/docs/ja-jp/api/authentication/multi-factor-authentication/delete-mfa-authenticator.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas delete /mfa/authenticators/{id} -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/list-authenticators.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/list-authenticators.mdx new file mode 100644 index 0000000000..5483fe81c1 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/multi-factor-authentication/list-authenticators.mdx @@ -0,0 +1,24 @@ +--- +title: "List Authenticators" +description: "Returns a list of authenticators associated with your application." +--- + +`GET /mfa/authenticators` + +Returns a list of authenticators associated with your application. + +To access this endpoint, you must set an Access Token at the Authorization header, with the following claims: +- `scope`: `read:authenticators` +- `audience`: `https://{yourDomain}/mfa/` + +## Parameters + + + Bearer ACCESS_TOKEN + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | A list of authenticators. | diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/list-mfa-authenticators.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/list-mfa-authenticators.mdx deleted file mode 100644 index b6ec4e0389..0000000000 --- a/main/docs/ja-jp/api/authentication/multi-factor-authentication/list-mfa-authenticators.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /mfa/authenticators -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx index 3c174b58d4..38a6ed53ff 100644 --- a/main/docs/ja-jp/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx +++ b/main/docs/ja-jp/api/authentication/multi-factor-authentication/request-mfa-challenge.mdx @@ -1,11 +1,77 @@ --- -openapi: authentication-api-oas post /mfa/challenge -playground: simple -deprecated: false +title: "Challenge Request" +description: "The Multi-factor Authentication (MFA) API endpoints allow you to enforce MFA when users interact with the Token endpoints, as well as enroll and manage user authenticators." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /mfa/challenge` - - \ No newline at end of file +The Multi-factor Authentication (MFA) API endpoints allow you to enforce MFA when users interact with the Token endpoints, as well as enroll and manage user authenticators. + +First, request a challenge based on the challenge types supported by the application and user. If you know that one-time password (OTP) is supported, you can skip the challenge request. + +Next, verify the multi-factor authentication using the `/oauth/token` endpoint and the specified challenge type: a one-time password (OTP), a recovery code, or an out-of-band (OOB) challenge. + +To learn more, read: +- [Multi-factor Authentication and Resource Owner Password](https://auth0.com/docs/secure/multi-factor-authentication/authenticate-using-ropg-flow-with-mfa) +- [Multi-factor Authentication API](https://auth0.com/docs/secure/multi-factor-authentication/multi-factor-authentication-developer-resources/mfa-api) +- [Multi-factor Authentication in Auth0](https://auth0.com/docs/secure/multi-factor-authentication) + +## Challenge Request + +Request a challenge for multi-factor authentication (MFA) based on the challenge types supported by the application and user. + +The `challenge_type` is how the user will get the challenge and prove possession. Supported challenge types include: +- `otp`: for one-time password (OTP) +- `oob`: for SMS/Voice messages or out-of-band (OOB) + +If OTP is supported by the user and you don't want to request a different factor, you can skip the challenge request and verify the multi-factor authentication with a one-time password. + +### Remarks +- This endpoint does not support enrollment; the user must be enrolled with the preferred method before requesting a challenge. +- Auth0 chooses the challenge type based on the application's supported types and types the user is enrolled with. +- An `unsupported_challenge_type` error is returned if your application does not support any of the challenge types the user has enrolled with. +- An `unsupported_challenge_type` error is returned if the user is not enrolled. +- If the user is not enrolled, you will get an `association_required` error, indicating the user needs to enroll to use MFA. Read [Add an authenticator](/multi-factor-authentication/add-an-authenticator) below on how to proceed. + +### Learn More +* [Authenticate With Resource Owner Password Grant and MFA](https://auth0.com/docs/secure/multi-factor-authentication/authenticate-using-ropg-flow-with-mfa) +* [Manage Authenticator Factors using the MFA API](https://auth0.com/docs/secure/multi-factor-authentication/manage-mfa-auth0-apis/manage-authenticator-factors-mfa-api) + +## Parameters + + + The token received from mfa_required error. + + + + Your application's Client ID. + + + + Your application's Client Secret. + + + + A whitespace-separated list of challenge types accepted by your application. + + Allowed values: `oob`, `otp` + + + + A JWT containing a signed assertion with your application credentials. + + + + The value is urn:ietf:params:oauth:client-assertion-type:jwt-bearer. + + + + The ID of the authenticator to challenge. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Challenge request successful | +| 400 | Invalid request, such as unsupported challenge type or missing enrollment. | diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx new file mode 100644 index 0000000000..601b909030 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx @@ -0,0 +1,55 @@ +--- +title: "Verify multi-factor authentication with one-time password (OTP)" +description: "Verifies multi-factor authentication (MFA) using a one-time password (OTP)." +--- + +`POST /oauth/token` + +Verifies multi-factor authentication (MFA) using a one-time password (OTP). To verify MFA with an OTP, prompt the user to get the OTP code, then make a request to the /oauth/token endpoint. The request must have the OTP code, the mfa_token you received (from the mfa_required error), and the grant_type set to http://auth0.com/oauth/grant-type/mfa-otp. The response is the same as responses for password or http://auth0.com/oauth/grant-type/password-realm grant types. Learn more at [Associate OTP Authenticators](/mfa/guides/mfa-api/otp). + +### Learn More + +- [Associate OTP Authenticators](https://auth0.com/docs/mfa/guides/mfa-api/otp) + +## Parameters + + + A DPoP proof for the request. This is optional and only required if your application uses Demonstrating Proof-of-Possession. + + +## Request Body + + + Denotes the flow you are using. For OTP MFA use `http://auth0.com/oauth/grant-type/mfa-otp`. + + + + Your application's Client ID. + + + + Your application's Client Secret. + + + + The `mfa_token` you received from `mfa_required` error. + + + + OTP Code provided by the user. + + + + A JWT containing a signed assertion with your application credentials. + + + + The value is `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | OTP verification successful. | +| 400 | Invalid request, such as missing parameters or invalid OTP. | diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-with-out-of-band.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-with-out-of-band.mdx new file mode 100644 index 0000000000..a8b372f450 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-with-out-of-band.mdx @@ -0,0 +1,71 @@ +--- +title: "Verify with Out-of-Band (OOB)" +description: "Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either Push notification, SMS, or Voice)." +--- + +`POST /oauth/token` + +Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either Push notification, SMS, or Voice). To verify MFA using an OOB challenge, your application must make a request to `/oauth/token` with `grant_type=http://auth0.com/oauth/grant-type/mfa-oob`. Include the `oob_code` you received from the challenge response, as well as the `mfa_token` you received as part of `mfa_required` error. + +The response to this request depends on the status of the underlying challenge verification: +- If the challenge has been accepted and verified, it will be the same as `password` or `http://auth0.com/oauth/grant-type/password-realm` grant types. +- If the challenge has been rejected, you will get an `invalid_grant` error, meaning that the challenge was rejected by the user. At this point you should stop polling, as this response is final. +- If the challenge verification is still pending (meaning it has not been accepted nor rejected), you will get an `authorization_pending` error, meaning that you must retry the same request a few seconds later. If you request too frequently, you will get a `slow_down` error. + +When the challenge response includes a `binding_method: prompt`, your app needs to prompt the user for the `binding_code` and send it as part of the request. The `binding_code` is usually a 6-digit number (similar to an OTP) included as part of the challenge. No `binding_code` is necessary if the challenge response did not include a `binding_method`. In this scenario, the response will be immediate; you will receive an `invalid_grant` or an `access_token` as response. + +### Learn More + +- [Associate Out-of-Band Authenticators](https://auth0.com/docs/secure/multi-factor-authentication/authenticate-using-ropg-flow-with-mfa/enroll-challenge-sms-voice-authenticators) + +## Parameters + + + A DPoP proof for the request. This is optional and only required if your application uses Demonstrating Proof-of-Possession. + + +## Request Body + + + Denotes the flow you are using. For OTP MFA, use `http://auth0.com/oauth/grant-type/mfa-oob`. + + Allowed values: `http://auth0.com/oauth/grant-type/mfa-oob` + + + + Your application's Client ID. + + + + A JWT containing a signed assertion with your application credentials. + + + + The value is `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. + + Allowed values: `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` + + + + Your application's Client Secret. + + + + The `mfa_token` you received from `mfa_required` error. + + + + The oob code received from the challenge request. + + + + A code used to bind the side channel with the main channel you are using to authenticate. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Successful response for OOB verification. | +| 400 | Bad request due to missing or invalid parameters. | +| 401 | Unauthorized, invalid mfa_token or oob_code. | diff --git a/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-with-recovery-code.mdx b/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-with-recovery-code.mdx new file mode 100644 index 0000000000..a8dd895186 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-with-recovery-code.mdx @@ -0,0 +1,58 @@ +--- +title: "Verify with Recovery Code" +description: "Verifies multi-factor authentication (MFA) using a recovery code." +--- + +`POST /oauth/token` + +Verifies multi-factor authentication (MFA) using a recovery code. Some multi-factor authentication (MFA) providers (such as Guardian) support using a recovery code to login. Use this method to authenticate when the user's enrolled device is unavailable, or the user cannot receive the challenge or accept it due to connectivity issues. + +To verify MFA using a recovery code your app must prompt the user for the recovery code, and then make a request to `/oauth/token` with `grant_type=http://auth0.com/oauth/grant-type/mfa-recovery-code`. Include the collected recovery code and the `mfa_token` from the `mfa_required` error. If the recovery code is accepted, the response will be the same as for `password` or `http://auth0.com/oauth/grant-type/password-realm` grant types. It might also include a `recovery_code` field, which the application must display to the end-user to be stored securely for future use. + +## Parameters + + + A DPoP proof for the request. This is optional and only required if your application uses Demonstrating Proof-of-Possession. + + +## Request Body + + + Denotes the flow you are using. For recovery code use `http://auth0.com/oauth/grant-type/mfa-recovery-code`. + + Allowed values: `http://auth0.com/oauth/grant-type/mfa-recovery-code` + + + + Your application's Client ID. + + + + A JWT containing a signed assertion with your application credentials. + + + + The value is `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`. + + Allowed values: `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` + + + + Your application's Client Secret. + + + + The `mfa_token` you received from `mfa_required` error. + + + + Recovery code provided by the end-user. + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | Successful response for recovery code verification. | +| 400 | Bad request due to missing or invalid parameters. | +| 401 | Unauthorized, invalid mfa_token or recovery_code. | diff --git a/main/docs/ja-jp/api/authentication/passwordless/authenticate-user.mdx b/main/docs/ja-jp/api/authentication/passwordless/authenticate-user.mdx new file mode 100644 index 0000000000..3673dc45d9 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/passwordless/authenticate-user.mdx @@ -0,0 +1,66 @@ +--- +title: "ユーザーを認証する" +description: "確認コードを入手したら、このエンドポイントを使用して、ユーザーを電話番号/メールアドレスと確認コードでログインします。" +--- + +`POST /oauth/token` + +確認コードを入手したら、このエンドポイントを使用して、ユーザーを電話番号/メールアドレスと確認コードでログインします。 + +### 備考[​](#備考) + +- `grant_type`は`http://auth0.com/oauth/grant-type/passwordless/otp`になります。 +アプリケーションの`client_id`が必要です。 +`username`はユーザーの電話番号（`realm=sms`の場合）またはユーザーのメールアドレス（`realm=email`の場合）です。- `realm`は`sms`または`email`のいずれかで、[POST /passwordless/start](#get-code-or-link)要求と一致しなければなりません。 +- `otp`はユーザーの確認コードです。 +- `redirect_uri`は必須のCallback URLで、アプリケーションの**［許可されているCallback URL］**に登録されていなければなりません。 + +### 詳しい情報[​](#詳しい情報) + +- [パスワードレス認証](https://auth0.com/docs/ja-jp/authenticate/passwordless) + +## Parameters + + + [http://auth0.com/oauth/grant-type/passwordless/otpにする必要があります。](http://auth0.com/oauth/grant-type/passwordless/otp%E3%81%AB%E3%81%99%E3%82%8B%E5%BF%85%E8%A6%81%E3%81%8C%E3%81%82%E3%82%8A%E3%81%BE%E3%81%99%E3%80%82) + + + + アプリケーションのclient_idです。 + + + + アプリケーションのclient_secretです。通常のWebアプリケーションのみに必須です。 + + + + ユーザーの確認コードです。 + + + + 使用される接続と一致する必要があります。 + + + + ユーザーの電話番号かメールアドレスです。 + + + + アクセストークンを取得したいAPIのAPI識別子です。 + + + + IDトークンを取得するためにopenidを使用します。 + + + + アプリケーションの許可されているCallback URLで登録されたCallback URLです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | ユーザーが正常に認証されました。 | +| 400 | 不正な要求です。無効なパラメーターです。 | +| 401 | 認可されていません。無効な資格情報です。 | diff --git a/main/docs/ja-jp/api/authentication/passwordless/get-code-or-link.mdx b/main/docs/ja-jp/api/authentication/passwordless/get-code-or-link.mdx new file mode 100644 index 0000000000..3c932fe750 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/passwordless/get-code-or-link.mdx @@ -0,0 +1,83 @@ +--- +title: "コードまたはリンクを取得する" +description: "パスワードレス接続では、ユーザーがパスワードを記憶する必要がありません。代わりに、ユーザーがログインする度にメールかSMSで送信されるワンタイムコードなど、別のメカニズムを使用して本人確認を行います。" +--- + +`POST /passwordless/start` + +パスワードレス接続では、ユーザーがパスワードを記憶する必要がありません。代わりに、ユーザーがログインする度にメールかSMSで送信されるワンタイムコードなど、別のメカニズムを使用して本人確認を行います。 + +[パスワードレス認証](https://auth0.com/docs/ja-jp/authenticate/passwordless)には3つのオプションがあります。 + +- メールで確認コードを送信する。 +- メールでリンクを送信する。 +- SMSで確認コードを送信する。 + +### 備考[​](#備考) + +- メールかSMSで確認コードを送信した場合、コードを取得した後に、[/passwordless/verifyエンドポイント](/docs/ja-jp/api/authentication/passwordless/authenticate-user)を使用してユーザーを認証しなければなりません。この際、`username`には`email`または`phone_number`、`password`には確認コードを使用します。 +- このエンドポイントはクライアント側から呼び出すように設計されており、[レート制限](https://auth0.com/docs/ja-jp/troubleshoot/customer-support/operational-policies/rate-limit-policy)の対象です。 +- サンプルのauth0.jsスクリプトは、バージョン8のライブラリーを使用しています。auth0.jsバージョン7を使用している場合には、こちらの[リファレンスガイド](https://auth0.com/docs/libraries/auth0js/v7)を参照してください。 + +### エラーコード[​](#エラーコード) + +このエンドポイントに関するエラーコード参照の全体については、「[エラー > POST /passwordless/start](#post-passwordless-start)」を参照してください。 + +### 詳しい情報[​](#詳しい情報) + +- [パスワードレス認証](https://auth0.com/docs/ja-jp/authenticate/passwordless) +- [パスワードレスのベストプラクティス](https://auth0.com/docs/ja-jp/authenticate/passwordless/best-practices) + +## Parameters + + + アプリケーションの`client_id`です。 + + + + アプリケーションの資格情報のある署名済みアサーションを含んだJWTです。アプリケーションの認証方法が秘密鍵JWTの場合に必須です。 + + + + `urn:ietf:params:oauth:client-assertion-type:jwt-bearer`値を使用します。秘密鍵JWTがアプリケーション認証方法の場合は必須。 + + + + アプリケーションの`client_secret`です。通常のWebアプリケーション**のみ**に必須です。 + + + + コード/リンクをユーザーに送信する方法です。メールで送信する場合は`email`、SMSで送信する場合は`sms`を使用します。 + + + + `connection=email`の場合は、これをユーザーのメールアドレスに設定します。 + + + + `connection=sms`の場合は、これをユーザーの電話番号に設定します。 + + + + リンクの送信には`link`、確認コードの送信には`code`を使用します。nullの場合はリンクが送信されます。 + + + + `scope`、`state`、`redirect_uri`など、追加したい任意の認証パラメーターです。 + + + + OAuthのスコープです。 + + + + 要求とコールバック間の状態を維持する状態パラメーターです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | コードまたはリンクが正常に送信されました。 | +| 400 | 不正な要求です。無効なパラメーターです。 | +| 401 | 認可されていません。無効なクライアント資格情報です。 | diff --git a/main/docs/ja-jp/api/authentication/passwordless/start-passwordless-authentication.mdx b/main/docs/ja-jp/api/authentication/passwordless/start-passwordless-authentication.mdx deleted file mode 100644 index 219cbd934d..0000000000 --- a/main/docs/ja-jp/api/authentication/passwordless/start-passwordless-authentication.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /passwordless/start -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/passwordless/verify.mdx b/main/docs/ja-jp/api/authentication/passwordless/verify.mdx index 1a13bc7dee..ecbe5fd530 100644 --- a/main/docs/ja-jp/api/authentication/passwordless/verify.mdx +++ b/main/docs/ja-jp/api/authentication/passwordless/verify.mdx @@ -1,11 +1,61 @@ --- -openapi: authentication-api-oas post /passwordless/verify -playground: simple -deprecated: false +title: "検証" +description: "note" --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`POST /passwordless/verify` - - \ No newline at end of file +note +2017年6月8日以降、新規テナントではこの機能がデフォルトで無効になりました。詳細については、「[アプリケーションの付与タイプ](/docs/ja-jp/api/authentication/applications/concepts/application-grant-types)」を参照してください。 + +確認コードを入手したら、このエンドポイントを使用して、ユーザーを電話番号/メールアドレスと確認コードでログインします。これはアクティブ認証のため、ユーザーはアプリでコードを入力しなければなりません。 + +### 備考[​](#備考) + +- `profile`スコープ値は、エンドユーザーのデフォルトのプロファイルクレームである`name`、`family_name`、`given_name`、`middle_name`、`nickname`、`preferred_username`、`profile`、`picture`、`website`、`gender`、`birthdate`、`zoneinfo`、`locale`、`updated_at`へのアクセスを要求します。 +- `email`スコープ値は`email`と`email_verified`クレームへのアクセスを要求します。 +- サンプルのauth0.jsスクリプトは、バージョン8のライブラリーを使用しています。auth0.jsバージョン7を使用している場合には、こちらの[リファレンスガイド](https://auth0.com/docs/ja-jp/libraries/auth0js)を参照してください + +### 詳しい情報[​](#詳しい情報) + +- [パスワードレスのベストプラクティス](/docs/ja-jp/api/authentication/connections/passwordless/best-practices) + +## Parameters + + + 付与タイプです。`password`でなければなりません。 + + + + アプリケーションの`client_id`です。 + + + + `sms`または`email`（[POST /passwordless/start](#get-code-or-link)と一致）を使用します。 + + + + `connection=sms`の場合はユーザーの電話番号、`connection=email`の場合はユーザーのメールアドレスです。 + + + + ユーザーの確認コードです。 + + + + IDトークンにユーザープロファイル情報を含めるために、`openid`を使用してIDトークンまたは`openid profile email`を取得します。 + + + + アプリケーションの許可されているCallback URLで登録されたCallback URLです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | ユーザーが正常に認証されました。 | +| 400 | 不正な要求です。無効なパラメーターです。 | +| 401 | 認可されていません。無効な資格情報です。 | +| 403 | 禁止されています。クライアントの認証が必要です。 | +| 500 | 内部サーバーエラーです。 | diff --git a/main/docs/ja-jp/api/authentication/pushed-authorization-requests/pushed-authorization-request-par.mdx b/main/docs/ja-jp/api/authentication/pushed-authorization-requests/pushed-authorization-request-par.mdx deleted file mode 100644 index 142c9425d8..0000000000 --- a/main/docs/ja-jp/api/authentication/pushed-authorization-requests/pushed-authorization-request-par.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/par -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/refresh-token/refresh-token.mdx b/main/docs/ja-jp/api/authentication/refresh-token/refresh-token.mdx new file mode 100644 index 0000000000..c288e92c6b --- /dev/null +++ b/main/docs/ja-jp/api/authentication/refresh-token/refresh-token.mdx @@ -0,0 +1,41 @@ +--- +title: "アクセストークンをリフレッシュする" +description: "認可中に取得したリフレッシュトークンを使用して、アクセストークンをリフレッシュするためにこのエンドポイントを使用します。" +--- + +`POST /oauth/token` + +認可中に取得したリフレッシュトークンを使用して、アクセストークンをリフレッシュするためにこのエンドポイントを使用します。 +詳しく学ぶ[​](#詳しく学ぶ) +- [リフレッシュトークン](https://auth0.com/docs/ja-jp/secure/tokens/refresh-tokens) + +## Parameters + + + 使用されるフローを指定します。アクセストークンを更新するには、これを`refresh_token`に設定する必要があります。 + + + + 要求を行うアプリケーションを特定する、アプリケーションのクライアントIDです。 + + + + アプリケーションのクライアントシークレット。トークンエンドポイントの認証方法が`Post`または`Basic`に設定されている場合は、必須。 + + + + クライアントに以前発行されたリフレッシュトークン。このトークンは、新しいアクセストークンを取得するために使用されます。 + + + + 要求されたスコープ権限のスペース区切りのリスト。省略した場合は、元のスコープが使用されます。それ以外の場合は、スコープの数を減らして要求することができます。これにはURLエンコードが必要です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 正常にリフレッシュされたアクセストークンです。 | +| 400 | 不正な要求です。必要なパラメーターが不足しているか、形式に誤りがあります。 | +| 401 | 認可されていません。クライアント資格情報が無効、またはリフレッシュトークンが無効です。 | +| 403 | 禁止されています。リフレッシュトークンが無効または期限切れです。 | diff --git a/main/docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-legacy.mdx b/main/docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-legacy.mdx deleted file mode 100644 index 13fe4961c2..0000000000 --- a/main/docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-legacy.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/ro -playground: simple -deprecated: true ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-password-grant.mdx b/main/docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-password-grant.mdx new file mode 100644 index 0000000000..c17573001d --- /dev/null +++ b/main/docs/ja-jp/api/authentication/resource-owner-legacy/resource-owner-password-grant.mdx @@ -0,0 +1,65 @@ +--- +title: "リソース所有者のパスワード付与" +description: "ユーザーの資格情報が渡されると、このエンドポイントはプロバイダーでユーザーを認証し、アクセストークンとIDトークンを含むJSONオブジェクトを返します。" +--- + +`POST /oauth/ro` + +ユーザーの資格情報が渡されると、このエンドポイントはプロバイダーでユーザーを認証し、アクセストークンとIDトークンを含むJSONオブジェクトを返します。 +note +このエンドポイントはレガシー認証パイプラインの一部で、現在は[パスワード付与](#resource-owner-password)に置き換えられています。最新の認証パイプラインについては、「[OIDC準拠の認証を導入する](/docs/ja-jp/api/authentication/api-auth/intro)」を参照してください。 + +### 備考[​](#備考) + +- このエンドポイントは、データベース接続、パスワードレス接続、Active Directory/LDAP、Microsoft Entra ID、ADFSにのみ利用できます。 +- `profile`スコープは、`name`や`family_name`、`given_name`など、エンドユーザーのデフォルトのプロファイルクレームへのアクセスを要求します。 +- `email`スコープは`email`と`email_verified`クレームへのアクセスを要求します。 + +### 詳しい情報[​](#詳しい情報) + +- [信頼性の高いアプリケーションからAPIを呼び出す](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/resource-owner-password-flow) + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 正常な認証 | +| 400 | 不正なリクエスト | +| 401 | 未認可 | +| 403 | 閲覧禁止 | +| 429 | 要求が多すぎます | +| default | 予期しないエラー | diff --git a/main/docs/ja-jp/api/authentication/resource-owner-password-flow/get-token.mdx b/main/docs/ja-jp/api/authentication/resource-owner-password-flow/get-token.mdx new file mode 100644 index 0000000000..ef0a6b0648 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/resource-owner-password-flow/get-token.mdx @@ -0,0 +1,72 @@ +--- +title: "トークンの取得" +description: "note" +--- + +`POST /oauth/token` + +note +このフローは、**リダイレクトできない**信頼性の高いアプレケーションからのみ使用されるべきです。アプリからリダイレクトベースのフローを使用できる場合は、代わりに[認可コードフロー](#regular-web-app-login-flow)を使用することをお勧めします。 + +これは、APIにアクセスするために信頼性の高いアプリが使用するOAuth 2.0権限付与です。このフローでは、エンドユーザーは資格情報（ユーザー名とパスワード）を、通常はユーザーエージェント（ブラウザー）の対話型フォームを使用して提供するように要求されます。この情報はバックエンドに送信され、そこからAuth0へ送信されます。そのため、この情報を扱うのにアプリケーションが絶対的に信頼できることが不可欠です。 + +### 要求ヘッダー[​](#要求ヘッダー) +パラメーター説明`auth0-forwarded-for`文字列値としてのエンドユーザーIP。サーバー側のシナリオで総当たり攻撃防御を有効にしたい場合は、これを設定します。 +### 応答[​](#応答) + +#### 200[​](#200) + +要求が成功するとアクセストークンを返します。 +HTTP/1.1 200 OKContent-Type: application/json{ "access_token":"eyJz93a...k4laUWw", "token_type":"Bearer", "expires_in":86400} +### 備考[​](#備考) + +- アプリケーションに発行されたスコープは、要求されるスコープとは異なる場合があります。この場合、`scope`パラメーターが、応答JSONに含まれます。 +- 特定のスコープを要求しない場合、この付与でのアプリケーションへの黙示的な信頼によって、オーディエンスに定義されたすべてのスコープが返されます。 +- レルムサポートを追加するには、`grant_type`を`http://auth0.com/oauth/grant-type/password-realm`に、また`realm`をユーザーが所属するレルムに設定します。これは、Auth0の接続にマッピングされます。 +- ユーザー名とパスワードに加えて、Auth0は、本人確認として追加要素を提供するようにエンドユーザーに要求する場合があります。この要求は、多要素認証のための`mfa_token`と一緒に、`mfa_required`エラーを返す場合があります。 + +### 詳しく学ぶ[​](#詳しく学ぶ) + +- [信頼性の高いアプリケーションからAPIを呼び出す](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/resource-owner-password-flow) +- [リソース所有者のパスワード付与を実行する](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/resource-owner-password-flow/call-your-api-using-resource-owner-password-flow) +- [多要素認証とリソース所有者のパスワード](https://auth0.com/docs/ja-jp/secure/multi-factor-authentication/authenticate-using-ropg-flow-with-mfa) + +## Parameters + + + 使用するフローを示します。リソース所有者のパスワードについては、`password`を使用します。 + + + + ユーザー名やメールアドレスなどのリソース所有者の識別子です。 + + + + リソース所有者のシークレットです。 + + + + アクセスしたいターゲットAPIの一意の識別子です。 + + + + アプリケーションが求める様々なスコープの文字列値。 + + + + アプリケーションのクライアントIDです。 + + + + アプリケーションのクライアントシークレットです。 + + + + ユーザーが所属するレルムの文字列値です。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | アクセストークンを返します。 | diff --git a/main/docs/ja-jp/api/authentication/revoke-refresh-token/revoke-refresh-token.mdx b/main/docs/ja-jp/api/authentication/revoke-refresh-token/revoke-refresh-token.mdx new file mode 100644 index 0000000000..d121e79bee --- /dev/null +++ b/main/docs/ja-jp/api/authentication/revoke-refresh-token/revoke-refresh-token.mdx @@ -0,0 +1,48 @@ +--- +title: "リフレッシュトークンを取り消す" +description: "侵害された場合は、このエンドポイントを使用してリフレッシュトークンを無効にします。" +--- + +`POST /oauth/revoke` + +侵害された場合は、このエンドポイントを使用してリフレッシュトークンを無効にします。 + +このエンドポイントの動作は、[リフレッシュトークンの取り消しによって付与を削除する](https://auth0.com/docs/ja-jp/tokens/refresh-tokens/revoke-refresh-tokens#refresh-tokens-and-grants)トグルの状態によって決まります。 +このトグルを有効にすると、取り消しの要求ごとに、特定のトークンだけでなく、同じ認可付与に基づくその他すべてのトークンを無効にします。つまり、**同じユーザー、アプリケーション、オーディエンスに発行されたリフレッシュトークンがすべて取り消されます**。 +このトグルを無効にすると、リフレッシュトークンのみが取り消され、付与はそのままです。 +備考[​](#備考) +- クライアントシークレットを安全に保護できない非機密アプリケーションについては（ネイティブアプリなど）、エンドポイントがクライアントシークレットを渡さないことをサポートしていますが、アプリケーション自体のプロパティ`tokenEndpointAuthMethod`が`none`に設定される必要があります。これは、UI（[Dashboard > アプリケーション > アプリケーション設定](https://manage.auth0.com/dashboard)）または[Management API](https://auth0.com/docs/ja-jp/api/management/v2/applications/patch-applications-by-id)を使用して設定できます。 + +詳しく学ぶ[​](#詳しく学ぶ) +- [リフレッシュトークン](https://auth0.com/docs/ja-jp/secure/tokens/refresh-tokens) + +## Parameters + + + アプリケーションの`client_id`です。 + + + + アプリケーションの資格情報を含む署名済みアサーションを含んだJWTです。秘密鍵JWTがアプリケーション認証方法の場合は必須。 + + + + 値は`urn:ietf:params:oauth:client-assertion-type:jwt-bearer`です。秘密鍵JWTがアプリケーション認証方法の場合は必須。 + + + + アプリケーションの`client_secret`です。クライアントシークレットBasicまたはクライアントシークレットPostがアプリケーション認証方法の場合は必須。通常のWebアプリケーション**のみ**必須。 + + + + 取り消したいリフレッシュトークンです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | (empty-response-body) | +| 400 | 不正なリクエスト | +| 401 | 未認可 | +| default | 予期しないエラー | diff --git a/main/docs/ja-jp/api/authentication/saml/accept-request.mdx b/main/docs/ja-jp/api/authentication/saml/accept-request.mdx deleted file mode 100644 index de95d365e5..0000000000 --- a/main/docs/ja-jp/api/authentication/saml/accept-request.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /samlp/{clientId} -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/saml/accept-saml-request.mdx b/main/docs/ja-jp/api/authentication/saml/accept-saml-request.mdx new file mode 100644 index 0000000000..2c213efbb8 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/saml/accept-saml-request.mdx @@ -0,0 +1,32 @@ +--- +title: "要求を受け入れる" +description: "このエンドポイントを使ってログインを開始するSAML要求を受け入れます。" +--- + +`GET /samlp/{clientId}` + +このエンドポイントを使ってログインを開始するSAML要求を受け入れます。 + +あるいは、`connection`パラメーターを含めて特定のプロバイダーでログインすることもできます。指定されている接続がないと、[Auth0ログインページ](https://auth0.com/docs/ja-jp/authenticate/login/auth0-universal-login)が表示されます。 + +または、SP起点のログイン要求には`organization`パラメーターを含めて、組織の中でユーザーを認証することもできます。詳細については、「[Organizations](https://auth0.com/docs/ja-jp/manage-users/organizations)」を参照してください。 + +## Parameters + + + アプリケーションのクライアントIDです。 + + + + ログイン時に使う接続です。 + + + + 組織の中で認証を行う場合はOrganization IDです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | SAML要求の受け入れに成功しました。 | diff --git a/main/docs/ja-jp/api/authentication/saml/get-metadata.mdx b/main/docs/ja-jp/api/authentication/saml/get-metadata.mdx deleted file mode 100644 index 625890b5e8..0000000000 --- a/main/docs/ja-jp/api/authentication/saml/get-metadata.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas get /samlp/metadata/{clientId} -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/saml/get-saml-metadata.mdx b/main/docs/ja-jp/api/authentication/saml/get-saml-metadata.mdx new file mode 100644 index 0000000000..694606724c --- /dev/null +++ b/main/docs/ja-jp/api/authentication/saml/get-saml-metadata.mdx @@ -0,0 +1,24 @@ +--- +title: "メタデータの取得" +description: "このエンドポイントはSAML 2.0メタデータを返します。" +--- + +`GET /samlp/metadata/{clientId}` + +このエンドポイントはSAML 2.0メタデータを返します。 + +### 詳しい情報[​](#詳しい情報) + +- [SAML](https://auth0.com/docs/ja-jp/authenticate/protocols/saml/saml-configuration) + +## Parameters + + + アプリケーションのclient_idです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | SAMLメタデータの取得に成功しました。 | diff --git a/main/docs/ja-jp/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow.mdx b/main/docs/ja-jp/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow.mdx deleted file mode 100644 index df437df5ab..0000000000 --- a/main/docs/ja-jp/api/authentication/saml/id-p-initiated-single-sign-on-sso-flow.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /login/callback -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/saml/idp-initiated-sso.mdx b/main/docs/ja-jp/api/authentication/saml/idp-initiated-sso.mdx new file mode 100644 index 0000000000..6e90aad388 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/saml/idp-initiated-sso.mdx @@ -0,0 +1,27 @@ +--- +title: "IdP主導のシングルサインオン（SSO）フロー" +description: "このエンドポイントは、SAML ID プロバイダーから IdP 主導の SAMLResponse を受け入れます。ID プロバイダーに対応するコネクションはクエリ文字列で指定されます。ユーザーは SAML プロバイダーの IdP 主導のサインオンセクションで指定されたアプリケーションにリダイレクトされます。" +--- + +`POST /login/callback` + +このエンドポイントは、SAML ID プロバイダーから IdP 主導のサインオン SAMLResponse を受け入れます。ID プロバイダーに対応するコネクションはクエリ文字列で指定されます。ユーザーは SAML プロバイダーの IdP 主導のサインオンセクションで指定されたアプリケーションにリダイレクトされます。 + +### 詳しく学ぶ +- [SAML](https://auth0.com/docs/ja-jp/authenticate/protocols/saml/saml-configuration) + +## Parameters + + + アプリケーションに設定された ID プロバイダーの名前です。 + + + + IdP 主導のサインオン SAML レスポンスです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | SSO フローの成功 | diff --git a/main/docs/ja-jp/api/authentication/signup/create-a-new-user.mdx b/main/docs/ja-jp/api/authentication/signup/create-a-new-user.mdx new file mode 100644 index 0000000000..38ab0882d8 --- /dev/null +++ b/main/docs/ja-jp/api/authentication/signup/create-a-new-user.mdx @@ -0,0 +1,79 @@ +--- +title: "新規ユーザーを作成する" +description: "ユーザーの資格情報と`connection`を指定すると、このエンドポイントは新規ユーザーを作成します。" +--- + +`POST /dbconnections/signup` + +ユーザーの資格情報と`connection`を指定すると、このエンドポイントは新規ユーザーを作成します。 + +このエンドポイントはデータベース接続でのみ機能します。 + +### 備考[​](#備考) + +- サンプルのauth0.jsスクリプトは、バージョン8のライブラリーを使用しています。auth0.jsバージョン7を使用している場合には、こちらの[リファレンスガイド](https://auth0.com/docs/ja-jp/libraries/auth0js/v7)を参照してください。 + +### 詳しい情報[​](#詳しい情報) + +- [Auth0データベース接続でのパスワードの強度](https://auth0.com/docs/ja-jp/authenticate/database-connections/password-strength) +- [Auth0データベース接続でのパスワードオプション](https://auth0.com/docs/ja-jp/authenticate/database-connections/password-options) +- [データベース接続のユーザー名の追加](https://auth0.com/docs/ja-jp/authenticate/database-connections/require-username) +- [メタデータの概要](https://auth0.com/docs/ja-jp/manage-users/user-accounts/metadata) + +## Parameters + + + クライアントの`client_id`です。 + + + + ユーザーのメールアドレスです。 + + + + ユーザーの希望するパスワードです。 + + + + ユーザーの電話番号です。 + + + + クライアントに構成されているデータベースの名前です。 + + + + ユーザーのユーザー名です。接続にユーザー名が必要な場合にのみ有効です。 + + + + ユーザーの名です。 + + + + ユーザーの姓です。 + + + + ユーザーのフルネームです。 + + + + ユーザーのニックネームです。 + + + + ユーザーの写真を指すURIです。 + + + + ユーザーに紐づけられるユーザーメタデータです。設定する場合、フィールドは10個以下のプロパティを含むオブジェクトでなければなりません。プロパティ名は100文字以内で、プロパティ値は500文字以内の文字列でなければなりません。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | ユーザーが正常に作成されました | +| 400 | 不正な要求です。パラメーターが欠けているか無効です。 | +| 409 | 競合しています。ユーザーがすでに存在しています。 | diff --git a/main/docs/ja-jp/api/authentication/token-exchange-for-native-social/token-exchange-native-social.mdx b/main/docs/ja-jp/api/authentication/token-exchange-for-native-social/token-exchange-native-social.mdx new file mode 100644 index 0000000000..8a52b7f9ea --- /dev/null +++ b/main/docs/ja-jp/api/authentication/token-exchange-for-native-social/token-exchange-native-social.mdx @@ -0,0 +1,73 @@ +--- +title: "ネイティブソーシャルのトークン交換" +description: "note" +--- + +`POST /oauth/token` + +note +このフローは、ネイティブソーシャルのインタラクションで**のみ**使用することを意図しています。このフローをネイティブソーシャル設定外で使用することは、まったくお勧めしません。 + +ブラウザーベースでないソリューション（モバイルプラットフォームのSDKなど）がユーザーを認証する場合、認証は通常アーティファクトがアプリケーションコードに返されるという結果になります。このような場合、この付与タイプは、信頼できるソースからのアーティファクトを受け入れ、応答でトークンを発行することをAuth0プラットフォームに許可します。こうして、（ネイティブアプリで一般的な）ブラウザーベースでない認証メカニズムを使用するアプリは、ユーザーインタラクションを求める必要なく、Auth0トークンを取得できます。 + +このフローで返されるアーティファクト（およびそのコンテンツ）は、`subject_token_type`およびテナントの構成設定によって決まります。 +備考[​](#備考) +- アプリケーションに発行されたスコープは、要求されるスコープとは異なる場合があります。この場合、`scope`パラメーターが、応答JSONに含まれます。 +- 特定のスコープを要求しない場合、この付与でのアプリケーションへの黙示的な信頼によって、オーディエンスに定義されたすべてのスコープが返されます。ルールで返されるスコープをカスタマイズできます。詳細については、[信頼性の高いアプリケーションからAPIを呼び出す](https://auth0.com/docs/ja-jp/get-started/authentication-and-authorization-flow/resource-owner-password-flow)をご覧ください。 + +詳しく学ぶ[​](#詳しく学ぶ) +- [ネイティブiOSアプリにAppleでのサインインを追加する](https://auth0.com/docs/ja-jp/authenticate/identity-providers/social-identity-providers/apple-native) +- [iOS Swift - Appleサインインのクイックスタート](https://auth0.com/docs/ja-jp/quickstart/native/ios-swift) + +## Parameters + + + 文字列値としてのエンドユーザーIP。サーバー側のシナリオで総当たり攻撃防御を有効にしたい場合は、これを設定します。このヘッダーの使用方法とタイミングについて詳しく学ぶには、[サーバー側からリソース所有者のパスワードを使用する](/docs/ja-jp/api/authentication/api-auth/tutorials/using-resource-owner-password-from-server-side)をご覧ください。 + + + + 使用するフローを示します。ネイティブソーシャルのトークン交換については、`urn:ietf:params:oauth:grant-type:token-exchange`を使用します。 + + + + ユーザーを表す外部で発行されたIDアーティファクトです。 + + + + `subject_token`の種類を示す識別子。 + + + + アプリケーションのクライアントIDです。 + + + + アクセスしたいターゲットAPIの一意の識別子です。 + + + + アプリケーションが要求する様々なスコープの文字列値。複数のスコープは、空白文字で区切ります。 + + + + iOSにネイティブなやり取りに使用される任意の要素で、このためにプロファイルが更新されます。予期されているパラメーターの値は次の形式のJSONです：`{ name: { firstName: 'John', lastName: 'Smith' }}`。 + + + + + + + + + + + + + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | 成功レスポンス | +| default | 予期しないエラー | diff --git a/main/docs/ja-jp/api/authentication/token-exchange/token-endpoint.mdx b/main/docs/ja-jp/api/authentication/token-exchange/token-endpoint.mdx deleted file mode 100644 index 19023bfe2a..0000000000 --- a/main/docs/ja-jp/api/authentication/token-exchange/token-endpoint.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/token -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/token-management/revoke-refresh-token.mdx b/main/docs/ja-jp/api/authentication/token-management/revoke-refresh-token.mdx deleted file mode 100644 index c620ed0473..0000000000 --- a/main/docs/ja-jp/api/authentication/token-management/revoke-refresh-token.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /oauth/revoke -playground: simple -deprecated: false ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/user-profile-legacy/get-token-info-legacy.mdx b/main/docs/ja-jp/api/authentication/user-profile-legacy/get-token-info-legacy.mdx deleted file mode 100644 index 85104e425f..0000000000 --- a/main/docs/ja-jp/api/authentication/user-profile-legacy/get-token-info-legacy.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -openapi: authentication-api-oas post /tokeninfo -playground: simple -deprecated: true ---- - -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; - - - \ No newline at end of file diff --git a/main/docs/ja-jp/api/authentication/user-profile-legacy/get-token-info.mdx b/main/docs/ja-jp/api/authentication/user-profile-legacy/get-token-info.mdx new file mode 100644 index 0000000000..6877983f5a --- /dev/null +++ b/main/docs/ja-jp/api/authentication/user-profile-legacy/get-token-info.mdx @@ -0,0 +1,30 @@ +--- +title: "トークン情報取得" +description: "::note" +--- + +`POST /tokeninfo` + +::note +このエンドポイントはレガシー認証パイプラインの一部で、OIDCに準拠した最新のパイプラインを使用しているユーザーには無効化される予定です。この代わりに、[/userinfoエンドポイント](#get-user-info)の使用をお勧めします。最新の認証パイプラインについては、「[OIDC準拠の認証を導入する](/docs/ja-jp/api/authentication/api-auth/intro)」を参照してください。 +::: + +このエンドポイントはJSON Web Token（JWT）（署名と有効期限）を検証し、トークンに含まれるユーザーIDの`sub`プロパティに関連付けられているユーザー情報を返します。 + +### 備考[​](#備考) + +このエンドポイントは3つのHTTP応答ヘッダーを返して、レート制限に関するデータを提供します。 +- `X-RateLimit-Limit`：1分間に許可される要求の数です。 +- `X-RateLimit-Remaining`：現在のレート制限枠に残っている要求の数です。新しい要求のたびに、この数が1つ減少します。1分が経過するごとに、要求数が戻され、この数が1ずつ加算されます。 +- `X-RateLimit-Reset`：レート制限（`X-RateLimit-Limit`）がリセットされるまでの残り時間です。この値は[UTCエポック秒](https://en.wikipedia.org/wiki/Unix_time)単位です。 + +### 詳しい情報[​](#詳しい情報) + +- [ユーザープロファイルの構造](https://auth0.com/docs/ja-jp/manage-users/user-accounts/user-profiles/user-profile-structure) +- [Auth0 APIのレート制限ポリシー](https://auth0.com/docs/ja-jp/troubleshoot/customer-support/operational-policies/rate-limit-policy) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | ユーザー情報を含む正常な応答 | diff --git a/main/docs/ja-jp/api/authentication/user-profile/get-user-info.mdx b/main/docs/ja-jp/api/authentication/user-profile/get-user-info.mdx index 43e7adcc9c..53bb661cd6 100644 --- a/main/docs/ja-jp/api/authentication/user-profile/get-user-info.mdx +++ b/main/docs/ja-jp/api/authentication/user-profile/get-user-info.mdx @@ -1,11 +1,36 @@ --- -openapi: authentication-api-oas get /userinfo -playground: simple -deprecated: false +title: "ユーザー情報を取得する" +description: "..." --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`GET /userinfo` - - \ No newline at end of file +ログイン時に取得したAuth0アクセストークンが指定されると、このエンドポイントはユーザーのプロファイルを返します。このエンドポイントは、`openid`がアクセストークンのスコープとして付与された場合にのみ機能します。応答に含まれるユーザープロファイル情報は要求されたスコープに応じて異なります。たとえば、スコープが`openid`だけの場合は、スコープが`openid profile email`の場合よりも返される情報が少なくなります。 + +### 備考[​](#備考) + +- サンプルのauth0.jsスクリプトは、バージョン8のライブラリーを使用しています。auth0.jsバージョン7を使用している場合には、こちらの[リファレンスガイド](https://auth0.com/docs/ja-jp/libraries/auth0js/v7)を参照してください。 +- auth0.js `parseHash`メソッドでは、トークンが`HS256`ではなく、`RS256`で署名される必要があります。 +- このエンドポイントから`user_metadata`または他のカスタム情報を返すには、IDトークンに[アクション](https://auth0.com/docs/ja-jp/secure/tokens/json-web-tokens/create-custom-claims#create-custom-claims)でカスタムクレームを追加します。詳細については、[ユーザープロファイルのクレームとスコープ](/docs/ja-jp/api/authentication/api-auth/tutorials/adoption/scope-custom-claims)を参照してください。 +このエンドポイントは3つのHTTP応答ヘッダーを返して、レート制限に関するデータを提供します。 +- `X-RateLimit-Limit`：1分間に許可される要求の数です。 +- `X-RateLimit-Remaining`：現在のレート制限枠に残っている要求の数です。新しい要求のたびに、この数が1つ減少します。1分が経過するごとに、要求数が戻され、この数が1ずつ加算されます。 +- `X-RateLimit-Reset`：レート制限（`X-RateLimit-Limit`）がリセットされるまでの残り時間です。この値は[UTCエポック秒](https://en.wikipedia.org/wiki/Unix_time)単位です。 + +- `Email`クレームはログイン時のメールのスナップショットを返します。 +- 標準クレーム（`email`以外）は（値が外部IdPから来る場合を除き）最新の値を返します。 +- カスタムクレームは常にクレームの最新の値を返します。 +- `email`またはカスタムクレームの最新の値にアクセスするには、新しいトークンを取得する必要があります。サイレント認証を使用してログインできます（[`authorize`エンドポイント](https://auth0.com/docs/ja-jp/api/authentication#authorization-code-grant)への呼び出しの`prompt`パラメーターが`none`の場合）。 +- 外部IdPを使用して変更された（たとえば、ユーザーがFacebookでメールアドレスを変更するなど）標準クレームの最新の値にアクセスするには、新しいトークンを取得する必要があります。外部IdPを使用して再びログインしますが、サイレント認証は*使用しません*。 + +### 詳しい情報[​](#詳しい情報) + +- [Auth0.js v8のリファレンス：authResultを抽出してユーザー情報を取得する](https://auth0.com/docs/ja-jp/libraries/auth0js#extract-the-authresult-and-get-user-info) +- [Auth0 APIのレート制限ポリシー](https://auth0.com/docs/ja-jp/troubleshoot/customer-support/operational-policies/rate-limit-policy) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | ユーザープロファイルが正常に取得されました。 | +| 401 | 認可されていません。アクセストークンが無効か欠けています。 | diff --git a/main/docs/ja-jp/api/authentication/ws-federation/accept-ws-federation-request.mdx b/main/docs/ja-jp/api/authentication/ws-federation/accept-ws-federation-request.mdx index 2fa57f881b..502c25bcbe 100644 --- a/main/docs/ja-jp/api/authentication/ws-federation/accept-ws-federation-request.mdx +++ b/main/docs/ja-jp/api/authentication/ws-federation/accept-ws-federation-request.mdx @@ -1,11 +1,48 @@ --- -openapi: authentication-api-oas get /wsfed/{clientId} -playground: simple -deprecated: false +title: "WS-Federation要求の受け入れ" +description: "このエンドポイントはWS-Federation要求を受け入れてログインを開始します。" --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`GET /wsfed/{clientId}` - - \ No newline at end of file +このエンドポイントはWS-Federation要求を受け入れてログインを開始します。 + +### 備考[​](#備考) + +`wtrealm`パラメーターの形式は以下のいずれかでなければなりません。 +- `urn:clientID`（たとえば、urn:${account.clientId}） +- このパラメーターがurnで始まらない場合、`client.clientAliases`配列を使って検索します。これを設定できるのは[/api/v2/clients]（[https://auth0.com/docs/ja-jp/api/management/v2/clients/get-clients）Management](https://auth0.com/docs/ja-jp/api/management/v2/clients/get-clients%EF%BC%89Management) APIのみです。 + +- `whr`パラメーターは、以下のように接続にマッピングされます：`urn:CONNECTION_NAME`. たとえば、`urn:google-oauth2`はGoogleでのログインを意味します。`whr`パラメーターが含まれていない場合、ユーザーには[Auth0ログインページ](https://auth0.com/docs/login_page)が表示されます。 + +### 詳しい情報[​](#詳しい情報) + +- [WS-Federation](https://auth0.com/docs/ja-jp/authenticate/protocols/ws-fed-protocol) + +## Parameters + + + アプリケーションの`client-id`です。 + + + + `client-id`の代わりに利用できます。 + + + + 接続名（ログインページをスキップするために使用）です。 + + + + アプリケーションの状態です。 + + + + Callback URLです。 + + +## Response + +| Status | Description | +|--------|-------------| +| 200 | WS-Federation要求が成功した場合の応答です。 | diff --git a/main/docs/ja-jp/api/authentication/ws-federation/get-ws-federation-metadata.mdx b/main/docs/ja-jp/api/authentication/ws-federation/get-ws-federation-metadata.mdx index e52084a4e7..d2851dc242 100644 --- a/main/docs/ja-jp/api/authentication/ws-federation/get-ws-federation-metadata.mdx +++ b/main/docs/ja-jp/api/authentication/ws-federation/get-ws-federation-metadata.mdx @@ -1,11 +1,18 @@ --- -openapi: authentication-api-oas get /wsfed/FederationMetadata/2007-06/FederationMetadata.xml -playground: simple -deprecated: false +title: "WS-Federationメタデータを取得" +description: "このエンドポイントはWS-Federationのメタデータを返します。" --- -import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; -import { Scopes } from "/snippets/ApiScopes.jsx"; +`GET /wsfed/FederationMetadata/2007-06/FederationMetadata.xml` - - \ No newline at end of file +このエンドポイントはWS-Federationのメタデータを返します。 + +### 詳しい情報[​](#詳しい情報) + +- [WS-Federation](https://auth0.com/docs/ja-jp/authenticate/protocols/ws-fed-protocol) + +## Response + +| Status | Description | +|--------|-------------| +| 200 | WS-Federationメタデータを含む正常な応答です。 |