Python Permission SDK-Referenz

Unter diesem Thema finden Sie Referenzinformationen für die vom snowflake.permissions-Modul der Python Permission SDK unterstützten Funktionen. Weitere Informationen zur Verwendung der Python Permission SDK zum Anfordern von Berechtigungen im Verbraucherkonto, siehe Benutzeroberfläche zum Anfordern von Berechtigungen und Referenzen erstellen.

get_application_specifications()

Gibt alle für die App definierten App-Spezifikationen zurück.

Signatur:
get_application_specifications()
Copy
Argumente:

Diese Funktion nimmt keine Argumente an.

Rückgabewerte:

Ein Array von Dictionarys, wobei jedes Dictionary die folgenden Schlüssel/Wert-Paare enthält:

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

Wobei:

  • name: Der Name der App-Spezifikation.

  • requested_on: Zeitstempel, wann die App-Spezifikation angefragt wurde.

  • type: Typ der App-Spezifikation. Unterstützte Werte sind: EXTERNAL ACCESS und SECURITY INTEGRATION.

  • sequence_number: ID für eine Version einer App-Spezifikation. Dieser Wert wird jedes Mal erhöht, wenn ein Anbieter die Definition der App-Spezifikation ändert.

  • status: Gibt den aktuellen Status der App-Spezifikation an. Mögliche Werte sind:

    • APPROVED: Der Verbraucher hat die App-Spezifikation genehmigt.

    • DECLINED: Die App-Spezifikation wartet darauf, dass der Verbraucher zustimmt oder ablehnt.

    • DECLINED: Der Verbraucher hat die Spezifikation der App abgelehnt.

    • PENDING: Die App-Spezifikation wartet darauf, dass der Verbraucher zustimmt oder ablehnt.

  • status_updated_on: Zeitstempel der letzten Statusänderung.

  • label: Name der App-Spezifikation, die dem Verbraucher in Snowsight angezeigt wird.

  • description: Beschreibung der App-Spezifikation, die dem Verbraucher in Snowsight angezeigt wird.

  • definition: Werte, die Teil sind von Definition der App-Spezifikation. Die Werte dieser Spalte hängen vom Typ der App-Spezifikation ab.

get_detailed_reference_associations()

Liefert detaillierte Informationen zu einer Referenz auf ein Objekt im Verbraucherkonto.

Signatur:
get_detailed_reference_associations(reference_name: str) -> List[dict]
Copy
Argumente:

Ein Zeichenfolgenwert, der den Namen einer Referenz enthält.

Rückgabewerte:

Gibt ein JSON-Objekt zurück, das ein Array von Dictionarys repräsentiert. Jedes Wörterbuch enthält die folgenden Schlüssel/Wert-Paare:

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

Wobei:

  • alias: Der vom System generierte Alias für die Referenz.

  • database: Der Name der übergeordneten Datenbank des Verbraucherobjekts, wenn sich das Objekt in einer Datenbank befindet. Andernfalls null.

  • schema: Das übergeordnete Schema des Verbraucherobjekts, wenn sich das Objekt in einem Schema befindet. Andernfalls null.

  • name: Der Name des Verbraucherobjekts.

get_gehalten_account_privileges ()

Gibt die Berechtigungen zurück, die der App erteilt wurden.

Signatur:
get_held_account_privileges(privilege_names: [str]) -> [str]
Copy
Argumente:

Ein Array von Zeichenfolgenwerten, die die Namen der zu prüfenden Berechtigungen enthalten.

Rückgabewerte:

Gibt ein Array mit den Berechtigungen zurück, die der App anhand des an die Funktion übergebenen Arrays von Berechtigungen erteilt wurden.

Gibt ein Array mit den Berechtigungen zurück, die der Snowflake Native App anhand des an die Funktion übergebenen Arrays von Berechtigungen erteilt wurden.

get_missing_account_privileges()

Gibt die Berechtigungen zurück, die der App nicht erteilt wurden.

Signatur:
get_missing_account_privileges(privilege_names: [str]) -> [str]
Copy
Argumente:

Ein Array von Zeichenfolgenwerten, die die Namen der zu prüfenden Berechtigungen enthalten.

Rückgabewerte:

Gibt ein String-Array mit den Berechtigungen zurück, die der App anhand des an die Funktion übergebenen Arrays von Berechtigungen nicht erteilt wurden.

get_reference_associations()

Ermittelt die Objekte im Verbraucherkonto, die mit einer Referenz verbunden sind.

Um detailliertere Informationen zu Referenzen auf Objekte im Verbraucherkonto zu erhalten, verwenden Sie get_detailed_reference_associations().

Signatur:
get_reference_associations(reference_name: str) -> [str]
Copy
Argumente:

Ein Zeichenfolgenwert, der den Namen einer Referenz enthält.

Rückgabewerte:

Gibt ein Array zurück, das von Snowflake generierte Aliasse von Objekten im Verbraucherkonto enthält, die an die Referenz gebunden sind.

is_application_all_mandatory _telemetry_event_definitions_enabled()

Prüft, ob alle obligatorischen Telemetrie-Ereignisdefinitionen für die App aktiviert sind.

Weitere Informationen zur Freigabe von Telemetrieereignissen finden Sie unter Überprüfen Sie Ereignisdefinitionen mithilfe von Berechtigungen SDK.

Signatur:
is_application_all_mandatory_telemetry_event_definitions_enabled() -> bool
Copy
Argumente:

Diese Funktion nimmt keine Argumente an.

Rückgabewerte:

Gibt TRUE zurück wenn alle obligatorischen Telemetrie-Ereignisdefinitionen für die App aktiviert sind. Gibt FALSE zurück, andernfalls.

is_application_authorized_for_telemetry_event_sharing()

Prüft, ob die aktuelle Anwendung für die Freigabe von Telemetrieereignissen autorisiert ist.

Weitere Informationen zur Freigabe von Telemetrieereignissen finden Sie unter Überprüfen Sie Ereignisdefinitionen mithilfe von Berechtigungen SDK.

Signatur:
is_application_authorized_for_telemetry_event_sharing() -> bool
Copy
Argumente:

Diese Funktion nimmt keine Argumente an.

Rückgabewerte:

Gibt TRUE zurück, wenn die Anwendung für die Freigabe von Telemetrieereignissen autorisiert ist. Gibt FALSE zurück, andernfalls.

is_application_local_to_package()

Prüft, ob sich die App in demselben Konto wie das Anwendungspaket befindet.

Signatur:
is_application_local_to_package() -> bool
Copy
Argumente:

Diese Funktion nimmt keine Argumente an.

Rückgabewerte:

Gibt TRUE zurück, wenn sich die App in demselben Konto wie das Anwendungspaket befindet. Gibt FALSE zurück, andernfalls.

is_event_sharing_enabled()

Prüft, ob die Ereignisfreigabe für die App aktiviert ist.

Signatur:
is_event_sharing_enabled() -> bool
Copy
Argumente:

Diese Funktion nimmt keine Argumente an.

Rückgabewerte:

Gibt TRUE zurück, wenn die Eigenschaft SHARE_EVENTS_WITH_PROVIDER den Wert „true“ hat und im Verbraucherkonto eine aktive Ereignistabelle konfiguriert ist. Gibt FALSE zurück, andernfalls.

is_external_data_enabled()

Prüft, ob die aktuelle Anwendung für die Verwendung von externen und Iceberg-Tabellen aktiviert ist.

Signatur:
is_external_data_enabled() -> bool
Copy
Argumente:

Diese Funktion nimmt keine Argumente an.

Rückgabewerte:

Gibt TRUE zurück, wenn die App für die Verwendung externer und Iceberg-Tabellen aktiviert ist. Gibt FALSE zurück, andernfalls.

request_application_specification_review()

Öffnet ein Dialogfeld in einer Streamlit-App, in dem der Verbraucher eine App-Spezifikation überprüfen und dann genehmigen, ablehnen oder nichts tun kann. Ein Verbraucher kann eine App-Spezifikation nur ablehnen, wenn diese optional ist.

Signatur:
request_application_specification_review(spec_names: [str] = None)
Copy
Argumente:

Ein optionales Array von Zeichenfolgenwerten, die die Namen der zu überprüfenden App-Spezifikationen enthalten. Wenn dieser Parameter nicht angegeben ist, zeigt der Dialog alle für die App definierten App-Spezifikationen an.

Rückgabewerte:

Diese Methode gibt nichts zurück.

request_aws_api_integration()

Fordert vom Verbraucher eine API-Integration für das Amazon API Gateway an.

Sie müssen die API-Integration in der Manifest-Datei definieren. Weitere Informationen dazu finden Sie unter CREATE API INTEGRATION, um Informationen zu anderen Parametern zu erhalten.

Signatur:
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
Argumente:

  • id: Der Name der API-Integration, die in der Manifest-Datei definiert ist.

  • allowed_prefixes: Ein Array von Zeichenfolgenwerten, die die zulässigen Präfixe für die API-Integration enthalten.

  • gateway: Der zu verwendende Typ des API-Gateways. Der Parameter muss einen der folgenden Werte haben:

    • permissions.AwsGateway.API_GATEWAY

    • permissions.AwsGateway.PRIVATE_API_GATEWAY

    • permissions.AwsGateway.GOV_API_GATEWAY

    • permissions.AwsGateway.GOV_PRIVATE_API_GATEWAY

  • aws_role_arn: Der Amazon Resource Name (ARN) der IAM-Rolle, die das API-Gateway verwendet für den Zugriff auf das Verbraucherkonto.

  • api_key: Ein optionaler API-Schlüssel für das API-Gateway.

  • name: Ein optionaler Name für die API-Integration.

  • comment: Ein optionaler Kommentar zu der API-Integration.

Siehe CREATE API INTEGRATION, um Informationen zu anderen möglichen Parametern zu erhalten.

Rückgabewerte:

Ein Zeichenfolgenwert, der den Namen einer Referenz enthält.

request_azure_api_integration()

Fordert vom Verbraucher eine API-Integration für Azure API Management an.

Sie müssen die API-Integration in der Manifest-Datei definieren. Weitere Informationen dazu finden Sie unter CREATE API INTEGRATION, um Informationen zu anderen Parametern zu erhalten.

Signatur:
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
Argumente:

  • id: Der Name der API-Integration, die in der Manifest-Datei definiert ist.

  • allowed_prefixes: Ein Array von Zeichenfolgenwerten, die die zulässigen Präfixe für die API-Integration enthalten.

  • tenant_id: Die Mandanten-ID für das Azure API-Management.

  • application_id: Die Anwendungs-ID für das Azure API-Management.

  • api_key: Ein optionaler API-Schlüssel für das Azure API-Management.

  • name: Ein optionaler Name für die API-Integration.

  • comment: Ein optionaler Kommentar zu der API-Integration.

Rückgabewerte:

Diese Methode gibt nichts zurück.

request_event_sharing()

Öffnet ein Dialogfeld in einer Streamlit-App, das es dem Verbraucher ermöglicht, Ereignisse für die App freizugeben.

Signatur:
request_event_sharing()
Copy
Argumente:

Diese Funktion nimmt keine Argumente an.

Rückgabewerte:

Diese Methode gibt nichts zurück.

request_external_data()

Fordert vom Verbraucher die Zustimmung zur Verwendung von externen und Iceberg-Tabellen an.

Signatur:
request_external_data()
Copy
Argumente:

Diese Funktion nimmt keine Argumente an.

Rückgabewerte:

Diese Methode gibt nichts zurück.

request_google_api_integration()

Fordert vom Verbraucher eine API-Integration für Google Cloud API Gateway an.

Sie müssen die API-Integration in der Manifest-Datei definieren. Weitere Informationen dazu finden Sie unter CREATE API INTEGRATION, um Informationen zu anderen Parametern zu erhalten.

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

  • id: Der Name der API-Integration, die in der Manifest-Datei definiert ist.

  • allowed_prefixes: Ein Array von Zeichenfolgenwerten, die die zulässigen Präfixe für die API-Integration enthalten.

  • audience: Die Zielgruppe für das Google Cloud API Gateway.

  • name: Ein optionaler Name für die API-Integration.

  • comment: Ein optionaler Kommentar zu der API-Integration.

  • api_key: Ein optionaler API-Schlüssel für das Google Cloud API Gateway.

Rückgabewerte:

Diese Methode gibt nichts zurück.

request_account_privileges()

Fordert Berechtigungen vom Verbraucher an, die durch ein an die Funktion übergebenes String-Array, das die Berechtigungen enthält, angegeben werden. Die angegebenen Berechtigungen müssen in der Manifest-Datei aufgeführt sein.

Signatur:
request_account_privileges(privileges: [str])
Copy
Argumente:

Ein Zeichenfolgen-Array mit einer Liste der Berechtigungen, die die App anfordert.

Rückgabewerte:

Diese Methode gibt nichts zurück.

request_reference()

Fordert eine Referenz von dem Verbraucher an, der durch die an die Funktion übergebene Zeichenfolge angegeben ist. Die Referenz, die an die Funktion übergeben wird, muss in der Manifest-Datei definiert sein.

Eine Liste zu den Objekten, die in einer Referenz enthalten sein können, und zu den von ihnen unterstützten Berechtigungen finden Sie unter Objekttypen und Berechtigungen, die eine Referenz enthalten kann.

Signatur:
request_reference(reference: str)
Copy
Argumente:

Ein Zeichenfolgenwert, der den Namen einer Referenz auf die -Anfrage enthält.

Rückgabewerte:

Diese Methode gibt nichts zurück.

Sprache: Deutsch