GXPAPIUser

Este procedimiento permite administrar la información de los usuarios del portal, tanto agregar un nuevo usuario, obtener información de un usuario, actualizar sus datos o bien eliminarlo.

Los parámetros que utiliza son: 

(inout:&GXPUser, inout:&GAMApiParm, inout:&GXPConnInf, out:&GXPStatus )

&GXPConnInf y &GXPStatus fueron explicados anteriormente, para verlo de clic aquí.

&GXPUser es un parámetro de entrada/salida, el mismo mantiene la información del usuario con el cual se desea trabajar.
Este parámetro es una variable de tipo SDT con la siguiente estructura:



 

Id	Identificador de usuario.
Delete	Booleano que indica GAMBoolean.True que el usuario está eliminado o GAMBoolean.False indica que no está eliminado.
Name	Nombre para autenticar un usuario (posible login).
EMail	Correo electrónico del usuario (posible login).
Login	String por el cual se está autenticando el usuario (Name o Email).
FirstName	Nombres del usuario.
LastName	Apellidos del usuario.
Gender	Sexo, el mismo puede ser: • GAMUsrGen.Not_Specified = No especificado • GAMUsrGen.Female = Femenino • GAMUsrGen.Male = Masculino
BirthDate	Fecha de nacimiento
CountryId	Identificador del País donde reside
NotReciveInformation	Booleano que indica si GAMBoolean.True que el usuario no desea recibir información adicional, no recibirá correos electrónicos desde la lista de noticias.
Password	Contraseña del usuario.
PasswordConf	Confirmación de la contraseña del usuario.
DateLastChgPwd	Fecha en la cual el usuario realizó el último cambio de contraseña.
Active	Booleano que indica si el usuario está o no activo para autenticarse en el portal, los valores posibles son: GAMUsrAct.YES y GAMUsrAct.NO.
ActiveKey	Clave que permitirá al usuario activar su cuenta desde la página con el portlet de activación de cuentas de usuario.
ChgPwdNexLog	Booleano  • GAMUsrChgPwdNexLog.CHG_PWD_NL = Cambiar la contraseña en su próxima autenticación. • GAMUsrChgPwdNexLog.NOT_CHG_PWD_NL = No cambiar la contraseña en su próxima autenticación.
NotChgPwd	Booleano que indica que el usuario puede o no cambiar la contraseña, los valores pueden ser: • GAMUsrNotChgPwd.CHANGE_PWD = Que tiene permitido el cambio. • GAMUsrNotChgPwd.NOT_CHANGE_PWD = Que no tiene permitido el cambio.
PwdNevExp	Booleano que indica que al usuario nunca se le expira la contraseña, el mismo puede ser: • GAMUsrPwdNevExp.NEVER_EXPIRE = Nunca expira su contraseña. • GAMUsrPwdNevExp.EXPIRE = La contraseña expira según la política de seguridad correspondiente.
Disable	Booleano que indica que al usuario está bloqueado para autenticarse, se puede bloquear desde el backend o por reintentos de autenticación fallidos. Puede tener los siguientes valores: • GAMUsrDis.TRUE = Verdadero • GAMUsrDis.FALSE = Falso
PortalLanguageId	Idioma en el cual el usuario visualizará el portal en forma predeterminada al autenticarse.
SecurityPolicyId	Identificador de política de seguridad del usuario, si no tiene una política asignada seguirá las preferencias del rol principal o del repositorio.
ExternalId	Identificador externo del usuario, utilizado por el SSO o para cuando una aplicación necesita contar con más información en su base de datos.
CreDate	Fecha y hora de creación del usuario.
ModDate	Fecha y hora de última modificación del usuario.
AttDin	Atributos dinámicos de los usuarios, el mismo es una colección con los siguiente valores: • Id = Identificador del atributo • Encripted = Indica si el valor del atributo se almacena encriptado en la base de datos. • IsMV = Booleano que indica si el mismo es Multi Valuado (debe ser GAMBoolean.False, ya que GAMBoolean.True no esta implementado. • Value = Valor del atributo

&GAMApiParm es un parámetro de entrada/salida, en el mismo informa a al procedimiento que función se desea cumplir y se retorna el estado del proceso realizado.
Este parámetro es una variable de tipo SDT con la siguiente estructura:

Mode	Modo en el cual indica al procedimiento su comportamiento, el mismo puede ser: • &GXPApiParm.Mode = GAMMode.INI = Inicializar datos. • &GXPApiParm.Mode = GAMMode.INS = Insertar usuario. • &GXPApiParm.Mode = GAMMode.UPD = Actualizar usuario. • &GXPApiParm.Mode = GAMMode.DLT = Eliminar usuario. • &GXPApiParm.Mode = GAMMode.DSP = Obtener datos de un usuario.
SubMode	Parámetro que permite personalizar el comportamiento del procedimiento, el mismo puede ser: Nulo = No realiza ninguna función en particular “NOTPWD” = No valida ni actualiza la contraseña del usuario “NOTPWD” = No valida ni actualiza la contraseña del usuario “NOTPWD” = No valida ni actualiza la contraseña del usuario“NOTPWD” = No valida ni actualiza la contraseña del usuario
Commit	Booleano que indica al procedimiento que realice commit al finalizar, para ello debe tener el valor GAMBoolean.True.
ForceDlt	No utilizado.
LoadProperties	No utilizado.

Para crear un nuevo usuario se deben inicializar todos los datos del SDT, el procedimiento debe ser llamado en Modo Insert.
Para actualizar algún dato del usuario, primero se deben obtener la información del mismo, actualizar el valor deseado en el SDT y recién luego se debe llamar al API en Modo Update.
Pata Obtener información del usuario, se debe llamar al API en Modo Display, para este caso el SDT del usuario debe tener uno de estos identificadores: Id, Name, Email o Login. No se retorna información de los usuarios eliminados.
Para eliminar un usuario el API debe ser llamada solo en modo Delete y el SDT del usuario debe tener Id.