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.

Supported Calls

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

Fields

Field Name Details
CreatedById
Type
reference
Properties
Defaulted on create, Filter
Description
System field that specifies the ID of the user who created this record.
CreatedDate
Type
dateTime
Properties
Defaulted on create, Filter
Description
System field that specifies the date and time when this record was created.
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
A brief description of this organization.
DisplayName
Type
string
Properties
Create, Filter, Group, Sort
Description
The name that the user has specified for this member organization.
EnvironmentHubId
Type
reference
Properties
Filter, Group, Sort
Description
The Organization ID of this member’s Environment Hub organization.
Id
Type
ID
Properties
Defaulted on create
Description
System field that uniquely identifies this record.
IsFedIdSsoMatchAllowed
Type
boolean
Properties
Defaulted on create
Description
Indicates if single sign-on has been enabled based on matching Federation ID. The default value is false.
LastModifiedById
Type
reference
Properties
Defaulted on create, Filter
Description
System field that specifies the ID of the user who last updated this record.
LastModifiedDate
Type
reference
Properties
Defaulted on create, Filter
Description
System field that specifies the date and time when this record was last modified.
MemberEntity
Type
string
Properties
Create, Filter, Group, Sort
Description
The Organization ID of the member organization this record is representing.
OrgEdition
Type
picklist
Properties
Filter, Group, 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, Sort
Description
The method by which this organization was added to the Environment Hub. Possible values are Auto Discovered and User Added.
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.
SsoStatus
Type
picklist
Properties
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.com support for assistance.
.
SsoUsernameFormula
Type
string
Properties
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.