Módulo PortalPy
En este tema de ayuda se enumeran todas las clases y métodos del módulo PortalPy que puede usar para escribir secuencias de comando administrativas con Portal for ArcGIS.
Clase: Portal
Un objeto que representa una conexión URL a un portal. Para crear la instancia de un objeto Portal, ejecute el código de este modo:
PortalPy.Portal(portalUrl, user, password)
Los métodos Portal disponibles se enumeran en las siguientes secciones. Antes de trabajar con los métodos, tenga en cuenta lo siguiente:
- ID de grupo: Muchas de las funciones de grupo requieren un ID de grupo. El ID es distinto del nombre o el título del grupo. Para determinar el ID de grupo, use la función search_groups y especifique el título para obtener el ID de grupo.
- Tiempo: Muchos de los métodos devuelven un campo de tiempo. Todo el tiempo se devuelve en forma de milisegundos desde el 1 de enero de 1970. Python espera el tiempo en segundos desde el 1 de enero de 1970, de modo que asegúrese de dividir los tiempos de PortalPy por 1.000. En el siguiente ejemplo se muestra cómo convertir el tiempo de PortalPy en tiempo de Python.
group = portalAdmin.get_group('67e1761068b7453693a0c68c92a62e2e') pythontime = time.ctime(group['created']/1000)
Métodos PortalPy
Los métodos Portal disponibles se describen a continuación.
_init_
El constructor de Portal. Requiere la URL del portal y, opcionalmente, un nombre de usuario y una contraseñ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
Agrega usuarios al grupo especificado. Sólo puede usar este método si el usuario para el objeto Portal es un administrador para todo el portal o el propietario explícito del grupo.
add_group_users(self, user_names, group_id)
Argumentos
Parámetro | Descripción |
|---|---|
user_names | cadena requerida, usuarios separados por comas |
group_id | cadena requerida, especificando el ID de grupo |
Valor de retorno
Un diccionario con una clave de not_added, que contiene los usuarios que no se agregaron al grupo.
create_group
Crea un grupo y devuelve un ID de grupo en caso satisfactorio.
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)
Argumentos
Parámetro | Descripción |
|---|---|
título | cadena requerida, nombre del grupo |
etiquetas | cadena requerida, lista de etiquetas delimitadas por comas |
descripción | cadena opcional, describe el grupo en detalle |
fragmento de código | cadena opcional, menos de 250 caracteres que resuman el grupo |
acceso | cadena opcional, puede ser privado, público u org |
vista en miniatura | cadena opcional, URL para imagen de grupo |
isInvitationOnly | booleano opcional, define si los usuarios pueden unirse o no previa solicitud |
sort_field | cadena opcional, especifica cómo se ordenan los elementos compartidos con el grupo |
sort_order | cadena opcional, asc o desc para ascendente o descendente |
is_view_only | booleano opcional, define si se puede buscar o no en el grupo |
Valor de retorno
Una cadena que es el ID de grupo.
create_group_from_dict
Crea un grupo y devuelve un ID de grupo en caso satisfactorio. En la mayoría de los casos, se recomienda usar create_group en su lugar, ya que este método puede tomar un diccionario de grupo devuelto por otra llamada de PortalPy y copiarlo.
create_group_from_dict(self, group, thumbnail=None)
Argumentos
Parámetro | Descripción |
|---|---|
grupo | objeto dict |
vista en miniatura | URL a imagen |
Ejemplo
create_group({'title': 'Test', 'access':'public'})
delete_group
Borra un grupo.
delete_group(self, group_id)
Argumentos
Parámetro | Descripción |
|---|---|
group_id | Cadena que contiene el ID del grupo que hay que eliminar. |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
delete_user
Elimina un usuario del portal, eliminando o reasignando opcionalmente grupos y elementos. No puede eliminar un usuario en el portal si dicho usuario es propietario de grupos o elementos. Si opta por actuar en cascada, dichos elementos y grupos se reasignarán al usuario identificado en la opción reassign_to. Si opta por no actuar en cascada, la eliminación tendrá o no éxito dependiendo de si los elementos y grupos del usuario se han transferido anteriormente o no.
Al actuar en cascada, este método borrará un máximo de 10.000 elementos. Si el usuario tiene más de 10.000 elementos, el método fallará.
delete_user(self, username, cascade=False, reassign_to=None)
Argumentos
Parámetro | Descripción |
|---|---|
nombre de usuario | cadena requerida, el nombre del usuario |
cascade | booleano opcional, true implica la reasignación de elementos y grupos |
reassign_to | cadena opcional, nuevo propietario de elementos y grupos |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
generate_token
Genera y devuelve un nuevo token, pero no vuelve a iniciar sesión. Este método no es necesario cuando se usa la clase Portal para hacer llamadas al portal. Se proporciona para el beneficio de hacer llamadas en el portal fuera de la clase Portal.
El portal usa un mecanismo de autenticación basado en token en el que un usuario proporciona sus credenciales; para las llamadas se emplea un token a corto plazo. La mayoría de las llamadas realizadas a la API REST de ArcGIS requiere un token, que puede adjuntarse a dichas solicitudes.
generate_token(self, username, password, expiration=60)
Argumentos
Parámetro | Descripción |
|---|---|
nombre de usuario | cadena requerida, el nombre del usuario |
contraseña | contraseña requerida, la contraseña del usuario |
expiration | entero opcional, número de minutos hasta que el token caduque |
Valor de retorno
Una cadena con el token.
get_group
Devuelve información de grupo correspondiente al group_id especificado.
get_group(self, group_id)
Argumentos
Parámetro | Descripción |
|---|---|
group_id | cadena requerida, indica el grupo |
Valor de retorno
Un objeto de diccionario con la información del grupo. Las claves en el objeto de diccionario pueden incluir:
Parámetro | Descripción |
|---|---|
título | el nombre del estilo |
isInvitationOnly | si está definido como true, los usuarios no pueden solicitar la incorporación al grupo |
propietario | el nombre de usuario del propietario del grupo |
descripción | explica el grupo |
fragmento de código | un breve resumen del grupo |
etiquetas | etiquetas definidas por usuario que describen el grupo |
teléfono | información de contacto para el grupo |
vista en miniatura | nombre de archivo relativo a http://<community-url>/groups/<groupId>/info |
creado | momento de creación del grupo, milisegundos desde el 1 de enero de 1970 |
modificado | momento de la última modificación del grupo, milisegundos desde el 1 de enero de 1970 |
acceso | puede ser privado, org o público |
userMembership | un diccionario con nombre de usuario de claves y memberType |
memberType | proporciona el acceso de usuario a las llamadas (propietario, admin, miembro, ninguno) |
get_group_members
Devuelve miembros del grupo especificado.
get_group_members(self, group_id)
Argumentos
Parámetro | Descripción |
|---|---|
group_id | cadena requerida, indica el grupo |
Valor de retorno
Un diccionario con claves: propietario, administradores y usuarios.
Parámetro | Descripción |
|---|---|
propietario | valor de cadena, el propietario del grupo |
admins | lista de cadenas, por lo general es la misma que el propietario |
usuarios | lista de cadenas, los miembros del grupo |
Ejemplo
Imprime los usuarios en un grupo:
response = portal.get_group_members("67e1761068b7453693a0c68c92a62e2e")
for user in response['users'] :
print user
get_group_thumbnail
Devuelve los bytes que conforman la miniatura para el group_id especificado.
get_group_thumbnail(self, group_id)
Argumentos
Parámetro | Descripción |
|---|---|
group_id | cadena requerida, especifica la miniatura del grupo |
Valor de retorno
Bytes que representan la imagen.
Ejemplo
response = portal.get_group_thumbnail("67e1761068b7453693a0c68c92a62e2e")
f = open(filename, 'wb')
f.write(response)
get_org_users
Devuelve todos los usuarios dentro de la organización del portal.
get_org_users(self, max_users=1000)
Argumentos
Parámetro | Descripción |
|---|---|
max_users | entero opcional, el número máximo de usuarios que devolver |
Valor de retorno
Una lista de diccionarios. Cada diccionario tiene las siguientes claves:
Clave | Valor |
|---|---|
nombre de usuario | cadena de caracteres |
storageUsage | entero |
storageQuota | entero |
descripción | cadena de caracteres |
etiquetas | lista de cadenas |
región | cadena de caracteres |
creado | entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970 |
modificado | entero, fecha de la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970 |
correo electrónico | cadena de caracteres |
culture | cadena de caracteres |
orgId | cadena de caracteres |
preferredView | cadena de caracteres |
grupos | lista de cadenas |
rol | cadena (org_user, org_publisher, org_admin) |
fullName | cadena de caracteres |
vista en miniatura | cadena de caracteres |
idpUsername | cadena de caracteres |
Ejemplo
Imprime todos los nombres de usuario en el portal:
resp = portalAdmin.get_org_users()
for user in resp:
print user['username']
get_properties
Devuelve las propiedades del portal, usando la caché a menos que force=True.
get_properties(self, force=False)
get_user
Devuelve la información de usuario correspondiente al nombre de usuario especificado.
get_user(self, username)
Argumentos
Parámetro | Descripción |
|---|---|
nombre de usuario | cadena requerida, el nombre de usuario cuya información desea |
Valor de retorno
Si se encuentra al usuario, devuelve un objeto de diccionario con las siguientes claves. Si no se encuentra ningún usuario, no se devuelve nada.
Clave | Valor |
|---|---|
acceso | cadena de caracteres |
creado | entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970 |
culture | cadena, código de idioma de dos letras ('en') |
descripción | cadena de caracteres |
correo electrónico | cadena de caracteres |
fullName | cadena de caracteres |
idpUsername | cadena, nombre del usuario en el sistema corporativo |
grupos | lista de diccionarios. Para obtener una lista de claves de diccionario, consulte get_group. |
modificado | entero, fecha de la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970 |
orgId | cadena, el ID de la organización |
preferredView | cadena, el valor es Web, GIS o nulo |
región | cadena, ninguno o código de país de dos letras |
rol | cadena (org_user, org_publisher, org_admin) |
storageUsage | entero |
storageQuota | entero |
etiquetas | lista de cadenas |
vista en miniatura | cadena de caracteres |
nombre de usuario | cadena de caracteres |
get_version
Devuelve el número de la versión del software, usando la caché a menos que force=True. La información de versión se recupera al crear el objeto de portal y después se almacena en caché para solicitudes futuras. Si quiere hacer una solicitud al portal y no confiar en la caché, puede definir el argumento force como True.
get_version(self, force=False)
Argumentos
Parámetro | Descripción |
|---|---|
force | booleano, true=realizar una solicitud, false=usar caché |
Valor de retorno
Una cadena con la versión. La versión es un número interno que puede que no coincida con la versión del producto instalado.
invite_group_users
Invita a usuarios a un grupo. Un usuario invitado a un grupo verá una lista de invitaciones en la ficha Grupos del portal. El usuario puede aceptar o rechazar la invitación. El usuario que ejecute el comando deberá ser el propietario del grupo.
invite_group_users(self, user_names, group_id, role='group_member', expiration=10080)
Argumentos
Parámetro | Descripción |
|---|---|
user_names | cadena requerida, lista separada por comas de usuarios que invitar |
group_id | cadena requerida, especificando el ID de grupo al que invita a los usuarios |
rol | una cadena opcional, group_member o group_admin |
expiration | un entero opcional, especifica durante cuánto tiempo es válida la invitación (en minutos) |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
is_all_ssl
Devuelve true si el portal requiere SSL.
is_all_ssl(self)
is_logged_in
Devuelve true si el usuario ha iniciado sesión en el portal.
is_logged_in(self)
is_org
Devuelve true si el portal es una organización.
is_org(self)
leave_group
Elimina al usuario que ha iniciado sesión del grupo especificado. El usuario debe haber iniciado sesión para usar este método.
leave_group(self, group_id)
Argumentos
Parámetro | Descripción |
|---|---|
group_id | cadena requerida, especificando el ID de grupo |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
logged_in_user
Devuelve información sobre el usuario que ha iniciado sesión.
logged_in_user(self)
Valor de retorno
Un diccionario con las siguientes claves:
Clave | Valor |
|---|---|
nombre de usuario | cadena de caracteres |
storageUsage | entero |
descripción | cadena de caracteres |
etiquetas | cadena separada por comas |
creado | entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970 |
modificado | entero, fecha de la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970 |
fullName | cadena de caracteres |
correo electrónico | cadena de caracteres |
idpUsername | cadena, nombre del usuario en el sistema corporativo |
iniciar sesión
Inicia sesión en el portal mediante un nombre de usuario y una contraseña. Puede iniciar sesión en un portal cuando construye un objeto de portal o más tarde. Esta función es para cuando necesite iniciar sesión más tarde.
login(self, username, password, expiration=60)
Argumentos
Parámetro | Descripción |
|---|---|
nombre de usuario | cadena requerida |
contraseña | cadena requerida |
expiration | entero opcional, cuánto durará el token generado |
Valor de retorno
Una cadena que incluye el token.
cerrar sesión
Cierra sesión en el portal. El portal olvidará cualquier token existente que estuviera usando, y todas las llamadas al portal siguientes serán anónimas hasta que se dé otra llamada de inicio de sesión.
logout(self)
Valor de retorno
Ningún valor de retorno.
reassign_group
Reasigna un grupo a otro propietario.
reassign_group(self, group_id, target_owner)
Argumentos
Parámetro | Descripción |
|---|---|
group_id | cadena requerida, identificador exclusivo para el grupo |
target_owner | cadena requerida, nombre de usuario del nuevo propietario de grupo |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
remove_group_users
Elimina usuarios de un grupo.
remove_group_users(self, user_names, group_id)
Argumentos
Parámetro | Descripción |
|---|---|
user_names | cadena requerida, lista separada por comas de usuarios |
group_id | cadena requerida, identificador exclusivo para el grupo |
Valor de retorno
Un diccionario con una clave notRemoved, indicando la lista de usuarios no eliminados.
reset_user
Restablece una contraseña de usuario, una pregunta de seguridad y una respuesta de seguridad. Esta función no se aplica a portales configurados con cuentas procedentes de un almacén de identidades corporativo como ActiveDirectory o LDAP. Sólo se aplica a usuarios de portal integrados. Si se especifica una nueva pregunta de seguridad, debe proporcionarse una nueva respuesta de seguridad.
reset_user(self, username, password, new_password=None, new_security_question=None, new_security_answer=None)
Argumentos
Parámetro | Descripción |
|---|---|
nombre de usuario | cadena requerida, cuenta que se está restableciendo |
contraseña | cadena requerida, contraseña actual |
new_password | cadena opcional, nueva contraseña si se está restableciendo la contraseña |
new_security_question | entero opcional, nueva pregunta de seguridad en caso deseado |
new_security_answer | cadena opcional, nueva respuesta a pregunta de seguridad en caso deseado |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
buscar
search(self, q, bbox=None, sort_field='title', sort_order='asc', max_results=1000, add_org=True)
search_groups
Busca grupos de portal. Tenga en cuenta lo siguiente cuando use este método:
- La sintaxis de la consulta tiene muchas entidades no descritas aquí; para revisar todas ellas, consulte la referencia de búsqueda en la API REST ArcGIS.
- Al buscar grupos, suelen buscarse dentro de la organización. Por comodidad, el método adjunta automáticamente el ID de su organización a la consulta de forma predeterminada. Si no quiere que la API lo adjunte a la consulta, defina add_org como false.
search_groups(self, q, sort_field='title', sort_order='asc', max_groups=1000, add_org=True)
Argumentos
Parámetro | Descripción |
|---|---|
q | cadena requerida, cadena de consulta. |
sort_field | cadena opcional, los valores válidos pueden ser título, propietario o creado |
sort_order | cadena opcional, los valores válidos son asc o desc |
max_groups | entero opcional, número máximo de grupos devuelto |
add_org | booleano opcional, controla si buscar o no dentro de la org |
Valor de retorno
Una lista de diccionarios. Cada diccionario tiene las siguientes claves:
Clave | Valor |
|---|---|
acceso | cadena, los valores son privado, org o público |
creado | entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970 |
descripción | cadena de caracteres |
Id. | cadena, ID exclusivo para el grupo |
isInvitationOnly | booleano |
isViewOnly | booleano |
modificado | entero, fecha de la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970 |
propietario | cadena, nombre de usuario del propietario |
teléfono | cadena de caracteres |
fragmento de código | cadena, un breve resumen del grupo |
sortField | cadena, cómo se ordenan los elementos compartidos |
sortOrder | cadena, ascendente o descendente |
etiquetas | lista de cadenas, etiquetas para búsqueda suministradas por el usuario |
vista en miniatura | cadena, nombre del archivo. Adjuntar a http://<community url>/groups/<group id>/info/ |
título | cadena, nombre del grupo como se muestra a los usuarios |
search_users
Busca usuarios de portal. Tenga en cuenta lo siguiente cuando use este método:
- La sintaxis de la consulta tiene muchas entidades no descritas aquí; para revisar todas ellas, consulte la referencia de búsqueda en la API REST ArcGIS.
- Al buscar usuarios, suelen buscarse dentro de la organización. Por comodidad, el método adjunta automáticamente el ID de su organización a la consulta de forma predeterminada. Si no quiere que la API lo adjunte a la consulta, defina add_org como false.
search_users(self, q, sort_field='username', sort_order='asc', max_users=1000, add_org=True)
Argumentos
Parámetro | Descripción |
|---|---|
q | cadena requerida, cadena de consulta. |
sort_field | cadena opcional, los valores válidos pueden ser título, propietario o creado |
sort_order | cadena opcional, los valores válidos son asc o desc |
max_users | entero opcional, número máximo de usuarios devuelto |
add_org | booleano opcional, controla si buscar o no dentro de la org |
Valor de retorno
Una lista de diccionarios. Cada diccionario tiene las siguientes claves:
Clave | Valor |
|---|---|
creado | entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970 |
culture | cadena, código de idioma de dos letras |
descripción | cadena de caracteres |
fullName | cadena, nombre del usuario |
modificado | entero, fecha de la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970 |
región | cadena, puede ser ninguno |
etiquetas | lista de cadenas, etiquetas para búsqueda suministradas por el usuario |
vista en miniatura | cadena, nombre del archivo. Adjuntar a http://<community url>/groups/<group id>/info/ |
nombre de usuario | cadena, nombre del usuario |
signup
Registra usuarios en Portal for ArcGIS. Este método sólo se aplica a Portal for ArcGIS y puede llamarse de forma anónima. Sin embargo, el autorregistro también puede deshabilitarse en el portal. También crea sólo cuentas integradas; no funciona con cuentas corporativas procedentes de un almacén de identidades corporativo.
Hay otro método llamado createUser que puede usarse siempre con Portal for ArcGIS 10.2.1 o posterior. El método requiere acceso de administrador y puede usarse para crear usuarios integrados o agregar cuentas corporativas al portal.
signup(self, username, password, fullname, email)
Argumentos
Parámetro | Descripción |
|---|---|
nombre de usuario | cadena requerida, debe ser exclusiva en el portal, mayor de 4 caracteres |
contraseña | cadena requerida, debe ser mayor o igual que 8 caracteres |
fullname | cadena requerida, nombre del usuario |
correo electrónico | cadena requerida, debe ser una dirección de correo electrónico válida |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
update_group
Actualiza un grupo. Sólo necesita proporcionar valores para los argumentos que desee actualizar.
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)
Argumentos
Parámetro | Descripción |
|---|---|
group_id | cadena requerida, el ID de grupo que modificar |
título | cadena requerida, nombre del grupo que modificar |
etiquetas | cadena requerida, lista de etiquetas delimitadas por comas |
descripción | cadena opcional, describe el grupo en detalle |
fragmento de código | cadena opcional, menos de 250 caracteres que resuman el grupo |
acceso | cadena opcional, puede ser privado, público u org |
vista en miniatura | cadena opcional, URL para imagen de grupo |
isInvitationOnly | booleano opcional, define si los usuarios pueden unirse o no previa solicitud |
sort_field | cadena opcional, especifica cómo se ordenan los elementos compartidos con el grupo |
sort_order | cadena opcional, asc o desc para ascendente o descendente |
is_view_only | booleano opcional, define si se puede buscar o no en el grupo |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
update_user
Actualiza las propiedades de un usuario. Sólo necesita proporcionar valores para los argumentos que desee actualizar.
update_user(self, username, access=None, preferred_view=None, description=None, tags=None, thumbnail=None, fullname=None, email=None, culture=None, region=None)
Argumentos
Clave | Valor |
|---|---|
nombre de usuario | cadena requerida, nombre del usuario que actualizar |
acceso | cadena opcional, valores: privado, org o público |
preferred_view | cadena opcional, valores: Web, GIS, nulo |
descripción | cadena opcional, una descripción del usuario |
etiquetas | cadena opcional, etiquetas para búsquedas separadas por comas |
vista en miniatura | cadena opcional, ruta o url a un archivo. Puede ser PNG, GIF o JPEG. El tamaño máximo es 1 MB. |
fullName | cadena opcional, nombre del usuario, sólo para usuarios integrados |
correo electrónico | cadena opcional, dirección de correo electrónico, sólo para usuarios integrados |
culture | cadena opcional, código de idioma de dos letras, por ejemplo "fr". |
región | cadena opcional, código de país de dos letras, por ejemplo FR |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.
update_user_role
Actualiza el rol de un usuario.
update_user_role(self, username, role)
Argumentos
Clave | Valor |
|---|---|
nombre de usuario | cadena requerida, el nombre del usuario cuyo rol cambiará |
rol | cadena requerida, org_user, org_publisher u org_admin |
Valor de retorno
Un booleano que indica si la operación se realizó correcta o incorrectamente.