예: 포털에 구성원 추가

이 예에서는 사용자에 관한 정보가 있는 입력 텍스트 파일을 사용하여 포털에 일괄적으로 구성원을 추가합니다. 포털에서 각 사용자에 대한 역할을 정의하고 부여합니다.

스크립트를 실행할 때 필요한 다음 정보를 입력합니다.

• 사용자 정보를 포함하는 텍스트 파일 경로(예: /home/admin/documents/users.txt)
• 포털에 추가하려는 사용자 유형(예: 빌트인 또는 엔터프라이즈). 사용자 유형에 대해 자세히 알아보려면 포털에 대한 접근 관리를 참고하세요.
• 포털을 호스팅하는 머신의 정규화된 도메인 이름(예: myportal.acme.com). 스크립트는 ArcGIS Web Adaptor를 무시하고 포트 7443에서 HTTPS를 통해 포털에 접근합니다. 이런 방법으로 스크립트는 포털이 웹 티어 인증을 사용하도록 구성되어 있어도 해당 인증을 처리할 필요가 없습니다.
• 포털에 대한 관리 권한을 가진 계정의 사용자 이름과 비밀번호. 빌트인 계정을 추가하는 경우 관리 권한이 있는 포털 구성원의 자격 증명을 제공합니다. 엔터프라이즈 계정을 추가하는 경우 Portal for ArcGIS 설치 후 생성된 초기 관리자 계정을 사용합니다.

참고 사항:

Python 스크립트가 웹 티어 인증을 처리하는 방법은 이 예에서 설명되지 않습니다.

엔터프라이즈 계정 등록

엔터프라이즈 계정을 등록할 때 텍스트 파일에 있는 각 항목의 형식은 다음과 같습니다.

<login>|<email address>|<name>|<role>|<description>|<Idp UserName>

• login - 등록할 엔터프라이즈 로그인입니다.

  • Active Directory를 사용하면 이 로그인은 sAMAccountName@DOMAIN 형식입니다. 도메인 이름은 모두 대문자여야 합니다.
  • LDAP를 사용하는 경우 로그인은 ID 저장소 구성 시 지정한 userNameAttribute 값과 일치합니다.
  • SAML 기반 엔터프라이즈 로그인을 사용하는 경우 지정된 로그인 값은 SAML ID 공급자의 NameID 속성과 일치합니다.

• email address - 로그인과 연결된 이메일 주소로, ID 저장소의 값과 일치합니다. 사용자 계정에 이메일 주소가 포함되지 않은 경우 false 또는 일반 값을 제공하세요.

• name - ArcGIS 기관에서 사용되는 로그인에 대한 별칭입니다. 대부분의 ID 저장소에서는 사용자의 전체 이름을 기본 별칭으로 사용합니다. 사용자가 포털 웹 사이트에 연결되면 웹 사이트 상단에 이 이름이 표시됩니다.

• role - ArcGIS 기관에서 엔터프라이즈 로그인에 부여되는 역할입니다. 올바른 역할 값은 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에서는 기존의 값을 계속 사용할 수 있지만 향후 릴리스에서는 값이 수락되지 않을 수 있습니다.

• description - 필요한 경우 계정을 설명하는 텍스트를 포함합니다. 이 값은 ID 저장소의 어떠한 속성에도 해당하지 않습니다. 설명은 250자를 초과할 수 없습니다.

• Idp UserName - 필요한 경우 ID 공급자에서 엔터프라이즈 계정의 사용자 이름을 지정합니다. 이 값이 제공되지 않으면 로그인 매개변수에 대해 지정된 값이 대신 사용됩니다.

login, email address, name 및 role 값을 제공해야 합니다. description 및 ldp UserName은 선택 사항입니다. 파일에 나열된 각 계정에 대해 login, email address 및 name에 입력한 값이 ID 저장소의 값과 정확히 일치하는지 확인하세요. 포털은 ID 저장소에 연결하여 이러한 값의 유효성을 검사하지 않습니다.

다음은 Active Directory 엔터프라이즈 계정을 등록하는 입력의 한 예로 로그인은 jcho111, 이메일 주소가 [e-mail]이고 전체 이름이 Jon Cho입니다. 이 로그인은 사용자 역할 user에 배치되고 department b의 사용자라고 설명합니다.

jcho111@DOMAIN|[e-mail]|Jon Cho|user|department b

다음은 SAML ID 공급자에서 엔터프라이즈 계정을 등록하는 입력의 예입니다. 사용자 로그인은 [e-mail]이고, 이메일 주소는 [e-mail]이며 전체 이름은 Robert Smith입니다. 이 로그인은 Idp 사용자 이름이 [e-mail]인 발행자 역할 publisher에 배치됩니다.

[e-mail]|[e-mail]|Robert Smith|publisher||[e-mail]

다음은 이메일 주소가 [e-mail]이고 전체 이름이 Sara James인 로그인 sjames4513에 대한 LDAP 엔터프라이즈 계정을 등록하는 입력의 예입니다. 이 로그인은 사용자 역할 admin에 배치되고 설명이 제공됩니다.

sjames4513@DOMAIN|[e-mail]|Sara James|admin|Department Lead and GIS Manager

다음은 이메일 주소가 [e-mail]이고 전체 이름이 Satish Rajhandas인 로그인 srajhandas에 대한 엔터프라이즈 계정을 등록하는 입력의 예입니다. 이 로그인은 사용자 역할 user에 배치됩니다.

srajhandas@DOMAIN|[e-mail]|Satish Rajhandas|user

다음은 SAML ID 공급자에서 엔터프라이즈 계정을 등록하는 입력의 예입니다. 사용자 로그인은 djohnson308이고, 이메일 주소는 [e-mail]이며 전체 이름은 Daisha Johnson입니다. 이 로그인은 사용자 역할 user에 배치되고 설명이 제공되며 Idp 사용자 이름은 [e-mail]으로 정의됩니다.

djohnson308@DOMAIN|[e-mail]|Daisha Johnson|user|Account Specialist|[e-mail]

빌트인 포털 계정 추가

빌트인 포털 계정을 추가할 때 텍스트 파일에 입력되는 각 항목의 형식은 다음과 같습니다.

<username>|<password>|<email address>|<name>|<role>|<description>

• username - 빌트인 계정에 사용되는 사용자 이름입니다. 사용자 이름은 고유해야 하므로 두 명의 구성원이 같은 사용자 이름을 가질 수 없습니다.
• password - 계정에 할당된 비밀번호입니다. 사용자는 포털에 처음 로그인할 때 이 비밀번호를 사용한 다음 프로필을 편집하여 비밀번호를 변경할 수 있습니다.
• email address - 이 계정에 대한 이메일 주소를 제공합니다. 이 매개변수는 필수 항목이므로 유효한 주소가 아닌 경우에도 이메일 주소 값을 제공해야 합니다.
• name - ArcGIS 기관에서 사용되는 계정에 대한 별칭입니다. 사용자가 포털 웹 사이트에 연결되면 포털 웹 사이트 상단에 이 이름이 표시됩니다.
• role - ArcGIS 기관에서 계정의 역할입니다. 올바른 역할 값은 user, publisher, admin, <custom_role_name>입니다. 여기서 <custom_role_name>은 hostedservicepublisher 같은 사용자 정의 역할의 이름입니다.
• description - 필요한 경우 계정을 설명하는 텍스트를 포함합니다. 설명은 250자를 초과할 수 없습니다.

다음은 Barbara Williams에 대한 사용자 이름이 pub1이고 이메일 계정이 [e-mail]인 빌트인 포털 계정을 추가하는 입력의 예입니다. 발행자 역할에도 pub1을 추가합니다.

pub1|changepasswordlater|[e-mail]|Barbara Williams|publisher

다음은 Jon Cho에 대한 사용자 이름이 jcho이고 이메일 계정이 [e-mail]인 빌트인 포털 계정을 추가하는 입력의 예입니다. 관리자 역할에도 jcho를 추가하고 GIS 관리자로 설명합니다.

jcho|changepasswordlater|[e-mail]|Jon Cho|admin|GIS Manager

#!/usr/bin/env python
# Requires Python 2.7+
# Demonstrates how to add users to Portal for ArcGIS in bulk
# For Http calls
import httplib, urllib2, urllib, json
# For system tools
import sys, os
# For reading passwords without echoing
import getpass
# Other utilities
import Queue
# Defines the entry point into the script
def main(argv):
    print "This script adds users in bulk into a portal. \n"
    #Get parameters
    parameters = getParametersFromUser ()
    portalURL = parameters['portalURL']
    provider = parameters['provider']
    userName = parameters['userName']
    password = parameters['password']
    inUserFile = parameters['inUserFile']
    #Get user data from file
    usersData = getUserDataFromFile(inUserFile,provider)
    #Create users
    createUsers (userName,password, portalURL,provider, usersData)
    raw_input('Press ENTER to close the script.')
    return
# This function loads all the user data in the input text file into a Python Queue.
# This usersQueue can be later passed to the createUsers function
def getUserDataFromFile(inUserFile,provider):
    usersQ = Queue.Queue()
    keyParams = ['username', 'password', 'email', 'fullname','role','description']
    inFileHandle = open(inUserFile, 'r')
    userCount = 0
    print '...Processing input users file at: ' + inUserFile
    entryCount = 1;
    for line in inFileHandle.readlines():
        userParams = line.split('|')
        userParamDict = {}
        if provider=="webadaptor":
            if len(userParams) == 5:
                for i in range (0,5):
                    userParamDict[keyParams[0]] = userParams[0]  # login
                    userParamDict[keyParams[1]] = ""
                    userParamDict[keyParams[2]] = userParams[1]  # email address
                    userParamDict[keyParams[3]] = userParams[2]  # name
                    userParamDict[keyParams[4]] = userParams[3]  # role
                    userParamDict[keyParams[5]] = userParams[4].replace('\n','')  # description
                usersQ.put (userParamDict)
                userCount = userCount + 1
            else:
                print ' The format for entry %s is invalid.  The format for enterprise accounts should be <login>|<email address>|<name>|<role>|<description>. \n '% (entryCount)
                raise SystemExit( 'When registering enterprise accounts, the format for each entry is as follows: <login>|<email address>|<name>|<role>|<description>')
        elif provider=="arcgis":
            if len(userParams) == 6:
                for i in range (0,6):
                    userParamDict[keyParams[0]] = userParams[0]  # account
                    userParamDict[keyParams[1]] = userParams[1]  # password
                    userParamDict[keyParams[2]] = userParams[2]  # email address
                    userParamDict[keyParams[3]] = userParams[3]  # name
                    userParamDict[keyParams[4]] = userParams[4]  # role
                    userParamDict[keyParams[5]] = userParams[5].replace('\n','')  # description
                usersQ.put (userParamDict)
                userCount = userCount + 1
            else:
                print ' The format for entry %s is invalid.  The format for built-in portal accounts should be <account>|<password>|<email address>|<name>|<role>|<description>.  \n '% (entryCount)
                raise SystemExit( 'When registering built-in portal accounts, the format for each entry is as follows: <account>|<password>|<email address>|<name>|<role>|<description>')
        else:
            print '   The provider is incorrect. Script ended. \n'
            raise SystemExit( 'The value for the user type is invalid. ')
        entryCount = entryCount +1
        if not ((userParamDict[keyParams[4]].lower()== "user") or (userParamDict[keyParams[4]].lower()=="publisher") or (userParamDict[keyParams[4]].lower()== "admin")):
            raise SystemExit( 'The value for the user role %s in users text file is invalid.  Accepted values are user or publisher or admin. ' % (userParamDict[keyParams[4]]))
    inFileHandle.close()
    # Create users and report results
    print '...Total members to be added: ' + str(userCount)
    return usersQ
# This function connects to the portal and adds members to it from a collection
def createUsers(username,password, portalUrl, provider,userParamsQ):
    print '...Connecting to ' + portalUrl
    token = generateToken(username,password, portalUrl)
    print '...Adding users '
    usersLeftInQueue = True
    while usersLeftInQueue:
        try:
            userDict = userParamsQ.get(False)
            userDict['f'] = 'json'
            userDict['token'] = token
            userDict['provider'] = provider
            params = urllib.urlencode(userDict)
            request = urllib2.Request(portalUrl + '/portaladmin/security/users/createUser?',params, { 'Referer' : portalUrl })
            # POST the create request
            response = urllib2.urlopen(request).read()
            responseJSON = json.loads(response)
            # Log results
            if responseJSON.has_key('error'):
                errDict = responseJSON['error']
                if int(errDict['code'])==498:
                    message = 'Token Expired. Getting new token... Username: ' + userDict['username'] + ' will be added later'
                    token = generateToken(username,password, portalUrl)
                    userParamsQ.put(userDict)
                else:
                    message =  'Error Code: %s \n Message: %s' % (errDict['code'],
                    errDict['message'])
                print '\n' + message
            else:
                # Success
                if responseJSON.has_key('status'):
                    resultStatus = responseJSON['status']
                    print '\n' + 'User: %s account created' % (userDict['username'])
                    print 'User: %s account created' % (userDict['username'])
        except Queue.Empty:
              usersLeftInQueue = False
# This function gets a token from the portal
def generateToken(username, password, portalUrl):
    '''Retrieves a token to be used with API requests.'''
    parameters = urllib.urlencode({'username' : username,
                                   'password' : password,
                                   'client' : 'referer',
                                   'referer': portalUrl,
                                   'expiration': 60,
                                   'f' : 'json'})
    try:
        response = urllib.urlopen(portalUrl + '/sharing/rest/generateToken?',
                              parameters).read()
    except Exception as e:
        raise SystemExit( 'Unable to open the url %s/sharing/rest/generateToken' % (portalUrl))
    responseJSON =  json.loads(response.strip(' \t\n\r'))
    # Log results
    if responseJSON.has_key('error'):
        errDict = responseJSON['error']
        if int(errDict['code'])==498:
            message = 'Token Expired. Getting new token... '
            token = generateToken(username,password, portalUrl)
        else:
            message =  'Error Code: %s \n Message: %s' % (errDict['code'],
            errDict['message'])
            raise SystemExit(message)
    token = responseJSON.get('token')
    return token
# This function gets gets parameters from the user in interactive mode
def getParametersFromUser():
    parameters = {}
    # Get Location of users file
    inUserFile = raw_input ("Enter path to users text file: ")
    if not os.path.exists(inUserFile):
        print '   File does not exist. Script ended. \n'
        raise SystemExit( 'Input file: %s does not exist' % (inUserFile))
    parameters['inUserFile'] = inUserFile
    # Enteprise logins or built-in accounts?
    userInput = raw_input ("What type of users do you want to add to the portal?  Accepted values are built-in or enterprise: ")
    if userInput.lower()=="built-in":
        parameters['provider'] = 'arcgis'
        print '   Built-in accounts will be added to the portal. \n'
    elif userInput.lower()=="enterprise":
        parameters['provider'] = 'webadaptor'
        print '   Enterprise accounts will be added to the portal. \n'
    else:
        print '   The type of users is incorrect. Script ended. \n'
        raise SystemExit( 'The value entered for the user type %s is invalid.  Accepted values are built-in or enterprise. ' % (userInput))
    # Get Portal URL
    hostname = raw_input("Enter the fully qualified portal hostname (for example myportal.acme.com): ")
    parameters['portalURL'] = 'https://' + hostname + ':7443/arcgis'
    print '   Users will be added to portal at: ' + parameters['portalURL'] + '\n'
    # Get a username and password with portal administrative privileges
    parameters['userName'] = raw_input("Enter a built-in user name with portal administrative privileges:")
    parameters['password'] = raw_input("Enter password: ")
    print '\n'
    return  parameters
# Script start
if __name__ == "__main__":
    sys.exit(main(sys.argv[1:]))