EnvironmentHubMember

Represents a member organization in the Environment Hub.

Introduced in API version 26.0.

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update()

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 38.0
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A brief description of this org.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name that the user has specified for this member org.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The Org ID of this member’s Environment Hub org.
  • Relationship name: EnvironmentHub
  • Relationship type: relationship
  • Refers to: EnvironmentHub
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 29.0
  • Description: Name of the instance where the Environment Hub member org resides.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 29.0
  • Description: Indicates if single sign-on (SSO) has been enabled based on matching the Federation ID. The default is false.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 36.0
  • Description: Indicates if the member org is a sandbox (true) or not (false).
  • Default value: false
  • Type: string
  • Properties: Filter, Group, idLookup, Nillable, Sort
  • Description: The unique Org ID of the member org for this record.
  • Type: picklist

  • Properties: Filter, Group, Nillable, Restricted picklist, Sort

  • Introduced: API version 35.0

  • Description: The type of member org for this record. Possible values include Branch Org, Patch Org, Release Org, Sandbox Org, Trialforce Management Org, and Trialforce Source Org.

    Only one member type at a time is stored. Member type is determined according to this hierarchy: (1) Sandbox, (2) Release, (3) Trialforce Source Org (TSO), (4) Patch, (5) Branch, and (6) Trialforce Management Org (TMO). For example, if an org is both a sandbox and a TMO, the value of MemberType is Sandbox Org.

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the member org for this record.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 29.0
  • Description: The org’s edition, for example, Enterprise Edition or Unlimited Edition.
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 32.0
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 29.0
  • Description: The licensing or creation status of this org. Possible values include Active, Demo, Deleted, Free, Inactive, and Trial.
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The method by which this org was added to the Environment Hub. Possible values are autoDiscovered, userAdded, and provisioned.
  • Type: textarea
  • Properties: Create, Nillable
  • Introduced: API version 28.0
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 29.0
  • Description: The total number of mapped users in this member org.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 28.0
  • Description: The ID of the service provider for this member org.
  • Relationship name: ServiceProvider
  • Relationship type: relationship
  • Refers to: ServiceProvider
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Status of the connection of related orgs to the hub. Possible values are done, notRequested, pending, and requested.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 33.0
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 33.0
  • Description: If SSO should be enabled when this member org is added. The default is false.
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 28.0
  • Description: If SSO has been enabled for this org.
  • Possible values:
    • Enabled — Enabled — Single sign-on is enabled.
    • Disabled — Disabled — Single sign-on is disabled.
    • Pending — Pending — Single sign-on is in the process of being enabled.
    • Failed — Failed — Single sign-on enablement failed. Contact Salesforce support for assistance.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 29.0
  • Description: The custom formula for matching users in the hub and member orgs.

Use this object to access and modify settings of member orgs in the Environment Hub.