Skip to main content
Skip table of contents

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: All child tenants will be synchronized.

  • False: One specific tenant will be synchronized.

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

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

string

Required

The username of your D3 SOAR account.

Site

string

Required

The D3 SOAR site to run the remote command.

allTenant

boolean

Optional

Whether to synchronize user, groups and roles with all tenants or only one.

  • True: All child tenants will be synchronized.

  • False: One specific tenant will be synchronized.

Region

string

Optional

The region of the tenant.

Tenant Name

string

Optional

The name of the tenant.

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

string

The error message if the API request has failed.

returnData

string

The return data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": "Successful"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.