createUser

Categoría	Modificación de metadatos
Descripción	Cree uno o varios usuarios. Si se realiza correctamente, la API devolverá un mensaje para el usuario que se acaba de crear. Admite la creación de no más de 1000 usuarios en una sola solicitud.
Permisos obligatorios para invocar	Permiso de usuario
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. El usuario debe tener el permiso "Permiso de usuario" para crear los usuarios.

Este método no funciona después de la sincronización de usuarios desde Workday.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="createUser" callerName="a string that identifies your client application">
      <credentials login="sampleuser@company.com" password="my_pwd" />
        <users>
            <user
              email="newUser@company.com"
              name="new guy"
              password="new Password"
              alternateEmail="abc@greenco.com"
              samlFedId= "1234"
              permissionSetId="1"
              ownedLevels="2,3,7,11"
              timeZone="America/Mexico_City"
            />
       </users>
</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)

elemento de usuarios
Nombre de etiqueta		usuarios
Descripción		Contiene uno o varios elementos de usuario.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
Contenido del elemento
Contiene uno o varios elementos de usuario. Admite la creación de no más de 1000 usuarios en una sola solicitud.

elemento de usuario
Nombre de etiqueta		usuario
Descripción		Especifica un usuario o usuarios para crear.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
correo electrónico	Sí	La dirección de correo electrónico de este usuario. La exclusividad es obligatoria. Los únicos caracteres permitidos son az, AZ, 0-9, - y .	newUser@company.com
nombre	Sí	El nombre de este usuario.	Melvin Morsmere
posición Disponible en API v39+	No	Posición para usuario	"CEO"
contraseña	Sí	La contraseña de este usuario. Este atributo es obligatorio, excepto en el caso de una instancia conectada a Workday que tenga activada la sincronización de usuario y utilice el inicio de sesión único basado en SAML de Workday para iniciar sesión en Adaptive Planning.	nueva contraseña
alternateEmail Disponible en API v27	No	La dirección de correo electrónico alternativa de este usuario. Seleccionamos automáticamente esta opción y la rellenamos con el ID de correo electrónico del usuario en la sección Detalles de usuario.	abc@greenco.com
samlFedId Disponible en API v27	No	El ID de federación SAML de este usuario.	1234, user@company.com
permissionSetId Disponible en API v25+	No	El ID de sistema interno del conjunto de permisos asignado a este usuario.	3
roleId Disponible en API v25 y anteriores No disponible en API v25+	No	El ID de sistema interno del rol asignado a este usuario. No hay valor por defecto. (El atributo roleId también se trata en la API exportRoles).	3
ownLevels	No	El ID de sistema interno para los niveles separados por comas. No hay valor por defecto. (El atributo ownLevels también se trata en la API exportLevels).	5,10,13
página de inicio Disponible en API v39+	No	Página de inicio del usuario.	"Welcome"
timeZone	No	El huso horario del usuario. Si no se especifica ninguno, el valor por defecto es EE. UU./Pacífico.	EE. UU./Pacífico
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"
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"
Contenido del elemento
(ninguno)

Formato de respuesta


  <?xml version='1.0' encoding='UTF-8'?>
  <response success="true">
     <output>
         <result>
               <created_users>
                   <user success="true" message="user newUser@company.com was created successfully." guid="0CCF69803A990160E063820012ACFDD7"/>
               </created_users>
         </result>
     </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
Contenido del elemento
Un único elemento de resultado con los elementos de estado created_user o update_user en función de si se ha realizado una llamada a createUser o updateUser, respectivamente.

elemento de resultado
Nombre de etiqueta		resultado
Descripción		Contenedor para uno o varios elementos de estado.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de estado created_user o update_user en función de si se ha realizado una llamada a createUser o updateUser, respectivamente.

elemento created_users
Nombre de etiqueta		created_users
Descripción		Representa un mensaje enviado desde el sistema a la persona que llama.
Atributos del elemento
Nombre de atributo	¿ Obligatorio ?	Valor	Ejemplo
éxito de usuario	Sí	El estado devuelto por la llamada. Puede ser verdadero o falso.	verdadero
mensaje	Sí	El mensaje de estado.	usuarionewuser@company.com se ha creado correctamente.
GUID	Sí	El GUID del usuario creado.	"0CCF69803A990160E063820012ACFDD7"
Contenido del elemento
Un elemento de suscripciones