The updateOrganizationForeignKey() GraphQL mutation field is used to fix manually any bad references. This is a root operation.

For more information on organization settings, see the Organization Settings documentation page.


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

   id: string!
   foreignType: Organizations__ForeignType!
   operation: Organizations__Operation!
): Organization!

Given and Returned Datatypes

The given datatype, Organizations__ForeignType is an enumerated list: Unknown, role(), group(), Idp, View, or user().

The Organizations__Operation datatype is also an enumerated list: Remove, or Add.

The returned datatype organization() has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: Organization

idstringyes The unique id for the Organization.
namestringyes The name for the Organization.
descriptionstring  The description for the Organization. Can be null.
detailsOrganizationDetailsyes Any additional details related to the organization (see OrganizationDetails Table).
statsOrganizationStatsyes Statistics of the organization (see OrganizationStats Table).
configsOrganizationConfigsyes Organization configurations and settings (see OrganizationDetails Table).
searchDomains[SearchDomain]yes Search domains within the organization (see SearchDomain Table).
readonlyDashboardIPFilterstring  IP filter for readonly dashboard links.
createdAtlong  Date organization was created.
trialStartedAtlong  Date organization's trial started.
isActionAllowedtypeyes Check if current user has a given permission in organization. OrganizationAction is the action to check if a user is allowed to perform on an organization (see OrganizationAction Table).
limits[Limit]yes Limits assigned to the organization (see Limit Table).
externalPermissionsbooleanyes Whether permissions are managed externally.
externalGroupSynchronizationbooleanyes Whether there is group synchronization.
defaultCachePolicyCachePolicy  The default cache policy of this organization. PREVIEW: Cache policies are a limited feature and is subject to change. See CachePolicy Table.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.