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

Summary

The updateOrganizationForeignKey() mutation repairs broken foreign key references within an organization. Foreign key references connect organization entities — including users, groups, and roles — to related records. When those references become invalid due to data inconsistency or account changes, call this mutation to correct them. This is a root-level administrative operation.

Syntax

graphql
updateOrganizationForeignKey(
      id: String!,
      foreignType: Organizations__ForeignType!,
      operation: Organizations__Operation!
   ): Organization!

The mutation requires three arguments: id, foreignType, and operation. All three are required. Use the searchOrganizations() query to retrieve the organization id. The foreignType and operation arguments accept enum values defined in the Input parameters tables. The mutation returns a non-null Organization! object.

Input parameters

All three parameters are required. Provide the organization ID, the category of foreign key reference to target, and the operation to perform on those references.

Table: Input parameters and datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation. Because some parameters use special datatypes, additional tables for them appear below.
foreignType Organizations__ForeignType yes   The type of foreign key reference to target. Determines which category of cross-entity reference — such as references to user records or role records — the operation acts on. See the enum table below for valid values.
id String yes   The unique identifier of the organization.
operation Organizations__Operation yes   The operation to perform on the identified foreign key references — for example, adding or removing them. See the enum table below for valid values.

The foreignType parameter accepts an Organizations__ForeignType enum value. The following table lists the available values:

The operation parameter accepts an Organizations__Operation enum value. The following table lists the available values:

Example

Raw
graphql
mutation {
  updateOrganizationForeignKey( 
     id: "abc123",
     foreignType: User,
     operation: Remove
  )
 { 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 {
  updateOrganizationForeignKey( 
     id: \"abc123\",
     foreignType: User,
     operation: Remove
  )
 { 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 {
  updateOrganizationForeignKey( 
     id: \"abc123\",
     foreignType: User,
     operation: Remove
  )
 { 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 { ^
  updateOrganizationForeignKey(  ^
     id: \"abc123\", ^
     foreignType: User, ^
     operation: Remove ^
  ) ^
 { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateOrganizationForeignKey( 
     id: \"abc123\",
     foreignType: User,
     operation: Remove
  )
 { 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 {
  updateOrganizationForeignKey( 
     id: \"abc123\",
     foreignType: User,
     operation: Remove
  )
 { 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 {
  updateOrganizationForeignKey( 
     id: \"abc123\",
     foreignType: User,
     operation: Remove
  )
 { 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 {
  updateOrganizationForeignKey( 
     id: \"abc123\",
     foreignType: User,
     operation: Remove
  )
 { 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": {
    "updateOrganizationForeignKey": {
      "id": "abc123"
    }
  }
}

Returned values

The mutation returns an Organization! object representing the organization after the repair. The Organization type includes fields for configuration, resource limits, membership data, and hosted URLs. Request only the fields you need.

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.