Sync All User Group Role

This utility command enables the synchronization of all user groups and roles from the master to the tenant instance.

Implementation	System
Command Category	System Utility
Tags	USER MULTITENANCY

Inputs

Parameter Name	Required/Optional	Description	Sample Data
allTenant	Optional	True: All Child Tenant; False: Special Tenant	`True`
Region	Required	The region for sync all users group and roles	`AMER`
Tenant Name	Required	The Tenant Name for sync all users group and roles	`user1`

Output

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE

https:/{base_url}/{api_namespace}/api/Command/SyncAllUserGroupRole

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "allTenant": <allTenant here>,
    "Region": <Region here>,
    "TenantName": <Tenant Name here>
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`Text`	Required	The username of your D3 SOAR account.
Site	`Text`	Required	The D3 SOAR site to run the remote command.
allTenant	`Text`	Optional	True: All Child Tenant; False: Special Tenant
Region	`Text`	Required	The region for sync all users group and roles
Tenant Name	`Text`	Required	The Tenant Name for sync all users group and roles

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "allTenant": "True",
    "Region": "AMER",
    "TenantName": "user1"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`text`	The error message if the API request has failed.
returnData	`text`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful"
}