ConsentementMembres

ConsentementMembres

Example

export interface ConsentMembers extends BaseMembers {
  /**
   * Fournit l'accès aux propriétés et données propres à l'écran de consentement,
   * notamment la liste des `scopes` demandés et l'indicateur `hideScopes`.
   * @type {ScreenMembersOnConsent}
   */
  screen: ScreenMembersOnConsent;

  /**
   * Soumet la décision de l'utilisateur d'accepter (accorder) les permissions demandées.
   * Cette action envoie une requête à l'endpoint `/u/consent` avec `action: "accept"`.
   *
   * @param {CustomOptions} [payload] - Facultatif. Un objet pour toute paire clé-valeur personnalisée
   *                                    à envoyer avec la requête. Ces paramètres seront
   *                                    inclus dans les données du formulaire soumis au serveur.
   * @returns {Promise<void>} Une promesse qui se résout lorsque l'action d'acceptation est soumise avec succès.
   *                          En cas de réussite, Auth0 redirige généralement l'utilisateur vers l'application
   *                          ou vers l'étape suivante du flux d'authentification.
   * @throws {Error} Génère une Error si la soumission du formulaire échoue (p. ex., problème réseau, état invalide).
   *                 Les erreurs côté serveur (comme « invalid_request ») seront reflétées dans `this.transaction.errors`
   *                 après l'opération, plutôt que d'être levées comme des erreurs JavaScript.
   *
   * @example
   * ```typescript
   * // En supposant que 'consentManager' est une instance de la classe SDK de l'écran de consentement
   * try {
   *   await consentManager.accept();
   *   // En cas de réussite, la page sera généralement redirigée.
   * } catch (error) {
   *   // Gérer les erreurs inattendues lors de la soumission elle-même.
   *   console.error("Failed to submit consent acceptance:", error);
   * }
   * // Après l'await, vérifier consentManager.transaction.errors pour les problèmes de validation côté serveur.
   * ```
   */
  accept(payload?: CustomOptions): Promise<void>;

  /**
   * Soumet la décision de l'utilisateur de rejeter les permissions demandées.
   * Cette action envoie une requête à l'endpoint `/u/consent` avec `action: "deny"`.
   *
   * @param {CustomOptions} [payload] - Facultatif. Un objet pour toute paire clé-valeur personnalisée
   *                                    à envoyer avec la requête. Ces paramètres seront
   *                                    inclus dans les données du formulaire soumis au serveur.
   * @returns {Promise<void>} Une promesse qui se résout lorsque l'action de rejet est soumise avec succès.
   *                          En cas de réussite, Auth0 redirige généralement l'utilisateur, en affichant
   *                          potentiellement un message d'accès refusé ou en retournant une erreur à l'application.
   * @throws {Error} Génère une Error si la soumission du formulaire échoue (p. ex., problème réseau, état invalide).
   *                 Les erreurs côté serveur sont reflétées dans `this.transaction.errors`.
   *
   * @example
   * ```typescript
   * // En supposant que 'consentManager' est une instance de la classe SDK de l'écran de consentement
   * try {
   *   await consentManager.deny({ reason: "user_declined" }); // Exemple d'option personnalisée
   *   // En cas de réussite, la page sera généralement redirigée.
   * } catch (error) {
   *   console.error("Failed to submit consent denial:", error);
   * }
   * // Après l'await, vérifier consentManager.transaction.errors pour les problèmes de validation côté serveur.
   * ```
   */
  deny(payload?: CustomOptions): Promise<void>;
}

Propriétés

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnConsent

Donne accès aux propriétés et données propres à l’écran de consentement, y compris la liste des scopes demandées et l’indicateur hideScopes.

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

Méthodes

accept · Promise<void>

Soumet la décision de l’utilisateur d’accepter (d’accorder) les permissions demandées. Cette action envoie une requête au point de terminaison /u/consent avec action: "accept".

Une promesse qui est résolue lorsque l’action d’acceptation est soumise avec succès. En cas de réussite, Auth0 redirige généralement l’utilisateur vers l’application ou vers l’étape suivante du flux d’authentification.

Throws

Lève une erreur si la soumission du formulaire échoue (p. ex., problème réseau, state invalide). Les erreurs côté serveur (comme “invalid_request”) seront reflétées dans this.transaction.errors après l’opération, plutôt que d’être levées comme des erreurs JavaScript.

Example

// En supposant que 'consentManager' est une instance de la classe SDK de l’écran Consent
try {
  await consentManager.accept();
  // En cas de réussite, il y aura généralement une redirection.
} catch (error) {
  // Gère les erreurs inattendues pendant la soumission elle-même.
  console.error("Failed to submit consent acceptance:", error);
}
// Après le await, vérifiez consentManager.transaction.errors pour les problèmes de validation côté serveur.

Show Paramètres

payload? · CustomOptions

Facultatif. Objet contenant toute paire clé-valeur personnalisée à envoyer avec la requête. Ces paramètres seront inclus dans les données du formulaire soumises au serveur.

deny · Promise<void>

Soumet la décision de l’utilisateur de rejeter (de rejeter) les permissions demandées. Cette action envoie une requête au point de terminaison /u/consent avec action: "deny".

Une promesse qui est résolue lorsque l’action de rejet est soumise avec succès. En cas de réussite, Auth0 redirige généralement l’utilisateur, et peut afficher un message d’accès refusé ou renvoyer une erreur à l’application.

Throws

Lève une erreur si la soumission du formulaire échoue (p. ex., problème réseau, state invalide). Les erreurs côté serveur sont reflétées dans this.transaction.errors.

Example

// En supposant que 'consentManager' est une instance de la classe SDK de l’écran Consent
try {
  await consentManager.deny({ reason: "user_declined" }); // Exemple d’option personnalisée
  // En cas de réussite, il y aura généralement une redirection.
} catch (error) {
  console.error("Failed to submit consent denial:", error);
}
// Après le await, vérifiez consentManager.transaction.errors pour les problèmes de validation côté serveur.

Show Paramètres

payload? · CustomOptions

Facultatif. Objet contenant toute paire clé-valeur personnalisée à envoyer avec la requête. Ces paramètres seront inclus dans les données du formulaire soumises au serveur.