Référence Python Permission SDK

Cette rubrique fournit des informations de référence pour les fonctions prises en charge par le module snowflake.permissions des Python Permission SDK. Pour plus d’informations sur l’utilisation des Python Permission SDK pour demander des privilèges dans le compte de consommateur, consultez Création d’une interface utilisateur pour demander des privilèges et des références.

get_application_specifications()

Renvoie toutes les spécifications d’application définies pour l’application.

Signature:
get_application_specifications()
Copy
Arguments:

Cette fonction ne prend aucun argument.

Renvoie:

Un tableau de dictionnaires, où chaque dictionnaire contient les paires clé/valeur suivantes :

{
  "name": "<value>",
  "requested_on": "<value>",
  "type": "<value>",
  "sequence_number": "<value>",
  "status": "<value>",
  "status_upgraded_on": "<value>",
  "label": "<value>",
  "description": "<value>",
  "definition": "<value>",
}
Copy

Où :

  • name : Nom de la spécification d’application.

  • requested_on : Horodatage de la demande de spécification d’application.

  • type : Type de spécification d’application. Les valeurs prises en charge sont EXTERNAL ACCESS et SECURITY INTEGRATION.

  • sequence_number : ID pour une version d’une spécification d’application. Cette valeur est incrémentée chaque fois qu’un fournisseur modifie la définition de la spécification d’application.

  • status : Spécifie l’état actuel de la spécification d’application. Les valeurs possibles sont les suivantes :

    • APPROVED : Le consommateur a approuvé la spécification d’application.

    • DECLINED : La spécification d’application est en attente d’approbation ou de refus par le consommateur.

    • DECLINED : Le consommateur a refusé la spécification d’application.

    • PENDING : La spécification d’application est en attente d’approbation ou de refus par le consommateur.

  • status_updated_on : Horodatage du dernier changement d’état.

  • label : Nom de la spécification d’application affichée au consommateur dans Snowsight.

  • description : Description de la spécification d’application affichée au consommateur dans Snowsight.

  • definition : Valeurs faisant partie de la définition de la spécification d’application. Les valeurs de cette colonne dépendent du type de spécification d’application.

get_detailed_reference_associations()

Fournit des informations détaillées sur une référence à un objet dans le compte de consommateur.

Signature:
get_detailed_reference_associations(reference_name: str) -> List[dict]
Copy
Arguments:

Valeur de chaîne contenant le nom d’une référence.

Renvoie:

Renvoie un objet JSON représentant un tableau de dictionnaires. Chaque dictionnaire contient les paires clé/valeur suivantes :

{
  "alias": "<value>",
  "database": "<value>",
  "schema": "<value>",
  "name": "<value>"
}
Copy

Où :

  • alias : Alias généré par le système pour la référence.

  • database : Nom de la base de données parente de l’objet du consommateur, si l’objet se trouve dans une base de données. Sinon, null.

  • schema : Schéma parent de l’objet du consommateur, si l’objet se trouve dans un schéma. Sinon, null.

  • name : Nom de l’objet du consommateur.

get_held_account_privileges()

Renvoie les privilèges qui ont été accordés à l’application.

Signature:
get_held_account_privileges(privilege_names: [str]) -> [str]
Copy
Arguments:

Tableau de valeurs de chaîne contenant les noms des privilèges à vérifier.

Renvoie:

Renvoie un tableau contenant les privilèges qui ont été accordés à l’application sur la base du tableau de privilèges transmis à la fonction.

Renvoie un tableau contenant les privilèges qui ont été accordés à l”Snowflake Native App sur la base du tableau de privilèges transmis à la fonction.

get_missing_account_privileges()

Renvoie les privilèges qui n’ont pas été accordés à l’application.

Signature:
get_missing_account_privileges(privilege_names: [str]) -> [str]
Copy
Arguments:

Tableau de valeurs de chaîne contenant les noms des privilèges à vérifier.

Renvoie:

Renvoie un tableau de chaînes contenant les privilèges qui n’ont pas été accordés à l’application sur la base du tableau de privilèges transmis à la fonction.

get_reference_associations()

Détermine les objets du compte de consommateur qui sont associés à une référence.

Pour obtenir des informations plus détaillées sur les références aux objets du compte de consommateur, consultez get_detailed_reference_associations().

Signature:
get_reference_associations(reference_name: str) -> [str]
Copy
Arguments:

Valeur de chaîne contenant le nom d’une référence.

Renvoie:

Renvoie un tableau contenant les alias générés par Snowflake pour les objets du compte de consommateur liés à la référence.

is_application_all_mandatory _telemetry_event_definitions_enabled()

Vérifie si toutes les définitions d’événements télémétriques obligatoires sont activées pour l’application.

Pour plus d’informations sur le partage des événements télémétriques, consultez Vérifier les définitions d’événements à l’aide du SDK Permissions.

Signature:
is_application_all_mandatory_telemetry_event_definitions_enabled() -> bool
Copy
Arguments:

Cette fonction ne prend aucun argument.

Renvoie:

Renvoie TRUE si toutes les définitions d’événements télémétriques obligatoires sont activées pour l’application. Renvoie FALSE, sinon.

is_application_authorized_for_telemetry_event_sharing()

Vérifie si l’application actuelle est autorisée pour le partage des événements télémétriques.

Pour plus d’informations sur le partage des événements télémétriques, consultez Vérifier les définitions d’événements à l’aide du SDK Permissions.

Signature:
is_application_authorized_for_telemetry_event_sharing() -> bool
Copy
Arguments:

Cette fonction ne prend aucun argument.

Renvoie:

Renvoie TRUE si l’application est autorisée pour le partage des événements télémétriques. Renvoie FALSE, sinon.

is_application_local_to_package()

Vérifie si l’application est installée sur le même compte que le paquet d’application.

Signature:
is_application_local_to_package() -> bool
Copy
Arguments:

Cette fonction ne prend aucun argument.

Renvoie:

Renvoie TRUE si l’application est installée sur le même compte que le paquet d’application. Renvoie FALSE, sinon.

is_event_sharing_enabled()

Vérifie si le partage des événements est activé pour l’application.

Signature:
is_event_sharing_enabled() -> bool
Copy
Arguments:

Cette fonction ne prend aucun argument.

Renvoie:

Renvoie TRUE si la propriété SHARE_EVENTS_WITH_PROVIDER est vraie et si le compte du consommateur a une table d’événements active configurée. Renvoie FALSE, sinon.

is_external_data_enabled()

Vérifie si l’application actuelle est autorisée à utiliser des tables externes et Iceberg.

Signature:
is_external_data_enabled() -> bool
Copy
Arguments:

Cette fonction ne prend aucun argument.

Renvoie:

Renvoie TRUE si l’application est autorisée à utiliser des tables externes et Iceberg. Renvoie FALSE, sinon.

request_application_specification_review()

Ouvre une boîte de dialogue dans une application Streamlit qui permet au consommateur d’examiner la spécification d’application, puis de l’approuver, de la refuser ou de n’effectuer aucune action. Un consommateur ne peut refuser une spécification d’application que si elle est facultative.

Signature:
request_application_specification_review(spec_names: [str] = None)
Copy
Arguments:

Tableau facultatif de valeurs de chaîne contenant les noms des spécifications d’application à examiner. Si ce paramètre n’est pas spécifié, la boîte de dialogue affichera toutes les spécifications d’application définies pour l’application.

Renvoie:

Cette méthode ne renvoie aucune valeur.

request_aws_api_integration()

Demande au consommateur une intégration d’API pour Amazon API Gateway.

Vous devez définir l’intégration d’API dans le fichier manifeste. Consultez CREATE API INTEGRATION pour obtenir des informations sur les autres paramètres.

Signature:
request_aws_api_integration(id: str, allowed_prefixes: [str], gateway: AwsGateway, aws_role_arn: str, api_key: str = None, name: str = None, comment: str = None)
Copy
Arguments:

  • id : Nom de l’intégration d’API définie dans le fichier manifeste.

  • allowed_prefixes : Tableau de valeurs de chaîne contenant les préfixes autorisés pour l’intégration d’API.

  • gateway : Type de Passerelle d’API à utiliser. La valeur de ce paramètre doit être l’une des suivantes :

    • permissions.AwsGateway.API_GATEWAY

    • permissions.AwsGateway.PRIVATE_API_GATEWAY

    • permissions.AwsGateway.GOV_API_GATEWAY

    • permissions.AwsGateway.GOV_PRIVATE_API_GATEWAY

  • aws_role_arn : Nom de la ressource Amazon (ARN) du rôle IAM que la Passerelle d’API utilise pour accéder au compte de consommateur.

  • api_key : Clé d’API facultative pour la Passerelle d’API.

  • name : Nom facultatif pour l’intégration d’API.

  • comment : Commentaire facultatif pour l’intégration d’API.

Consultez CREATE API INTEGRATION pour obtenir des informations sur les autres paramètres possibles.

Renvoie:

Valeur de chaîne contenant le nom d’une référence.

request_azure_api_integration()

Demande au consommateur une intégration d’API pour la gestion des API Azure.

Vous devez définir l’intégration d’API dans le fichier manifeste. Consultez CREATE API INTEGRATION pour obtenir des informations sur les autres paramètres.

Signature:
request_azure_api_integration(id: str, allowed_prefixes: [str], tenant_id: str, application_id: str, api_key: str = None, name: str = None, comment: str = None)
Copy
Arguments:

  • id : Nom de l’intégration d’API définie dans le fichier manifeste.

  • allowed_prefixes : Tableau de valeurs de chaîne contenant les préfixes autorisés pour l’intégration d’API.

  • tenant_id : ID de locataire pour la gestion de l’API Azure.

  • application_id : ID de l’application pour la gestion de l’API Azure.

  • api_key : Clé d’API facultative pour la gestion de l’API Azure.

  • name : Nom facultatif pour l’intégration d’API.

  • comment : Commentaire facultatif pour l’intégration d’API.

Renvoie:

Cette méthode ne renvoie aucune valeur.

request_event_sharing()

Ouvre une boîte de dialogue dans une application Streamlit qui permet au consommateur de partager des événements avec l’application.

Signature:
request_event_sharing()
Copy
Arguments:

Cette fonction ne prend aucun argument.

Renvoie:

Cette méthode ne renvoie aucune valeur.

request_external_data()

Demande le consentement du consommateur pour utiliser des tables externes et Iceberg.

Signature:
request_external_data()
Copy
Arguments:

Cette fonction ne prend aucun argument.

Renvoie:

Cette méthode ne renvoie aucune valeur.

request_google_api_integration()

Demande au consommateur une intégration d’API pour Google Cloud API Gateway.

Vous devez définir l’intégration d’API dans le fichier manifeste. Consultez CREATE API INTEGRATION pour obtenir des informations sur les autres paramètres.

Signature:
request_google_api_integration(id: str, allowed_prefixes: [str], audience: str, name: str = None, comment: str = None, api_key: str = None
Copy
Arguments:

  • id : Nom de l’intégration d’API définie dans le fichier manifeste.

  • allowed_prefixes : Tableau de valeurs de chaîne contenant les préfixes autorisés pour l’intégration d’API.

  • audience : Audience pour la Passerelle d’API Google Cloud.

  • name : Nom facultatif pour l’intégration d’API.

  • comment : Commentaire facultatif pour l’intégration d’API.

  • api_key : Clé d’API facultative pour la Passerelle d¹API Google Cloud.

Renvoie:

Cette méthode ne renvoie aucune valeur.

request_account_privileges()

Demande des privilèges du consommateur spécifié par un tableau de chaînes transmis à la fonction qui contient les privilèges. Les privilèges spécifiés doivent être répertoriés dans le fichier manifeste.

Signature:
request_account_privileges(privileges: [str])
Copy
Arguments:

Tableau de chaînes contenant une liste des privilèges demandés par l’application.

Renvoie:

Cette méthode ne renvoie aucune valeur.

request_reference()

Demande une référence au consommateur spécifié par la chaîne transmise à la fonction. La référence transmise à la fonction doit être définie dans le fichier manifeste.

Consultez Types d’objets et privilèges qu’une référence peut contenir pour obtenir une liste des objets qui peuvent être inclus dans une référence et les privilèges qui leur sont associés.

Signature:
request_reference(reference: str)
Copy
Arguments:

Valeur de chaîne contenant le nom d’une référence à demander.

Renvoie:

Cette méthode ne renvoie aucune valeur.

Langage: Français