Objetos de respuesta

Este documento describe los tipos de objeto que la API de administración devuelve en el campo ResultData de la respuesta.

UserView

Devuelto por métodos que listan o recuperan información de usuarios, como ListUsersInDomain.

Campo	Tipo	Descripción
uid	string	Identificador único del usuario en formato USER:<id>@<dominio>.
userHandler	integer	ID interno del usuario.
username	string	Nombre de usuario.
friendlyName	string	Nombre completo del usuario.
domain	string	Alias del dominio al que pertenece el usuario.
email	string	Correo electrónico del usuario.
type	string	Tipo de usuario. Valores: LOCAL_USER, CERTIFICATE_USER, ACTIVE_DIRECTORY, LDAP, SAML2, OAuth2, ACTIVATION_CODE, UNKNOWN.
groupType	string	Indica si la entidad es un usuario o un grupo. Valores: USER, GROUP.
status	boolean	true si el usuario está activo.
consumeLicense	boolean	true si el usuario ha consumido una licencia.
lastCertificateUsage	datetime	Última vez que el usuario usó un certificado. null si nunca lo ha usado.
passwordExpirationDate	datetime	Fecha de expiración de la contraseña. null si no está configurada.

DomainView

Devuelto por métodos que listan dominios, como ListDomains.

Campo	Tipo	Descripción
id	integer	ID del dominio.
alias	string	Alias del dominio.
allowPersonalArea	boolean	true si los usuarios del dominio pueden acceder al área personal.
webSignatureAccess	boolean	true si los usuarios del dominio pueden usar el módulo Signtrust.
allowUploadCerts	boolean	true si los usuarios del dominio pueden subir certificados personales.
schema	string	Tipo de dominio. Mismos valores que UserView.type.
allowedUsers	integer	Número máximo de usuarios permitidos. 0 significa sin límite.
numUsers	integer	Número actual de usuarios en el dominio.
isExternal	boolean	true si el dominio es externo.
sharepointAccess	boolean	true si los usuarios del dominio pueden usar el módulo de SharePoint.

CertificateView

Devuelto por ListCertificates. Contiene la información principal de un certificado.

Campo	Tipo	Descripción
certificateHandler	integer	ID del certificado.
name	string	Alias del certificado.
active	boolean	true si el certificado está activo.
groups	array de strings	Nombres de los grupos de certificados que contienen este certificado.
policies	array de strings	Nombres de las políticas que usan este certificado.
users	array de strings	Usuarios asociados al certificado.
user_groups	array de strings	Grupos de usuarios asociados al certificado.
issuer	string	Emisor del certificado.
subject	string	Sujeto del certificado.
creationDate	datetime	Fecha de creación del certificado en Redtrust.
expirationDate	datetime	Fecha de expiración del certificado.
expired	boolean	true si el certificado ha expirado.
times_used	integer	Número de veces que se ha usado el certificado.
datetime_last_usage	datetime	Fecha del último uso del certificado. null si nunca se ha usado.
needPin	boolean	true si el uso del certificado requiere un PIN.
externalId	string	Identificador externo del certificado.
assignable	boolean	true si el propietario del certificado puede cambiarse.
owner	string	Nombre de usuario del propietario del certificado.
ownerId	integer	ID del propietario del certificado.
ownerUID	string	UID del propietario del certificado.
usageReason	boolean	true si el uso del certificado requiere indicar un motivo.
userPinPolicy	string	Comportamiento del PIN de usuario respecto al certificado.
allowBackup	boolean	true si el certificado puede descargarse desde Redtrust.
allowCSR	boolean	true si se puede crear una CSR a partir de este certificado.
isRevoked	boolean	true si el certificado está revocado.
policyIdentifier	string	Identificador del perfil del certificado.

CertificateDetail

Devuelto por GetCertificateData. Incluye todos los campos de CertificateView más los detalles completos del certificado X.509.

Campo	Tipo	Descripción
certificateHandler	integer	ID del certificado.
active	boolean	true si el certificado está activo.
alias	string	Alias del certificado.
friendlyName	string	Nombre descriptivo del certificado.
certificateSN	string	Número de serie del certificado.
thumbprint	string	Huella digital del certificado.
subject	string	Sujeto del certificado (DN completo).
issuer	string	Emisor del certificado (DN completo).
validFrom	datetime	Inicio del período de validez del certificado.
validUntil	datetime	Fin del período de validez del certificado.
expired	boolean	true si el certificado ha expirado.
notEnabledYet	boolean	true si la fecha de inicio de validez aún no ha llegado.
version	integer	Versión del certificado X.509.
signatureAlg	string	Algoritmo de firma del certificado.
keyValue	string	Valor de la clave pública del certificado.
extensions	string	Extensiones del certificado.
archived	boolean	true si el certificado está archivado.
comment	string	Comentario libre sobre el certificado.
needPin	boolean	true si el uso del certificado requiere un PIN.
usageReason	boolean	true si el uso del certificado requiere indicar un motivo.
userPinPolicy	string	Comportamiento del PIN de usuario respecto al certificado.
assignable	boolean	true si el propietario del certificado puede cambiarse.
owner	string	Nombre de usuario del propietario del certificado.
ownerId	integer	ID del propietario del certificado.
ownerUID	string	UID del propietario del certificado.
ownerName	string	Nombre completo del propietario del certificado.
groups	array de strings	Grupos de certificados que contienen este certificado.
policies	array de strings	Políticas que usan este certificado.
users	array de strings	Usuarios asociados al certificado.
user_groups	array de strings	Grupos de usuarios asociados al certificado.
timesUsed	integer	Número de veces que se ha usado el certificado.
datetimeLastUsage	datetime	Fecha del último uso del certificado. null si nunca se ha usado.
subjectSimpleName	string	Nombre simple del sujeto.
subjectDnsName	string	Nombre DNS del sujeto.
subjectDnsFromAlternativeName	string	Nombre DNS del sujeto obtenido del nombre alternativo.
subjectEmailName	string	Correo electrónico del sujeto.
subjectUpnName	string	UPN del sujeto.
subjectUrlName	string	URL asociada al sujeto.
issuerSimpleName	string	Nombre simple del emisor.
issuerDnsName	string	Nombre DNS del emisor.
issuerDnsFromAlternativeName	string	Nombre DNS del emisor obtenido del nombre alternativo.
issuerEmailName	string	Correo electrónico del emisor.
issuerUpnName	string	UPN del emisor.
issuerUrlName	string	URL asociada al emisor.

CACertificateView

Devuelto por ListCACertificates.

Campo	Tipo	Descripción
id	integer	ID del certificado CA.
issuer	string	Emisor del certificado CA.
subject	string	Sujeto del certificado CA.
expirationDate	datetime	Fecha de expiración del certificado CA.
creationDate	datetime	Fecha desde la que el certificado CA es válido.
expired	boolean	true si el certificado CA ha expirado.
installed	boolean	true si el certificado CA está instalado en Redtrust.
thumbprint	string	Huella digital del certificado CA.

CertificateAttribute

Devuelto por ListCertificateAttributes. Representa un tipo de atributo de certificado disponible en el sistema.

Campo	Tipo	Descripción
id	integer	ID del atributo de certificado. Usa este valor en el campo id de certAttributes al llamar a AddCertificateUser.
name	string	Nombre del atributo de certificado.

GroupsResponse

Devuelto por ListApplicationGroups y ListSiteGroups.

Campo	Tipo	Descripción
globalApps	boolean	true si hay grupos de aplicaciones globales configurados en el sistema.
groups	array de BaseGroup	Lista de grupos. Cada elemento puede ser de tipo ApplicationGroup o SiteGroup, indicado por el atributo i:type en la respuesta XML.

ApplicationGroup

Devuelto directamente por GetApplicationGroup. También incluido en el campo groups de GroupsResponse, devuelto por ListApplicationGroups.

Campo	Tipo	Descripción
groupId	integer	ID del grupo de aplicaciones.
friendlyName	string	Nombre del grupo.
roleId	integer	ID del rol al que pertenece el grupo. 0 si pertenece a todos los roles.
roleName	string	Nombre del rol. null si pertenece a todos los roles.
applications	array de Application	Lista de aplicaciones del grupo. Cada elemento incluye: id (ID interno), name (nombre del proceso o patrón), expType (tipo de expresión: PROCESS, REGEXP, RTREGEXP, COMMAND_LINE).
mappedSites	array de strings	Lista de sitios web asociados al grupo.

SiteGroup

Devuelto directamente por GetSitesGroup. También incluido en el campo groups de GroupsResponse, devuelto por ListSiteGroups.

Campo	Tipo	Descripción
groupId	integer	ID del grupo de sitios.
friendlyName	string	Nombre del grupo.
roleId	integer	ID del rol al que pertenece el grupo. 0 si pertenece a todos los roles.
roleName	string	Nombre del rol. null si pertenece a todos los roles.
sites	array de Site	Lista de sitios del grupo. Cada elemento incluye: id (ID interno), name (URL o patrón del sitio), expType (tipo de expresión: REGEXP, RTREGEXP) y postdata (datos POST para distinguir sitios con la misma URL; puede ser null).
mappedSites	array de strings	Lista de sitios web adicionales asociados al grupo.

PolicyView

Devuelto por ListPolicies. Contiene los datos principales de una política.

Campo	Tipo	Descripción
action	string	Acción de la política: ALLOW o DENY.
active	boolean	true si la política está activa.
certificates	array de strings	Nombres de los certificados individuales incluidos en la política.
context	PolicyContext	Contexto de aplicación. Incluye: sites (nombres de grupos de sitios), apps (nombres de grupos de aplicaciones), browsers (navegadores permitidos), dss (si permite DSS), macAgent (si permite el Agente macOS).
groups	array de strings	Nombres de los grupos de certificados incluidos en la política.
idRole	integer	ID del rol al que pertenece la política. 0 si pertenece a todos los roles.
name	string	Nombre de la política.
policyId	integer	ID de la política.
priority	integer	Prioridad de la política. Los valores más bajos tienen mayor prioridad.
role	string	Nombre del rol al que pertenece la política.
userGroups	array de strings	Nombres de los grupos de usuarios incluidos en la política.
userPinPolicy	string	Comportamiento del PIN de usuario: DO_NOTHING, ASK_FOR_USER_PIN, DONT_ASK_FOR_USER_PIN.
users	array de strings	Nombres de los usuarios incluidos en la política.

Policy

Devuelto por GetPolicyData. Contiene los detalles completos de una política, incluidos sus recursos asociados.

Campo	Tipo	Descripción
action	string	Acción de la política: ALLOW o DENY.
active	boolean	true si la política está activa.
allowAllBrowser	boolean	true si la política aplica a todos los navegadores.
allowedBrowsers	array de strings	Navegadores específicos cuando allowAllBrowser es false. Valores: IE, FF, CH, EDGE.
applications	array de ApplicationGroup	Grupos de aplicaciones donde se aplica la política.
certificateGroups	array de CertificateGroup	Grupos de certificados incluidos en la política.
certificates	array de Certificate	Certificados individuales incluidos en la política. Cada elemento incluye: certificateHandler (ID del certificado), alias (alias del certificado), active, certificateUserPinPolicy, expirationDate, needPin y usageReason.
comment	string	Descripción o comentario de la política.
dss	boolean	true si la política permite el uso del servicio DSS.
macAgent	boolean	true si la política permite el uso del Agente macOS.
name	string	Nombre de la política.
policyId	integer	ID de la política.
priority	integer	Prioridad de la política.
sites	array de SiteGroup	Grupos de sitios donde se aplica la política.
userPinPolicy	string	Comportamiento del PIN de usuario: DO_NOTHING, ASK_FOR_USER_PIN, DONT_ASK_FOR_USER_PIN.
users	array de UserView	Usuarios incluidos en la política.
when	When	Planificación horaria. Incluye: always (true si la política es siempre válida) y entries (lista de franjas horarias con days, startDate, endDate, startTime, endTime).

EventView

Devuelto por ListEvents.

Campo	Tipo	Descripción
date	datetime	Fecha y hora del evento.
ip	string	Dirección IP desde la que se produjo el evento.
user	string	Nombre de usuario que generó el evento.
context	array de strings	Información de contexto adicional del evento.
certificate	string	Nombre del certificado usado en el evento.
description	string	Descripción del evento.
url	string	Objeto JSON con datos de contexto del evento, como el proceso, el tipo de navegador, la URL visitada, la política aplicada y el ID del agente. null si no aplica.

SystemEventView

Devuelto por ListSystemEvents y ListHAEvents.

Campo	Tipo	Descripción
dateTime	datetime	Fecha y hora del evento.
ip	string	Dirección IP desde la que se produjo el evento.
user	string	Nombre de usuario que realizó la acción.
section	string	Sección de la consola de administración donde se produjo el evento.
information	string	Descripción de la acción realizada.
oldData	string	Estado anterior al cambio, en formato JSON. null si no aplica.
newData	string	Estado posterior al cambio, en formato JSON. null si no aplica.
context	array	Lista de pares clave-valor con información de contexto adicional. Cada elemento tiene Item1 (etiqueta) e Item2 (valor). null si no aplica.

CertificateDirective

Devuelto por ListCertificateDirectives. Representa una directiva de certificado configurada en el sistema.

Campo	Tipo	Descripción
id	integer	ID de la directiva de certificado. Usa este valor en certDirectiveIds al llamar a AddCertificateUser.
value	string	Descripción o valor de la directiva de certificado.