{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "field_reference"
  ],
  "title": "ScratchOrgInfo - Data API",
  "description": "Represents a scratch org and its audit log. Use this object to create a scratch org and keep a log of its creation and deletion. This object is available in API version 41.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "AdminEmail": {
      "type": "email",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The email address of the scratch org’s Administration user. The read only SignupEmail field is populated with this value. If you don't provide a value for AdminEmail, the field is left blank and the SignupEmail is populated with the email address of the org user who is creating this object."
    },
    "AuthCode": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "A one-time authorization code that can be exchanged for an OAuth access token and refresh token using standard Salesforce APIs. It’s used with ConnectedAppCallbackUrl and ConnectedAppConsumerKey, when the specified connected app hasn't been configured with an X.509 certificate. This field is read only."
    },
    "ConnectedAppCallbackUrl": {
      "type": "textarea",
      "properties": "Create",
      "description": "When used with ConnectedAppConsumerKey, it specifies the callback URL used for OAuth. If using Salesforce CLI, the default is http://localhost:1717/OauthRedirect.",
      "required": true
    },
    "ConnectedAppConsumerKey": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort",
      "description": "When used with ConnectedAppCallbackUrl, it specifies the connected app that is approved automatically during scratch org creation. If using Salesforce CLI and the default connected app, indicate PlatformCLI.",
      "required": true
    },
    "Country": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The two-character, upper-case ISO-3166 country code. You can find a full list of these codes at several sites, such as: www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html. The language of the scratch org is auto-determined based on the value of this field. If you don’t specify a value, this field defaults to the Dev Hub’s country code."
    },
    "DeletedBy": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The user who requested that the scratch org be deleted. This field is read only."
    },
    "DeletedDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The date when the DeletedBy user requested that the scratch org be deleted. This field is read only."
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "A free-form text field for you to enter a description of this scratch org."
    },
    "DurationDays": {
      "type": "int",
      "properties": "Create, Filter, Nillable, Group, Sort",
      "description": "Number of days after which the scratch org expires. Valid values are 1–30. The default is 7."
    },
    "Edition": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Required if you don’t provide Snapshot or SourceOrg. The org edition of this scratch org. Valid values are Group, Developer, Enterprise, and Professional.",
      "required": true
    },
    "ErrorCode": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The error code if the scratch org creation isn’t successful. This field is read only."
    },
    "ExpirationDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Date when the scratch org expires. This field is read only."
    },
    "Features": {
      "type": "textarea",
      "properties": "Create, Nillable",
      "description": "A semi-colon delimited list of the features enabled in this scratch org, such as MultiCurrency. See the Salesforce DX Developer Guide for the full list of valid features."
    },
    "HasSampleData": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort",
      "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."
    },
    "Language": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The language of the scratch org being created. Specify the language using a language code listed under \"Supported Languages\" in Salesforce Help. For example, use zh_CN for simplified Chinese. The value you select overrides the language set by locale. If you don’t specify a value, the language is based on the Country used during scratch org creation. If you don’t specify a value for Country, the value defaults to the Dev Hub’s country."
    },
    "LastLoginDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The date of the last user login to the scratch org. This field is read only."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. This field is read only."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. This field is read only."
    },
    "LoginUrl": {
      "type": "textarea",
      "properties": "Nillable",
      "description": "A URL that logs you in to the scratch org. This field is read only."
    },
    "Name": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, Sort",
      "description": "The auto-generated ID of this scratch org. This field is read only."
    },
    "Namespace": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The namespace you want to associate with this scratch org. The value of this field corresponds to the NamespacePrefix field of the NamespaceRegistry object that describes your namespace."
    },
    "OrgName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort",
      "description": "The name of the scratch org. This name appears as the Organization Name in the Company Information Setup page.",
      "required": true
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "The ID of the user who created this scratch org."
    },
    "Release": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The release of the scratch org. During Salesforce's major release transitions, this field allows you to select the Salesforce release version, based on the version of your Dev Hub. This field is available in API version 46.0 and later. Valid values are: Current Preview Previous See Select the Salesforce Release for a Scratch Org for more information."
    },
    "ScratchOrg": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The org ID of the scratch org. This field is read only."
    },
    "SignupCountry": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The country code of the scratch org. This field is populated with the value of the Country field. If you didn’t provide a value for Country, it’s the country code of the Dev Hub. This field is read only."
    },
    "SignupEmail": {
      "type": "email",
      "properties": "Filter, Group, Sort",
      "description": "The email address of the scratch org’s Administration user. This field is populated with the value of the AdminEmail field. If you didn't provide a value for AdminEmail, it's the email address of your user in the Dev Hub. This field is read only."
    },
    "SignupInstance": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The Salesforce instance on which this scratch org resides. This field is read only."
    },
    "SignupLanguage": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The language of the scratch org. This field is populated with the value of the Language field. If you didn’t provide a value for Language, it’s the language of the Dev Hub. This field is read only."
    },
    "SignupTrialDays": {
      "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."
    },
    "SignupUsername": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The username of the Administration user of this scratch org. This field is populated with the value of the Username field. If you didn’t provide a value for Username, the value of this field is auto-generated. This field is read only."
    },
    "Snapshot": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "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. If you specify Snapshot, you can’t specify Edition or SourceOrg. This field is available in API version 61.0 and later."
    },
    "SourceOrg": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The ID of the org whose shape (features, settings, limits, and licenses) information is used for creating scratch orgs. If you specify SourceOrg, you can’t specify Edition or Snapshot."
    },
    "Status": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
      "description": "The status of the scratch org, such as active, expired, or deleted. This field is read only."
    },
    "Username": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The username of the Administration user of this scratch org."
    }
  },
  "associated_objects": "This object has the following associated objects. Unless noted, they’re available in the same API version as this object.\n\n- **ScratchOrgInfoFeed**: Feed tracking is available for the object.\n- **ScratchOrgInfoHistory**: History is available for tracked fields of the object.\n- **ScratchOrgInfoShare**: Sharing is available for the object.",
  "field_reference": {
    "AdminEmail": {
      "field_label": "Requested Admin Email",
      "type": "email",
      "length": "80"
    },
    "AuthCode": {
      "field_label": "Connected App Authorization Code",
      "type": "string",
      "length": "120"
    },
    "ConnectedAppCallbackUrl": {
      "field_label": "Connected App Callback URL",
      "type": "textarea",
      "length": "2000"
    },
    "ConnectedAppConsumerKey": {
      "field_label": "Connected App Consumer Key",
      "type": "string",
      "length": "120"
    },
    "Country": {
      "field_label": "Requested Country",
      "type": "string",
      "length": "3"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "DeletedBy": {
      "field_label": "Deleted By",
      "type": "string",
      "length": "15"
    },
    "DeletedDate": {
      "field_label": "Deleted Date",
      "type": "date"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "2000"
    },
    "DurationDays": {
      "field_label": "Requested Duration In Days",
      "type": "int",
      "digits": "9"
    },
    "Edition": {
      "field_label": "Edition",
      "type": "picklist",
      "length": "255"
    },
    "ErrorCode": {
      "field_label": "Error Code",
      "type": "string",
      "length": "8"
    },
    "ExpirationDate": {
      "field_label": "Expiration Date",
      "type": "date"
    },
    "Features": {
      "field_label": "Features",
      "type": "textarea",
      "length": "10000"
    },
    "HasSampleData": {
      "field_label": "Has Sample Data",
      "type": "boolean"
    },
    "Id": {
      "field_label": "Scratch Org Info ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Requested Language",
      "type": "picklist",
      "length": "255"
    },
    "LastLoginDate": {
      "field_label": "Last Login Date",
      "type": "date"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "LoginUrl": {
      "field_label": "Login URL",
      "type": "textarea",
      "length": "2000"
    },
    "Name": {
      "field_label": "Number",
      "type": "string",
      "length": "255"
    },
    "Namespace": {
      "field_label": "Namespace",
      "type": "string",
      "length": "15"
    },
    "OrgName": {
      "field_label": "Org Name",
      "type": "string",
      "length": "80"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "Package2AncestorIds": {
      "field_label": "Requested Package2 Ancestor IDs",
      "type": "textarea",
      "length": "2000"
    },
    "Release": {
      "field_label": "Release",
      "type": "picklist",
      "length": "255"
    },
    "ScratchOrg": {
      "field_label": "Scratch Org ID",
      "type": "string",
      "length": "15"
    },
    "SignupCountry": {
      "field_label": "Signup Country",
      "type": "string",
      "length": "3"
    },
    "SignupEmail": {
      "field_label": "Signup Email",
      "type": "email",
      "length": "80"
    },
    "SignupInstance": {
      "field_label": "Signup Instance",
      "type": "string",
      "length": "15"
    },
    "SignupLanguage": {
      "field_label": "Signup Language",
      "type": "picklist",
      "length": "255"
    },
    "SignupTrialDays": {
      "field_label": "Signup Trial Days",
      "type": "int",
      "digits": "9"
    },
    "SignupUsername": {
      "field_label": "Signup Username",
      "type": "string",
      "length": "80"
    },
    "SourceOrg": {
      "field_label": "Shape Source Org",
      "type": "string",
      "length": "18"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Username": {
      "field_label": "Requested Username",
      "type": "string",
      "length": "80"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}