Portal for ArcGIS | Administrator Guide - Пример: Добавление участников на портал

В этом примере используется текстовой файл с данными пользователей, которые добавляются на портал в пакетном режиме. Вы можете выбрать роль каждого участника на портале.

При запуске скрипта вам потребуется ввести следующую информацию:

Путь к текстовому файлу с данными пользователей, например, C:\users.txt.
Типы добавляемых на портал пользователей, например, built-in или enterprise. Более подробно о типах пользователей см. в Управление доступом на портал.
Полное доменное имя компьютера с порталом, например, myportal.acme.com. Скрипт будет обращаться к порталу по HTTPS через порт 7443, пропуская ArcGIS Web Adaptor. Таким образом скрипту не потребуется обрабатывать аутентификация на веб-уровне, если портал настроен на ее использование.
Имя пользователя и пароль для учетной записи, которая имеет права администратора портала. Если вы добавляете встроенные учетные записи, вы можете ввести учетные данные любого пользователя портала с административными правами. Если вы добавляете корпоративные учетные записи , необходимо использовать первичную учетную запись администратора, созданную после установки Portal for ArcGIS.

Примечание:

Демонстрация обработки аутентификации на веб-уровне скриптом Python не входит в круг вопросов, освещаемых этим примером.

Добавление встроенных учетных записей портала

При добавлении встроенных учетных записей портала формат каждой записи в текстовом файле выглядит следующим образом:

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

username – имя пользователя для встроенной учетной записи. Имена пользователей должны быть уникальны; два участника не могут иметь одинаковые имена.
пароль – Пароль, присвоенный учетной записи. Пользователи могут использовать этот пароль во время первого входа на портал, а затем изменить этот пароль в своем профиле.
email address – Укажите адрес email для учетной записи. Этот параметр является обязательным. Поэтому укажите адрес email, даже если он некорректный.
name – Имя – это псевдоним учетной записи, который будет использоваться в вашей организации ArcGIS. При подключении пользователя это имя появляется в верхней части веб-сайта портала.
role – Роль учетной записи в организации ArcGIS. Допустимыми являются роли org_user, org_publisher и org_admin.
description – Описание: дополнительно вы можете ввести текст с описанием учетной записи. Описание не может быть более 250 символов.

Этот пример добавляет встроенную учетную запись портала с именем пользователя pub1 для Барбары Уильямс (Barbara Williams) с адресом электронной почты учетной записи bwilliams@domain.com. Кроме того, добавляется запись pub1 к роли издателя и ее описание как принадлежащей сотруднику департамента планирования.

pub1|changepasswordlater|bwilliams@domain.com|Barbara Williams|org_publisher|planning department

Регистрация корпоративных учетных записей

При регистрации корпоративных учетных записей используется следующий формат каждой строки:

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

username – имя пользователя регистрируемой корпоративной учетной записи. Если вы используете Active Directory, имя учетной записи должно иметь формат sAMAccountName@DOMAIN. Имя домена должно быть полностью в верхнем регистре. Если вы используете LDAP, имя учетной записи должно совпадать со значением userNameAttribute, которое вы указали при настройке хранилища учетных данных.
email address – должен быть введен адрес электронной почты, связанный с учетной записью и совпадающий с адресом в хранилище учетных данных. Если учетная запись пользователя не имеет адреса электронной почты, укажите вымышленное или общее значение.
name – Имя – это псевдоним учетной записи, который будет использоваться в вашей организации, использующей ArcGIS. В большинстве хранилищ учетных данных в качестве псевдонима по умолчанию используется полное имя пользователя. При подключении пользователя к веб-сайту портала это имя появляется в верхней части веб-сайта.
role – Роль учетной записи в организации ArcGIS. Допустимыми являются роли org_user, org_publisher и org_admin.
description – Описание: дополнительно вы можете ввести текст с описанием учетной записи. Это значение не соответствует какому-либо атрибуту в хранилище учетных данных. Описание не может быть более 250 символов.

Вам необходимо указать имя пользователя, адрес электронной почты, имя и роль. Описание необязательно. Убедитесь, что значения имени учетной записи, адреса электронной почты и имени, которые вы ввели для каждой учетной записи, перечисленной в файле, полностью совпадают со значениями в вашем хранилище учетных данных. Портал не будет подключаться к вашему хранилищу учетных данных для проверки этих значений.

Далее показан пример записи регистрации корпоративной учетной записи для имени пользователя jcho111 с email-адресом jcho@domain.com и полным именем Jon Cho. Имя пользователя (login) размещено в пользовательской роли (org_user) и описано как "пользователь департамента b":

jcho111@DOMAIN|jcho@domain.com|Jon Cho|org_user|department b

#!/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)

    print '\n ...Script ended. '

    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()== "org_user") or (userParamDict[keyParams[4]].lower()=="org_publisher") or (userParamDict[keyParams[4]].lower()== "org_admin")):
            raise SystemExit( 'The value for the user role %s in users text file is invalid.  Accepted values are org_user or org_publisher or org_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)

            # 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:]))

5/10/2014