Skip To Content

PortalPy 모듈

이 도움말 항목은 Portal for ArcGIS에 대한 관리 스크립트를 쓰는 데 사용할 수 있는 PortalPy 모듈의 모든 클래스와 메소드를 나열합니다.

Class: Portal

포털 연결 URL을 나타내는 개체입니다. 포털 개체를 인스턴스화하려면 다음과 같이 코드를 실행합니다.

PortalPy.Portal(portalUrl, user, password)

사용 가능한 포털 메소드가 아래 섹션에 나와 있습니다. 메소드로 작업하기 전에 다음 사항을 고려합니다.

  • 그룹 ID - 대부분의 그룹 기능에는 그룹 ID가 필요합니다. ID는 그룹 이름이나 제목이 아닙니다. 그룹 ID를 결정하려면 search_groups 함수를 사용하고 제목을 지정해 그룹 ID를 가져옵니다.
  • 시간 - 대부분의 메소드는 시간 필드를 반환합니다. 모든 시간 필드가 1970년 1월 1일부터 밀리초로 반환합니다. Python은 1970년 1월 1일부터 초 단위의 시간을 예상하므로 PortalPy에서 1,000으로 시간을 나눕니다. 다음 예는 PortalPy 시간을 Python 시간으로 변환하는 방법을 보여 줍니다.
    group = portalAdmin.get_group('67e1761068b7453693a0c68c92a62e2e')
    pythontime = time.ctime(group['created']/1000)

PortalPy 메소드

사용 가능한 포털 메소드는 아래에 설명되어 있습니다.

_init_

포털 생성자입니다. 포털 URL과 선택적으로 사용자 이름과 비밀번호가 필요합니다.

_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

지정한 그룹에 사용자를 추가합니다. 이 메소드는 포털 개체에 대한 사용자가 전체 포털의 관리자거나 그룹의 분명한 소유자인 경우에만 사용합니다.

add_group_users(self, user_names, group_id)

인수

매개변수설명

user_names

필수 문자열, 쉼표로 구분된 사용자

group_id

필수 문자열, 그룹 ID 지정

반환 값

그룹에 추가되지 않은 사용자를 포함하는 not_added 키의 사전입니다.

create_group

그룹을 정상적으로 생성하면 그룹 ID를 반환합니다.

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)

인수

매개변수설명

title

필수 문자열, 그룹 이름

tags

필수 문자열, 쉼표로 구분된 태그 목록

description

선택적 문자열, 그룹을 자세하게 설명

snippet

선택적 문자열, 그룹을 요약하는 250자 미만 문자열

access

선택적 문자열, private, public 또는 org일 수 있음

thumbnail

선택적 문자열, 그룹 이미지 URL

isInvitationOnly

선택적 불린(Boolean), 사용자가 요청하여 참여할 수 있는지 여부 정의

sort_field

선택적 문자열, 그룹과 공유 항목 정렬 방식 지정

sort_order

선택적 문자열, 오름차순의 경우 asc, 내림차순의 경우 desc

is_view_only

선택적 불린(Boolean), 그룹의 검색 가능 여부 정의

반환 값

그룹 ID인 문자열입니다.

create_group_from_dict

그룹을 정상적으로 생성하면 그룹 ID를 반환합니다. 대부분의 경우 create_group 메소드는 다른 PortalPy 호출에서 반환된 그룹 사전을 사용해 복사할 수 있으므로 이 메소드를 대신 사용하는 것이 좋습니다.

create_group_from_dict(self, group, thumbnail=None)

인수

매개변수설명

group

사전 개체

thumbnail

이미지 URL

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

delete_group

그룹을 삭제합니다.

delete_group(self, group_id)

인수

매개변수설명

group_id

삭제된 그룹에 대한 ID를 포함하는 문자열입니다.

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

delete_user

포털에서 사용자를 삭제하고 선택적으로 그룹과 항목을 삭제하거나 다시 할당합니다. 포털에서 그룹이나 항목을 소유한 사용자를 삭제할 수 없습니다. 계단식으로 배열하도록 선택하면 이 항목과 그룹은 reassign_to 옵션에서 식별된 사용자에게 다시 할당됩니다. 계단식으로 배열하지 않도록 선택하면 사용자의 항목과 그룹이 이전에 전송되었는지 여부에 따라 삭제에 성공하거나 실패합니다.

계단식으로 배열 시 이 메소드는 최대 10,000개의 항목을 삭제합니다. 사용자가 10,000개가 넘는 항목을 가진 경우 이 메소드는 실패합니다.

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

인수

매개변수설명

username

필수 문자열, 사용자 이름

cascade

선택적 불린(Boolean), true는 항목 및 그룹을 다시 할당하는 것을 의미

reassign_to

선택적 문자열, 항목 및 그룹의 새 소유자

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

generate_token

새 토큰을 생성하고 반환하지만 다시 로그인하지 않습니다.이 메소드는 포털 클래스를 사용하여 포털을 호출할 때는 필요하지 않습니다. 포털 클래스를 사용하지 않고 포털을 호출하는 이점을 제공하기 때문입니다.

포털은 사용자가 자격 증명을 제공하고 호출에 단기 토큰이 사용되는 토큰 기반 인증 메커니즘을 사용합니다. ArcGIS REST API에 대해 이루어지는 대부분의 호출에는 토큰이 필요하며 해당 요청에 토큰이 추가될 수 있습니다.

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

인수

매개변수설명

username

필수 문자열, 사용자 이름

password

필수 비밀번호, 사용자 비밀번호

expiration

선택적 정수, 토큰이 만료될 때까지의 분 수

반환 값

토큰이 있는 문자열입니다.

get_group

지정한 group_id에 대한 그룹 정보를 반환합니다.

get_group(self, group_id)

인수

매개변수설명

group_id

필수 문자열, 그룹 표시

반환 값

그룹 정보를 포함한 사전 개체입니다. 사전 개체의 키는 다음을 포함할 수 있습니다.

매개변수설명

title

그룹 이름

isInvitationOnly

true로 설정하면 사용자는 그룹 참여를 신청할 수 없습니다.

owner

소유자의 그룹 사용자 이름

description

그룹 설명

snippet

그룹의 짧은 요약

tags

그룹을 설명하는 사용자 정의 태그

phone

그룹에 대한 연락처 정보

thumbnail

http://<community-url>/groups/<groupId>/info와 관련된 파일 이름

created

그룹이 생성된 시간(1970년 1월 1일 이후 밀리초)

modified

그룹이 마지막으로 수정된 시간(1970년 1월 1일 이후 밀리초)

access

private, org 또는 public일 수 있음

userMembership

username 및 memberType 키가 있는 사전

memberType

호출 사용자 접근 권한(owner, admin, member, none)을 제공합니다.

get_group_members

지정한 그룹의 구성원을 반환합니다.

get_group_members(self, group_id)

인수

매개변수설명

group_id

필수 문자열, 그룹 표시

반환 값

owner, admins, users 키가 있는 사전

매개변수설명

owner

문자열 값, 그룹 소유자

admins

문자열 목록, 일반적으로 소유자와 같음

users

문자열 목록, 그룹 구성원

그룹의 사용자를 인쇄합니다.

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

get_group_thumbnail

지정한 group_id에 대한 섬네일을 구성하는 바이트를 반환합니다.

get_group_thumbnail(self, group_id)

인수

매개변수설명

group_id

필수 문자열, 그룹의 섬네일 지정

반환 값

이미지를 나타내는 바이트입니다.

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

get_users

포털 기관 내 모든 사용자를 반환합니다.

get_users(self, max_users=1000)

인수

매개변수설명

max_users

선택적 정수, 반환할 최대 사용자 수

반환 값

사전 목록입니다. 각 사전에는 다음 키가 있습니다.

username

문자열

storageUsage

정수

storageQuota

정수

description

문자열

tags

문자열 목록

region

문자열

created

정수, 계정이 생성된 시간(1970년 1월 1일 이후 밀리초)

modified

정수, 계정이 마지막으로 수정된 시간(1970년 1월 1일 이후 밀리초)

email

문자열

culture

문자열

orgId

문자열

preferredView

문자열

groups

문자열 목록

role

문자열(user, publisher, admin, <custom_role_name> [여기서 <custom_role_name>은 hostedservicepublisher 같은 사용자 정의 역할의 이름])

기존:

Portal for ArcGIS 10.3 이전 버전에서의 사용자 정의 역할 이외의 역할은 org_user, org_publisher, org_admin입니다. 10.3.1에서는 이러한 값이 사용되지 않고 위에 나열된 값으로 대체됩니다. 10.3.1에서는 기존의 값을 계속 사용할 수 있지만 향후 릴리스에서는 값이 수락되지 않을 수 있습니다.

fullName

문자열

thumbnail

문자열

idpUsername

문자열

포털의 모든 사용자 이름을 인쇄합니다.

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

get_properties

force=True가 아니면 캐시를 사용하여 포털의 등록정보를 반환합니다.

get_properties(self, force=False)

get_user

지정한 사용자 이름에 대한 사용자 정보를 반환합니다.

get_user(self, username)

인수

매개변수설명

username

필수 문자열, 정보를 원하는 사용자 이름

반환 값

사용자가 발견되면 다음 키가 있는 사전 개체를 반환합니다. 사용자가 발견되지 않으면 아무 것도 반환하지 않습니다.

access

문자열

created

정수, 계정이 생성된 시간(1970년 1월 1일 이후 밀리초)

culture

문자열, 두 자리 언어 코드(en)

description

문자열

email

문자열

fullName

문자열

idpUsername

문자열, 엔터프라이즈 시스템의 사용자 이름

그룹

사전 목록입니다. 사전 키 목록은 get_group을 참고하세요.

modified

정수, 계정이 마지막으로 수정된 시간(1970년 1월 1일 이후 밀리초)

orgId

문자열, 기관 ID

preferredView

문자열, 값은 Web, GIS 또는 null

region

문자열, 없음 또는 두 자리 지역 코드

role

문자열(user, publisher, admin, <custom_role_name> [여기서 <custom_role_name>은 hostedservicepublisher 같은 사용자 정의 역할의 이름])

기존:

Portal for ArcGIS 10.3 이전 버전에서의 사용자 정의 역할 이외의 역할은 org_user, org_publisher, org_admin입니다. 10.3.1에서는 이러한 값이 사용되지 않고 위에 나열된 값으로 대체됩니다. 10.3.1에서는 기존의 값을 계속 사용할 수 있지만 향후 릴리스에서는 값이 수락되지 않을 수 있습니다.

storageUsage

정수

storageQuota

정수

tags

문자열 목록

thumbnail

문자열

username

문자열

get_version

force=True가 아니면 캐시를 사용하여 소프트웨어 버전 번호를 반환합니다. 버전 정보는 포털 개체를 생성할 때 가져온 후 나중 요청을 위해 캐시됩니다. 포털에 요청하고 캐시에 의존하지 않으려면 force 인수를 True로 설정합니다.

get_version(self, force=False)

인수

매개변수설명

force

불린(Boolean), true=요청, false=캐시 사용

반환 값

버전이 있는 문자열입니다. 버전은 내부 번호로, 설치한 제품 버전과 일치하지 않을 수 있습니다.

invite_group_users

사용자를 그룹에 초대합니다. 그룹에 초대된 사용자는 포털의 그룹 탭에서 초대 목록을 볼 수 있습니다. 사용자는 초대를 수락하거나 거부할 수 있습니다. 커맨드를 실행하는 사용자는 그룹 소유자여야 합니다.

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

인수

매개변수설명

user_names

필수 문자열, 쉼표로 구분된 초대할 사용자 목록

group_id

필수 문자열, 사용자를 초대할 그룹 ID 지정

role

선택적 문자열, group_member 또는 group_admin

expiration

선택적 정수, 초대 유효 기간(분) 지정

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

is_all_ssl

포털이 HTTPS를 필요로 하면 true를 반환합니다.

is_all_ssl(self)

is_logged_in

사용자가 포털에 로그인되어 있으면 true를 반환합니다.

is_logged_in(self)

is_org

포털이 기관이면 true를 반환합니다.

is_org(self)

leave_group

지정한 그룹에서 로그인한 사용자를 제거합니다. 이 메소드를 사용하려면 사용자가 로그인해야 합니다.

leave_group(self, group_id)

인수

매개변수설명

group_id

필수 문자열, 그룹 ID 지정

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

logged_in_user

로그인한 사용자에 관한 정보를 반환합니다.

logged_in_user(self)

반환 값

다음 키가 있는 사전:

username

문자열

storageUsage

정수

description

문자열

tags

쉼표로 구분된 문자열

created

정수, 계정이 생성된 시간(1970년 1월 1일 이후 밀리초)

modified

정수, 계정이 마지막으로 수정된 시간(1970년 1월 1일 이후 밀리초)

fullName

문자열

email

문자열

idpUsername

문자열, 엔터프라이즈 시스템의 사용자 이름

로그인

사용자 이름과 비밀번호를 사용하여 포털에 로그인합니다. 포털 개체를 생성할 때 포털에 로그인하거나 나중에 로그인할 수 있습니다. 이 함수는 나중에 로그인하기 위해 사용합니다.

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

인수

매개변수설명

username

필수 문자열

password

필수 문자열

expiration

선택적 정수, 생성된 토큰 지속 기간

반환 값

토큰을 포함한 문자열입니다.

logout

포털에서 로그아웃합니다. 사용하던 기존 토큰이 사라지고 다른 로그인 호출이 발생할 때까지 모든 후속 포털 호출이 익명으로 처리됩니다.

logout(self)

반환 값

반환 값이 없습니다.

reassign_group

다른 소유자에게 그룹을 다시 할당합니다.

reassign_group(self, group_id, target_owner)

인수

매개변수설명

group_id

필수 문자열, 그룹에 대한 고유 식별자

target_owner

필수 문자열, 새 그룹 소유자의 사용자 이름

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

remove_group_users

그룹에서 사용자를 제거합니다.

remove_group_users(self, user_names, group_id)

인수

매개변수설명

user_names

필수 문자열, 쉼표로 구분된 사용자 목록

group_id

필수 문자열, 그룹에 대한 고유 식별자

반환 값

제거되지 않은 사용자 목록을 나타내는 notRemoved 키가 있는 사전입니다.

reset_user

사용자 비밀번호, 보안 질문, 보안 답변을 재설정합니다. 이 함수는 ActiveDirectory 또는 LDAP 같은 엔터프라이즈 ID 저장소의 계정으로 구성한 포털에는 적용되지 않습니다.. 빌트인 포털 사용자에게만 적용됩니다. 새 보안 질문이 지정되면 새 보안 답변이 제공됩니다.

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

인수

매개변수설명

username

필수 문자열, 재설정되는 계정

password

필수 문자열, 현재 비밀번호

new_password

선택적 문자열, 비밀번호가 재설정되는 경우 새 비밀번호

new_security_question

선택적 정수, 필요한 경우 새 보안 질문

new_security_answer

선택적 문자열, 필요한 경우 새 보안 답변

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

search

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

search_groups

포털 그룹을 검색합니다. 이 메소드를 사용할 때 다음 사항을 고려합니다.

  • 쿼리 구문에는 여기에서 설명되지 않은 많은 기능이 있습니다. 모든 기능을 검토하려면 ArcGIS REST API에서 검색 참조를 참고하세요.
  • 그룹을 검색할 때는 일반적으로 기관 내에서 검색합니다. 편의를 위해 메소드는 기본 설정에 따라 자동으로 쿼리에 기관 ID를 추가합니다. API에서 쿼리에 추가하지 않도록 하려면 add_org를 false로 설정합니다.

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

인수

매개변수설명

q

필수 문자열, 쿼리 문자열

sort_field

선택적 문자열, 유효한 값은 title, owner 또는 created가 될 수 있음

sort_order

선택적 문자열, 유효한 값은 asc 또는 desc

max_groups

선택적 정수, 반환된 그룹의 최대 수

add_org

선택적 불린(Boolean), 기관 내 검색 여부 제어

반환 값

사전 목록입니다. 각 사전에는 다음 키가 있습니다.

access

문자열, 값은 private, org 또는 public

created

정수, 계정이 생성된 시간(1970년 1월 1일 이후 밀리초)

description

문자열

ID

문자열, 그룹에 대한 Unique ID

isInvitationOnly

불린(Boolean)

isViewOnly

불린(Boolean)

modified

정수, 계정이 마지막으로 수정된 시간(1970년 1월 1일 이후 밀리초)

소유자

문자열, 소유자의 사용자 이름

phone

문자열

snippet

문자열, 그룹의 짧은 요약

sortField

문자열, 공유 항목 정렬 방식

sortOrder

문자열, 오름차순 또는 내림차순

tags

문자열 목록, 검색에 대해 사용자가 제공한 태그

thumbnail

문자열, 파일 이름. http://<community url>/groups/<group id>/info/에 추가

title

문자열, 사용자에게 보이는 그룹 이름

search_users

포털 사용자를 검색합니다. 이 메소드를 사용할 때 다음 사항을 고려합니다.

  • 쿼리 구문에는 여기에서 설명되지 않은 많은 기능이 있습니다. 모든 기능을 검토하려면 ArcGIS REST API에서 Search reference을(를) 참고하세요.
  • 사용자를 검색할 때는 일반적으로 기관 내에서 검색합니다. 편의를 위해 메소드는 기본 설정에 따라 자동으로 쿼리에 기관 ID를 추가합니다. API에서 쿼리에 추가하지 않도록 하려면 add_org를 false로 설정합니다.

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

인수

매개변수설명

q

필수 문자열, 쿼리 문자열

sort_field

선택적 문자열, 유효한 값은 title, owner 또는 created가 될 수 있음

sort_order

선택적 문자열, 유효한 값은 asc 또는 desc

max_users

선택적 정수, 반환된 사용자의 최대 수

add_org

선택적 불린(Boolean), 기관 내 검색 여부 제어

반환 값

사전 목록입니다. 각 사전에는 다음 키가 있습니다.

created

정수, 계정이 생성된 시간(1970년 1월 1일 이후 밀리초)

culture

문자열, 두 자리 언어 코드

description

문자열

fullName

문자열, 사용자 이름

modified

정수, 계정이 마지막으로 수정된 시간(1970년 1월 1일 이후 밀리초)

region

문자열, none이 될 수 있음

tags

문자열 목록, 검색에 대해 사용자가 제공한 태그

thumbnail

문자열, 파일 이름. http://<community url>/groups/<group id>/info/에 추가합니다.

username

문자열, 사용자 이름

signup

Portal for ArcGIS에 사용자를 등록합니다. 이 메소드는 Portal for ArcGIS에만 적용되고 익명으로 호출할 수 있습니다. 그러나 포털에서 셀프 등록을 비활성화할 수도 있습니다. 또한 빌트인 계정만 생성하며, 엔터프라이즈 ID 저장소의 엔터프라이즈 계정으로는 작동하지 않습니다.

항상 Portal for ArcGIS 10.2.1 이후 버전에서 사용할 수 있는 createUser라는 또 다른 메소드가 있습니다. 이 메소드는 관리자 접근 권한이 필요하고 빌트인 사용자를 생성하거나 포털에 엔터프라이즈 계정을 추가하는 데 사용할 수 있습니다.

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

인수

매개변수설명

username

필수 문자열, 포털에서 고유하고 5자 이상이어야 함

password

필수 문자열, 8자 이상이어야 함

fullname

필수 문자열, 사용자 이름

email

필수 문자열, 유효한 이메일 주소여야 함

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

update_group

그룹을 업데이트합니다. 업데이트할 인수에 대한 값만 제공해야 합니다.

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)

인수

매개변수설명

group_id

필수 문자열, 수정할 그룹 ID

title

필수 문자열, 수정할 그룹 이름

tags

필수 문자열, 쉼표로 구분된 태그 목록

description

선택적 문자열, 그룹을 자세하게 설명

snippet

선택적 문자열, 그룹을 요약하는 250자 미만 문자열

access

선택적 문자열, private, public 또는 org일 수 있음

thumbnail

선택적 문자열, 그룹 이미지 URL

isInvitationOnly

선택적 불린(Boolean), 사용자가 요청하여 참여할 수 있는지 여부 정의

sort_field

선택적 문자열, 그룹과 공유 항목 정렬 방식 지정

sort_order

선택적 문자열, 오름차순의 경우 asc, 내림차순의 경우 desc

is_view_only

선택적 불린(Boolean), 그룹의 검색 가능 여부 정의

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

update_user

사용자의 등록정보를 업데이트합니다. 업데이트할 인수에 대한 값만 제공합니다.

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

인수

username

필수 문자열, 업데이트할 사용자 이름

access

선택적 문자열, 값: private, org, public

preferred_view

선택적 문자열, 값: Web, GIS, null

설명

선택적 문자열, 사용자 설명

태그

선택적 문자열, 검색을 위한 쉼표로 구분된 태그

섬네일

선택적 문자열, 파일에 대한 경로 또는 URL. PNG, GIF 또는 JPEG가 될 수 있습니다. 최대 크기는 1MB입니다.

fullName

선택적 문자열, 사용자 이름, 빌트인 사용자 전용

이메일

선택적 문자열, 이메일 주소, 빌트인 사용자 전용

문화

선택적 문자열, 두 자리 언어 코드(예: fr)

지역

선택적 문자열, 두 자리 지역 코드(예: FR)

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.

update_user_role

사용자 역할을 업데이트합니다.

update_user_role(self, username, role)

인수

username

필수 문자열, 역할이 변경되는 사용자 이름

역할

필수 문자열(user, publisher, admin, <custom_role_ID> (여기서 <custom_role_ID>는 ArcGIS Portal Directory 공유 위치의 roles 디렉터리에서 찾아볼 수 있는 1eo7LSAhbNiG1q9t 같은 사용자 정의 역할의 ID이며, 공유 위치의 URL은 https://webadaptorhost.domain.com/<webadaptorname>/sharing/portals/0123456789ABCDEF/roles 형식입니다.))

기존:

Portal for ArcGIS 10.3 이전 버전에서의 사용자 정의 역할 이외의 역할은 org_user, org_publisher, org_admin입니다. 10.3.1에서는 이러한 값이 사용되지 않고 위에 나열된 값으로 대체됩니다. 10.3.1에서는 기존의 값을 계속 사용할 수 있지만 향후 릴리스에서는 값이 수락되지 않을 수 있습니다.

반환 값

불린(Boolean)은 작업에 성공했는지 또는 실패했는지를 나타냅니다.