🔒Security Requirements and Controls
🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The updateSharedDashboardsSecurityPolicies() mutation updates the shared dashboard security policies for an organization. When you change the policies, LogScale immediately updates or deletes all shared dashboard tokens that do not conform to the new settings. Enforcing an IP filter applies that filter to all tokens. Disabling shared dashboards immediately and permanently deletes all shared dashboard tokens. To remove an IP filter restriction without disabling shared dashboards, set enforceIpFilterId to null.

Syntax

graphql
updateSharedDashboardsSecurityPolicies(
      input: SharedDashboardsSecurityPoliciesInput!
   ): Organization!

The mutation takes a required input argument of type SharedDashboardsSecurityPoliciesInput, which specifies whether shared dashboard tokens are enabled and optionally identifies an IP filter to enforce. The mutation returns a non-nullable Organization object.

Input parameters

The input argument takes two fields. The required sharedDashboardsEnabled field controls whether shared dashboard tokens are active for the organization; setting it to false immediately and permanently deletes all tokens. The optional enforceIpFilterId field takes the ID of an IP filter to apply to all shared dashboard tokens; pass null to remove any IP filter enforcement without affecting token availability. The following table describes each field:

Table: SharedDashboardsSecurityPoliciesInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
enforceIpFilterIdString  Long-Term The IP filter that will be enforced on all shared dashboard tokens.
sharedDashboardsEnabledBooleanyes Long-Term Whether shared dashboard tokens should be enabled.

Example

Raw
graphql
mutation {
  updateSharedDashboardsSecurityPolicies( input:
    {
      sharedDashboardsEnabled: true
    }
  )
  { id }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateSharedDashboardsSecurityPolicies( input:
    {
      sharedDashboardsEnabled: true
    }
  )
  { id }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateSharedDashboardsSecurityPolicies( input:
    {
      sharedDashboardsEnabled: true
    }
  )
  { id }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateSharedDashboardsSecurityPolicies( input: ^
    { ^
      sharedDashboardsEnabled: true ^
    } ^
  ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateSharedDashboardsSecurityPolicies( input:
    {
      sharedDashboardsEnabled: true
    }
  )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateSharedDashboardsSecurityPolicies( input:
    {
      sharedDashboardsEnabled: true
    }
  )
  { id }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateSharedDashboardsSecurityPolicies( input:
    {
      sharedDashboardsEnabled: true
    }
  )
  { id }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateSharedDashboardsSecurityPolicies( input:
    {
      sharedDashboardsEnabled: true
    }
  )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateSharedDashboardsSecurityPolicies": {
      "id": "SINGLE_ORGANIZATION_ID"
    }
  }
}

Returned values

The mutation returns the updated Organization object. To confirm the applied changes, request the sharedDashboardsEnabled and enforceIpFilterId fields from the returned object. The following table lists all available fields:

Table: Organization Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
actionOrganizationAction):Booleanyes Short-Term The action to check if a user is allowed to perform on an organization.
cidString  Short-Term The CID corresponding to the organization.
configsOrganizationConfigsyes Short-Term Organization configurations and settings. See OrganizationDetails.
createdAtLong  Short-Term Date organization was created.
defaultCachePolicyCachePolicy  Short-Term The default cache policy of the organization. See CachePolicy. This is a preview and subject to change.
deletedAtLong  Short-Term Day organization was deleted if it was marked for deletion.
descriptionString  Short-Term The description for the Organization. Can be null.
detailsOrganizationDetailsyes Short-Term Any additional details related to the organization. See OrganizationDetails.
externalGroupSynchronizationBooleanyes Short-Term Whether there is group synchronization.
externalPermissionsBooleanyes Short-Term Whether permissions are managed externally.
idStringyes Short-Term The unique id for the Organization.
ingestUrlString  Short-Term The ingest URL for the organization.
limitsLimityes Short-Term Limits assigned to the organization. See Limit.
limitsV2LimitV2yes Short-Term Limits assigned to the organization. See LimitV2.
nameStringyes Short-Term The name for the Organization.
publicUrlString  Short-Term The public URL for the organization.
readonlyDashboardIPFilterString  Short-Term IP filter for readonly dashboard links.
searchDomainsSearchDomainyes Short-Term Search domains within the organization. See SearchDomain.
statsOrganizationStatsyes Short-Term Statistics of the organization. See OrganizationStats.
trialStartedAtLong  Short-Term Date organization's trial started.