Enable/Disable Azure Tenant Connector

POST /connectors/v1.0/org/azure/status/

We are introducing an API endpoint to update the status of a tenant connector. You can toggle between enabling or disabling the tenant connector by specifying the action as ENABLE or DISABLE.

Input ParameterInput Parameter

Parameter

Mandatory/Optional

Data Type

Description

organizationConnectorId

Mandatory

Integer

The ID (s) of the tenant connector you want to enable or disable.

Sample: Enable a Tenant ConnectorSample: Enable a Tenant Connector

API request

curl --x "PUT" --location 'https://<QualysGatewayURL>/connectors/v1.0/org/azure/status/?action=ENABLE
    
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \  
      

Request POST data

    [xxxxxx]
    

Response

   {
      
    "currentPage": 0,
      
    "currentPageSize": 1,
      
    "totalPages": 1,
      
    "numberOfElements": 1,
      
    "content": [
      
        {
      
            "id": xxxxxx,
      
            "organizationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
            "name": "Azure Org",
      
            "connectorPrefixName": "createdbyorg",
      
            "runFrequency": "60",
      
            "connectorRunFrequency": "60",
      
            "lastSynced": "2023-05-17T07:56:38.051+00:00",
      
            "customerId": "axxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
            "userUuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
            "userName": "abcde_xxxx",
      
            "type": "AZURE",
      
            "lastError": null,
      
            "isDeleted": false,
      
            "isDisabled": false,
      
            "description": "azure org connector description",
      
            "state": "FINISHED_SUCCESS",
      
            "nextSync": "2023-05-17T08:56:38.051+00:00",
      
            "isRemediationEnabled": true,
      
            "organizationName": "Azure org",
      
            "uuid": xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
            "isAssignStaticTagToAssetsPulledByThatConnector": false,
      
            "isAssignStaticTagToConnectors": false,
      
            "connectorAppInfos": [
      
                {
      
                    "name": "AI",
      
                    "identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
                    "tagId": null,
      
                    "tagMetadata": null
      
                },
      
                {
      
                    "name": "CI",
      
                    "identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
                    "tagId": null,
      
                                        "tagMetadata": null
      
                },
      
                {
      
                    "name": "CSA",
      
                    "identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
                    "tagId": null,
      
                    "tagMetadata": null
      
                }
      
            ],
      
            "defaultTagIds": [],
      
            "memberConfigurations": {
      
                "includedMembers": [
      
                    "TestingManagementGroup"
      
                ],
      
                "excludedMembers": []
      
            },
      
            "createConnectorForNewSubscriptionsAutomatically": true,
      
            "disableConnectorsForDeletedManagementGroups": true,
      
            "createStaticTagsForManagementGroups": false
      
        }],
      
    "hasContent": true,
      
    "hasNext": false,
      
    "hasPrevious": false,
      
    "first": true,
      
    "last": true
      
}   
      

Sample: Disable a Tenant ConnectorSample: Disable a Tenant Connector

API request

curl --x "PUT" --location 'https://<QualysGatewayURL>/connectors/v1.0/org/azure/status/?action=DISABLE
    
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
      

 

Request POST data

      [xxxxxx]
      

Response

       
      {
      
    "currentPage": 0,
      
    "currentPageSize": 1,
      
    "totalPages": 1,
      
    "numberOfElements": 1,
      
    "content": [
      
        {
      
            "id": xxxxxx,
      
            "organizationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
            "name": "Azure Org",
      
            "connectorPrefixName": "createdbyorg",
      
            "runFrequency": "60",
      
            "connectorRunFrequency": "60",
      
            "lastSynced": "2023-05-17T07:56:38.051+00:00",
      
            "customerId": "axxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
            "userUuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
            "userName": "abcde_xxxx",
      
            "type": "AZURE",
      
            "lastError": null,
      
            "isDeleted": false,
      
            "isDisabled": true,
      
            "description": "azure org connector description",
      
            "state": "FINISHED_SUCCESS",
      
            "nextSync": "2023-05-17T08:56:38.051+00:00",
      
            "isRemediationEnabled": true,
      
            "organizationName": "Azure org",
      
            "uuid": xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
            "isAssignStaticTagToAssetsPulledByThatConnector": false,
      
            "isAssignStaticTagToConnectors": false,
      
            "connectorAppInfos": [
      
                {
      
                    "name": "AI",
      
                    "identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
                    "tagId": null,
      
                    "tagMetadata": null
      
                },
      
                {
      
                    "name": "CI",
      
                    "identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
                    "tagId": null,
      
                                        "tagMetadata": null
      
                },
      
                {
      
                    "name": "CSA",
      
                    "identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      
                    "tagId": null,
      
                    "tagMetadata": null
      
                }
      
            ],
      
            "defaultTagIds": [],
      
            "memberConfigurations": {
      
                "includedMembers": [
      
                    "TestingManagementGroup"
      
                ],
      
                "excludedMembers": []
      
            },
      
            "createConnectorForNewSubscriptionsAutomatically": true,
      
            "disableConnectorsForDeletedManagementGroups": true,
      
            "createStaticTagsForManagementGroups": false
      
        }],
      
    "hasContent": true,
      
    "hasNext": false,
      
    "hasPrevious": false,
      
    "first": true,
      
    "last": true
      
}