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.

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.