exportUsers
Categoría
| Metadata retrieval |
Descripción
| Devuelve los metadatos de la lista completa de todos los usuarios de la instancia. |
Permisos obligatorios para invocar
| Administrador de usuarios |
Parámetros obligatorios bajo petición
| Credenciales |
La solicitud de este método solo contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. Una vez verificado, el método devuelve un documento XML que describe el conjunto completo de todos los usuarios definidos en la instancia.
Formato de solicitud
<?xml version='1.0' encoding='UTF-8'?> <call method="exportUsers" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </call>
elemento de credenciales
| |||
Nombre de etiqueta
| credenciales | ||
Descripción
| Todas las llamadas a la API deben contener un único elemento de credenciales para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la llamada a la API se lleve a cabo. correcta | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
inicio de sesión | Sí | El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método. | sampleuser@company.com |
contraseña | Sí | La contraseña del usuario que invoca el método API. | my_password |
configuración regional | No | Especifique la configuración regional que se utilizará para interpretar los números y las fechas de entrada, y para dar formato a los números y las fechas de salida (utilizando el separador de miles, los nombres de mes y el formato de fecha adecuados). La configuración regional también se utiliza para especificar el idioma en el que deben aparecer los mensajes del sistema en la respuesta. Si no se especifica, se utiliza en_US (inglés americano). | fr_FR |
instanceCode | No | Si el usuario especificado en las credenciales tiene acceso a más de una instancia de Adaptive Planning , este atributo se puede utilizar para especificar que el usuario tiene la intención de acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utilizará la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances. | MYINSTANCE1 |
Contenido del elemento
| |||
(ninguno) | |||
incluir elemento Disponible en API v17 y anteriores. No disponible en API v18+. | |||
Nombre de etiqueta
| incluir | ||
Descripción
| Representa un conjunto de indicadores que indican qué aspectos de la información de los usuarios deben incluirse o excluirse de la respuesta. Este elemento es opcional: si no está presente, los valores por defecto son true para ownLevels y false para hiddenVersions. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
grupos Disponible en API v23+. | No | La palabra verdadero o falso. Indica si los elementos de usuario de la respuesta incluyen un atributo groupIds. Si es verdadero, los groupIds de la respuesta contienen una lista separada por comas de todos los grupos en los que se encuentra el usuario. Si el atributo no está presente, o si su valor es distinto de verdadero o falso, se utiliza el valor por defecto de falso. | verdadero |
ownLevels Disponible en API v17 y anteriores. No disponible en API v18+. | No | La palabra verdadero o falso. Indica si los elementos de usuario de la respuesta deben incluir o no los atributos ownLevels. Si el atributo no está presente, o si su valor es distinto de verdadero o falso, se utiliza el valor por defecto verdadero. | verdadero |
hiddenVersions Disponible en API v17 y anteriores. No disponible en API v18+. | No | La palabra verdadero o falso. Indica si los elementos de usuario de la respuesta deben incluir atributos hiddenVersions o no. Si el atributo no está presente, o si su valor es distinto de verdadero o falso, se utiliza el valor por defecto de falso. | falso |
Contenido del elemento
| |||
(ninguno) | |||
Formato de respuesta
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <users seqNo="55"> <user id="19" guid="B9ADBCB81AA2F9BAE040307F02092C2E" login="analytica@fakecompany.com" email="analytica@fakecompany.com" name="Anna Analyzer" permissionSetId="3" timeZone="US/Pacific"/> <user id="123" guid="AAFF5218D55ABB9234660001BEC117A9" login="randomuser@fakecompany.com" email="randomuser@fakecompany.com" name="J. Random User" permissionSetId="2" timeZone="US/Pacific"/> </users> </output> </response>
elemento de respuesta
| |||
Nombre de etiqueta
| respuesta | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
éxito | Sí | Verdadero o falso, que indica si la llamada a la API se ha realizado correctamente o no. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta. | verdadero |
obsoleto | No | Si está presente en la etiqueta de respuesta y se establece en verdadero, este atributo indica que la versión del método o API que se está invocando ha quedado obsoleta y está oficialmente desaprobada. Aunque sigue funcionando en este momento, es posible que deje de funcionar en un breve periodo de tiempo. Normalmente, este atributo no está presente. | falso |
Contenido del elemento
| |||
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio. | |||
elemento de resultado
| |
Nombre de etiqueta
| salida |
Atributos del elemento
| |
(ninguno) | |
Contenido del elemento
| |
Un solo elemento de cuentas Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta. | |
elemento de usuarios
| |||
Nombre de etiqueta
| usuarios | ||
Descripción
| Contenedor para uno o varios elementos de usuario. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
seqNo Añadido en API v17, pero reservado para uso futuro. | |||
Contenido del elemento
| |||
Uno o varios elementos de usuario | |||
elemento de usuario
| |||
Nombre de etiqueta
| usuario | ||
Descripción
| Representa un solo usuario que se devuelve en la respuesta a una llamada a la API exportUsers. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
ID | Sí | El número de ID de sistema interno del usuario. | 19 |
GUID | Sí | Un identificador exclusivo global para el usuario. Este identificador nunca cambiará para este usuario, aunque su conexión o su nombre cambien en el futuro. | B9ADBCB81AA2F9BAE040307F02092C2E |
inicio de sesión | Sí | El inicio de sesión de este usuario. | analytica@fakecompany.com |
correo electrónico | Sí | La dirección de correo electrónico de este usuario. Puede estar en blanco si el usuario no ha configurado una dirección de correo electrónico válida. | analytica@fakecompany.com |
nombre | Sí | El nombre de este usuario. | Analizador de Anna |
posición
Disponible en API v39+ | No | Posición para usuario | "CEO" |
permissionSetId Disponible en API v25+ No disponible en API v36+ | Sí | El ID de sistema interno del conjunto de permisos asignado a este usuario. Consulte también exportPermissionSets. | |
permissionSetIds
Disponible en API v36+ | Sí | Los IDs de sistema internos de los conjuntos de permisos asignados a este usuario. Consulte también exportPermissionSets. | |
roleId Disponible en API v25 y anteriores No disponible en API v25+ | Sí | El ID de sistema interno del rol asignado a este usuario. Consulte también exportRoles. | 3 |
ownLevels No disponible en API v18 | Sí | Este atributo solo se incluye si el usuario incluido en las credenciales de la solicitud tiene permiso de administrador de nivel en todo el árbol de la organización y la solicitud ha indicado que ownLevels debe incluirse. Si se incluye, el valor de este atributo es una lista separada por comas de IDs de sistema internos para los niveles de organización a los que se ha concedido acceso directo a este usuario. El usuario también tendrá acceso a cualquier nivel secundario de los niveles que se enumeran aquí. | 5,10,13 |
hiddenVersions No disponible en API v18 | N (ver descripción) | Este atributo solo se incluye si el usuario incluido en las credenciales de la solicitud tiene permiso de administrador de versiones y la solicitud ha indicado que se deben incluir hiddenVersions. Si se incluye, el valor de este atributo es una lista separada por comas de IDs de sistema internos para versiones o carpetas de versión que están ocultas para este usuario (pero cuyo elemento principal no existe o no está oculto). El usuario tampoco podrá ver ninguna versión secundaria de las versiones que se enumeran aquí. | 121 |
alternateEmail
Disponible en API v39+ | No | La dirección de correo electrónico alternativa de este usuario. | "abc@greenco.com" |
samlFedId
Disponible en API v39+ | No | El ID de SAMLFederation para este usuario. | "1234" |
timeZone | Sí | El huso horario del usuario. | EE. UU./Pacífico |
página de inicio
Disponible en API v39+ | No | Página de inicio del usuario. | "Welcome" |
país
Disponible en API v39+ | No | Código de país para usuario (código alfa-2). | "EE. UU." |
usState
Disponible en API v39+ | No | Código de estado para usuario (el país debe ser EE. UU.). | "CA" |
perspectiva
Disponible en API v39+ | No | ID de perspectiva para usuario. | "111" |
OutlookName
Disponible en API v39+ | No | Nombre de perspectiva de la perspectiva del usuario. | "Prueba de perspectiva" |
tablero de control
Disponible en API v39+ | No | ID de tablero de control para usuario: requiere un ID de perspectiva para establecer el ID de tablero de control, si se especifica el ID de perspectiva y no el ID de tablero de control, el ID de tablero de control se establece como nulo. | "222" |
DashboardName
Disponible en API v39+ | No | Nombre del tablero de control del usuario. | "Prueba de tablero de control" |
netsuiteLogin
Disponible en API v39+ | No | Inicio de sesión de NetSuite | "abc@netsuite.com" |
salesforceLogin
Disponible en API v39+ | No | Inicio de sesión de Salesforce. | "abc@salesforce.com" |
createdDate
Disponible en API v39+ | No | La marca de tiempo de fecha y hora en la que se creó el usuario. | "2023-08-15 08:02:16.0" |
lastLogin
Disponible en API v39+ | No | La marca de tiempo de fecha y hora de la última vez que el usuario se conectó. | "2023-11-13 22:22:39.0" |
Intentos fallidos
Disponible en API v39+ | No | Número de intentos de inicio de sesión fallidos para este usuario (consecutivos). | "0" |
bloqueado
Disponible en API v39+ | No | Si el usuario está bloqueado o no puede iniciar sesión (debido a demasiados inicios de sesión fallidos). | "false" |
Contenido del elemento
| |||
Un elemento de suscripciones | |||
elemento de suscripciones
| |||
Nombre de etiqueta
| suscripciones | ||
Descripción
| Representa la configuración de suscripción de correo electrónico de un usuario. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
nosubscriptions | Sí | Configuración para indicar que el usuario ha descartado todas las suscripciones. 1 significa que el usuario ha cancelado todas las suscripciones. | 0 |
systemAlertsAndUpdates | Sí | Configuración de alertas de sistema y suscripción de actualizaciones elegida por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
customerNewsLetter | Sí | Parámetro para la suscripción al boletín de noticias del cliente elegido por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
localEvents | Sí | Configuración de la suscripción a eventos locales elegida por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
educaciónFormación | Sí | Configuración de la suscripción a eventos de educación y formación elegida por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
customerWebinars | Sí | Configuración de la suscripción a eventos de seminario web de cliente elegida por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
newProductsAndEnhancements | Sí | Parámetro para notificación de nuevo producto y mejoras elegido por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
partnerNewsLetter | Sí | Parámetro de suscripción a boletines informativos de partners elegido por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
partnerWebinars | Sí | Configuración de la suscripción a eventos de seminarios web de partners elegida por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
userGroups | Sí | Configuración de notificación de eventos de grupos de usuarios elegida por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 1 |
encuestas | Sí | Configuración para recibir encuestas elegida por el usuario. 1 significa que el usuario ha aceptado y 0 significa que ha excluido. | 0 |
Contenido del elemento
| |||
ninguno | |||