PortalPy-Modul
In diesem Hilfethema sind alle Klassen und Methoden im PortalPy-Modul aufgelistet, die zum Schreiben von Verwaltungsskripten für Portal for ArcGIS herangezogen werden können.
Klasse: Portal
Ein Objekt, das eine URL-Verbindung mit einem Portal darstellt. Um ein Portal-Objekt zu instanziieren, führen Sie den Code beispielsweise folgendermaßen aus:
PortalPy.Portal(portalUrl, user, password)
Die verfügbaren Portal-Methoden sind in den folgenden Abschnitten aufgeführt. Bevor Sie die Methoden verwenden, sollten Sie Folgendes berücksichtigen:
- Gruppen-IDs: Viele Gruppenfunktionen erfordern eine Gruppen-ID. Die ID unterscheidet sich vom Namen oder Titel der Gruppe. Um die Gruppen-ID zu bestimmen, verwenden Sie die Funktion "search_groups", und geben Sie den Titel an, um die Gruppen-ID abzurufen.
- Zeit: Bei vielen Methoden wird ein Zeitfeld zurückgegeben. Alle Zeitangaben werden in Millisekunden seit 1. Januar 1970 zurückgegeben. Da Python Zeitangaben in Sekunden seit1. Januar 1970 erwartet, müssen die Zeitangaben aus PortalPy durch 1.000 dividiert werden. Im folgenden Beispiel wird veranschaulicht, wie PortalPy-Zeitangaben in Python-Zeitangaben umgewandelt werden.
group = portalAdmin.get_group('67e1761068b7453693a0c68c92a62e2e') pythontime = time.ctime(group['created']/1000)
PortalPy-Methoden
Nachfolgend werden die verfügbaren Portal-Methoden beschrieben.
_init_
Der Portal-Konstruktor. Hierfür ist die Portal-URL und optional ein Benutzername und ein Passwort erforderlich.
_init_(self, url, username=None, password=None, key_file=None, cert_file=None, expiration=60, referer=None, proxy_host=None, proxy_port=None, connection=None, workdir=r'c:\users\davi3690\appdata\local\temp\2')
add_group_users
Fügt der angegebenen Gruppe Benutzer hinzu. Diese Methode kann nur verwendet werden, wenn der Benutzer des Portal-Objekts Administrator für das gesamte Portal oder der explizite Besitzer der Gruppe ist.
add_group_users(self, user_names, group_id)
Argumente
Parameter | Beschreibung |
|---|---|
user_names | erforderliche Zeichenfolge, kommagetrennte Benutzer |
group_id | erforderliche Zeichenfolge, angegebene Gruppen-ID |
Rückgabewert
Ein Wörterbuch mit dem Schlüssel "not_added", das die Benutzer enthält, die der Gruppe nicht hinzugefügt wurden.
create_group
Erstellt eine Gruppe und gibt, wenn erfolgreich, eine Gruppen-ID zurück.
create_group(self, title, tags, description=None, snippet=None, access='public', thumbnail=None, is_invitation_only=False, sort_field='avgRating', sort_order='desc', is_view_only=False)
Argumente
Parameter | Beschreibung |
|---|---|
title | erforderliche Zeichenfolge, Name der Gruppe |
tags | erforderliche Zeichenfolge, kommagetrennte Tag-Liste |
description | optionale Zeichenfolge, beschreibt die Gruppe im Detail |
snippet | optionale Zeichenfolge, weniger als 250 Zeichen für Gruppenzusammenfassung |
access | optionale Zeichenfolge, kann "private", "public" oder "org" sein |
thumbnail | optionale Zeichenfolge, URL zum Gruppenbild |
isInvitationOnly | optional boolescher Wert, legt fest, ob Benutzer auf Anforderung beitreten können |
sort_field | optionale Zeichenfolge, legt fest, wie für die Gruppe freigegebene Elemente sortiert werden |
sort_order | optionale Zeichenfolge, "asc" oder "desc" für aufsteigend oder absteigend |
is_view_only | optionaler boolescher Wert, definiert, ob die Gruppe durchsuchbar ist |
Rückgabewert
Eine Zeichenfolge, bei der es sich um die Gruppen-ID handelt.
create_group_from_dict
Erstellt eine Gruppe und gibt, wenn erfolgreich, eine Gruppen-ID zurück. In den meisten Fällen wird empfohlen, stattdessen "create_group" zu verwenden, da bei dieser Methode ein Gruppenwörterbuch, das von einem anderen PortalPy-Aufruf zurückgegeben wurde, verwendet und kopiert werden kann.
create_group_from_dict(self, group, thumbnail=None)
Argumente
Parameter | Beschreibung |
|---|---|
group | dict-Objekt |
thumbnail | URL für Bild |
Beispiel
create_group({'title': 'Test', 'access':'public'})
delete_group
Löscht eine Gruppe.
delete_group(self, group_id)
Argumente
Parameter | Beschreibung |
|---|---|
group_id | Zeichenfolge mit der ID für die Gruppe, die gelöscht werden soll. |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
delete_user
Löscht einen Benutzer aus dem Portal, wobei Gruppen und Elemente optional gelöscht oder erneut zugewiesen werden. Benutzer, die Gruppen oder Elemente besitzen, können im Portal nicht gelöscht werden. Wenn Sie Kaskadierung auswählen, werden diese Elemente und Gruppen dem in der Option "reassign_to" identifizierten Benutzer neu zugewiesen. Wenn Sie keine Kaskadierung auswählen, ist der Löschvorgang je nachdem, ob die Elemente und Gruppen des Benutzers zuvor übertragen wurden, erfolgreich oder nicht.
Beim Kaskadieren werden bei dieser Methode bis zu 10.000 Elemente gelöscht. Wenn der Benutzer über mehr als 10.000 Elemente verfügt, schlägt die Methode fehl.
delete_user(self, username, cascade=False, reassign_to=None)
Argumente
Parameter | Beschreibung |
|---|---|
username | erforderliche Zeichenfolge, der Name des Benutzers |
cascade | optionaler boolescher Wert, "true" bedeutet, dass Elemente und Gruppen neu zugewiesen werden |
reassign_to | optionale Zeichenfolge, neuer Besitzer von Elementen und Gruppen |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
generate_token
Generiert und gibt neue Token zurück, es erfolgt jedoch keine erneute Anmeldung. Diese Methode ist nicht erforderlich, wenn Aufrufe im Portal mit der Portal-Klasse erfolgen. Sie dient für Aufrufe im Portal außerhalb der Portal-Klasse.
Das Portal verwendet einen Token-basierten Authentifizierungsmechanismus, bei dem Benutzer ihre Anmeldeinformationen bereitstellen und ein kurzfristiger Token für Aufrufe verwendet wird. Die meisten Aufrufe an die ArcGIS-REST-API erfordern einen Token, der an diese Anforderungen angehängt werden kann.
generate_token(self, username, password, expiration=60)
Argumente
Parameter | Beschreibung |
|---|---|
username | erforderliche Zeichenfolge, der Name des Benutzers |
password | erforderliches Kennwort, das Kennwort des Benutzers |
expiration | optionaler Ganzzahlwert, Anzahl der Minuten bis Token abläuft |
Rückgabewert
Eine Zeichenfolge mit dem Token.
get_group
Gibt Gruppeninformationen für den angegebenen group_id-Wert zurück.
get_group(self, group_id)
Argumente
Parameter | Beschreibung |
|---|---|
group_id | erforderliche Zeichenfolge, die die Gruppe angibt |
Rückgabewert
Ein Wörterbuchobjekt mit den Gruppeninformationen. Die Schlüssel im Wörterbuchobjekt können Folgendes enthalten:
Parameter | Beschreibung |
|---|---|
title | der Name der Gruppe |
isInvitationOnly | wenn dieser Wert auf "true" festgelegt ist, können Benutzer sich nicht um den Beitritt zur Gruppe bewerben |
owner | der Benutzername des Besitzers der Gruppe |
description | beschreibt die Gruppe |
Snippet | eine kurze Zusammenfassung der Gruppe |
tags | benutzerdefinierte Tags, die die Gruppe beschreiben |
phone | Kontaktinformationen für die Gruppe |
thumbnail | Dateiname relativ zu http://<community-url>/groups/<groupId>/info |
created | Zeitpunkt der Erstellung der Gruppe, Millisekunden seit 1. Januar 1970 |
modified | Zeitpunkt der letzten Änderung der Gruppe, Millisekunde seit 1. Januar 1970 |
access | kann "private", "org" oder "public" sein |
userMembership | ein Wörterbuch mit Schlüsseln (Benutzername) und memberType |
memberType | bietet dem aufrufenden Benutzer Zugriff ("owner", "admin", "member", "none") |
get_group_members
Gibt Mitglieder der angegebenen Gruppe zurück.
get_group_members(self, group_id)
Argumente
Parameter | Beschreibung |
|---|---|
group_id | erforderliche Zeichenfolge, die die Gruppe angibt |
Rückgabewert
Ein Wörterbuch mit Schlüsseln: "owner", "admins" und "users".
Parameter | Beschreibung |
|---|---|
owner | Zeichenfolgenwert, der Besitzer der Gruppe |
admins | Liste der Zeichenfolgen, in der Regel mit "owner" identisch |
users | Liste der Zeichenfolgen, die Mitglieder der Gruppe |
Beispiel
Die Benutzer in einer Gruppe drucken:
response = portal.get_group_members("67e1761068b7453693a0c68c92a62e2e")
for user in response['users'] :
print user
get_group_thumbnail
Gibt die Byte zurück, aus denen die Miniaturansicht für die angegebene "group_id" besteht.
get_group_thumbnail(self, group_id)
Argumente
Parameter | Beschreibung |
|---|---|
group_id | erforderliche Zeichenfolge, gibt die Miniaturansicht der Gruppe an |
Rückgabewert
Byte zur Darstellung des Bildes.
Beispiel
response = portal.get_group_thumbnail("67e1761068b7453693a0c68c92a62e2e")
f = open(filename, 'wb')
f.write(response)
get_org_users
Gibt alle Benutzer in der Portal-Organisation zurück.
get_org_users(self, max_users=1000)
Argumente
Parameter | Beschreibung |
|---|---|
max_users | optionaler Ganzzahlwert, die maximale Anzahl von Benutzern, die zurückgegeben werden sollen |
Rückgabewert
Eine Wörterbuchliste. Jedes Wörterbuch enthält die folgenden Schlüssel:
Schlüssel | Wert |
|---|---|
username | string |
storageUsage | integer |
storageQuota | Ganzzahl |
description | Zeichenfolge |
tags | Zeichenfolgenliste |
region | Zeichenfolge |
created | Ganzzahlwert, bei Erstellung des Kontos, Millisekunden seit 1. Januar 1970 |
modified | Ganzzahlwert, seit der letzten Änderung des Kontos, Millisekunden seit 1. Januar 1970 |
Zeichenfolge | |
culture | Zeichenfolge |
orgId | Zeichenfolge |
preferredView | Zeichenfolge |
groups | Zeichenfolgenliste |
role | Zeichenfolge (org_user, org_publisher, org_admin) |
fullName | Zeichenfolge |
thumbnail | Zeichenfolge |
idpUsername | Zeichenfolge |
Beispiel
Alle Benutzernamen im Portal drucken:
resp = portalAdmin.get_org_users()
for user in resp:
print user['username']
get_properties
Gibt die Eigenschaften des Portals unter Verwendung des Caches zurück, es sei denn "force=True".
get_properties(self, force=False)
get_user
Gibt die Benutzerinformationen für den angegebenen Benutzernamen zurück.
get_user(self, username)
Argumente
Parameter | Beschreibung |
|---|---|
username | erforderliche Zeichenfolge, der Benutzername, dessen Informationen abgerufen werden sollen |
Rückgabewert
Wenn der Benutzer gefunden wurde, wird ein Wörterbuchobjekt mit den folgenden Schlüsseln zurückgegeben. Wenn kein Benutzer gefunden wurde, wird nichts zurückgegeben.
Schlüssel | Wert |
|---|---|
access | Zeichenfolge |
created | Ganzzahlwert, bei Erstellung des Kontos, Millisekunden seit 1. Januar 1970 |
culture | Zeichenfolge, zweistelliger Sprachcode ('en') |
description | Zeichenfolge |
Zeichenfolge | |
fullName | Zeichenfolge |
idpUsername | Zeichenfolge, Name des Benutzer im Enterprise-System |
groups | Wörterbuchliste. Weitere Informationen zu Wörterbuchschlüsseln finden Sie unter get_group. |
modified | Ganzzahlwert, seit der letzten Änderung des Kontos, Millisekunden seit 1. Januar 1970 |
orgId | Zeichenfolge, die Organisations-ID |
preferredView | Zeichenfolge, Wert ist "Web", "GIS" oder "null" |
region | Zeichenfolge, kein oder zweistelliger Ländercode |
role | Zeichenfolge (org_user, org_publisher, org_admin) |
storageUsage | Ganzzahl |
storageQuota | Ganzzahl |
tags | Zeichenfolgenliste |
thumbnail | Zeichenfolge |
username | Zeichenfolge |
get_version
Gibt die Softwareversionsnummer unter Verwendung des Caches zurück, es sei denn "force=True". Die Versionsinformationen werden abgerufen, wenn Sie das Portal-Objekt erstellen, und dann für zukünftige Anforderungen gecacht. Wenn Sie eine Anforderung an das Portal senden und sich nicht auf den Cache stützen möchten, können Sie das force-Argument auf "true" festlegen.
get_version(self, force=False)
Argumente
Parameter | Beschreibung |
|---|---|
force | boolescher Wert, "true=make a request", "false=use cache" |
Rückgabewert
Eine Zeichenfolge mit der Version. Die Version ist eine interne Nummer, die möglicherweise nicht mit der Version des installierten Produkts übereinstimmt.
invite_group_users
Lädt Benutzer zur Gruppe ein. Einem Benutzer, der zu einer Gruppe eingeladen wird, wird auf der Registerkarte "Gruppen" des Portals eine Liste der Einladungen angezeigt. Der Benutzer kann die Einladung annehmen oder ablehnen. Der Benutzer, der den Befehl ausführt, muss der Gruppenbesitzer sein.
invite_group_users(self, user_names, group_id, role='group_member', expiration=10080)
Argumente
Parameter | Beschreibung |
|---|---|
user_names | erforderliche Zeichenfolge, kommagetrennte Liste der Benutzer, die eingeladen werden sollen |
group_id | erforderliche Zeichenfolge, gibt die ID der Gruppe an, zu der Sie Benutzer einladen |
role | eine optionale Zeichenfolge, "group_member" oder "group_admin" |
expiration | ein optionaler Ganzzahlwert, gibt an, wie lange die Einladung gültig ist (in Minuten) |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
is_all_ssl
Gibt "true" zurück, wenn das Portal SSL erfordert.
is_all_ssl(self)
is_logged_in
Gibt "true" zurück, wenn der Benutzer beim Portal angemeldet ist.
is_logged_in(self)
is_org
Gibt "true" zurück, wenn das Portal eine Organisation ist.
is_org(self)
leave_group
Entfernt den angemeldeten Benutzer aus der angegebenen Gruppe. Der Benutzer muss angemeldet sein, um diese Methode verwenden zu können.
leave_group(self, group_id)
Argumente
Parameter | Beschreibung |
|---|---|
group_id | erforderliche Zeichenfolge, angegebene Gruppen-ID |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
logged_in_user
Gibt Informationen zum angemeldeten Benutzer zurück.
logged_in_user(self)
Rückgabewert
Ein Wörterbuch mit den folgenden Schlüsseln:
Schlüssel | Wert |
|---|---|
username | Zeichenfolge |
storageUsage | Ganzzahl |
description | Zeichenfolge |
tags | Kommagetrennte Zeichenfolge |
created | Ganzzahlwert, bei Erstellung des Kontos, Millisekunden seit 1. Januar 1970 |
modified | Ganzzahlwert, seit der letzten Änderung des Kontos, Millisekunden seit 1. Januar 1970 |
fullName | Zeichenfolge |
Zeichenfolge | |
idpUsername | Zeichenfolge, Name des Benutzers im Enterprise-System |
Anmeldung
Die Anmeldung beim Portal erfolgt mit einem Benutzernamen und einem Kennwort. Sie können sich beim Konstruieren eines Portal-Objekts oder zu einem späteren Zeitpunkt bei einem Portal anmelden. Diese Funktion ist relevant, wenn Sie sich zu einem späteren Zeitpunkt anmelden wollen.
login(self, username, password, expiration=60)
Argumente
Parameter | Beschreibung |
|---|---|
username | erforderliche Zeichenfolge |
password | erforderliche Zeichenfolge |
expiration | optionaler Ganzzahlwert, wie lange der generierte Token gültig ist |
Rückgabewert
Eine Zeichenfolge, die den Token enthält.
Abmelden
Führt die Abmeldung vom Portal aus. Vorhandene Token, die zuvor verwendet wurden, werden vom Portal nicht mehr erkannt und alle nachfolgenden Portal-Aufrufe sind so lange anonym, bis eine andere Anmeldung erfolgt.
logout(self)
Rückgabewert
Kein Rückgabewert.
reassign_group
Weist einem anderen Besitzer eine Gruppe erneut zu.
reassign_group(self, group_id, target_owner)
Argumente
Parameter | Beschreibung |
|---|---|
group_id | erforderliche Zeichenfolge, eindeutige Kennung für die Gruppe |
target_owner | erforderliche Zeichenfolge, Benutzername eines neuen Gruppenbesitzers |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
remove_group_users
Entfernt Benutzer aus einer Gruppe.
remove_group_users(self, user_names, group_id)
Argumente
Parameter | Beschreibung |
|---|---|
user_names | erforderliche Zeichenfolge, kommagetrennte Benutzerliste |
group_id | erforderliche Zeichenfolge, eindeutige Kennung für die Gruppe |
Rückgabewert
Ein Wörterbuch mit dem Schlüssel "notRemoved" zur Angabe der Liste der nicht entfernten Benutzer.
reset_user
Setzt das Kennwort, die Sicherheitsfrage und Sicherheitsantwort eines Benutzers zurück. Diese Funktion gilt nicht für Portale, die mit Konten konfiguriert sind, die aus einem Enterprise-Identitätsspeicher wie ActiveDirectory or LDAP stammen. Sie gilt nur für integrierte Portal-Benutzer. Wenn eine neue Sicherheitsfrage angegeben wird, sollte eine neue Sicherheitsantwort bereitgestellt werden.
reset_user(self, username, password, new_password=None, new_security_question=None, new_security_answer=None)
Argumente
Parameter | Beschreibung |
|---|---|
username | erforderliche Zeichenfolge, Konto wird zurückgesetzt |
password | erforderliche Zeichenfolge, aktuelles Kennwort |
new_password | optionale Zeichenfolge, neues Kennwort, wenn das Kennwort zurückgesetzt wird |
new_security_question | optionaler Ganzzahlwert, bei Bedarf eine neue Sicherheitsfrage |
new_security_answer | optionale Zeichenfolge, bei Bedarf eine neue Sicherheitsantwort |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
Suchen
search(self, q, bbox=None, sort_field='title', sort_order='asc', max_results=1000, add_org=True)
search_groups
Sucht nach Portal-Gruppen. Berücksichtigen Sie bei Verwendung dieser Methode Folgendes:
- Die Abfragesyntax verfügt über viele Funktionen, die hier nicht beschrieben werden. Weitere Informationen zu allen Funktionen finden Sie in der Suchreferenz der ArcGIS-REST-API.
- Wenn Sie Gruppen suchen, suchen Sie häufig innerhalb der Organisation. Bei dieser Methode wird die Organisations-ID standardmäßig an die Abfrage angehängt. Wenn die API nicht an Ihre Abfrage angehängt werden soll, legen Sie "add_org" auf "false" fest.
search_groups(self, q, sort_field='title', sort_order='asc', max_groups=1000, add_org=True)
Argumente
Parameter | Beschreibung |
|---|---|
q | erforderliche Zeichenfolge, Abfragezeichenfolge. |
sort_field | optionale Zeichenfolge, gültige Werte können "title", "owner" oder "created" sein |
sort_order | optionale Zeichenfolge, gültige Werte sind "asc" oder "desc" |
max_groups | optionaler Ganzzahlwert, maximale Anzahl von zurückgegebenen Gruppen |
add_org | optionaler boolescher Wert, steuert, ob in der Organisation gesucht werden soll |
Rückgabewert
Eine Wörterbuchliste. Jedes Wörterbuch enthält die folgenden Schlüssel:
Schlüssel | Wert |
|---|---|
access | Zeichenfolge, Werte sind "private", "org" oder "public" |
created | Ganzzahlwert, bei Erstellung des Kontos, Millisekunden seit 1. Januar 1970 |
description | Zeichenfolge |
id | Zeichenfolge, eindeutige ID für die Gruppe |
isInvitationOnly | boolesch |
isViewOnly | boolesch |
modified | Ganzzahlwert, seit der letzten Änderung des Kontos, Millisekunden seit 1. Januar 1970 |
owner | Zeichenfolge, Benutzername des Besitzers |
phone | Zeichenfolge |
snippet | Zeichenfolge, kurze Zusammenfassung der Gruppe |
sortField | Zeichenfolge, Sortierung freigegebener Elemente |
sortOrder | Zeichenfolge, aufsteigend oder absteigend |
tags | Zeichenfolgenliste, vom Benutzer für die Suche bereitgestellte Tags |
thumbnail | Zeichenfolge, Name der Datei. Anhängen an http://<community url>/groups/<group id>/info/ |
title | Zeichenfolge, Name der Gruppe, wie er Benutzern angezeigt wird |
search_users
Sucht nach Portal-Benutzern. Berücksichtigen Sie bei Verwendung dieser Methode Folgendes:
- Die Abfragesyntax verfügt über viele Funktionen, die hier nicht beschrieben werden. Weitere Informationen zu allen Funktionen finden Sie in der Suchreferenz der ArcGIS-REST-API.
- Wenn Sie Benutzer suchen, suchen Sie häufig innerhalb der Organisation. Bei dieser Methode wird die Organisations-ID standardmäßig an die Abfrage angehängt. Wenn die API nicht an Ihre Abfrage angehängt werden soll, legen Sie "add_org" auf "false" fest.
search_users(self, q, sort_field='username', sort_order='asc', max_users=1000, add_org=True)
Argumente
Parameter | Beschreibung |
|---|---|
q | erforderliche Zeichenfolge, Abfragezeichenfolge. |
sort_field | optionale Zeichenfolge, gültige Werte können "title", "owner" oder "created" sein |
sort_order | optionale Zeichenfolge, gültige Werte sind "asc" oder "desc" |
max_users | optionaler Ganzzahlwert, maximale Anzahl von zurückgegebenen Benutzern |
add_org | optionaler boolescher Wert, steuert, ob in der Organisation gesucht werden soll |
Rückgabewert
Eine Wörterbuchliste. Jedes Wörterbuch enthält die folgenden Schlüssel:
Schlüssel | Wert |
|---|---|
created | Ganzzahlwert, bei Erstellung des Kontos, Millisekunden seit 1. Januar 1970 |
culture | Zeichenfolge, zweistelliger Sprachcode |
description | Zeichenfolge |
fullName | Zeichenfolge, Benutzername des Benutzers |
modified | Ganzzahlwert, seit der letzten Änderung des Kontos, Millisekunden seit 1. Januar 1970 |
region | Zeichenfolge, möglicherweise "none" |
tags | Zeichenfolgenliste, vom Benutzer für die Suche bereitgestellte Tags |
thumbnail | Zeichenfolge, Name der Datei. Anhängen an http://<community url>/groups/<group id>/info/ |
username | Zeichenfolge, Benutzername des Benutzers |
signup
Registriert Benutzer bei Portal for ArcGIS. Diese Methode gilt nur für Portal for ArcGIS und kann anonym aufgerufen werden. Selbstregistrierung kann jedoch auch im Portal deaktiviert werden. Bei dieser Methode werden außerdem nur integrierte Konten erstellt. Es werden keine Enterprise-Konten verwendet, die aus einem Enterprise-Identitätsspeicher stammen.
Es gibt eine andere Methode namens "createUser", die immer für Portal for ArcGIS 10.2.1 oder höher verwendet werden kann. Diese Methode erfordert Administratorzugriff und kann zum Erstellen integrierter Benutzer oder zum Hinzufügen von Enterprise-Konten zum Portal verwendet werden.
signup(self, username, password, fullname, email)
Argumente
Parameter | Beschreibung |
|---|---|
username | erforderliche Zeichenfolge, muss im Portal eindeutig sein, größer als 4 Zeichen |
password | erforderliche Zeichenfolge, muss größer oder gleich 8 Zeichen sein |
fullname | erforderliche Zeichenfolge, Name des Benutzers |
erforderliche Zeichenfolge, muss eine gültige E-Mail-Adresse sein |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
update_group
Aktualisiert eine Gruppe. Sie müssen nur für die Argumente Werte angeben, die aktualisiert werden sollen.
update_group(self, group_id, title=None, tags=None, description=None, snippet=None, access=None, is_invitation_only=None, sort_field=None, sort_order=None, is_view_only=None, thumbnail=None)
Argumente
Parameter | Beschreibung |
|---|---|
group_id | erforderliche Zeichenfolge, die Gruppen-ID, die geändert werden soll |
title | erforderliche Zeichenfolge, Name der Gruppe, die geändert werden soll |
tags | erforderliche Zeichenfolge, kommagetrennte Tag-Liste |
description | optionale Zeichenfolge, beschreibt die Gruppe im Detail |
snippet | optionale Zeichenfolge, weniger als 250 Zeichen für Gruppenzusammenfassung |
access | optionale Zeichenfolge, kann "private", "public" oder "org" sein |
thumbnail | optionale Zeichenfolge, URL zum Gruppenbild |
isInvitationOnly | optional boolescher Wert, legt fest, ob Benutzer auf Anforderung beitreten können |
sort_field | optionale Zeichenfolge, legt die Sortierung der für die Gruppe freigegebenen Elemente fest |
sort_order | optionale Zeichenfolge, "asc" oder "desc" für aufsteigend oder absteigend |
is_view_only | optionaler boolescher Wert, definiert, ob die Gruppe durchsuchbar ist |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
update_user
Aktualisiert die Eigenschaften eines Benutzers. Sie müssen nur für die Argumente Werte angeben, die aktualisiert werden sollen.
update_user(self, username, access=None, preferred_view=None, description=None, tags=None, thumbnail=None, fullname=None, email=None, culture=None, region=None)
Argumente
Schlüssel | Wert |
|---|---|
username | erforderliche Zeichenfolge, Name des Benutzers, der aktualisiert werden soll |
access | optionale Zeichenfolge, Werte: "private", "org", "public" |
preferred_view | optionale Zeichenfolge, Werte: "Web", "GIS", "null" |
description | optionale Zeichenfolge, eine Beschreibung des Benutzers |
tags | optionale Zeichenfolge, kommagetrennte Tags für die Suche |
thumbnail | optionale Zeichenfolge, Pfad oder URL zu einer Datei. Kann PNG, GIF oder JPEG sein. Maximale Größe ist 1 MB. |
fullName | optionale Zeichenfolge, Name des Benutzers, nur für integrierte Benutzer |
optionale Zeichenfolge, E-Mail, Adresse, nur für integrierte Benutzer | |
culture | optionale Zeichenfolge, zweistelliger Sprachcode, z. B. "fr". |
region | optionale Zeichenfolge, zweistelliger Ländercode, z. B. "FR". |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.
update_user_role
Aktualisiert die Rolle eines Benutzers.
update_user_role(self, username, role)
Argumente
Schlüssel | Wert |
|---|---|
username | erforderliche Zeichenfolge, der Name des Besitzers, dessen Rolle geändert wird |
role | erforderliche Zeichenfolge, "org_user", "org_publisher" oder "org_admin" |
Rückgabewert
Ein boolescher Wert, der angibt, ob der Vorgang erfolgreich war oder nicht.