Value types
Instead of showing the XML schema definitions, we describe the value types in a pseudo-java syntax. Some types represent enums, which are listed below. This is followed by a description of the more complex types.
Enum value types
Note that the nevisIDM SOAP interface ignores unknown enum values, and reacts as if the enum value for the corresponding attribute is missing (that is, the value is converted to null
internally). Thus make sure to use the right spelling for enum values when you write the SOAP requests.
Type | Values |
---|---|
CredentialState | ACTIVE, DISABLED, ARCHIVED, INITIAL, EXPIRED, RESET_CODE, LOCKED, LOCKED_TEMPORARY, ADMIN_CHANGED |
UserState | ACTIVE, DISABLED, ARCHIVED |
ProfileState | ACTIVE, DISABLED, ARCHIVED |
UnitState | ACTIVE, DISABLED |
PropertyScope | ON_USER_GLOBAL,ON_PROFILE_GLOBAL, ON_UNIT_GLOBAL, ON_APPLICATION_GLOBAL, ON_ROLE_FOR_APPLICATION, ON_PROFILE_FOR_APPLICATION, ON_PROFILE_FOR_APPLICATION_GLOBAL, ON_USER_GLOBAL, ON_CREDENTIAL_CERTIFICATE_GLOBAL, ON_CREDENTIAL_GENERIC_GLOBAL, ON_CREDENTIAL_MOBILESIGNATURE_GLOBAL,ON_CREDENTIAL_SAMLFEDERATION_GLOBAL, ON_CREDENTIAL_SECURITYQUESTIONS_GLOBAL, ON_ENTERPRISE_ROLE_GLOBAL |
CredentialType | PASSWORD, CERTIFICATE, SECURID_ACCOUNT, TICKET, SAFEWORD_ACCOUNT, OTP, TEMP_STRONG_PASSWORD, GENERIC, MTAN, VASCO, PUK, URL_TICKET, DEVICE_PASSWORD, MOBILE_SIGNATURE, SAML_FEDERATION, SECURITY_QUESTIONS,CONTEXT_PASSWORD, OATH, FIDO_UAF |
PolicyType | PASSWORD_POLICY, OTP_CARD_POLICY, TICKET_POLICY, TEMP_STRONG_PASSWORD_POLICY, CERTIFICATE_POLICY, GENERIC_CREDENTIAL_POLICY, TAN_POLICY, PUK_POLICY, URLTICKET_POLICY, DEVICE_PASSWORD_POLICY, VASCO_POLICY, MOBILE_SIGNATURE_POLICY, SAML_FEDERATION_POLICY, SECURITY_QUESTIONS_POLICY, CONTEXT_PASSWORD_POLICY, LOGIN_POLICY, PROFILE_POLICY, CLIENT_POLICY, UNIT_POLICY, OATH_POLICY |
UserSex | MALE, FEMALE |
UserGender | MALE, FEMALE, OTHER |
DetailLevel | EXCLUDE, LOW, MEDIUM, HIGH |
FileType | PDF, SMS, EMAIL, OO |
CommEventType | OTP_INIT, OTP_RENEW, OTP_RESET, TICKET, RESET_CODE, TICKET_EXPIRATION_WARNING, CERTIFICATE_EXPIRATION_WARNING, TMP_STRONG_PWD, NEW_PASSWORD, DEACTIVATION_WARNING, OTP_EXPIRATION_WARNING, OTP_LOW_ON_CHALLENGES_WARNING, PUK_INIT, PUK_RESET, URL_TICKET, USER_NOTIFICATION_1- USER_NOTIFICATION_20, VASCO_ASSIGNMENT, NEVISADAPT_NOTIFICATION |
SortOrder | ASC, DESC |
sendingMethod | NONE, PRINT, EMAIL, PDF_EMAIL, PDF_STORE, SMS_SMTP, HTML_EMAIL |
Mode | add, remove, recreate |
PersonalQuestionState | ACTIVE, DISABLED, REVOKED |
OperationType | INSERT, UPDATE, DELETE |
OathType | HOTP, TOTP |
OathAlgorithm | SHA1, SHA256, SHA512 |
Complex types
Type | Field | Type, Characteristics | Description |
---|---|---|---|
AbstractEntity | ctlCreUid | String, read-only | Login ID of record creator |
ctlCreDat | Date, read-only | Date of record creation | |
ctlModUid | String, read-only | Login ID of last modifier | |
ctlModDat | Date, read-only | Date of last modification | |
ctlTcn | Int, read-only | Version number of the entity | |
Authorization (extends AbstractEntity) | role | Role | The role associated with the authorization |
authorizedUnits | Unit[] | Units of the data room | |
authorizedApplications | Application[] | Applications of the data room | |
authorizedClients | Client[] | Clients of the data room | |
authorizedEnterpriseRoles | EnterpriseRole[] | EnterpriseRoles of the data room | |
unitGlobal | Boolean | Authorized for all units | |
appGlobal | Boolean | Authorized for all applications | |
clientGlobal | Boolean | Authorized for all clients | |
eRoleGlobal | Boolean | Authorized for all enterprise roles | |
extId | String, read-only, identifier | External key | |
directAssignment | Boolean, read-only | This parameter shows whether an authorization is a direct assignment between a role and a profile or whether it is assigned via an enterprise role. | |
Profile (extends AbstractEntity) | name | String(100) | Profile name |
extId | String, read-only, identifier | External key | |
state | ProfileState | State of the profile | |
unit | Unit, one-to-one | The unit the profile is associated with | |
properties | PropertyValue[] | Profile properties | |
defaultProfile | Boolean | Whether the profile is the user‘s default profile (applies if the user has > 1 profile) | |
roles | Role[] | The roles associated with the profile, including roles assigned via enterprise roles | |
userExtId | String, read-only, identifier | External key for user | |
authorizations | Authorization[], write-only | The authorizations of a profile, including roles assigned via enterprise roles | |
enterpriseRoles | EnterpriseRole[], write-only | Authorizations for enterprise roles | |
deputedExtId | String, read-only, identifier | The deputed (original) profile for deputy profiles | |
remarks | String (1000), description | Description | |
modificationComment | String, write-only | Takes a modification comment that is related to the current operation. | |
Unit (extends AbstractEntity) | name | String | Name of the unit |
extId | String, read-only, identifier | External key | |
state | UnitState | State of the unit | |
displayName | DictEntry | Localized display name | |
displayNameAbbreviation | DictEntry | Localized display name abbreviation | |
location | String(50) | Location | |
description | String, description | Description | |
parentExtId | String, read-only, identifier | External key of the parent unit | |
properties | PropertyValue[] | Unit properties | |
hname | String(50) | Hierarchical name | |
hnameDictEntry | String(50) | Localized hierarchical name | |
profileless | Boolean | Defines whether the unit can be assigned to profiles or whether it is a structural unit. | |
modificationComment | String, write-only | Takes a modification comment that is related to the current operation. | |
policyName | String(50) | Name of policy | |
childUnits | Unit[], read-only | List of the child units. Only returned for the method "getUnits()". | |
User (extends AbstractEntity) | loginId | String, identifier | Login name |
extId | String, dentifier | External key | |
state | Enum UserState | State of user | |
firstName | String(50) | First name | |
name | String(50) | Surname | |
remarks | String(1000), description | Description | |
isTechnicalUser | Boolean | Technical user flag. Only returned for technical users. Thus, if not defined, the value is "false". | |
sex | Enum UserSex | Sex of the user. Up to WebService version 1.42, the field sex will be present in the SOAP responses. From WebService version 1.43 on, sex will be replaced by gender. | |
gender | Enum UserGender | Gender of the user. From WebService version 1.43 on, the field gender will be included in SOAP responses. It replaces the field sex. | |
birthDate | Date | Day of birth | |
title | String(20) | Title | |
telephone | String(50) | Phone number | |
String(300) | |||
telefax | String(50) | Fax number | |
mobile | String(50) | Mobile number | |
addressLine1 | String(50) | First address line | |
addressLine2 | String(50) | Second address line | |
street | String(120) | Up to WebService version 1.37 it will be present in the SOAP response depending on Client policy parameter address.ech0010.enabled . From WebService version 1.38 it will be included into SOAP responses by default. Modifying is allowed for all of the supported WebService versions. | |
houseNumber | String(12) | Up to WebService version 1.37 it will be present in the SOAP response depending on Client policy parameter address.ech0010.enabled . From WebService version 1.38 it will be included into SOAP responses by default. Modifying is allowed for all of the supported WebService versions. | |
dwellingNumber | String(10) | number of dwellingUp to WebService version 1.37 it will be present in the SOAP response depending on Client policy parameter address.ech0010.enabled . From WebService version 1.38 it will be included into SOAP responses by default. Modifying is allowed for all of the supported WebService versions. | |
postOfficeBoxNumber | Long | number of postoffice-boxUp to WebService version 1.37 it will be present in the SOAP response depending on Client policy parameter address.ech0010.enabled . From WebService version 1.38 it will be included into SOAP responses by default. Modifying is allowed for all of the supported WebService versions. | |
postOfficeBoxText | String(15) | postoffice-box textUp to WebService version 1.37 it will be present in the SOAP response depending on Client policy parameter address.ech0010.enabled . From WebService version 1.38 it will be included into SOAP responses by default. Modifying is allowed for all of the supported WebService versions. | |
locality | String(255) | As of WebService version 1.38, the locality field is included in SOAP responses by default. In previous WebService versions, the locality field is not present at all. Modifying is allowed for all of the supported WebService versions. | |
postalCode | String(10) | Postal code | |
city | String(50) | City | |
country | String | country code according to ISO 3166 | |
properties | PropertyValue[] | List of assigned properties | |
language | String | ISO 639 language code | |
templateCollection | String | Name of the user‘s template collection | |
profiles | Profile[] | List of assigned profiles | |
credentials | Certificate[] | List of assigned credentials | |
certificates | Credential[] | List of assigned certificates | |
mobileSignatures | MobileSignature[] | List of assigned mobile signature credentials | |
samlFederations | SamlFederation[] | List of assigned SAML federation credentials | |
securityQuestions | SecurityQuestions[] | List of assigned security question credentials | |
lastLogin | Date, read-only | Date of last login | |
lastLoginFailure | Date, read-only | Date of last login failure | |
validFrom | DateTime | Start of validity period (not set means infinitely long ago) | |
validTo | DateTime | End of validity period (not set means far in the future) | |
clientExtId | String, read-only, identifier | ❌ Still supported but deprecated. Use clientExtId on abstractRequest instead. The client’s external key | |
clientName | String(50), read-only | ❌ Still supported but deprecated. Use clientName on abstractRequest instead. The client’s name | |
birthDateFrom | Date | never returned, only evaluated for queryUsers(). | |
birthDateTo | Date | never returned, only evaluated for queryUsers() | |
validFromHi | DateTime | never returned, only evaluated for queryUsers(). Upper bound for "validFrom" | |
validFromLow | DateTime | never returned, only evaluated for queryUsers(). Lower bound for "validFrom" | |
validToHi | DateTime | never returned, only evaluated for queryUsers(). Upper bound for "validTo" | |
validToLow | DateTime | never returned, only evaluated for queryUsers(). Lower bound for "validTo" | |
modificationComment | String, write-only | Takes a modification comment that is related to the current operation. | |
stateChangeReasonCd | int | Reason code for the last state change of the user. The change reason code must exist in the TIDMR_CHANGE_REASON table (see Table 47 in chapter 3.5.5.1). | |
stateChangeDetail | String | ❌ This attribute is deprecated and removed. Reason detail for the last state change of the user. | |
stateChangedDate | DateTime | Date of the last state change of the user. | |
Client (extends AbstractEntity) | name | String(50) | Name of client |
extId | String(50), read-only | External key | |
remarks | String(1000), description | Description | |
displayName | DictEntry | Localized display name | |
Policy(extends AbstractEntity) | name | String(50) | Policy name |
extId | String(50) | identifier External key | |
type | PolicyType | Policy type | |
default | Boolean | If context is unit (credential policy to unit assignments), the flag marks the default assignment; if context is client (unit not defined), the flag marks the default policy among all policies of the underlying policy type. | |
description | String(300) | Description of policy | |
config | String(4000) | The actual configuration of the policy. | |
Credential (extends AbstractEntity) | state | Enum CredentialState | State of the credential, see WSDL interface for details |
type | Enum CredentialType | Type of the credential, see WSDL interface for details | |
lastChange | Date | Date of last change applied to credential | |
validFrom | Date | The date when the credential becomes valid | |
validTo | Date | The date when the credential becomes invalid | |
resetCount | int, ³0 | Number of times the credential was reset | |
value | String(4000) | Opaque value of the credential | |
extId | String, read-only | External credential key | |
properties | PropertyValue[] | Credential properties | |
policyName | String(50) | Name of policy | |
policyExtId | String(50) | External policy identifier | |
context | String(2048) | Credential context. It is used for context password credentials only. | |
stateChangeReasonCd | int | Reason code for the last state change of the credential. | |
stateChangeDetail | String | Reason detail for the last state change of the credential. | |
userExtId | String (50), read-only | External user key | |
newValue | String(4000), write-only | New value | |
lastLogin | Date, read-only | Last login with credential | |
lastLoginFailure | Date, read-only | Last login failure with credential | |
failureCount | int, ³0 | Number of times this credential was used in a failed login | |
successCount | int, ≥0 | Absolute number of times this credential was used for successful authentications | |
modificationComment | String, write-only | Takes a modification comment that is related to the current operation. | |
autoTransitionState | Enum CredentialStateread-only | Next state in the credential state model. | |
autoTransitionDate | Date, read-only | The date/time the auto transition will be triggered. | |
urlPrefix | String, write-only, optional | Used for creation of URL ticket credentials only. Value is used to build up the personalized link that is communicated to the user. | |
mobileSignature | MobileSignature | Mobile signature extension. Only mobile signature credentials can have this extension. | |
samlFederation | SamlFederation | SAML federation extension. Only SAML federation credentials can have this extension. | |
certificate | Certificate | Certificate extension. Only Certificate credentials can have this extension. | |
securityQuestion | SecurityQuestion | Security question extension. Only security question credentials can have this extension. | |
oath | Oath | OATH extension. Only OATH credentials have this extension. | |
Application(extends AbstractEntity) | name | String(50) | Application name |
extId | String(50) | identifier External key | |
description | String, description | Description | |
url | String(1000) | URL | |
displayName | DictEntry | Localized display name | |
displayed | boolean | ||
roles | Role[] | Contains all roles of the application | |
properties | PropertyValue[] | Properties | |
ApplicationClientAssignment (extends AbstractEntity) | application | Application | Application of the client application assignment |
client | Client | Client the application is assigned to | |
Certificate(extends AbstractEntity) | userExtId | String (50), read-only | External key of the user who owns this credential |
credentialExtId | String(50) | External key of the credential the certificate belongs to | |
state | Enum CredentialState | Credential state, see WSDL interface for details | |
shaFingerprint | String(80) | Fingerprint of the certificate in hexbyte-colon notation | |
certificate | String, mandatory for inputs | PEM certificate with start and end headers | |
serial | String(50) | Serial number | |
issuerDn | String(1000) | DN of the issuer | |
issuerCn | String | CN of the issuer (convenience) | |
subjectDn | String(1000) | DN of the subject | |
subjectCn | String | CN of the subject (convenience) | |
subjectKeyIdentifier | String | ||
properties | PropertyValue[], mandatory for inputs | PEM certificate with start and end delimiters | |
MobileSignature(extends AbstractEntity) | userExtId | String(50) | External key of the user who owns this mobile signature |
credentialExtId | String(50) | External key of the credential the mobile signature belongs to | |
state | Enum CredentialState | Credential state, see WSDL interface for details | |
identificator | String(50) | MSSP-specific identificator of the mobile signature credential | |
msspIdentifier | String(50) | URI-based identifier of MSSP | |
msisdn | String(4000) | Calling number for mobile device according to ETSI Standard, e.g., +417912345678 | |
signerCert | String(4000) | X509 signer certificate in PEM format | |
properties | PropertyValue[] | Properties | |
SamlFederation (extends AbstractEntity) | userExtId | String(50) | External key of the user who owns this SAML federation |
credentialExtId | String(50) | External key of the credential the SAML federation belongs to | |
state | Enum CredentialState | Credential state, see WSDL | |
subjectNameId | String(1030) | Name ID of the Subject | |
subjectNameIdFormat | String(100) | URI of the Subject Name ID format | |
issuerNameId | String(1030) | Name ID of the Issuer | |
issuerNameIdFormat | String(100) | URI of the Issuer Name ID format | |
properties | PropertyValue[] | Properties | |
Oath (extends AbstractEntity) | type | Enum OathType | Type of the OATH credential. |
digits | Long | The length of the generated token.Values: 6, 7, 8 | |
periode | long | The time window how long a TOTP token is valid in seconds. | |
counter | long | The current counter value. | |
algorithm | Enum oathAlgorithm | The hash algorithm to use with this OATH credential. | |
SecurityQuestions | userExtId | String(50) | External key of the user the security questions belong to. |
credentialExtId | String(50) | External key of the credential the security questions belong to. | |
state | Enum CredentialState | State of the security question credential | |
answers | PersonalAnswer[] | The user’s answers the security question credential holds | |
properties | PropertyValue[] | Properties | |
PersonalAnswer | question | PersonalQuestion | The personal question the answer belongs to |
answer | String(4000) | The answer to the personal question | |
revealCount | Int | Number of times the answer has been revealed to an admin. | |
failureCount | Int | Number of times the answer has been failed to verify. | |
successCount | Int | Number of times the answer has been successfully verified. | |
PersonalQuestion | extId | String(50) | identifier External key |
description | String(1000) | Description | |
state | Enum PersonalQuestionState | State of the personal question, see WSDL interface for details. | |
displayName | DictEntry | Localized display name | |
content | DictEntry | Localized content of the question | |
Role(extends AbstractEntity) | name | String(50) | Role name |
extId | String(50) | identifier External key | |
description | String, description | Description | |
applicationName | String(50) | Application name | |
applicationExtId | String(50) | The extId of the application which the role belongs to. | |
properties | PropertyValue[] | Role properties | |
EnterpriseRole(extends AbstractEntity) | name | String(100) | EnterpriseRole name |
extId | String, read-only, identifier | External key | |
description | String, description | Description | |
displayName | DictEntry | Localized display name | |
roles | Role[] | Application roles assigned to EnterpriseRole | |
Property(extends AbstractEntity) | name | String(50) | Name of the property |
scope | Enum PropertyScope | Scope of the property, see WSDL interface for details | |
allowedValues | String[] | Allowed values | |
guiPrecedence | Int | Order of the property on the GUI | |
PropertyValue | name | String(50) | Name of the property |
value | String | Value of the property | |
scopeName | String | Optional target information, e.g., "applName" or "applName,roleName" for "onProfileForApp" scope. See below for more information. | |
DictEntry(extends AbstractEntity) | name | String(50) | Name of the dictionary entry |
entries | DictEntryValue[] | Dictionary entry values | |
DictEntryValue | lang | String | ISO 639 language code |
value | String(100) | Localized value | |
File | content | xs:base64Binary | The file content is always base64 encoded. For the encoding, the class org.apache.commons.codec.binary . Base64 of the library Apache Commons Coded in version 1.4 is used. |
type | Enum FileType | File type of content | |
Caller | user | User | |
selectedProfileApplications | Application[] | The applications associated with the selected profile. | |
selectdProfileUnits | Unit[] | The units associated with the selected profile. | |
Template | extId | String(50) | identifier External key |
documentType | enum FileType | File type of the template | |
commEventType | enum CommEventType | Communication event the template belongs to (e.g., password initialization, password reset). | |
precedence | Integer | Precedence of the template. It has to be unique for all template collection, communication event and document type combinations. The lowest precedence denotes the default template. | |
content | TemplateContent[] | The language-dependent content of the template. The content can be a string template text or an OpenOffice document. | |
TemplateContent | lang | String ISO | language code |
sender | String(50) | The e-mail address of the sender (placeholders may be used). | |
receiver | String(50) | The e-mail address or phone number of the receiver (placeholders may be used). | |
receiverCC | String(50) | The e-mail address of the CC receiver (placeholders may be used). | |
receiverBCC | String(50) | The e-mail address of the BCC receiver (placeholders may be used). | |
subject | String(50) | The e-mail’s subject (placeholders may be used). | |
mandPlaceholders | String(4000) | A comma-separated list of mandatory placeholders. | |
optPlaceholders | String(4000) | A comma-separated list of optional placeholders. | |
tableNames | String(4000) | A comma-separated list of the tables contained in the template. | |
stringContent | String(4000) | The e-mail’s or SMS’s Base64 encoded text (placeholders may be used). | |
binaryContent | Base64Binary | Contains the whole OpenOffice document. | |
ShareOATHResult | type | OathType | The authentication type of the OATH credential. Its value can be "TOTP" or "HOTP" |
algorithm | OathAlgorithm | The hashing algorithm used to calculate the OATH tokens. Its value can be "SHA_1", "SHA_256" and "SHA_512". | |
digits | Integer | The length of the generated token. | |
period | Long | The amount of time (in seconds) a TOTP token is valid. | |
counter | Long | The current state of the OATH counter. | |
account | String | The account name. This will be shown in the Mobile App for User. | |
issuer | String | The issuer is indicating the provider or service this OATH credential is associated with. | |
secret | String | The secret that is required to initialize the mobile application. | |
qrCodeContent | String | The content of the QR code in plain string. It is the concatenation of the OATH attributes in a URL format. For example: otpauth://totp/Issuer:Account?secret=JBSWY3DPEHPK3PXP&issuer=Issuer&algorithm=SHA1&digits=6 | |
qrCode | Base64Binary | The base64 encoded QR code image (PNG). | |
PasswordChangeResult (extends Credential-VerifyResult) | credentialCheckStatus | CredentialCheckStatus | CRED_CHANGE_OK or CRED_CHANGE_REJECTED |
policyInformations | List<PolicyDetail> | Contains the policy settings for this particular password when the change attempt fails due to policy violations. | |
policyViolations | List<PolicyDetail> | Contains the policy violations for a failed password change attempt. | |
credentialState | CredentialState | ACTIVE or not set | |
userState | UserState | ACTIVE or not set | |
credentialUpdatedOnSuccess | boolean | True if the password was successfully updated or not set | |
PasswordPolicyCheckResult | policyInformations | List<PolicyDetail> | Contains the policy settings for this particular password when the check fails due to policy violations. |
policyViolations | List<PolicyDetail> | Contains the policy violations for a failed password check. |
PropertyValue scopeName with onProfileForApp* properties
The purpose of the field "scopeName" is to uniquely identify the referred property of scope onProfileForApp*
in context of operations such as ^createProfile
, updateProfile
. Therefore, it has to follow this format:
- Full scopeName format: "name of application", "name of role", e.g., MyApp2,MyRole3
- Short scopeName format: "name of application", e.g., MyApp2
Note that the short format is only allowed in case it is sufficient, i.e., the profile holds only one role of the referred application.
Complex history types
These types are exclusively used for the SOAP history methods.
Type | Field | Type, Characteristics | Description |
---|---|---|---|
AbstractHistory(extends AbstractEntity) | versionDate | Date | Timestamp of history entry |
versionNumber | int | The version of the entry(VersionNumber can be missing) | |
event | OperationType | ||
originator | String | clientName/loginID of originator | |
HistoryOfProfile (extends AbstractHistory) | name | String(100) | Profile name |
extId | String, read-only, identifier | External key | |
state | ProfileState | State of the profile | |
unit | Unit, one-to-one | The unit the profile is associated with | |
properties | PropertyValue[] | Profile properties | |
defaultProfile | Boolean | Defines if the profile is the default profile of the user (applies if the user has more than one profile). | |
roles | Role[] | The roles associated with the profile | |
modificationComment | String, write-only | Takes a modification comment that is related to the current operation. | |
HistoryOfUnit (extends AbstractHistory) | name | String | Name of the unit |
extId | String, read-only, identifier | External key | |
state | UnitState | State of the unit | |
location | String(50) | Location | |
description | String, description | Description | |
parentExtId | String, read-only, identifier | External key of the parent unit | |
properties | PropertyValue[] | Unit properties | |
hname | String(50) | Hierarchical name | |
profileless | Boolean | Defines whether the unit can be assigned to a profile or whether it is a structural unit. | |
modificationComment | String, write-only | Takes a modification comment that is related to the current operation. | |
policyName | String(50) | Name of policy | |
HistoryOfUser (extends AbstractHistory) | loginId | String, identifier | Login name |
extId | String, identifier | External key | |
state | Enum UserState | State of user | |
firstName | String(50) | First name | |
name | String(50) | Surname | |
remarks | String, description | Description | |
sex | Enum UserSex | Sex of the user. Up to WebService version 1.42, the field sex will be present in the SOAP responses. From WebService version 1.43 on, sex will be replaced by gender. | |
gender | Enum UserGender | Gender of the user. From WebService version 1.43 on, the field gender will be included in SOAP responses. It replaces the field sex. | |
birthDate | Date | Day of birth | |
title | String(20) | Title | |
telephone | String(50) | Phone number | |
String(300) | |||
telefax | String(50) | Fax number | |
mobile | String(50) | Mobile number | |
addressLine1 | String(50) | First address line | |
addressLine2 | String(50) | Second address line | |
postalCode | String(10) | Postal code | |
city | String(50) | City | |
country | String | ISO 3166 country code | |
properties | PropertyValue[] | List of assigned properties | |
language | String | ISO 639 language code | |
templateCollection | String | Name of the user‘s template collection | |
modificationComment | String, write-only | Takes a modification comment that is related to the current operation. | |
validFrom | Date | Start of validity period (not set means infinitely long ago) | |
validTo | Date | End of validity period (not set means far in the future) | |
stateChangeReasonCd | Integer | Reason code of the user state change | |
stateChangeDetail | String(1000) | Details of the user state change | |
HistoryOfUserLoginInfo(extends AbstractHistory) | lastLogin | Date | Timestamp of last successful login |
lastFailure | Date | Timestamp of last failed login | |
HistoryOfCredential (extends AbstractHistory) | state | Enum CredentialState | State of the credential, see WSDL interface for details |
type | Enum Credential Type | Type of the credential, see WSDL interface for details | |
lastChange | Date | Date of last change applied to credential | |
validFrom | Date | Date when the credential becomes valid | |
validTo | Date | Date when the credential becomes invalid | |
resetCount | int, ³0 | Number of times the credential was reset | |
value | String(4000) | Opaque value of the credential | |
extId | String, read-only | External credential key | |
properties | PropertyValue[] | Credential properties | |
policyName | String(50) | Name of policy | |
stateChangeReasonCd | int | Reason code for the last state change of the credential. | |
stateChangeDetail | String | Reason detail for the last state change of the credential. | |
modificationComment | String, write-only | Takes a modification comment that is related to the current operation. | |
HistoryOfCredentialLoginInfo(extendsAbstractHistory) | lastLogin | Date | Timestamp of last successful login |
lastLoginFailure | Date | Timestamp of last failed login | |
failureCount | int | Number of failed logins (since last successful login) | |
successCount | int | Cumulated number of successful logins | |
HistoryOfEnterpriseRole (extends AbstractHistory) | name | String(50) | Name of the enterprise role |
extId | String, read-only, identifier | External key | |
description | String, description | Description | |
clientName | String(50) | The name of the client the enterprise role belongs to. | |
displayNameDe | String(50) | Display name in German | |
displayNameFr | String(50) | Display name in French | |
displayNameIt | String(50) | Display name in Italian | |
displayNameEn | String(50) | Display name in English | |
properties | PropertyValue[] | The properties of the enterprise role | |
roleHistoryForEnterpriseRole | Role | Member roles of the enterprise role |