POST /v1/roles

Create a new role in the organization.

Servers

https://api.au.sumologic.com/api/
https://api.ca.sumologic.com/api/
https://api.de.sumologic.com/api/
https://api.eu.sumologic.com/api/
https://api.fed.sumologic.com/api/
https://api.jp.sumologic.com/api/
https://api.kr.sumologic.com/api/
https://api.in.sumologic.com/api/
https://api.sumologic.com/api/
https://api.us2.sumologic.com/api/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`name`	String	Yes	Name of the role.
`description`	String	No	Description of the role.
`filterPredicate`	String	No	A search filter to restrict access to specific logs. The filter is silently added to the beginning of each query a user runs. For example, using '!_sourceCategory=billing' as a filter predicate will prevent users assigned to the role from viewing logs from the source category named 'billing'.
`autofillDependencies`	Boolean	No	Set this to true if you want to automatically append all missing capability requirements. If set to false an error will be thrown if any capabilities are missing their dependencies. Default value: true
`users[]`	Array	No	List of user identifiers to assign the role to.
`capabilities[]`	Array	No	List of capabilities associated with this role. Valid values are Data Management viewCollectors manageCollectors manageBudgets manageDataVolumeFeed viewFieldExtraction manageFieldExtractionRules manageS3DataForwarding manageContent manageApps dataVolumeIndex manageConnections viewScheduledViews manageScheduledViews viewPartitions managePartitions viewFields manageFields viewAccountOverview manageTokens downloadSearchResults manageIndexes manageDataStreams viewParsers viewDataStreams Entity management manageEntityTypeConfig Metrics metricsTransformation metricsExtraction metricsRules Security managePasswordPolicy ipAllowlisting ipWhitelisting createAccessKeys manageAccessKeys manageSupportAccountAccess manageAuditDataFeed manageSaml shareDashboardOutsideOrg manageOrgSettings changeDataAccessLevel Dashboards shareDashboardWorld shareDashboardAllowlist shareDashboardWhitelist UserManagement manageUsersAndRoles Observability searchAuditIndex auditEventIndex Cloud SIEM Enterprise viewCse cseViewAutomations cseManageContextActions cseViewNetworkBlocks cseManageInsightTags cseViewRules cseViewThreatIntelligence cseCommentOnInsights cseViewEntityGroups cseManageEntityConfiguration cseManageNetworkBlocks cseManageMatchLists cseViewCustomInsights cseManageActions cseManageAutomations cseManageMappings cseManageThreatIntelligence cseViewActions cseCreateInsights cseManageTagSchemas cseInvokeInsights cseManageCustomEntityType cseViewTagSchemas cseDeleteInsights cseManageCustomInsights cseViewFileAnalysis cseManageFileAnalysis cseManageEntityCriticality cseViewEntityCriticality cseViewEntity cseManageCustomInsightStatuses cseViewContextActions cseViewMappings cseViewCustomEntityType cseManageEntityGroups cseViewCustomInsightStatuses cseViewEnrichments cseManageInsightSignals cseManageRules cseManageArtifacts cseViewMatchLists cseManageInsightPolicy cseManageEnrichments cseViewEntityConfiguration cseManageEntity cseExecuteAutomations cseManageSuppressedEntities cseManageInsightStatus cseManageInsightAssignee cseManageFavoriteFields cseViewSuppressedEntities Alerting viewMonitorsV2 manageMonitorsV2 viewAlerts viewMutingSchedules manageMutingSchedules adminMonitorsV2 SLO viewSlos manageSlos CloudSoar cloudSoarPlaybooksAccess cloudSoarNotificationConfigure cloudSoarReportAll cloudSoarIncidentTriageAccess cloudSoarIncidentTaskView cloudSoarIncidentChangeOwnership cloudSoarIncidentNotesEdit cloudSoarAPIEmailEdit cloudSoarIncidentTemplatesAccess cloudSoarIncidentPlaybooksManage cloudSoarGeneralConfigure cloudSoarEntitiesAccess cloudSoarEntitiesBulkPhysicalDelete cloudSoarIncidentAttachmentsAccess cloudSoarAppCentralAccess cloudSoarBridgeMonitoringAccess viewCloudSoar cloudSoarIncidentView cloudSoarObservabilityAccess cloudSoarAPIEmailRead cloudSoarAppCentralExport cloudSoarWidgetsAll cloudSoarIncidentTaskReassign cloudSoarIntegrationsAccess cloudSoarCustomizationIncidentLabels cloudSoarAutomationRulesConfigure cloudSoarIncidentTaskAccessAll cloudSoarAuditAndInformationConfigureAuditTrail cloudSoarIncidentTriageEdit cloudSoarIncidentEdit cloudSoarNotificationTriage cloudSoarIncidentTriageBulkPhysicalDelete cloudSoarIncidentNotesAccess cloudSoarAPIUse cloudSoarIncidentPlaybooksEdit cloudSoarDashboardAll cloudSoarEntitiesManage cloudSoarIncidentTemplatesConfigure cloudSoarIncidentTriageAccessAll cloudSoarPlaybooksConfigure cloudSoarIncidentAccessAll cloudSoarCustomizationLogo cloudSoarIncidentTaskAccess cloudSoarIncidentTriageView cloudSoarIntegrationsConfigure cloudSoarIncidentManageInvestigators cloudSoarIncidentAccess cloudSoarAuditAndInformationLicenseInformation cloudSoarIncidentBulkOperations cloudSoarCustomizationFields cloudSoarIncidentTaskEdit cloudSoarDashboardAccess cloudSoarIncidentAttachmentsEdit cloudSoarIncidentFoldersEdit cloudSoarUserManagementGroups cloudSoarIncidentPlaybooksAccess cloudSoarIncidentWarRoomUse cloudSoarReportAccess cloudSoarAuditAndInformationAuditTrail cloudSoarAutomationRulesAccess cloudSoarIncidentTriageChangeOwnership cloudSoarObservabilityManagement

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.