updateOrganizationRoot()

API Stability	`Short-Term`

The updateOrganizationRoot() GraphQL mutation is used to update a user's organization's root state.

For information on root access, see the Managing Root Access documentation page. For information on organization settings, see the Organization Settings documentation page.

Syntax

Below is the syntax for the updateOrganizationRoot() mutation field:

graphql

updateOrganizationRoot(
     userId: string!, 
     organizationRoot: boolean!
   ): Organization!

Below is an example of how this mutation field might be used:

Show:

graphql

mutation {
  updateOrganizationRoot(
     userId: "xyz098",
     organizationRoot: true
  )
  { id }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateOrganizationRoot(
     userId: \"xyz098\",
     organizationRoot: true
  )
  { id }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateOrganizationRoot(
     userId: \"xyz098\",
     organizationRoot: true
  )
  { id }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateOrganizationRoot( ^
     userId: \"xyz098\", ^
     organizationRoot: true ^
  ) ^
  { id } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateOrganizationRoot(
     userId: \"xyz098\",
     organizationRoot: true
  )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  updateOrganizationRoot(
     userId: \"xyz098\",
     organizationRoot: true
  )
  { id }
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateOrganizationRoot(
     userId: \"xyz098\",
     organizationRoot: true
  )
  { id }
}"
}'''

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

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateOrganizationRoot(
     userId: \"xyz098\",
     organizationRoot: true
  )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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

Show:

json

{
  "data": {
    "updateOrganizationRoot": {
      "id": "abc123"
    }
  }
}

Returned Datatypes

The returned datatype Organization has several parameters. Below is a list of them along with a description of each:

Table: Organization

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 27, 2024
`cid`	string		`Short-Term`	The CID corresponding to the organization.
`configs`	`OrganizationConfigs`	yes	`Short-Term`	Organization configurations and settings. See `OrganizationDetails`.
`createdAt`	long		`Short-Term`	Date organization was created.
`defaultCachePolicy`	`CachePolicy`		`Preview`	The default cache policy of the organization. See `CachePolicy`. This is a preview and subject to change.
`description`	string		`Short-Term`	The description for the Organization. Can be null.
`details`	`OrganizationDetails`	yes	`Short-Term`	Any additional details related to the organization. See `OrganizationDetails`.
`externalGroupSynchronization`	boolean	yes	`Short-Term`	Whether there is group synchronization.
`externalPermissions`	boolean	yes	`Short-Term`	Whether permissions are managed externally.
`id`	string	yes	`Short-Term`	The unique id for the Organization.
`ingestUrl`	string		`Short-Term`	The ingest URL for the organization.
`isActionAllowed`	multiple	yes	`Short-Term`	Check if user has a permission in organization. The datatype consists of `(action: OrganizationAction): boolean`. For `OrganizationAction`, give the action to check if a user is allowed to perform on the organization. See `OrganizationAction`.
`limits`	[`limit`]	yes	`Short-Term`	Limits assigned to the organization. See `limit`.
`limitsV2`	[`LimitV2`]	yes	`Short-Term`	Limits assigned to the organization. See `LimitV2`.
`name`	string	yes	`Short-Term`	The name for the Organization.
`publicUrl`	string		`Short-Term`	The public URL for the organization.
`readonlyDashboardIPFilter`	string		`Short-Term`	IP filter for readonly dashboard links.
`searchDomains`	[`searchDomain`]	yes	`Short-Term`	Search domains within the organization. See `searchDomain`.
`stats`	`OrganizationStats`	yes	`Short-Term`	Statistics of the organization. See `OrganizationStats`.
`trialStartedAt`	long		`Short-Term`	Date organization's trial started.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes