Aller au contenu principal
Dernière mise à jour le

Activer ou désactiver les applications OAuth des Partenaires

Cet article décrit comment activer et désactiver les applications OAuth partenaires pour votre compte Databricks.

Les applications OAuth dbt Core, Power BI, Tableau Desktop et Tableau Cloud sont activées par default pour votre compte.

remarque

Le traitement des mises à jour des applications OAuth peut prendre 30 minutes.

Activer les applications OAuth personnalisées à l'aide de l'interface utilisateur de Databricks​

Vous pouvez utiliser l'interface utilisateur de Databricks pour activer des applications OAuth personnalisées supplémentaires.

Pour activer une application OAuth personnalisée dans l'interface utilisateur, procédez comme suit:

  1. Connectez-vous à la Console du compte et cliquez sur l'icône Paramètres dans la barre latérale.

  2. Sous l'onglet **App connections tab**, cliquez sur **Ajouter une connexion**.

  3. Saisissez les détails suivants :

    1. Un nom pour votre connexion.

    2. Les URL de redirection pour votre connexion OAuth.

    3. Pour les étendues d'accès , les étendues déterminent aux quelles APIs l'application doit avoir accès.

      • Pour les applications BI, l’étendue SQL est requise pour permettre à l’application connectée d’accéder aux API Databricks SQL.
      • Pour les applications qui ont besoin d'accéder aux APIs Databricks à des fins autres que l'interrogation, le champ d'application **Toutes les APIs** est requis.

      Les périmètres suivants sont automatiquement autorisés :

      • openid, email, profile: Requis pour générer le jeton d'ID.
      • offline_accessRequis pour générer des jetons refresh.

      Si vous ne souhaitez pas autoriser ces périmètres pour l'application, vous pouvez gérer des périmètres à grain fin en utilisant le POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations API pour créer votre application personnalisée.

    4. La durée de vie du jeton d'accès (TTL) en minutes. Default : 60.

    5. La durée de vie (TTL) du jeton refresh, en minutes. Default : 10080.

    6. Faut-il générer un secret client ? Ceci est requis pour les clients non publics (confidentiels).

      La boîte de dialogue Connexion créée affiche l’ID client et le secret client de votre connexion, le cas échéant.

  4. Si vous avez sélectionné Générer un secret client , copiez et stockez en toute sécurité le secret client. Vous ne pourrez pas récupérer le secret du client ultérieurement.

Vous pouvez modifier l'URL de redirection, le TTL du jeton et le TTL du jeton refresh pour les applications OAuth personnalisées existantes dans l'interface utilisateur en cliquant sur le nom de l'application sur la page Paramètres > Connexions d'applications de la console de compte. Vous pouvez également afficher vos applications OAuth publiées existantes (dbt Core, Power BI, Tableau) dans l'interface utilisateur.

Vous pouvez désactiver les applications OAuth publiées et personnalisées dans l'interface utilisateur en cliquant sur le nom de l'application ou sur le menu kebab à côté du nom de l'application, puis en cliquant sur Supprimer .

remarque

Désactiver une application rompt la connexion de l'application, alors faites preuve de prudence lors de la désactivation des applications OAuth. Si vous désactivez une application OAuth publiée dans l'interface utilisateur, elle ne peut pas être réactivée dans l'interface utilisateur. Pour réactiver une application publiée, consultez Réactiver l'application OAuth dbt Core, Power BI, Tableau Desktop ou Tableau Cloud à l'aide de la CLI.

remarque

Vous ne pouvez configurer des fonctionnalités de sécurité OAuth supplémentaires (telles que les jetons de refresh à usage unique) que via l'API. Voir Jetons refresh à usage unique pour activer les jetons refresh à usage unique pour une sécurité renforcée.

Activer ou désactiver les applications à l'aide de la CLI Databricks​

Cette section décrit comment utiliser le Databricks CLI pour désactiver les applications Partenaires OAuth qui sont activées par default pour votre compte, et comment les réactiver après qu'elles aient été désactivées. Il décrit également comment activer et désactiver Tableau Server, qui n’est pas activé par default.

Avant de commencer​

Avant d'activer ou de désactiver les intégrations d'applications OAuth des Partenaires à l'aide de la CLI Databricks, veuillez faire ce qui suit :

  • Installez le CLI Databricks et configurez l’authentification entre le CLI Databricks et votre compte Databricks.

  • Pour désactiver ou modifier une application OAuth existante, localisez l’ID d’intégration.

    • Pour dbt Core, Power BI, Tableau Desktop ou Tableau Cloud, exécutez la commande suivante :

      databricks account published-app-integration list

    • Pour les applications personnalisées, comme Tableau Server, exécutez la commande suivante :

      databricks account custom-app-integration list

    L’ID d’intégration unique pour chaque application OAuth est renvoyé.

Désactivez l'application OAuth dbt Core, Power BI, Tableau Desktop ou Tableau Cloud à l'aide de la CLI​

Pour désactiver une application OAuth dbt Core, Power BI, Tableau Desktop ou Tableau Cloud, exécutez la commande suivante, en remplaçant <integration-id> par l'ID d'intégration de l'application OAuth que vous souhaitez supprimer :

databricks account published-app-integration delete <integration-id>

Réactiver l'application OAuth dbt Core, Power BI, Tableau Desktop ou Tableau Cloud à l'aide de l'interface CLI​

dbt Core, Power BI, Tableau Desktop et Tableau Cloud sont activés par default en tant qu'applications OAuth dans votre compte. Pour réactiver l'une de ces applications OAuth après qu'elle a été désactivée, exécutez la commande suivante, en remplaçant <application-id> par databricks-dbt-adapter, power-bi, tableau-desktop ou 7de584d0-b7ad-4850-b915-be7de7d58711 (Tableau Cloud) :

databricks account published-app-integration create <application-id>

L'ID d'intégration unique pour l'application OAuth est renvoyé.

Activer les applications OAuth personnalisées à l'aide de l'interface CLI​

Les applications OAuth dbt Core, Power BI, Tableau Desktop et Tableau Cloud sont activées par default pour votre compte. Vous pouvez utiliser la CLI Databricks pour activer des applications OAuth personnalisées supplémentaires.

Pour connaître les étapes d’activation d’une application OAuth personnalisée de Tableau Server, consultez Configurer la connexion Databricks à partir de Tableau Server. Pour connaître les étapes génériques d’activation de toute application OAuth personnalisée à l’aide de la CLI, consultez ce qui suit :

  1. Exécutez la commande custom-app-integration create. L'exemple suivant crée une application non publique (confidentielle) :

    databricks account custom-app-integration create --confidential --json '{"name":"<name>", "redirect_urls":["<redirect-url>"], "scopes":[<scopes>]}'
    • Remplacez <name> par un nom pour votre application OAuth personnalisée.
    • Remplacez <redirect-url> par les URL de redirection de votre application.
    • Remplacez <scopes> par la liste des portées que vous souhaitez autoriser pour l'application.
      • Pour les applications BI, l'étendue sql est requise pour permettre à l'application connectée d'accéder aux APIs Databricks SQL.
      • Pour les applications qui doivent accéder aux APIs Databricks à d'autres fins que SQL, la portée all-apis est requise.
      • Les étendues openid, email et profile sont nécessaires pour générer le jeton d'ID.
      • La portée offline_access est requise pour générer des jetons refresh.

    Pour plus d'informations sur les valeurs prises en charge, consultez POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations dans la référence de l'API REST.

    Un ID client est généré. Pour les applications non publiques (confidentielles), un secret client est également généré. Le résultat suivant est retourné :

    {"integration_id":"<integration-id>","client_id":"<client-id>","client_secret":"<client-secret>"}
remarque

L'activation d'une application OAuth peut prendre 30 minutes pour être traitée.

  1. Stockez en toute sécurité le secret client, le cas échéant.
important

Vous ne pouvez pas récupérer le secret du client ultérieurement.

Désactiver les applications OAuth personnalisées à l'aide de la CLI​

Pour désactiver une application OAuth personnalisée existante, comme Tableau Server, exécutez la commande suivante, en remplaçant <integration-id> par l’ID d’intégration de l’application OAuth que vous souhaitez désactiver :

databricks account custom-app-integration delete <integration-id>
Sur cette page