Ejemplo: Agregar miembros al portal

En este ejemplo se toma un archivo de texto de entrada con información sobre usuarios y se les añade al portal en bloque. Defina y asigne el rol de cada usuario del portal.

Introduzca la siguiente información obligatoria cuando ejecute la secuencia de comandos:

• Ruta al archivo de texto que contiene la información de usuario, por ejemplo, C:\users.txt.
• Tipo de usuarios que desee agregar al portal, por ejemplo, integrados o corporativos. Para obtener más información sobre tipos de usuario, consulte Administrar el acceso al portal.
• El nombre de dominio completo de la máquina que aloja su portal, por ejemplo, myportal.acme.com. El script accede a su portal a través de HTTPS en el puerto 7443 omitiendo ArcGIS Web Adaptor. De este modo, la secuencia de comandos no necesita manejar autenticación a nivel web si su portal está configurado para usarla.
• El nombre de usuario y la contraseña de una cuenta que tenga privilegios administrativos en el portal. Si desea agregar cuentas integradas, proporcione las credenciales de cualquier miembro del portal con privilegios administrativos. Si agrega cuentas específicas de la organización, utilice la cuenta de administrador inicial creada después de instalar Portal for ArcGIS.

Nota:

Demostrar cómo hacer que los scripts de Python manejen la autenticación a nivel web trasciende el ámbito de este ejemplo.

Registro de cuentas corporativas

Para registrar cuentas corporativas, el formato de cada entrada en el archivo de texto es como sigue:

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

• Inicio de sesión: inicio de sesión corporativo que se debe registrar.

  • Si está utilizando Active Directory, este inicio de sesión debe tener el formato sAMAccountName@DOMAIN. El nombre de dominio debe estar todo en mayúsculas.
  • Si utiliza LDAP, el inicio de sesión coincide con el valor del userNameAttribute especificado al configurar el almacén de identidades.
  • Si utiliza inicios de sesión corporativos basados en SAML, el valor del inicio de sesión especificado coincide con el atributo NameID del proveedor de identidad SAML.

• Dirección de correo electrónico: dirección de correo electrónico asociada con el inicio de sesión, que coincide con el valor del almacén de identidad. Si la cuenta de usuario no dispone de una dirección de correo electrónico, proporcione un valor falso o genérico.

• Nombre: alias del inicio de sesión que se utilizará en su organización de ArcGIS. La mayoría de almacenes de identidades utilizan el nombre completo del usuario como alias predeterminado. Cuando el usuario se conecta al sitio web del portal, este nombre aparece en la parte superior del sitio web.

• tipo de usuario: nombre del tipo de usuario al que se asignará el usuario. Seleccione cualquier tipo de usuario disponible de la lista desplegable. Puede hacer clic en los roles compatibles y en el recuento de licencias complementarias compatibles para obtener más información sobre cuáles son compatibles con el tipo de usuario seleccionado. Para obtener más información, consulte Tipos de usuarios, roles y privilegios.

• Rol: Nombre del rol que el nombre del usuario corporativo tendrá en la organización de ArcGIS. Los valores de roles válidos son usuario, publicador, administrador o <custom_role_name>, donde <custom_role_name> es el nombre del rol personalizado (por ejemplo, hostedservicepublisher).

  Heredado:

  En Portal for ArcGIS 10.3 y versiones anteriores, los valores aceptados de roles no personalizados eran org_user, org_publisher y org_admin. En 10.3.1, estos valores se han desaprobado y reemplazado por los valores indicados arriba. Puede continuar usando los valores heredados en 10.3.1, pero tenga en cuenta que es posible que los valores no se acepten en una versión futura.

• Descripción: opcionalmente, se puede incluir texto para describir la cuenta. Este valor no corresponde a ningún atributo del almacén de identidades. La descripción no puede superar los 250 caracteres.

• Idp UserName: si lo desea, especifique el nombre de usuario de la cuenta corporativa en el proveedor de identidad. Si no se proporciona este valor, se utiliza en su lugar el valor especificado para el parámetro de inicio de sesión.

Debe proporcionar un valor para el inicio de sesión, la dirección de correo electrónico, nombre y rol. La descripción e Idp UserName son opcionales. Para cada cuenta mostrada en el archivo, compruebe que los valores introducidos para el inicio de sesión, dirección de correo electrónico y nombre coincidan exactamente con los valores del almacén de identidades. El portal no se conectará al almacén de identidades para validar dichos valores.

A continuación se muestra un ejemplo de una entrada para registrar una cuenta corporativa de Active Directory para el nombre de usuario jcho111, con la dirección de correo electrónico [e-mail] y John Cho como nombre completo. El inicio de sesión se coloca en el rol de usuario (usuario) y en un tipo de usuario Viewer y se describe como usuario del departamento b.

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

A continuación se muestra un ejemplo de una entrada para registrar una cuenta corporativa de un proveedor de identidad SAML. El inicio de sesión del usuario es [e-mail], con la dirección de correo electrónico [e-mail] y el nombre completo Robert Smith. El inicio de sesión se coloca en el rol de publicador (publicador) y el tipo de usuario Creator con un ajuste de Idp UserName igual a [e-mail].

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

A continuación se muestra un ejemplo de una entrada para registrar una cuenta corporativa LDAP para el inicio de sesión sjames4513, con la dirección de correo electrónico [e-mail] y el nombre completo Sara James. El inicio de sesión se coloca en el rol de usuario (administrador) y el tipo de usuario GIS Professional y se proporciona una descripción.

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

A continuación se muestra un ejemplo de una entrada para registrar una cuenta corporativa para el inicio de sesión srajhandas, con la dirección de correo electrónico [e-mail] y Satish Rajhandas como nombre completo. El inicio de sesión se coloca en el rol de usuario (usuario) y en el tipo de usuario Viewer.

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

A continuación se muestra un ejemplo de una entrada para registrar una cuenta corporativa de un proveedor de identidad SAML. El inicio de sesión del usuario es djohnson308, con la dirección de correo electrónico [e-mail] y el nombre completo Daisha Johnson. El inicio de sesión se coloca en el rol de usuario (usuario) y el tipo de usuario Creator; se proporciona una descripción y se define Idp UserName como [e-mail].

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

Adición de cuentas del portal integradas

Al agregar cuentas integradas del portal, el formato de cada entrada del archivo de texto es el siguiente:

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

• Nombre de usuario: el nombre de usuario que se utiliza para la cuenta integrada. Los nombres de usuario deben ser exclusivos; no puede haber dos miembros que tengan el mismo.
• Contraseña: la contraseña asignada a la cuenta. Los usuarios pueden usar esta contraseña la primera vez que inician la sesión en el portal y, a continuación, pueden cambiarla modificando su perfil.
• Dirección de correo electrónico: Dirección de correo electrónico para la cuenta. Este parámetro es obligatorio. Por consiguiente, deberá proporcionar un valor de la dirección de correo electrónico aunque no sea una dirección válida.
• Nombre: alias de la cuenta que se utilizará en su organización de ArcGIS. Cuando el usuario se conecta al sitio web portal, este nombre aparece en la parte superior del sitio web del portal.
• tipo de usuario: nombre del tipo de usuario al que se asignará el usuario. Seleccione cualquier tipo de usuario disponible de la lista desplegable. Puede hacer clic en los roles compatibles y en el recuento de licencias complementarias compatibles para obtener más información sobre cuáles son compatibles con el tipo de usuario seleccionado. Para obtener más información, consulte Tipos de usuarios, roles y privilegios.
• Rol: rol que tiene la cuenta en la organización de ArcGIS. Los valores de roles válidos son usuario, publicador, administrador o <custom_role_name>, donde <custom_role_name> es el nombre del rol personalizado (por ejemplo, hostedservicepublisher).
• Descripción: opcionalmente, se puede incluir texto para describir la cuenta. La descripción no puede superar los 250 caracteres.

El siguiente ejemplo muestra una entrada que agrega una cuenta integrada del portal con el nombre de usuario pub1 para Barbara Williams y la dirección de correo electrónico [e-mail]. También agrega pub1 al rol de publicador:

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

El siguiente ejemplo muestra una entrada que agrega una cuenta integrada del portal con el nombre de usuario jcho para Jon Cho y la dirección de correo electrónico [e-mail]. También agrega jcho al rol de administrador y lo describe como administrador de SIG:

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

#!/usr/bin/env python
# Requires Python 2.7+

# Demonstrates how to add users to the ArcGIS Enterprise portal in bulk

# For Http calls
import 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()
    inFileHandle = open(inUserFile, 'r')
    userCount = 0
    print '...Processing input users file at: ' + inUserFile
    entryCount = 1
    roleID = {'admin':'org_admin', 'publisher':'org_publisher', 'user':'org_user', 'viewer':'iAAAAAAAAAAAAAAA'}
    for line in inFileHandle.readlines():
        userParams = line.strip('\n').split('|')
        userParamDict = {}
        if provider=="enterprise":
            keyParams = ['username', 'email', 'fullname', 'role', 'userLicenseTypeId', 'description', 'idpUsername', 'firstname', 'lastname']
            if len(userParams) == len(keyParams):
                for i, param in enumerate(keyParams):
                    userParamDict[param] = userParams[i]
                if userParamDict['role'] in roleID.keys():
                    userParamDict['role'] = roleID[userParamDict['role']]
                else:
                    print('The value for the user role "{}" in users text file is invalid.'.format(userParamDict['role']))
                    print('Accepted values are viewer, user, publisher, or admin.')
                    raise SystemExit('Invalid user role')
                usersQ.put(userParamDict)
                userCount = userCount + 1
            else:
                print('The format for entry "{}" is invalid.\nThe format for enterprise accounts is:'.format(line.strip('\n')))
                print(' <login>|<email address>|<full name>|<role>|<user type id>|<description>|<idp username>|<first name>|<last name>')
                raise SystemExit('Invalid format')
        elif provider=="arcgis":
            keyParams = ['username', 'password', 'email', 'fullname', 'role', 'userLicenseTypeId', 'description', 'firstname', 'lastname']
            if len(userParams) == len(keyParams):
                for i, param in enumerate(keyParams):
                    userParamDict[param] = userParams[i]
                if userParamDict['role'] in roleID.keys():
                    userParamDict['role'] = roleID[userParamDict['role']]
                else:
                    print('The value for the user role "{}" in users text file is invalid.'.format(userParamDict['role']))
                    print('Accepted values are viewer, user, publisher, or admin.')
                    raise SystemExit('Invalid user role')
                usersQ.put (userParamDict)
                userCount = userCount + 1
            else:
                print('The format for entry "{}" is invalid.\nThe format for built-in accounts is:'.format(line.strip('\n')))
                print(' <account>|<password>|<email address>|<full name>|<role>|<description>|<first name>|<last name>|<level>')
                raise SystemExit('Invalid format')
        else:
            raise SystemExit( 'The value for the user type is invalid. ')
        entryCount = entryCount +1
    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 'User: %s account created' % (userDict['username'])
        except Queue.Empty:
              usersLeftInQueue = False

# This function gets a token from the portal
def generateToken(username, password, portalUrl):
    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):
        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'] = 'enterprise'
        print '   Enterprise accounts will be added to the portal. \n'
    else:
        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'] = getpass.getpass("Enter password: ")
    print '\n'

    return  parameters

# Script start
if __name__ == "__main__":
    sys.exit(main(sys.argv[1:]))