PUT /v1/roles/{id}

Update an existing 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/

Path parameters

Name	Type	Required	Description
`id`	String	Yes	Identifier of the role to update.

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	Yes	Description of the role.
`filterPredicate`	String	Yes	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	Yes	List of user identifiers to assign the role to.
`capabilities[]`	Array	Yes	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 Entity management manageEntityTypeConfig Metrics metricsTransformation metricsExtraction metricsRules Security managePasswordPolicy ipAllowlisting createAccessKeys manageAccessKeys manageSupportAccountAccess manageAuditDataFeed manageSaml shareDashboardOutsideOrg manageOrgSettings changeDataAccessLevel Dashboards shareDashboardWorld shareDashboardAllowlist UserManagement manageUsersAndRoles Observability searchAuditIndex auditEventIndex Cloud SIEM Enterprise viewCse Alerting viewMonitorsV2 manageMonitorsV2 viewAlerts

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.