Response objects

This document describes the object types that the Administration API returns in the ResultData field of the response.

UserView

Returned by methods that list or retrieve user information, such as ListUsersInDomain.

Field	Type	Description
uid	string	Unique user identifier in the format USER:<id>@<domain>.
userHandler	integer	Internal user ID.
username	string	Username.
friendlyName	string	User's display name.
domain	string	Alias of the domain the user belongs to.
email	string	User's email address.
type	string	User type. Values: LOCAL_USER, CERTIFICATE_USER, ACTIVE_DIRECTORY, LDAP, SAML2, OAuth2, ACTIVATION_CODE, UNKNOWN.
groupType	string	Whether the entity is a user or a group. Values: USER, GROUP.
status	boolean	true if the user is active.
consumeLicense	boolean	true if the user has consumed a license.
lastCertificateUsage	datetime	Last time the user used a certificate. null if never used.
passwordExpirationDate	datetime	Password expiration date. null if not set.

DomainView

Returned by methods that list domains, such as ListDomains.

Field	Type	Description
id	integer	Domain ID.
alias	string	Domain alias.
allowPersonalArea	boolean	true if domain users can access the personal area.
webSignatureAccess	boolean	true if domain users can use the Signtrust module.
allowUploadCerts	boolean	true if domain users can upload personal certificates.
schema	string	Domain type. Same values as UserView.type.
allowedUsers	integer	Maximum number of allowed users. 0 means unlimited.
numUsers	integer	Current number of users in the domain.
isExternal	boolean	true if the domain is external.
sharepointAccess	boolean	true if domain users can use the SharePoint module.

CertificateView

Returned by ListCertificates. Contains the main information for a certificate.

Field	Type	Description
certificateHandler	integer	Certificate ID.
name	string	Certificate alias.
active	boolean	true if the certificate is active.
groups	array of strings	Names of the certificate groups that contain this certificate.
policies	array of strings	Names of the policies that use this certificate.
users	array of strings	Users associated with the certificate.
user_groups	array of strings	User groups associated with the certificate.
issuer	string	Certificate issuer.
subject	string	Certificate subject.
creationDate	datetime	Date the certificate was added to Redtrust.
expirationDate	datetime	Certificate expiration date.
expired	boolean	true if the certificate has expired.
times_used	integer	Number of times the certificate has been used.
datetime_last_usage	datetime	Date of the last certificate use. null if never used.
needPin	boolean	true if using the certificate requires a PIN.
externalId	string	External identifier of the certificate.
assignable	boolean	true if the certificate owner can be changed.
owner	string	Username of the certificate owner.
ownerId	integer	ID of the certificate owner.
ownerUID	string	UID of the certificate owner.
usageReason	boolean	true if using the certificate requires a reason.
userPinPolicy	string	User PIN behavior for this certificate.
allowBackup	boolean	true if the certificate can be downloaded from Redtrust.
allowCSR	boolean	true if a CSR can be created from this certificate.
isRevoked	boolean	true if the certificate is revoked.
policyIdentifier	string	Identifier of the certificate's profile.

CertificateDetail

Returned by GetCertificateData. Includes all fields from CertificateView plus full X.509 certificate details.

Field	Type	Description
certificateHandler	integer	Certificate ID.
active	boolean	true if the certificate is active.
alias	string	Certificate alias.
friendlyName	string	Certificate friendly name.
certificateSN	string	Certificate serial number.
thumbprint	string	Certificate thumbprint.
subject	string	Certificate subject (full DN).
issuer	string	Certificate issuer (full DN).
validFrom	datetime	Start of the certificate's validity period.
validUntil	datetime	End of the certificate's validity period.
expired	boolean	true if the certificate has expired.
notEnabledYet	boolean	true if the validity start date has not yet been reached.
version	integer	X.509 certificate version.
signatureAlg	string	Certificate signature algorithm.
keyValue	string	Certificate public key value.
extensions	string	Certificate extensions.
archived	boolean	true if the certificate is archived.
comment	string	Free-text comment on the certificate.
needPin	boolean	true if using the certificate requires a PIN.
usageReason	boolean	true if using the certificate requires a reason.
userPinPolicy	string	User PIN behavior for this certificate.
assignable	boolean	true if the certificate owner can be changed.
owner	string	Username of the certificate owner.
ownerId	integer	ID of the certificate owner.
ownerUID	string	UID of the certificate owner.
ownerName	string	Display name of the certificate owner.
groups	array of strings	Certificate groups that contain this certificate.
policies	array of strings	Policies that use this certificate.
users	array of strings	Users associated with the certificate.
user_groups	array of strings	User groups associated with the certificate.
timesUsed	integer	Number of times the certificate has been used.
datetimeLastUsage	datetime	Date of the last certificate use. null if never used.
subjectSimpleName	string	Subject simple name.
subjectDnsName	string	Subject DNS name.
subjectDnsFromAlternativeName	string	Subject DNS name from the alternative name extension.
subjectEmailName	string	Subject email address.
subjectUpnName	string	Subject UPN.
subjectUrlName	string	URL associated with the subject.
issuerSimpleName	string	Issuer simple name.
issuerDnsName	string	Issuer DNS name.
issuerDnsFromAlternativeName	string	Issuer DNS name from the alternative name extension.
issuerEmailName	string	Issuer email address.
issuerUpnName	string	Issuer UPN.
issuerUrlName	string	URL associated with the issuer.

CACertificateView

Returned by ListCACertificates.

Field	Type	Description
id	integer	CA certificate ID.
issuer	string	CA certificate issuer.
subject	string	CA certificate subject.
expirationDate	datetime	CA certificate expiration date.
creationDate	datetime	Date from which the CA certificate is valid.
expired	boolean	true if the CA certificate has expired.
installed	boolean	true if the CA certificate is installed in Redtrust.
thumbprint	string	CA certificate thumbprint.

CertificateAttribute

Returned by ListCertificateAttributes. Represents a certificate attribute type available in the system.

Field	Type	Description
id	integer	Certificate attribute ID. Use this value in the id field of certAttributes when calling AddCertificateUser.
name	string	Certificate attribute name.

GroupsResponse

Returned by ListApplicationGroups and ListSiteGroups.

Field	Type	Description
globalApps	boolean	true if there are global application groups configured in the system.
groups	array of BaseGroup	List of groups. Each item can be of type ApplicationGroup or SiteGroup, indicated by the i:type attribute in the XML response.

ApplicationGroup

Returned directly by GetApplicationGroup. Also included in the groups field of GroupsResponse, returned by ListApplicationGroups.

Field	Type	Description
groupId	integer	Application group ID.
friendlyName	string	Group name.
roleId	integer	ID of the role the group belongs to. 0 if it belongs to all roles.
roleName	string	Role name. null if it belongs to all roles.
applications	array of Application	List of applications in the group. Each item includes: id (internal ID), name (process name or pattern), expType (expression type: PROCESS, REGEXP, RTREGEXP, COMMAND_LINE).
mappedSites	array of strings	List of websites associated with the group.

SiteGroup

Returned directly by GetSitesGroup. Also included in the groups field of GroupsResponse, returned by ListSiteGroups.

Field	Type	Description
groupId	integer	Site group ID.
friendlyName	string	Group name.
roleId	integer	ID of the role the group belongs to. 0 if it belongs to all roles.
roleName	string	Role name. null if it belongs to all roles.
sites	array of Site	List of sites in the group. Each item includes: id (internal ID), name (URL or site pattern), expType (expression type: REGEXP, RTREGEXP) and postdata (POST data to distinguish sites with the same URL; can be null).
mappedSites	array of strings	List of additional websites associated with the group.

PolicyView

Returned by ListPolicies. Contains the main data for a policy.

Field	Type	Description
action	string	Policy action: ALLOW or DENY.
active	boolean	true if the policy is active.
certificates	array of strings	Names of the individual certificates included in the policy.
context	PolicyContext	Application context. Includes: sites (site group names), apps (application group names), browsers (allowed browsers), dss (whether DSS is allowed), macAgent (whether the macOS Agent is allowed).
groups	array of strings	Names of the certificate groups included in the policy.
idRole	integer	ID of the role the policy belongs to. 0 if it belongs to all roles.
name	string	Policy name.
policyId	integer	Policy ID.
priority	integer	Policy priority. Lower values have higher priority.
role	string	Name of the role the policy belongs to.
userGroups	array of strings	Names of the user groups included in the policy.
userPinPolicy	string	User PIN behavior: DO_NOTHING, ASK_FOR_USER_PIN, DONT_ASK_FOR_USER_PIN.
users	array of strings	Names of the users included in the policy.

Policy

Returned by GetPolicyData. Contains the full details of a policy, including its associated resources.

Field	Type	Description
action	string	Policy action: ALLOW or DENY.
active	boolean	true if the policy is active.
allowAllBrowser	boolean	true if the policy applies to all browsers.
allowedBrowsers	array of strings	Specific browsers when allowAllBrowser is false. Values: IE, FF, CH, EDGE.
applications	array of ApplicationGroup	Application groups where the policy applies. Each item includes full group details.
certificateGroups	array of CertificateGroup	Certificate groups included in the policy. Each item includes: id (group ID), description (group name), certificatesCount (total certificates in the group), allowedCertificates (certificates the user can use; 0 means all).
certificates	array of Certificate	Individual certificates included in the policy. Each item includes: certificateHandler (certificate ID), alias (certificate alias), active, certificateUserPinPolicy, expirationDate, needPin, and usageReason.
comment	string	Policy description or comment.
dss	boolean	true if the policy allows use of the DSS service.
macAgent	boolean	true if the policy allows use of the macOS Agent.
name	string	Policy name.
policyId	integer	Policy ID.
priority	integer	Policy priority.
sites	array of SiteGroup	Site groups where the policy applies. Each item includes full group details.
userPinPolicy	string	User PIN behavior: DO_NOTHING, ASK_FOR_USER_PIN, DONT_ASK_FOR_USER_PIN.
users	array of UserView	Users included in the policy.
when	When	Time schedule. Includes: always (true if the policy is always valid) and entries (list of time slots with days, startDate, endDate, startTime, endTime).

EventView

Returned by ListEvents.

Field	Type	Description
date	datetime	Event date and time.
ip	string	IP address from which the event occurred.
user	string	Username that generated the event.
context	array of strings	Additional context information for the event.
certificate	string	Name of the certificate used in the event.
description	string	Event description.
url	string	JSON object with event context data, including the process name, browser type, visited URL, applied policy, and agent ID. null if not applicable.

SystemEventView

Returned by ListSystemEvents and ListHAEvents.

Field	Type	Description
dateTime	datetime	Event date and time.
ip	string	IP address from which the event occurred.
user	string	Username that performed the action.
section	string	Section of the admin console where the event occurred.
information	string	Description of the action performed.
oldData	string	State before the change, in JSON format. null if not applicable.
newData	string	State after the change, in JSON format. null if not applicable.
context	array	List of key-value pairs with additional context for the event. Each item has Item1 (label) and Item2 (value). null if not applicable.

CertificateDirective

Returned by ListCertificateDirectives. Represents a certificate directive configured in the system.

Field	Type	Description
id	integer	Certificate directive ID. Use this value in certDirectiveIds when calling AddCertificateUser.
value	string	Certificate directive description or value.