Moduł PortalPy

W tym temacie pomocy zamieszczono listę wszystkich klas i metod modułu PortalPy, których można użyć do pisania skryptów administracyjnych dla oprogramowania Portal for ArcGIS.

Klasa: Portal

Obiekt reprezentujący połączenie z portalem w postaci adresu URL. Aby utworzyć obiekt portalu, uruchom następujący kod:

PortalPy.Portal(portalUrl, user, password)

Dostępne metody portalu zostały podane w poniższych sekcjach. Przed rozpoczęciem pracy z metodami należy wziąć pod uwagę następujące kwestie:

• Identyfikatory grup — wiele funkcji grup wymaga podania identyfikatora grupy. Identyfikator grupy jest różny od jej nazwy i tytułu. Aby sprawdzić identyfikator grupy, skorzystaj z funkcji search_groups i określ tytuł, aby uzyskać identyfikator grupy.
• Czas — wiele z metod zwraca pole czasu. Zwracany czas jest podawany w milisekundach od 1 stycznia 1970 r. Język Python wymaga podania czasu w sekundach od 1 stycznia 1970 r., dlatego czas uzyskany z modułu PortalPy należy podzielić przez 1000. Poniższy przykład ilustruje, w jaki sposób zamienić czas uzyskany z modułu PortalPy na czas wymagany w języku Python.

  group = portalAdmin.get_group('67e1761068b7453693a0c68c92a62e2e')
  pythontime = time.ctime(group['created']/1000)

Metody PortalPy

Poniżej znajduje się opis dostępnych metod portalu.

_init_

Kreator portalu. Wymaga adresu URL portalu, a także opcjonalnie nazwy użytkownika i hasła.

_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

Umożliwia dodanie użytkownika do określonej grupy. Z metody tej można skorzystać, tylko jeżeli użytkownik obiektu portalu jest administratorem całego portalu lub właścicielem grupy.

add_group_users(self, user_names, group_id)

Argumenty

Parametr	Opis
user_names	Wymagany ciąg znakowy, rozdzielana przecinkami lista użytkowników
group_id	Wymagany ciąg znakowy, określa identyfikator grupy

Wartość zwracana

Słownik z kluczem not_added zawierający użytkowników, którzy nie zostali dodani do grupy.

create_group

Tworzy grupę i zwraca identyfikator grupy, jeśli operacja zostanie zakończona powodzeniem.

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)

Argumenty

Parametr	Opis
tytuł	Wymagany ciąg znakowy, nazwa grupy
znaczniki	Wymagany ciąg znakowy, lista rozdzielanych przecinkami znaczników
opis	Opcjonalny ciąg znakowy, szczegółowy opis grupy
ekstrakt	Opcjonalny ciąg znakowy, podsumowanie grupy składające się z maksymalnie 250 znaków
dostęp	Opcjonalny ciąg znakowy, może mieć wartość private (prywatny), public (publiczny) lub org (instytucja)
thumbnail	Opcjonalny ciąg znakowy, adres URL obrazu grupy
isInvitationOnly	Opcjonalna wartość logiczna (Boolean), określa, czy użytkownicy mogą przyłączać się poprzez wysłanie wniosku
sort_field	Opcjonalny ciąg znakowy, określa sposób sortowania elementów udostępnionych grupie
sort_order	Opcjonalny ciąg znakowy, kolejność sortowania: asc, czyli rosnąco, lub desc, czyli malejąco
is_view_only	Opcjonalna wartość logiczna (Boolean), określa, czy grupę można przeszukiwać

Wartość zwracana

Ciąg będący identyfikatorem grupy.

create_group_from_dict

Tworzy grupę i zwraca identyfikator grupy, jeśli operacja zostanie zakończona powodzeniem. W większości przypadków zalecane jest korzystanie z metody create_group, ponieważ w tej opisanej tutaj skopiowany i użyty może zostać słownik grupy zwrócony z innego wywołania PortalPy.

create_group_from_dict(self, group, thumbnail=None)

Argumenty

Parametr	Opis
grupa	obiekt słownika
thumbnail	adres URL obrazu

Przykład

create_group({'title': 'Test', 'access':'public'})

delete_group

Usuwa grupę.

delete_group(self, group_id)

Argumenty

Parametr	Opis
group_id	Ciąg znakowy zawierający identyfikator usuwanej grupy.

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

delete_user

Usuwa użytkownika z portalu, dodatkowo może też usuwać lub ponownie przypisywać grupy i elementy. Z portalu nie można usunąć użytkownika, który jest właścicielem grup lub elementów. Jeżeli przeprowadzone zostanie usunięcie kaskadowe, te elementy i grupy zostaną ponownie przypisane do użytkownika określonego przez opcję reassign_to. Jeżeli nie będzie wykonywane usuwanie kaskadowe, operacja usuwania zakończy się pomyślnie lub nie powiedzie się zależnie od tego, czy elementy i grupy użytkownika zostały wcześniej przeniesione.

W przypadku usuwania kaskadowego użycie tej metody umożliwia usunięcie maksymalnie 10 000 elementów. Jeżeli użytkownik posiada ponad 10 000 elementów, metoda zakończy się niepowodzeniem.

delete_user(self, username, cascade=False, reassign_to=None)

Argumenty

Parametr	Opis
username	Wymagany ciąg znakowy, nazwa użytkownika
cascade	Opcjonalna wartość logiczna (Boolean), jeżeli przypisano jej wartość true, wykonane zostanie ponowne przypisanie elementów i grup
reassign_to	Opcjonalny ciąg znakowy, nowy właściciel elementów i grup

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

generate_token

Generuje i zwraca nowy token, nie wykonuje jednak ponownego logowania. Ta metoda nie jest wymagana, gdy do wykonywania wywołań do portalu używana jest klasa. Jest ona podana, aby zapewnić możliwość wykonywania wywołań do portalu poza klasą portalu.

Portal korzysta z mechanizmu uwierzytelniania opartego na tokenach, który zakłada podanie przez użytkownika poświadczeń i użycie tymczasowego tokena do wykonywania wywołań. Większość wywołań interfejsu ArcGIS REST API wymaga tokena, który można dołączyć do tych żądań.

generate_token(self, username, password, expiration=60)

Argumenty

Parametr	Opis
username	Wymagany ciąg znakowy, nazwa użytkownika
hasło	Wymagane hasło, hasło powiązane z danym użytkownikiem
expiration	Opcjonalna liczba całkowita, liczba minut do wygaśnięcia tokena

Wartość zwracana

Ciąg zawierający token.

get_group

Zwraca informacje dotyczące grupy określonej przez parametr group_id.

get_group(self, group_id)

Argumenty

Parametr	Opis
group_id	Wymagany ciąg znakowy, określa grupę

Wartość zwracana

Obiekt słownika zawierający informacje o grupie. Klucze w obiekcie słownika mogą obejmować:

Parametr	Opis
tytuł	Nazwa grupy
isInvitationOnly	Jeżeli wartość tego parametru to true, użytkownicy nie mogą przesyłać wniosków o przyłączenie się do grupy
właściciel	Nazwa użytkownika właściciela grupy
opis	Opis grupy
ekstrakt	Krótkie podsumowanie grupy
znaczniki	Zdefiniowane przez użytkownika znaczniki opisujące grupę
telefon	Informacje kontaktowe danej grupy
thumbnail	Nazwa pliku względem katalogu http://<community-url>/groups/<groupId>/info
utworzone	Czas utworzenia grupy, w milisekundach od 1 stycznia 1970
modified	Czas ostatniej modyfikacji grupy, w milisekundach od 1 stycznia 1970
dostęp	Może mieć wartość private (prywatny), org (instytucja) lub public (publiczny)
userMembership	Słownik z kluczami username oraz memberType
memberType	Informacja o uprawnieniach dostępu użytkownika wykonującego wywołanie (owner (właściciel), admin (administrator), member (członek), none (żadne z tych))

get_group_members

Zwraca członków określonej grupy.

get_group_members(self, group_id)

Argumenty

Parametr	Opis
group_id	Wymagany ciąg znakowy, określa grupę

Wartość zwracana

Słownik z kluczami: owner, admins i users.

Parametr	Opis
właściciel	Wartość ciągu znakowego, właściciel grupy
admins	Lista ciągów znakowych, zwykle jest taka sama jak parametr owner
użytkownicy	Lista ciągów znakowych, członkowie danej grupy

Przykład

Drukowanie listy użytkowników należących do grupy:

response = portal.get_group_members("67e1761068b7453693a0c68c92a62e2e")
for user in response['users'] :
   print user

get_group_thumbnail

Zwraca liczbę bajtów będącą rozmiarem miniatury grupy określonej przez parametr group_id.

get_group_thumbnail(self, group_id)

Argumenty

Parametr	Opis
group_id	Wymagany ciąg znakowy, definiuje miniaturę grupy

Wartość zwracana

Liczba bajtów reprezentująca obraz.

Przykład

response = portal.get_group_thumbnail("67e1761068b7453693a0c68c92a62e2e")
f = open(filename, 'wb')
f.write(response)

get_users

Zwraca listę wszystkich użytkowników w instytucji portalu.

get_users(self, max_users=1000)

Argumenty

Parametr	Opis
max_users	Opcjonalna liczba całkowita, maksymalna liczba użytkowników, która może zostać zwrócona

Wartość zwracana

Lista słowników. Każdy słownik zawiera następujące klucze:

Klucz	Wartość
username	Ciąg znakowy
storageUsage	Całkowite
storageQuota	Całkowite
opis	Ciąg znakowy
znaczniki	Lista ciągów znakowych
region	Ciąg znakowy
utworzone	Liczba całkowita, czas utworzenia konta, w sekundach od 1 stycznia 1970
modified	Liczba całkowita, czas od ostatniej modyfikacji konta, w sekundach od 1 stycznia 1970
email	Ciąg znakowy
culture	Ciąg znakowy
orgId	Ciąg znakowy
preferredView	Ciąg znakowy
grupy	Lista ciągów znakowych
role	Ciąg znakowy (user, publisher, admin, <nazwa_roli_niestandardowej> [gdzie <nazwa_roli_niestandardowej> jest nazwą roli niestandardowej, np. hostedservicepublisher]) Wcześniejsze: W oprogramowaniu Portal for ArcGIS w wersji 10.3 i w wersjach wcześniejszych akceptowane były następujące wartości ról niestandardowych: org_user, org_publisher oraz org_admin. W wersji 10.3.1 te wartości stały się nieaktualne i zostały zastąpione wymienionymi wyżej wartościami. W wersji 10.3.1 nadal można używać wcześniejszych wartości, ale należy pamiętać, że mogą one nie być akceptowane w przyszłych wersjach.
fullName	Ciąg znakowy
thumbnail	Ciąg znakowy
idpUsername	Ciąg znakowy

Przykład

Drukowanie wszystkich nazw użytkowników w portalu:

resp = portalAdmin.get_users() for user in resp:
   print user['username']

get_properties

Zwraca właściwości portalu, korzystając z pamięci podręcznej, chyba że parametr force=True.

get_properties(self, force=False)

get_user

Zwraca informacje o użytkowniku określonym za pomocą nazwy użytkownika.

get_user(self, username)

Argumenty

Parametr	Opis
username	Wymagany ciąg znakowy, nazwa użytkownika, o którym uzyskane zostaną informacje

Wartość zwracana

Jeżeli użytkownik zostanie odnaleziony, zwracany jest obiekt słownika z podanymi poniżej kluczami. Jeżeli nie zostanie znaleziony żaden użytkownik, nie zostaje zwrócony żaden element.

Klucz	Wartość
dostęp	Ciąg znakowy
utworzone	Liczba całkowita, czas utworzenia konta, w sekundach od 1 stycznia 1970
culture	Ciąg znakowy, dwuliterowy kod języka (en)
opis	Ciąg znakowy
email	Ciąg znakowy
fullName	Ciąg znakowy
idpUsername	Ciąg znakowy, nazwa użytkownika w systemie firmowym
grupy	Lista słowników. Aby zapoznać się z listą kluczy słownika, sprawdź parametr get_group.
modified	Liczba całkowita, czas od ostatniej modyfikacji konta, w sekundach od 1 stycznia 1970
orgId	Ciąg znakowy, identyfikator instytucji
preferredView	Ciąg znakowy, dozwolone wartości to Web, GIS lub null
region	Ciąg znakowy, może mieć wartość none lub mieć postać dwuliterowego kodu kraju
role	Ciąg znakowy (user, publisher, admin, <nazwa_roli_niestandardowej> [gdzie <nazwa_roli_niestandardowej> jest nazwą roli niestandardowej, np. hostedservicepublisher]) Wcześniejsze: W oprogramowaniu Portal for ArcGIS w wersji 10.3 i w wersjach wcześniejszych akceptowane były następujące wartości ról niestandardowych: org_user, org_publisher oraz org_admin. W wersji 10.3.1 te wartości stały się nieaktualne i zostały zastąpione wymienionymi wyżej wartościami. W wersji 10.3.1 nadal można używać wcześniejszych wartości, ale należy pamiętać, że mogą one nie być akceptowane w przyszłych wersjach.
storageUsage	Całkowite
storageQuota	Całkowite
znaczniki	Lista ciągów znakowych
thumbnail	Ciąg znakowy
username	Ciąg znakowy

get_version

Zwraca numer wersji oprogramowania, korzystając z pamięci podręcznej, chyba że parametr force=True. Informacje o wersji są pobierane w momencie utworzenia obiektu portalu, a następnie są przesyłane do pamięci podręcznej na potrzeby przyszłych wywołań. Jeżeli chcesz, aby zamiast do pamięci podręcznej, żądanie było wysyłane do portalu, określ wartość argumentu force jako True.

get_version(self, force=False)

Argumenty

Parametr	Opis
force	Wartość logiczna (Boolean), true = wysyłaj żądanie, false = korzystaj z pamięci podręcznej

Wartość zwracana

Ciąg zawierający wersję. Wersja to wewnętrzny numer, który może nie być zgodny z wersją zainstalowanego produktu.

invite_group_users

Wysyła do użytkowników zaproszenie do przyłączenia się do grupy. Użytkownik zaproszony do przyłączenia się do grupy widzi w portalu listę zaproszeń na karcie Grupy. Użytkownik ma możliwość zaakceptowania lub odrzucenia zaproszenia. Użytkownik wykonujący polecenie musi być właścicielem grupy.

invite_group_users(self, user_names, group_id, role='group_member', expiration=10080)

Argumenty

Parametr	Opis
user_names	Wymagany ciąg znakowy, rozdzielana przecinkami lista użytkowników do zaproszenia
group_id	Wymagany ciąg znakowy, określa identyfikator grupy, do której zapraszani są użytkownicy
role	Opcjonalny ciąg znakowy, może mieć wartość group_member lub group_admin
expiration	Opcjonalna liczba całkowita, określa czas ważności danego zaproszenia (w minutach)

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

is_all_ssl

Zwracana wartość to true, jeżeli portal wymaga protokołu HTTPS.

is_all_ssl(self)

is_logged_in

Zwracana wartość to true, jeżeli użytkownik jest zalogowany w portalu.

is_logged_in(self)

is_org

Zwracana wartość to true, jeżeli portal jest instytucją.

is_org(self)

leave_group

Usuwa zalogowanego użytkownika z określonej grupy. Aby skorzystać z tej metody użytkownik musi być zalogowany.

leave_group(self, group_id)

Argumenty

Parametr	Opis
group_id	Wymagany ciąg znakowy, określa identyfikator grupy

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

logged_in_user

Zwraca informacje na temat zalogowanego użytkownika.

logged_in_user(self)

Wartość zwracana

Słownik zawierający następujące klucze:

Klucz	Wartość
username	Ciąg znakowy
storageUsage	Całkowite
opis	Ciąg znakowy
znaczniki	Ciąg znakowy rozdzielany przecinkami
utworzone	Liczba całkowita, czas utworzenia konta, w sekundach od 1 stycznia 1970
modified	Liczba całkowita, czas od ostatniej modyfikacji konta, w sekundach od 1 stycznia 1970
fullName	Ciąg znakowy
email	Ciąg znakowy
idpUsername	Ciąg znakowy, nazwa użytkownika w systemie firmowym

login

Wykonuje logowanie do portalu za pomocą nazwy i hasła użytkownika. Możesz zalogować się do portalu w momencie tworzenia obiektu portalu lub wykonać logowanie później. Ta funkcja służy do logowania w późniejszym czasie.

login(self, username, password, expiration=60)

Argumenty

Parametr	Opis
username	Wymagany ciąg znakowy
hasło	Wymagany ciąg znakowy
expiration	Opcjonalna liczba całkowita, okres ważności wygenerowanego tokena

Wartość zwracana

Ciąg zawierający token.

logout

Przeprowadza proces wylogowania z portalu. Portal usunie z pamięci wszystkie istniejące tokeny, które były używane, a wszystkie kolejne wywołania portalu będą anonimowe aż do wykonania następnego wywołania logowania.

logout(self)

Wartość zwracana

Nie jest zwracana żadna wartość.

reassign_group

Przypisuje grupę innemu właścicielowi.

reassign_group(self, group_id, target_owner)

Argumenty

Parametr	Opis
group_id	Wymagany ciąg znakowy, unikalny identyfikator grupy
target_owner	Wymagany ciąg znakowy, nazwa użytkownika nowego właściciela grupy

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

remove_group_users

Usuwa użytkownika z grupy.

remove_group_users(self, user_names, group_id)

Argumenty

Parametr	Opis
user_names	Wymagany ciąg znakowy, rozdzielana przecinkami lista użytkowników
group_id	Wymagany ciąg znakowy, unikalny identyfikator grupy

Wartość zwracana

Słownik z kluczem notRemoved, który wskazuje, że użytkownicy z listy nie zostali usunięci.

reset_user

Resetuje wartości hasła, pytania weryfikacyjnego i odpowiedzi na pytanie weryfikacyjne powiązane z danym użytkownikiem. Ta funkcja nie ma zastosowania w przypadku portali, dla których skonfigurowano konta pobrane z korporacyjnego systemu przechowywania tożsamości, takiego jak Active Directory lub LDAP. Ma ona zastosowanie wyłącznie do wbudowanych kont użytkowników portalu. Jeżeli określone zostanie nowe pytanie weryfikacyjne, należy podać na nie nową odpowiedź.

reset_user(self, username, password, new_password=None, new_security_question=None, new_security_answer=None)

Argumenty

Parametr	Opis
username	Wymagany ciąg znakowy, konto, które zostanie zresetowane
hasło	Wymagany ciąg znakowy, bieżące hasło
new_password	Opcjonalny ciąg znakowy, nowe hasło w przypadku resetowania hasła
new_security_question	Opcjonalna liczba całkowita, nowe pytanie weryfikacyjne, jeśli ma być używane
new_security_answer	Opcjonalny ciąg znakowy, nowa odpowiedź na pytanie weryfikacyjne, jeśli ma ono być używane

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

szukaj

search(self, q, bbox=None, sort_field='title', sort_order='asc', max_results=1000, add_org=True)

search_groups

Wyszukiwanie grup w portalu. W przypadku korzystania z tej metody należy wziąć pod uwagę następujące kwestie:

• Składnia zapytania ma wiele funkcji, które nie są omawiane w tym miejscu. Aby przejrzeć wszystkie funkcje, zapoznaj się z sekcją Wyszukiwanie — szczegółowe informacje w interfejsie ArcGIS REST API.
• Podczas wyszukiwania grup przeszukiwanie najczęściej jest wykonywane w obrębie instytucji. Dla większej wygody użytkowania metoda ta domyślnie dołącza automatycznie identyfikator instytucji do zapytania. Jeżeli nie chcesz, aby ten element był dodawany do zapytania, nadaj parametrowi add_org wartość false.

search_groups(self, q, sort_field='title', sort_order='asc', max_groups=1000, add_org=True)

Argumenty

Parametr	Opis
q	Wymagany ciąg znakowy, ciąg zapytania
sort_field	Opcjonalny ciąg znakowy, dostępne wartości to title, owner lub created
sort_order	Opcjonalny ciąg znakowy, dostępne wartości to asc (rosnąco) lub desc (malejąco)
max_groups	Opcjonalna liczba całkowita, maksymalna liczba zwróconych grup
add_org	Opcjonalna wartość logiczna (Boolean), określa, czy wyszukiwanie ma być przeprowadzane w obrębie instytucji

Wartość zwracana

Lista słowników. Każdy słownik zawiera następujące klucze:

Klucz	Wartość
dostęp	Ciąg znakowy, dostępne wartości to: private (prywatny), org (instytucja) lub public (publiczny)
utworzone	Liczba całkowita, czas utworzenia konta, w sekundach od 1 stycznia 1970
opis	Ciąg znakowy
identyfikator	Ciąg znakowy, unikalny identyfikator grupy
isInvitationOnly	Wartość logiczna
isViewOnly	Wartość logiczna
modified	Liczba całkowita, czas od ostatniej modyfikacji konta, w sekundach od 1 stycznia 1970
właściciel	Ciąg znakowy, nazwa użytkownika właściciela
telefon	Ciąg znakowy
ekstrakt	Ciąg znakowy, krótkie podsumowanie grupy
sortField	Ciąg znakowy, sposób sortowania elementów udostępnionych
sortOrder	Ciąg znakowy, kolejność sortowania, rosnąco lub malejąco
znaczniki	Lista ciągów znakowych, podane przez użytkownika znaczniki używane w wyszukiwaniu
thumbnail	Ciąg znakowy, nazwa pliku; jest dołączana do ścieżki http://<community url>/groups/<group id>/info/
tytuł	Ciąg znakowy, nazwa grupy widoczna dla użytkowników

search_users

Wyszukiwanie użytkowników w portalu. W przypadku korzystania z tej metody należy wziąć pod uwagę następujące kwestie:

• Składnia zapytania ma wiele funkcji, które nie są omawiane w tym miejscu. Aby przejrzeć wszystkie funkcje, zapoznaj się z sekcją Search reference w interfejsie ArcGIS REST API.
• Podczas wyszukiwania użytkowników przeszukiwanie najczęściej jest wykonywane w obrębie instytucji. Dla większej wygody użytkowania metoda ta domyślnie dołącza automatycznie identyfikator instytucji do zapytania. Jeżeli nie chcesz, aby ten element był dodawany do zapytania, nadaj parametrowi add_org wartość false.

search_users(self, q, sort_field='username', sort_order='asc', max_users=1000, add_org=True)

Argumenty

Parametr	Opis
q	Wymagany ciąg znakowy, ciąg zapytania
sort_field	Opcjonalny ciąg znakowy, dostępne wartości to title, owner lub created
sort_order	Opcjonalny ciąg znakowy, dostępne wartości to asc (rosnąco) lub desc (malejąco)
max_users	Opcjonalna liczba całkowita, maksymalna liczba zwróconych użytkowników
add_org	Opcjonalna wartość logiczna (Boolean), określa, czy wyszukiwanie ma być przeprowadzane w obrębie instytucji

Wartość zwracana

Lista słowników. Każdy słownik zawiera następujące klucze:

Klucz	Wartość
utworzone	Liczba całkowita, czas utworzenia konta, w sekundach od 1 stycznia 1970
culture	Ciąg znakowy, dwuliterowy kod języka
opis	Ciąg znakowy
fullName	Ciąg znakowy, nazwa danego użytkownika
modified	Liczba całkowita, czas od ostatniej modyfikacji konta, w sekundach od 1 stycznia 1970
region	Ciąg znakowy, może mieć wartość none
znaczniki	Lista ciągów znakowych, podane przez użytkownika znaczniki używane w wyszukiwaniu
thumbnail	Ciąg znakowy, nazwa pliku; jest dołączana do ścieżki http://<community url>/groups/<group id>/info/.
username	Ciąg znakowy, nazwa danego użytkownika

signup

Loguje użytkowników w oprogramowaniu Portal for ArcGIS. Ta metoda ma zastosowanie wyłącznie w oprogramowaniu Portal for ArcGIS i można ją wywoływać anonimowo. Jednak można również wyłączyć funkcję automatycznego logowania. Metoda ta umożliwia tworzenie wyłącznie kont wbudowanych; nie obsługuje ona kont korporacyjnych pozyskanych z korporacyjnego magazynu tożsamości.

Dostępna jest również inna metoda o nazwie createUser, której zawsze można użyć w oprogramowaniu Portal for ArcGIS w wersji 10.2.1 lub nowszej. Metoda wymaga uzyskania dostępu z poziomu konta administratora i może być używana do tworzenia kont użytkowników wbudowanych lub korporacyjnych.

signup(self, username, password, fullname, email)

Argumenty

Parametr	Opis
username	Wymagany ciąg znakowy, musi to być unikalna wartość w portalu składająca się z ponad 4 znaków
hasło	Wymagany ciąg znakowy, musi mieć co najmniej 8 znaków
fullname	Wymagany ciąg znakowy, nazwa danego użytkownika
email	Wymagany ciąg znakowy, musi to być prawidłowy adres e-mail

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

update_group

Aktualizuje grupę. Konieczne jest podanie wyłącznie wartości argumentów, które mają zostać zaktualizowane.

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)

Argumenty

Parametr	Opis
group_id	Wymagany ciąg znakowy, identyfikator grupy, który zostanie zmodyfikowany
tytuł	Wymagany ciąg znakowy, nazwa grupy, która zostanie zmodyfikowana
znaczniki	Wymagany ciąg znakowy, lista rozdzielanych przecinkami znaczników
opis	Opcjonalny ciąg znakowy, szczegółowy opis grupy
ekstrakt	Opcjonalny ciąg znakowy, podsumowanie grupy składające się z maksymalnie 250 znaków
dostęp	Opcjonalny ciąg znakowy, może mieć wartość private (prywatny), public (publiczny) lub org (instytucja)
thumbnail	Opcjonalny ciąg znakowy, adres URL obrazu grupy
isInvitationOnly	Opcjonalna wartość logiczna (Boolean), określa, czy użytkownicy mogą przyłączać się poprzez wysłanie wniosku
sort_field	Opcjonalny ciąg znakowy, określa sposób sortowania elementów udostępnionych grupie
sort_order	Opcjonalny ciąg znakowy, kolejność sortowania: asc, czyli rosnąco, lub desc, czyli malejąco
is_view_only	Opcjonalna wartość logiczna (Boolean), określa, czy grupę można przeszukiwać

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

update_user

Aktualizuje właściwości użytkownika. Konieczne jest podanie wyłącznie tych wartości argumentów, które mają zostać zaktualizowane.

update_user(self, username, access=None, preferred_view=None, description=None, tags=None, thumbnail=None, fullname=None, email=None, culture=None, region=None)

Argumenty

Klucz	Wartość
username	Wymagany ciąg znakowy, nazwa użytkownika, którego właściwości zostaną zaktualizowane
dostęp	Opcjonalny ciąg znakowy, wartości: private, org, public
preferred_view	Opcjonalny ciąg znakowy, wartości: Web, GIS, null
opis	Opcjonalny ciąg znakowy, opis użytkownika
znaczniki	Opcjonalny ciąg znakowy, rozdzielone przecinkami znaczniki używane podczas wyszukiwania
thumbnail	Opcjonalny ciąg znakowy, ścieżka pliku lub jego adres URL; dostępne formaty to: PNG, GIF lub JPEG; maksymalny rozmiar pliku wynosi 1 MB
fullName	Opcjonalny ciąg znakowy; nazwa danego użytkownika, dotyczy tylko wbudowanych kont użytkowników
email	Opcjonalny ciąg znakowy; adres e-mail, dotyczy tylko wbudowanych użytkowników
culture	Opcjonalny ciąg znakowy, dwuliterowy kod języka, na przykład fr
region	Opcjonalny ciąg znakowy, dwuliterowy kod kraju, na przykład FR

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.

update_user_role

Aktualizuje rolę użytkownika.

update_user_role(self, username, role)

Argumenty

Klucz	Wartość
username	Wymagany ciąg znakowy, nazwa użytkownika, którego rola zostanie zmieniona
role	Wymagany ciąg znakowy, jedna z wartości user, publisher, admin, <identyfikator_roli_niestandardowej> (gdzie <identyfikator_roli_niestandardowej> oznacza identyfikator roli niestandardowej, na przykład 1eo7LSAhbNiG1q9t, którą można znaleźć w rolach w udostępnianej lokalizacji aplikacji ArcGIS Portal Directory. Adres URL ma format https://webadaptorhost.domain.com/<webadaptorname>/sharing/portals/0123456789ABCDEF/roles). Wcześniejsze: W oprogramowaniu Portal for ArcGIS w wersji 10.3 i w wersjach wcześniejszych akceptowane były następujące wartości ról niestandardowych: org_user, org_publisher oraz org_admin. W wersji 10.3.1 te wartości stały się nieaktualne i zostały zastąpione wymienionymi wyżej wartościami. W wersji 10.3.1 nadal można używać wcześniejszych wartości, ale należy pamiętać, że mogą one nie być akceptowane w przyszłych wersjach.

Wartość zwracana

Wartość logiczna (Boolean) określająca, czy operacja została zakończona pomyślnie.