EnvironmentHubMember

Represents a member organization in the Environment Hub. This object is available in API version 29.0 and later.

You can create only 20 member orgs per day. If you need to create additional orgs, log a support case in the Salesforce Partner Community. For product, specify Platform. For topic, specify AppExchange & Managed Packages.

Note

Supported Calls

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

Fields

Field Name Details
Description
Type
textarea
Properties
Nillable, Update
Description
A brief description of this org.
DisplayName
Type
string
Properties
Filter, Group, Nillable,Sort, Update
Description
The name that the user has specified for this member org.
EnvironmentHubId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The Org ID of this member’s Environment Hub org.
Instance
Type
String
Properties
Filter, Group, Nillable, Sort
Description
Name of the instance where the Environment Hub member org resides.
IsFedIdSsoMatchAllowed
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if single sign-on (SSO) has been enabled based on matching the Federation ID. The default is false.
IsSandbox
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if the member org is a sandbox (true) or not (false). This field is available in API version 36.0 and later.
MemberEntity
Type
string
Properties
Filter, Group, idLookup, Sort
Description
The unique Org ID of the member org for this record.
MemberType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
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.

Note

Name
Type
string
Properties
Defaulted on create, Filter, idLookup, Sort
Description
The name of the member org for this record.
OrgEdition
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The org’s edition, for example, Enterprise Edition or Unlimited Edition.
OrgStatus
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The licensing or creation status of this org. Possible values include Active, Demo, Deleted, Free, Inactive, and Trial.
Origin
Type
picklist
Properties
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.
SSOMappedUsers
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total number of mapped users in this member org. This field is available in API version 36.0 and later.
ServiceProviderId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The ID of the service provider for this member org. This field is available in API version 36.0 and later.
ShouldAddRelatedOrgs
Type
picklist
Properties
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.
ShouldEnableSSO
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
If SSO should be enabled when this member org is added. The default is false.
SsoStatus
Type
picklist
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
If SSO has been enabled for this org. Possible values are:
  • Enabled—Single sign-on is enabled.
  • Disabled—Single sign-on is disabled.
  • Pending—Single sign-on is in the process of being enabled.
  • Failed—Single sign-on enablement failed. Contact Salesforce support for assistance.
SsoUsernameFormula
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
The custom formula for matching users in the hub and member orgs.

Usage

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