Newer Version Available

This content describes an older version of this product. View Latest

EnvironmentHubMember

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

You can only create 20 member orgs per day. If you need to create additional orgs, log a case in the Partner Community.

Note

Supported Calls

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

Fields

Field Name Details
CreatedDate
Type
dateTime
Properties
Defaulted on create, Filter, Sort
Description
System field that specifies the date and time when this record was created.
Description
Type
string
Properties
Nillable, Update
Description
A brief description of this organization.
DisplayName
Type
string
Properties
Filter, Group, Nillable,Sort, Update
Description
The name that the user has specified for this member organization.
EnvironmentHubId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The Organization ID of this member’s Environment Hub organization.
Id
Type
ID
Properties
Defaulted on create, Filter, Group, idLookup, Sort
Description
System field that uniquely identifies this record.
IsFedIdSsoMatchAllowed
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if single sign-on has been enabled based on matching Federation ID. The default value is false.
IsSandbox
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if the member organization 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 Organization ID of the member organization for this record.
MemberType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of member organization 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 organization for this record.
OrgEdition
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The organization’s edition, for example, Enterprise Edition or Unlimited Edition.
OrgStatus
Type
picklist
Properties
Filter, Group, Sort, Update
Description
The licensing or creation status of this organization. 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 organization was added to the Environment Hub. Possible values are Auto Discovered, User Added, and Provisioned.
ServiceProviderId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The ID of the service provider for this member organization. This field is available in API version 36.0 and later.
ShouldAddRelatedOrgs
Type
boolean
Properties
Defaulted on create, Update
Description
If related organizations should be automatically connected to the hub when this member organization is added. The default value is true.
ShouldEnableSSO
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
If SSO should be enabled when this member organization is added. The default value is false.
SSOMappedUsers
Type
int
Properties
Filter, Group, Nillable, Sort, Update
Description
The total number of mapped users in this member organization. This field is available in API version 36.0 and later.
SsoStatus
Type
picklist
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
If single sign-on has been enabled for this organization. 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 organizations.

Usage

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