Sync All User Group Role
LAST UPDATED: AUG 12, 2024
Enables the synchronization of all user, groups and roles between the master and the tenant instance(s).
Implementation | System |
Command Category | System Utility |
Tags | USER MULTITENANCY |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
allTenant | Optional | Whether to synchronize user, groups and roles with all tenants or only one.
| True |
Region | Optional | The region of the tenant. | AMER |
Tenant Name | Optional | The name of the tenant. | user1 |
READER NOTE
Either allTenant or both Region and Tenant Name must receive input. If all three receive input, the D3 system will ignore the Region and Tenant Name inputs.
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
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
{
"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 |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
allTenant |
| Optional | Whether to synchronize user, groups and roles with all tenants or only one.
|
Region |
| Optional | The region of the tenant. |
Tenant Name |
| Optional | The name of the tenant. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"allTenant": "True",
"Region": "AMER",
"TenantName": "user1"
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
Sample Response
{
"error": "",
"returnData": "Successful"
}