Objetos de resposta

Este documento descreve os tipos de objeto que a API de administração retorna no campo ResultData da resposta.

UserView

Retornado por métodos que listam ou recuperam informações de usuários, como ListUsersInDomain.

Campo	Tipo	Descrição
uid	string	Identificador único do usuário no formato USER:<id>@<domínio>.
userHandler	integer	ID interno do usuário.
username	string	Nome de usuário.
friendlyName	string	Nome completo do usuário.
domain	string	Alias do domínio ao qual o usuário pertence.
email	string	Endereço de e-mail do usuário.
type	string	Tipo de usuário. Valores: LOCAL_USER, CERTIFICATE_USER, ACTIVE_DIRECTORY, LDAP, SAML2, OAuth2, ACTIVATION_CODE, UNKNOWN.
groupType	string	Indica se a entidade é um usuário ou um grupo. Valores: USER, GROUP.
status	boolean	true se o usuário está ativo.
consumeLicense	boolean	true se o usuário consumiu uma licença.
lastCertificateUsage	datetime	Última vez que o usuário usou um certificado. null se nunca usou.
passwordExpirationDate	datetime	Data de expiração da senha. null se não estiver configurada.

DomainView

Retornado por métodos que listam domínios, como ListDomains.

Campo	Tipo	Descrição
id	integer	ID do domínio.
alias	string	Alias do domínio.
allowPersonalArea	boolean	true se os usuários do domínio podem acessar a área pessoal.
webSignatureAccess	boolean	true se os usuários do domínio podem usar o módulo Signtrust.
allowUploadCerts	boolean	true se os usuários do domínio podem fazer upload de certificados pessoais.
schema	string	Tipo de domínio. Mesmos valores que UserView.type.
allowedUsers	integer	Número máximo de usuários permitidos. 0 significa sem limite.
numUsers	integer	Número atual de usuários no domínio.
isExternal	boolean	true se o domínio é externo.
sharepointAccess	boolean	true se os usuários do domínio podem usar o módulo do SharePoint.

CertificateView

Retornado por ListCertificates. Contém as informações principais de um certificado.

Campo	Tipo	Descrição
certificateHandler	integer	ID do certificado.
name	string	Alias do certificado.
active	boolean	true se o certificado está ativo.
groups	array de strings	Nomes dos grupos de certificados que contêm este certificado.
policies	array de strings	Nomes das políticas que usam este certificado.
users	array de strings	Usuários associados ao certificado.
user_groups	array de strings	Grupos de usuários associados ao certificado.
issuer	string	Emissor do certificado.
subject	string	Sujeito do certificado.
creationDate	datetime	Data em que o certificado foi adicionado ao Redtrust.
expirationDate	datetime	Data de expiração do certificado.
expired	boolean	true se o certificado expirou.
times_used	integer	Número de vezes que o certificado foi usado.
datetime_last_usage	datetime	Data do último uso do certificado. null se nunca foi usado.
needPin	boolean	true se o uso do certificado requer um PIN.
externalId	string	Identificador externo do certificado.
assignable	boolean	true se o proprietário do certificado pode ser alterado.
owner	string	Nome de usuário do proprietário do certificado.
ownerId	integer	ID do proprietário do certificado.
ownerUID	string	UID do proprietário do certificado.
usageReason	boolean	true se o uso do certificado requer informar um motivo.
userPinPolicy	string	Comportamento do PIN do usuário em relação ao certificado.
allowBackup	boolean	true se o certificado pode ser baixado do Redtrust.
allowCSR	boolean	true se é possível criar uma CSR a partir deste certificado.
isRevoked	boolean	true se o certificado está revogado.
policyIdentifier	string	Identificador do perfil do certificado.

CertificateDetail

Retornado por GetCertificateData. Inclui todos os campos de CertificateView mais os detalhes completos do certificado X.509.

Campo	Tipo	Descrição
certificateHandler	integer	ID do certificado.
active	boolean	true se o certificado está ativo.
alias	string	Alias do certificado.
friendlyName	string	Nome amigável do certificado.
certificateSN	string	Número de série do certificado.
thumbprint	string	Impressão digital do certificado.
subject	string	Sujeito do certificado (DN completo).
issuer	string	Emissor do certificado (DN completo).
validFrom	datetime	Início do período de validade do certificado.
validUntil	datetime	Fim do período de validade do certificado.
expired	boolean	true se o certificado expirou.
notEnabledYet	boolean	true se a data de início de validade ainda não foi atingida.
version	integer	Versão do certificado X.509.
signatureAlg	string	Algoritmo de assinatura do certificado.
keyValue	string	Valor da chave pública do certificado.
extensions	string	Extensões do certificado.
archived	boolean	true se o certificado está arquivado.
comment	string	Comentário livre sobre o certificado.
needPin	boolean	true se o uso do certificado requer um PIN.
usageReason	boolean	true se o uso do certificado requer informar um motivo.
userPinPolicy	string	Comportamento do PIN do usuário em relação ao certificado.
assignable	boolean	true se o proprietário do certificado pode ser alterado.
owner	string	Nome de usuário do proprietário do certificado.
ownerId	integer	ID do proprietário do certificado.
ownerUID	string	UID do proprietário do certificado.
ownerName	string	Nome completo do proprietário do certificado.
groups	array de strings	Grupos de certificados que contêm este certificado.
policies	array de strings	Políticas que usam este certificado.
users	array de strings	Usuários associados ao certificado.
user_groups	array de strings	Grupos de usuários associados ao certificado.
timesUsed	integer	Número de vezes que o certificado foi usado.
datetimeLastUsage	datetime	Data do último uso do certificado. null se nunca foi usado.
subjectSimpleName	string	Nome simples do sujeito.
subjectDnsName	string	Nome DNS do sujeito.
subjectDnsFromAlternativeName	string	Nome DNS do sujeito obtido da extensão de nome alternativo.
subjectEmailName	string	Endereço de e-mail do sujeito.
subjectUpnName	string	UPN do sujeito.
subjectUrlName	string	URL associada ao sujeito.
issuerSimpleName	string	Nome simples do emissor.
issuerDnsName	string	Nome DNS do emissor.
issuerDnsFromAlternativeName	string	Nome DNS do emissor obtido da extensão de nome alternativo.
issuerEmailName	string	Endereço de e-mail do emissor.
issuerUpnName	string	UPN do emissor.
issuerUrlName	string	URL associada ao emissor.

CACertificateView

Retornado por ListCACertificates.

Campo	Tipo	Descrição
id	integer	ID do certificado CA.
issuer	string	Emissor do certificado CA.
subject	string	Sujeito do certificado CA.
expirationDate	datetime	Data de expiração do certificado CA.
creationDate	datetime	Data a partir da qual o certificado CA é válido.
expired	boolean	true se o certificado CA expirou.
installed	boolean	true se o certificado CA está instalado no Redtrust.
thumbprint	string	Impressão digital do certificado CA.

CertificateAttribute

Retornado por ListCertificateAttributes. Representa um tipo de atributo de certificado disponível no sistema.

Campo	Tipo	Descrição
id	integer	ID do atributo de certificado. Use este valor no campo id de certAttributes ao chamar AddCertificateUser.
name	string	Nome do atributo de certificado.

GroupsResponse

Retornado por ListApplicationGroups e ListSiteGroups.

Campo	Tipo	Descrição
globalApps	boolean	true se houver grupos de aplicações globais configurados no sistema.
groups	array de BaseGroup	Lista de grupos. Cada elemento pode ser do tipo ApplicationGroup ou SiteGroup, indicado pelo atributo i:type na resposta XML.

ApplicationGroup

Retornado diretamente por GetApplicationGroup. Também incluído no campo groups de GroupsResponse, retornado por ListApplicationGroups.

Campo	Tipo	Descrição
groupId	integer	ID do grupo de aplicações.
friendlyName	string	Nome do grupo.
roleId	integer	ID do perfil ao qual o grupo pertence. 0 se pertencer a todos os perfis.
roleName	string	Nome do perfil. null se pertencer a todos os perfis.
applications	array de Application	Lista de aplicações no grupo. Cada item inclui: id (ID interno), name (nome do processo ou padrão), expType (tipo de expressão: PROCESS, REGEXP, RTREGEXP, COMMAND_LINE).
mappedSites	array de strings	Lista de sites associados ao grupo.

SiteGroup

Retornado diretamente por GetSitesGroup. Também incluído no campo groups de GroupsResponse, retornado por ListSiteGroups.

Campo	Tipo	Descrição
groupId	integer	ID do grupo de sites.
friendlyName	string	Nome do grupo.
roleId	integer	ID do perfil ao qual o grupo pertence. 0 se pertencer a todos os perfis.
roleName	string	Nome do perfil. null se pertencer a todos os perfis.
sites	array de Site	Lista de sites no grupo. Cada item inclui: id (ID interno), name (URL ou padrão de site), expType (tipo de expressão: REGEXP, RTREGEXP) e postdata (dados POST para distinguir sites com a mesma URL; pode ser null).
mappedSites	array de strings	Lista de sites adicionais associados ao grupo.

PolicyView

Retornado por ListPolicies. Contém os dados principais de uma política.

Campo	Tipo	Descrição
action	string	Ação da política: ALLOW ou DENY.
active	boolean	true se a política está ativa.
certificates	array de strings	Nomes dos certificados individuais incluídos na política.
context	PolicyContext	Contexto de aplicação. Inclui: sites (nomes dos grupos de sites), apps (nomes dos grupos de aplicações), browsers (navegadores permitidos), dss (se permite DSS), macAgent (se permite o Agente macOS).
groups	array de strings	Nomes dos grupos de certificados incluídos na política.
idRole	integer	ID do perfil ao qual a política pertence. 0 se pertencer a todos os perfis.
name	string	Nome da política.
policyId	integer	ID da política.
priority	integer	Prioridade da política. Valores menores têm maior prioridade.
role	string	Nome do perfil ao qual a política pertence.
userGroups	array de strings	Nomes dos grupos de usuários incluídos na política.
userPinPolicy	string	Comportamento do PIN do usuário: DO_NOTHING, ASK_FOR_USER_PIN, DONT_ASK_FOR_USER_PIN.
users	array de strings	Nomes dos usuários incluídos na política.

Policy

Retornado por GetPolicyData. Contém os detalhes completos de uma política, incluindo seus recursos associados.

Campo	Tipo	Descrição
action	string	Ação da política: ALLOW ou DENY.
active	boolean	true se a política está ativa.
allowAllBrowser	boolean	true se a política se aplica a todos os navegadores.
allowedBrowsers	array de strings	Navegadores específicos quando allowAllBrowser é false. Valores: IE, FF, CH, EDGE.
applications	array de ApplicationGroup	Grupos de aplicações onde a política se aplica. Cada item inclui os detalhes completos do grupo.
certificateGroups	array de CertificateGroup	Grupos de certificados incluídos na política. Cada item inclui: id (ID do grupo), description (nome do grupo), certificatesCount (total de certificados no grupo), allowedCertificates (certificados que o usuário pode usar; 0 significa todos).
certificates	array de Certificate	Certificados individuais incluídos na política. Cada item inclui: certificateHandler (ID do certificado), alias (alias do certificado), active, certificateUserPinPolicy, expirationDate, needPin e usageReason.
comment	string	Descrição ou comentário da política.
dss	boolean	true se a política permite o uso do serviço DSS.
macAgent	boolean	true se a política permite o uso do Agente macOS.
name	string	Nome da política.
policyId	integer	ID da política.
priority	integer	Prioridade da política.
sites	array de SiteGroup	Grupos de sites onde a política se aplica. Cada item inclui os detalhes completos do grupo.
userPinPolicy	string	Comportamento do PIN do usuário: DO_NOTHING, ASK_FOR_USER_PIN, DONT_ASK_FOR_USER_PIN.
users	array de UserView	Usuários incluídos na política.
when	When	Agenda de horários. Inclui: always (true se a política é sempre válida) e entries (lista de intervalos de tempo com days, startDate, endDate, startTime, endTime).

EventView

Retornado por ListEvents.

Campo	Tipo	Descrição
date	datetime	Data e hora do evento.
ip	string	Endereço IP a partir do qual o evento ocorreu.
user	string	Nome de usuário que gerou o evento.
context	array de strings	Informações de contexto adicionais do evento.
certificate	string	Nome do certificado usado no evento.
description	string	Descrição do evento.
url	string	Objeto JSON com dados de contexto do evento, incluindo o nome do processo, o tipo de navegador, a URL visitada, a política aplicada e o ID do agente. null se não aplicável.

SystemEventView

Retornado por ListSystemEvents e ListHAEvents.

Campo	Tipo	Descrição
dateTime	datetime	Data e hora do evento.
ip	string	Endereço IP a partir do qual o evento ocorreu.
user	string	Nome de usuário que realizou a ação.
section	string	Seção do console de administração onde o evento ocorreu.
information	string	Descrição da ação realizada.
oldData	string	Estado anterior à alteração, em formato JSON. null se não aplicável.
newData	string	Estado posterior à alteração, em formato JSON. null se não aplicável.
context	array	Lista de pares chave-valor com informações de contexto adicionais. Cada item contém Item1 (rótulo) e Item2 (valor). null se não aplicável.

CertificateDirective

Retornado por ListCertificateDirectives. Representa uma diretiva de certificado configurada no sistema.

Campo	Tipo	Descrição
id	integer	ID da diretiva de certificado. Use este valor em certDirectiveIds ao chamar AddCertificateUser.
value	string	Descrição ou valor da diretiva de certificado.