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. Todos los datos de tiempo se devuelven 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 se deben dividir los tiempos de PortalPy por 1000. 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 dirección 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

Agregue usuarios al grupo especificado. Use este método únicamente si el usuario del objeto Portal es administrador en todo el portal o propietario explícito del grupo.

add_group_users(self, user_names, group_id)

Argumentos

Parámetro	Descripción
user_names	Cadena de caracteres obligatoria, usuarios separados por comas
group_id	Cadena de caracteres obligatoria que especifica el Id. de grupo

Valor de retorno

Un diccionario con una clave de not_added, que contiene los usuarios que no se han agregado 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 de caracteres obligatoria, nombre del grupo
etiquetas	Cadena de caracteres obligatoria, lista de etiquetas delimitadas por comas
description	Cadena de caracteres opcional, describe el grupo en detalle
snippet	Cadena de caracteres opcional, menos de 250 caracteres que resumen el grupo
Acceso	Cadena de caracteres opcional, puede ser privado, público u org
vista en miniatura	Cadena de caracteres opcional, URL de la imagen del grupo
isInvitationOnly	Booleano opcional, define si los usuarios pueden unirse previa solicitud
sort_field	Cadena de caracteres opcional, especifica cómo se ordenan los elementos compartidos con el grupo
sort_order	Cadena de caracteres 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 de caracteres que contiene el Id. del grupo eliminado.

Valor de retorno

Un Booleano que indica si la operación se realizó correctamente o no.

delete_user

Elimina un usuario del portal, eliminando o reasignando opcionalmente grupos y elementos. No puede eliminar un usuario del portal si dicho usuario es propietario de grupos o elementos. Si opta por actuar en cascada, esos 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 previamente.

Cuando actúa en cascada, este método elimina un máximo de 10.000 elementos. Si el usuario tiene más de 10.000 elementos, el método falla.

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

Argumentos

Parámetro	Descripción
nombre de usuario	Cadena de caracteres obligatoria, nombre del usuario
cascada	Booleano opcional, true implica la reasignación de elementos y grupos
reassign_to	Cadena de caracteres opcional, nuevo propietario de elementos y grupos

Valor de retorno

Un Booleano que indica si la operación se realizó correctamente o no.

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 requieren un token, que puede adjuntarse a dichas solicitudes.

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

Argumentos

Parámetro	Descripción
nombre de usuario	Cadena de caracteres obligatoria, nombre del usuario
contraseña	Contraseña obligatoria, 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 de caracteres obligatoria, 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	Nombre del grupo
isInvitationOnly	Si se ha definido como verdadero, los usuarios no pueden solicitar la incorporación al grupo
propietario	Nombre de usuario del propietario del grupo
description	Explica el grupo
snippet	Un breve resumen del grupo
etiquetas	Etiquetas definidas por el 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 del usuario que llama (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 de caracteres obligatoria, indica el grupo

Valor de retorno

Un diccionario con claves: propietario, administradores y usuarios.

Parámetro	Descripción
propietario	Valor de cadena de caracteres, propietario del grupo
admins	Lista de cadenas de caracteres, normalmente coincide con el propietario
usuarios	Lista de cadenas de caracteres, miembros del grupo

Ejemplo

Imprimir 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 de caracteres obligatoria, 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_users

Devuelve todos los usuarios dentro de la organización del portal.

get_users(self, max_users=1000)

Argumentos

Parámetro	Descripción
max_users	Entero opcional, número máximo de usuarios que se deben devolver

Valor de retorno

Una lista de diccionarios. Cada diccionario tiene las siguientes claves:

Clave	Valor
nombre de usuario	Cadena
storageUsage	Entero
storageQuota	Entero
description	Cadena
etiquetas	Lista de cadenas de caracteres
región	Cadena
creado	Entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970
modificado	Entero, tiempo transcurrido desde la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970
correo electrónico	Cadena
culture	Cadena
orgId	Cadena
preferredView	Cadena
grupos	Lista de cadenas de caracteres
rol	Cadena de caracteres (user, publisher, admin, <nombre_rol_personalizado> [donde <nombre_rol_personalizado> es el nombre del rol personalizado, por ejemplo, org_hostedservicepublisher]). Legado: 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.
fullName	Cadena
vista en miniatura	Cadena
idpUsername	Cadena

Ejemplo

Imprimir todos los nombres de usuario en el portal:

resp = portalAdmin.get_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 de caracteres obligatoria, nombre de usuario cuya información se 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
creado	Entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970
culture	Cadena de caracteres, código de idioma de dos letras (en)
description	Cadena
correo electrónico	Cadena
fullName	Cadena
idpUsername	Cadena de caracteres, nombre del usuario en el sistema corporativo
grupos	Lista de diccionarios. Para obtener una lista de claves de diccionario, consulte get_group.
modificado	Entero, tiempo transcurrido desde la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970
orgId	Cadena de caracteres, Id. de la organización
preferredView	Cadena de caracteres, el valor es web, SIG o nulo
región	Cadena de caracteres, ninguno o código de país de dos letras
rol	Cadena de caracteres (user, publisher, admin, <nombre_rol_personalizado> [donde <nombre_rol_personalizado> es el nombre del rol personalizado, por ejemplo, org_hostedservicepublisher]). Legado: 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.
storageUsage	Entero
storageQuota	Entero
etiquetas	Lista de cadenas de caracteres
vista en miniatura	Cadena
nombre de usuario	Cadena

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 recurrir a la caché, defina 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 ve una lista de invitaciones en la pestaña 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 de caracteres obligatoria, lista separada por comas de usuarios que se desea invitar
group_id	Cadena de caracteres obligatoria, especifica el Id. del grupo al que se invita a los usuarios
rol	Cadena de caracteres opcional, group_member o group_admin
expiration	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ó correctamente o no.

is_all_ssl

Devuelve true si el portal requiere HTTPS.

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 de caracteres obligatoria que especifica el Id. de grupo

Valor de retorno

Un Booleano que indica si la operación se realizó correctamente o no.

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
storageUsage	Entero
description	Cadena
etiquetas	Cadena de caracteres separada por comas
creado	Entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970
modificado	Entero, tiempo transcurrido desde la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970
fullName	Cadena
correo electrónico	Cadena
idpUsername	Cadena de caracteres, nombre del usuario en el sistema corporativo

iniciar sesión

Inicia sesión en el portal con 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 se usa para iniciar sesión más tarde.

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

Argumentos

Parámetro	Descripción
nombre de usuario	Cadena de caracteres obligatoria
contraseña	Cadena de caracteres obligatoria
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 olvida los tokens que estaba usando, y todas las llamadas al portal posteriores 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 de caracteres obligatoria, identificador único del grupo
target_owner	Cadena de caracteres obligatoria, nombre de usuario del nuevo propietario del grupo

Valor de retorno

Un Booleano que indica si la operación se realizó correctamente o no.

remove_group_users

Elimina usuarios de un grupo.

remove_group_users(self, user_names, group_id)

Argumentos

Parámetro	Descripción
user_names	Cadena de caracteres obligatoria, lista de usuarios separada por comas
group_id	Cadena de caracteres obligatoria, identificador único del 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, se proporciona 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 de caracteres obligatoria, cuenta que se está restableciendo
contraseña	Cadena de caracteres obligatoria, contraseña actual
new_password	Cadena de caracteres opcional, nueva contraseña si se está restableciendo la contraseña
new_security_question	Entero opcional, nueva pregunta de seguridad si se desea
new_security_answer	Cadena de caracteres opcional, respuesta a la pregunta de seguridad si se desea

Valor de retorno

Un Booleano que indica si la operación se realizó correctamente o no.

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 características que no se describen aquí. Para revisar todas las características, consulte Referencia de búsquedas en la API REST de ArcGIS.
• Al buscar grupos, suelen buscarse dentro de su 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 de caracteres obligatoria, cadena de consulta.
sort_field	Cadena de caracteres opcional, los valores válidos pueden ser título, propietario o creado
sort_order	Cadena de caracteres 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 se debe buscar o no dentro de la organización

Valor de retorno

Una lista de diccionarios. Cada diccionario tiene las siguientes claves:

Clave	Valor
Acceso	Cadena de caracteres, los valores son privado, org o público
creado	Entero, cuándo se creó la cuenta, milisegundos desde el 1 de enero de 1970
description	Cadena
Id.	Cadena de caracteres, Id. único del grupo
isInvitationOnly	Booleano
isViewOnly	Booleano
modificado	Entero, tiempo transcurrido desde la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970
propietario	Cadena de caracteres, nombre de usuario del propietario
teléfono	Cadena
snippet	Cadena de caracteres, un breve resumen del grupo
sortField	Cadena de caracteres, cómo se ordenan los elementos compartidos
sortOrder	Cadena de caracteres, ascendente o descendente
etiquetas	Lista de cadenas de caracteres, etiquetas para búsqueda suministradas por el usuario
vista en miniatura	Cadena de caracteres, nombre del archivo. Incorporar a http://<community url>/groups/<group id>/info/
título	Cadena de caracteres, nombre del grupo tal y 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 características que no se describen aquí. Para revisar todas las características, consulte Search reference en la API REST de ArcGIS.
• Al buscar usuarios, se suelen buscar 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 de caracteres obligatoria, cadena de consulta.
sort_field	Cadena de caracteres opcional, los valores válidos pueden ser título, propietario o creado
sort_order	Cadena de caracteres 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 se debe buscar o no dentro de la organización

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 de caracteres, código de idioma de dos letras
description	Cadena
fullName	Cadena de caracteres, nombre del usuario
modificado	Entero, tiempo transcurrido desde la última modificación de la cuenta, milisegundos desde el 1 de enero de 1970
región	Cadena de caracteres, puede ser ninguno
etiquetas	Lista de cadenas de caracteres, etiquetas para búsqueda suministradas por el usuario
vista en miniatura	Cadena de caracteres, nombre del archivo. Anexar a http://<community url>/groups/<group id>/info/.
nombre de usuario	Cadena de caracteres, nombre del usuario

signup

Registra usuarios en Portal for ArcGIS. Este método solo 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 solo 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 de caracteres obligatoria, debe ser única en el portal, mayor de 4 caracteres
contraseña	Cadena de caracteres obligatoria, debe ser mayor o igual que 8 caracteres
fullname	Cadena de caracteres obligatoria, nombre del usuario
correo electrónico	Cadena de caracteres obligatoria, debe ser una dirección de correo electrónico válida

Valor de retorno

Un Booleano que indica si la operación se realizó correctamente o no.

update_group

Actualiza un grupo. Solo tiene que 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 de caracteres obligatoria, Id. de grupo que se va a modificar
título	Cadena de caracteres obligatoria, nombre del grupo que se va a modificar
etiquetas	Cadena de caracteres obligatoria, lista de etiquetas delimitadas por comas
description	Cadena de caracteres opcional, describe el grupo en detalle
snippet	Cadena de caracteres opcional, menos de 250 caracteres que resumen el grupo
Acceso	Cadena de caracteres opcional, puede ser privado, público u org
vista en miniatura	Cadena de caracteres opcional, URL de la imagen del grupo
isInvitationOnly	Booleano opcional, define si los usuarios pueden unirse previa solicitud
sort_field	Cadena de caracteres opcional, especifica cómo se ordenan los elementos compartidos con el grupo
sort_order	Cadena de caracteres 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ó correctamente o no.

update_user

Actualiza las propiedades de un usuario. Solo tiene que 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 de caracteres obligatoria, nombre del usuario que se va a actualizar
Acceso	Cadena de caracteres opcional, valores: privado, org o público
preferred_view	Cadena de caracteres opcional, valores: web, SIG, nulo
description	Cadena de caracteres opcional, descripción del usuario
etiquetas	Cadena de caracteres opcional, etiquetas para búsquedas separadas por comas
vista en miniatura	Cadena de caracteres opcional, ruta o URL de un archivo. Puede ser PNG, GIF o JPEG. El tamaño máximo es 1 MB.
fullName	Cadena de caracteres opcional, nombre del usuario, solo para usuarios integrados
correo electrónico	Cadena de caracteres opcional, dirección de correo electrónico, solo para usuarios integrados
culture	Cadena de caracteres opcional, código de idioma de dos letras, por ejemplo "fr".
región	Cadena de caracteres 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ó correctamente o no.

update_user_role

Actualiza el rol de un usuario.

update_user_role(self, username, role)

Argumentos

Clave	Valor
nombre de usuario	Cadena de caracteres obligatoria, nombre del usuario cuyo rol va a cambiar
rol	Cadena de caracteres obligatoria, ya sea usuario, publicador, administrador o <custom_role_ID> (donde <custom_role_ID> es el Id. del rol personalizado, por ejemplo 1eo7LSAhbNiG1q9t, que se puede encontrar en roles en la ubicación compartida del Directorio de Portal for ArcGIS. La URL tiene el formato https://webadaptorhost.domain.com/<webadaptorname>/sharing/portals/0123456789ABCDEF/roles. Legado: 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.

Valor de retorno

Un Booleano que indica si la operación se realizó correctamente o no.