RSA Archer GRC Web Services API Reference Guide 6.0 ContactInformation GototheRSAcorporatewebsiteforregionalCustomerSupporttelephoneandfaxnumbers: http://www.emc.com/support/rsa/index.htm. Trademarks RSA,theRSALogo,RSAArcher,RSAArcherLogo,andEMCareeitherregisteredtrademarksortrademarksofEMC Corporation("EMC")intheUnitedStatesand/orothercountries.Allothertrademarksusedhereinarethepropertyoftheir respectiveowners.ForalistofRSAtrademarks,gotowww.rsa.com/legal/trademarks_list.pdf. Licenseagreement ThissoftwareandtheassociateddocumentationareproprietaryandconfidentialtoEMC,arefurnishedunderlicense,andmay beusedandcopiedonlyinaccordancewiththetermsofsuchlicenseandwiththeinclusionofthecopyrightnoticebelow.This softwareandthedocumentation,andanycopiesthereof,maynotbeprovidedorotherwisemadeavailabletoanyotherperson. Notitletoorownershipofthesoftwareordocumentationoranyintellectualpropertyrightstheretoisherebytransferred.Any unauthorizeduseorreproductionofthissoftwareandthedocumentationmaybesubjecttociviland/orcriminalliability. ThissoftwareissubjecttochangewithoutnoticeandshouldnotbeconstruedasacommitmentbyEMC. Third-partylicenses ThisproductmayincludesoftwaredevelopedbypartiesotherthanRSA. Noteon encryption technologies Thisproductmaycontainencryptiontechnology.Manycountriesprohibitorrestricttheuse,import,orexportofencryption technologies,andcurrentuse,import,andexportregulationsshouldbefollowedwhenusing,importingorexportingthis product. Noteon Section 508Compliance TheRSAArcherGRCisbuiltonwebtechnologieswhichcanbeusedwithassistivetechnologies,suchasscreenreaders, magnifiers,andcontrasttools.Whilethesetoolsarenotyetfullysupported,RSAiscommittedtoimprovingtheexperienceof usersofthesetechnologiesaspartofourongoingproductroadmapfortheRSAArcherGRC. Distribution Use,copying,anddistributionofanyEMCsoftwaredescribedinthispublicationrequiresanapplicablesoftwarelicense. EMCbelievestheinformationinthispublicationisaccurateasofitspublicationdate.Theinformationissubjecttochange withoutnotice. THEINFORMATIONINTHISPUBLICATIONISPROVIDED"ASIS."EMCCORPORATIONMAKESNO REPRESENTATIONSORWARRANTIESOFANYKINDWITHRESPECTTOTHEINFORMATIONINTHIS PUBLICATION,ANDSPECIFICALLYDISCLAIMSIMPLIEDWARRANTIESOFMERCHANTABILITYOR FITNESSFORAPARTICULARPURPOSE. Copyright©2010-2016EMCCorporationAllRightsReserved.PublishedintheUSA. April2016 RSA Archer GRC WebServices API Reference Guide Contents RSA® Archer® GRC Suite Web Services API 9 Using the Web Services API 10 APIAccessConfiguration 10 Accessthe Web ServicesAPI 11 Accessthe APIIntegration Manager 13 Determine SystemIDs 14 Determine Application GUIDs 14 Time-Based Filtering 15 Classes and Methods 18 AccessControl Class 18 AddChildToGroup 20 AddContactInfo 22 AddUserToGroup 25 AddUserToRole 26 AddUsersToGroup 28 ChangePassword 30 CreateDomainUser 31 CreateExtendedSecurityParameter 34 CreateGroup 37 CreateSecurityParameter 38 CreateUser 41 CreateUserEx 42 CreateUserExWithPassword 44 DeleteContactInfo 47 DeleteGroup 49 DeleteSecurityParameter 50 DeleteUser 52 DoesDomainUserExist 53 DoesUserExist 55 ForcePasswordChange 57 3 RSA Archer GRC WebServices API Reference Guide GetContactSubTypes 58 GetContactTypes 62 GetDomainUserList 64 GetDomainUserListCount 66 GetDomainUserListPaginated 68 GetGroup 70 GetGroupInformation 72 GetGroups 74 GetSecurityParameterName 76 GetSecurityParameters 78 GetTimeZones 80 GetUser 80 GetUserContactInfo 82 GetUserDefaultEMail 84 GetUserList 86 GetUserListCount 88 GetUserListPaginated 90 LookupDomainUserByFirstName 92 LookupDomainUserByLastName 94 LookupDomainUserId 96 LookupEveryoneGroup 98 LookupGroup 99 LookupUserByFirstName 101 LookupUserByLastName 103 LookupUserId 105 LookupUserName 107 RemoveChildFromGroup 108 RemoveUserFromGroup 110 RemoveUserFromRole 112 SetUserDefaultEmail 113 UpdateContactInfo 115 UpdateDomainUser 118 UpdateExtendedSecurityParameter 120 UpdateGroup 124 UpdateSecurityParameter 125 4 RSA Archer GRC WebServices API Reference Guide UpdateUser 129 UpdateUserAccountStatus 129 UpdateUserEx 131 UpdateUserName 133 UpdateUserNote 135 UseDaylightSavings 137 AccessRole Class 137 CreateRole 137 DeleteRole 139 GetRole 141 GetRoleDependencies 142 GetRolePagePermissions 144 GetRolePagePermissionsForModule 146 GetRoles 149 UpdateRole 150 UpdateRolePagePermissions 152 UpdateRolePagePermissions2 152 Field Class 154 CreateChildValuesListItemWithNumericValue 155 CreateValuesListItemWithNumericValue 155 CreateValuesListValue 157 CreateValuesListValueChild 159 DeleteValuesListValue 159 GetFieldIdByGUID 161 GetValueListByParent 162 GetValueListForField 162 GetValuesList 164 GetValuesListIdByGUID 167 GetValuesListItem 168 GetValuesListValue 170 GetValuesListValueIdByGUID 172 LookupListValue 173 UpdateValuesListItemWithNumericValue 175 UpdateValuesListNumericValueToNull 177 UpdateValuesListValue 179 5 RSA Archer GRC WebServices API Reference Guide General Class 180 CreateDomainUserSession 181 CreateDomainUserSessionFromInstance 181 CreateUserSession 183 CreateUserSessionFromInstance 183 TerminateSession 184 Module Class 186 GetModuleIdByGUID 186 Record Class 188 BindContentToChildLevelContent 188 BindContentToParentLevelContent 189 CheckAsyncMailMergeProcess 189 CreateCMSTEntry 190 CreateQuestionnaireRecord 192 CreateRecord 194 CreateRecords 196 CreateSubformRecord 198 DeleteAllRecords 200 DeleteRecord 200 GetAccessHistory 202 GetAsyncMailMergeDocument 203 GetChildRecordIds 205 GetParentRecordIds 207 GetRecordById 207 PerformMailMerge 209 StartAsyncMailMerge 210 UnbindContentFromChildLevelContent 212 UnbindContentFromParentLevelContent 212 UpdateRecord 212 UpdateRecords 214 Search Class 216 CheckSearchStatus 216 CheckSearchStatusByPageSize 217 ExecuteQuickSearchWithModuleIds 217 ExecuteQuickSearchWithSolutionId 219 6 RSA Archer GRC WebServices API Reference Guide ExecuteSearch 220 ExecuteStatisticSearch 224 ExecuteStatisticSearchByReport 225 GetReports 227 GetSearchOptions 229 GetSearchOptionsByGuid 230 RetrieveSearchResultsPage 232 RetrieveSearchResultsPageByPageSize 232 SearchRecords 233 SearchRecordsByField 233 SearchRecordsByReport 233 Technology Class 235 AssociateToVendor 236 CreateTechnology 236 CreateTechnologyVersion 236 CreateVendor 236 DeleteTechnology 237 DeleteTechnologyVersion 237 DeleteVendor 237 DisassociateFromVendor 237 GetTechnology 237 GetTechnologyVersion 237 LookupTechnology 238 LookupTechnologyVersion 238 LookupVendorByName 238 UpdateTechnology 238 UpdateTechnologyVersion 238 UpdateVendor 238 Deprecated and Disabled Methods 239 Sample Use Cases 242 Sessions 242 Create a Session 242 Terminate a Session 242 Users 242 Create and Update a Basic User 242 7 RSA Archer GRC WebServices API Reference Guide Adding Records 243 Construct Record XML 243 Add a New Record 244 Update a Record 245 Searching 245 Search Fora User 245 Search Fora Keyword 246 Search Fora Filter 246 Search ForStatistics 248 Search by Time 250 XML Formatting Used in Field Results and Input 254 XMLFormatting GuidelinesforField Input 254 XMLFormatting GuidelinesforField Results 259 Common Attributes 259 Field-Specific Attributes 259 XMLFormatting Guidelinesfor5.x Search Input 268 General Settings 269 Result Display 270 Search Criteria 272 KeywordsSearch 273 Filters 273 StatisticsCriteria 296 Module Definition 301 XMLFormatting GuidelinesforLegacy Input 304 Keyword Search 305 Result Display 305 Special Search Characteristics 307 Filter 308 Appendix A:Supported Locales 310 Appendix B:Supported Time Zones 312 8 RSA Archer GRC WebServices API Reference Guide ® ® RSA Archer GRC Suite Web Services API The RSA Archer GRC Suite WebServices API is a collectionof webservices thatprovide a programmatic interface for interactingwiththe RSA Archer GRC. Eachwebservice supports multiple methods thatcanbe usedtogether toautomate the exchange of informationbetweenthe Platformandanexternalapplication. The followingwebservices are available withthe RSA Archer GRC. AvailableWeb Services Access The Access Controlclass provides programmatic access tothe Access Controlfeature, Control suchas creatingusers andmanagingsecurityparameters. Access The Access Role class provides programmatic access tooptions relatingtomanaging Role access roles. Field The Fieldclass allows youtomanage andconfigure the values lists usedinthe applications, questionnaires, andsub-forms. General The Generalclass allows youtocreate andterminate WebServices API user sessions. Module The Module class provides programmatic access tomodule information. Record The Recordclass allows youtocreate andmanipulate contentrecords incontent applications. Search The Searchclass allows programmatic access tothe Platform’s searchfeatures. RSA®Archer®GRC Suite Web ServicesAPI 9 RSA Archer GRC WebServices API Reference Guide Using the Web Services API API Access Configuration 10 Access the WebServices API 11 Access the API IntegrationManager 13 Determine SystemIDs 14 Determine ApplicationGUIDs 14 Time-BasedFiltering 15 API Access Configuration AllWebServices API calls require validuser credentials tobe submittedbefore the calling applicationgains access. The privileges thatyougrantdifferentusers dependonthe functions that theyneedtoperform. Inthis guide, eachof the webservices includes a listof methods, andfor each method, the levelof access neededtoexecute itis provided. Important: As of version5.x, WebServices API privileges andRSA Archer GRC privileges are shared. For example, if a Platformuser has Readprivileges toa certainapplication, thatuser is now able touse WebServices API calls thatrequire Readpermissions for thatapplication. The followingrules offer insightintothe requiredlevelof access for a method: Methods thatstartwiththe word“Create” require Create permissions. l Methods thatstartwiththe followingwords require Readpermissions: l o Check o Does o Get o Lookup o Retrieve o Search Using the Web ServicesAPI 10