ActiveScratchOrg

Represents an active scratch org.

Introduced in API version 40.0.

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

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A description of this scratch org.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: The org edition of this scratch org. Possible values are Group, Developer, Enterprise, and Professional. This field is read only.
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: Date when the scratch org expires. This field is read only.
  • Type: textarea
  • Properties: Nillable
  • Description: The features enabled in this scratch org, such as MultiCurrency. See the Salesforce DX Developer Guide for the full list of valid features. This field is read only.
  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort
  • Introduced: API version 41.0
  • Description: Specifies whether the scratch org contains sample data. If set to true, the sample data is similar to the data in a Salesforce free trial org.
  • Default value: false
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: The date of the last user login to the scratch org. This field is read only.
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The auto-generated ID of this scratch org. This field is read only.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: The namespace associated with this scratch org. This field is read only.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: The name of the scratch org. This field is read only.
  • Type: string
  • Properties: Filter, Group, Sort
  • Description: The org ID of the scratch org. This field is read only.
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The id of the associated ScratchOrgInfo object. This field is read only.
  • Relationship name: ScratchOrgInfo
  • Relationship type: relationship
  • Refers to: ScratchOrgInfo
  • Type: email
  • Properties: Filter, Group, Nillable, Sort
  • Description: The email address of the Administration user. This field is read only.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: The Salesforce instance on which this scratch org resides. This field is read only.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: The number of days between the scratch org’s creation and expiration. This field is read only.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: The username of the Administration user of the scratch org. This field is read only.

  • Type: string

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 59.0

  • Description:

    If this scratch org was created from a scratch org snapshot, then this field contains either the name or ID of the snapshot. Specifically, the name corresponds to the Name field of the snapshot’s record in the OrgSnapshot standard object; the ID corresponds to the record ID.

    If this scratch org wasn’t created from a snapshot, this field is empty. This field is read only.

  • Type: string
  • Properties: Filter, Group, Nillable, Sort

Salesforce automatically creates an instance of this object after a ScratchOrgInfo record moves to the Active state. The new ActiveScratchOrg gets many of its field values from the ScratchOrgInfo object with which it’s associated.

When you delete an ActiveScratchOrg record, its associated scratch org is deleted and its associated ScratchOrgInfo record is moved to the Deleted state.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.