🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The updateOrganizationInfo() mutation updates the core profile of an organization in LogScale, including its display name, country, industry classification, and use cases. All four parameters are required on every call, so the mutation always replaces the full profile. Call this mutation after creating an organization or when organization details change. To retrieve the current profile before updating, call the organization() query.

Syntax

graphql
updateOrganizationInfo(
      name: String!,
      countryCode: String!,
      industry: String!,
      useCases: [Organizations__UseCases!]!
   ): Organization!

All four parameters are required. Provide the organization's display name and a two-letter ISO 3166-1 Alpha-2 countryCode. Also provide the industry classification string and one or more useCases values from the Organizations__UseCases enum. The mutation returns a non-null Organization object containing the updated profile.

Input parameters

The following table describes each input parameter.

Table: Input parameters and datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation. The useCases parameter accepts values from the Organizations__UseCases enum; the following table lists its valid values.
countryCode String yes   The two-letter ISO 3166-1 Alpha-2 country code for the organization's primary location (for example, US or DE).
industry String yes   The industry classification for the organization (for example, Technology or Financial Services).
name String yes   The display name of the organization in LogScale.
useCases [Organizations__UseCases] yes   One or more intended use cases for the organization (for example, Security or ApplicationDevelopment). Select values from the Organizations__UseCases enum in the following table.

The useCases parameter accepts one or more values from the Organizations__UseCases enum. The following table lists the available values:

Example

Raw
graphql
mutation {
  updateOrganizationInfo( 
     name: "our-company",
     countryCode: "us",
     industry: "",
     useCases: [ Unknown ]
  )
 { 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 {
  updateOrganizationInfo( 
     name: \"our-company\",
     countryCode: \"us\",
     industry: \"\",
     useCases: [ Unknown ]
  )
 { 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 {
  updateOrganizationInfo( 
     name: \"our-company\",
     countryCode: \"us\",
     industry: \"\",
     useCases: [ Unknown ]
  )
 { 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 { ^
  updateOrganizationInfo(  ^
     name: \"our-company\", ^
     countryCode: \"us\", ^
     industry: \"\", ^
     useCases: [ Unknown ] ^
  ) ^
 { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateOrganizationInfo( 
     name: \"our-company\",
     countryCode: \"us\",
     industry: \"\",
     useCases: [ Unknown ]
  )
 { 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 {
  updateOrganizationInfo( 
     name: \"our-company\",
     countryCode: \"us\",
     industry: \"\",
     useCases: [ Unknown ]
  )
 { 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 {
  updateOrganizationInfo( 
     name: \"our-company\",
     countryCode: \"us\",
     industry: \"\",
     useCases: [ Unknown ]
  )
 { 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 {
  updateOrganizationInfo( 
     name: \"our-company\",
     countryCode: \"us\",
     industry: \"\",
     useCases: [ Unknown ]
  )
 { 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": {
    "updateOrganizationInfo": {
      "id": "abc123"
    }
  }
}

Returned values

The mutation returns a non-null Organization object reflecting the updated state. The object includes the organization's configuration, URLs, limits, and related metadata. The following table lists the 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.