Class Org

Provides a way to manage a locally authenticated Org.

See Aliases

// Email username
const org1: Org = await Org.create({ aliasOrUsername: 'foo@example.com' });
// The target-org config property
const org2: Org = await Org.create();
// Full Connection
const org3: Org = await Org.create({
  connection: await Connection.create({
    authInfo: await AuthInfo.create({ username: 'username' })
  })
});

See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_cli_usernames_orgs.htm

Hierarchy

AsyncOptionalCreatable<Org.Options>
- Org

Methods

addUsername

addUsername(auth): Promise<Org>

Adds a username to the user config for this org. For convenience this object is returned.

const org: Org = await Org.create({
  connection: await Connection.create({
    authInfo: await AuthInfo.create('foo@example.com')
  })
});
const userAuth: AuthInfo = await AuthInfo.create({
  username: 'bar@example.com'
});
await org.addUsername(userAuth);

Parameters

auth: string | AuthInfo
The AuthInfo for the username to add.

Returns Promise<Org>

checkScratchOrg

checkScratchOrg(devHubUsernameOrAlias?): Promise<Partial<AuthFields>>
Check that this org is a scratch org by asking the dev hub if it knows about it.

Throws SfError{ name: 'NotADevHubError' } Not a Dev Hub.

Throws SfError{ name: 'NoResultsError' } No results.
Parameters
- Optional devHubUsernameOrAlias: string
  The username or alias of the dev hub org.
Returns Promise<Partial<AuthFields>>
- Defined in src/org/org.ts:517

cleanLocalOrgData

cleanLocalOrgData(orgDataPath?, throwWhenRemoveFails?): Promise<void>
Clean all data files in the org's data path. Usually /.sfdx/orgs/.
Parameters
- Optional orgDataPath: string
  A relative path other than "orgs/".
- throwWhenRemoveFails: boolean = false
  Should the remove org operations throw an error on failure?
Returns Promise<void>
- Defined in src/org/org.ts:454

cloneSandbox

cloneSandbox(sandboxReq, sourceSandboxName, options): Promise<SandboxProcessObject>
Parameters
- sandboxReq: SandboxRequest
  SandboxRequest options to create the sandbox with
- sourceSandboxName: string
  the name of the sandbox that your new sandbox will be based on
- options: {
  interval?: Duration;
  wait?: Duration;
  }
  Wait: The amount of time to wait before timing out, defaults to 0, Interval: The time interval between polling defaults to 30 seconds
  - Optional interval?: Duration
  - Optional wait?: Duration
Returns Promise<SandboxProcessObject>
the newly created sandbox process object
- Defined in src/org/org.ts:327

createSandbox

createSandbox(sandboxReq, options?): Promise<SandboxProcessObject>
create a sandbox from a production org 'this' needs to be a production org with sandbox licenses available
Parameters
- sandboxReq: SandboxRequest
  SandboxRequest options to create the sandbox with
- options: {
      async?: boolean;
      interval?: Duration;
      wait?: Duration;
  } = ...
  Wait: The amount of time to wait before timing out, Interval: The time interval between polling
  - Optional async?: boolean
  - Optional interval?: Duration
  - Optional wait?: Duration
Returns Promise<SandboxProcessObject>
- Defined in src/org/org.ts:226

delete

delete(): Promise<void>
Will delete 'this' instance remotely and any files locally

Returns Promise<void>
- Defined in src/org/org.ts:601

deleteFrom

deleteFrom(controllingOrg): Promise<void>
Will delete 'this' instance remotely and any files locally
Parameters
- controllingOrg: string | Org
  username or Org that 'this.devhub' or 'this.production' refers to. AKA a DevHub for a scratch org, or a Production Org for a sandbox
Returns Promise<void>
- Defined in src/org/org.ts:583

determineIfDevHubOrg

determineIfDevHubOrg(forceServerCheck?): Promise<boolean>
Returns true if the org is a Dev Hub.

Use a cached value. If the cached value is not set, then check access to the ScratchOrgInfo object to determine if the org is a dev hub.
Parameters
- forceServerCheck: boolean = false
  Ignore the cached value and go straight to the server which will be required if the org flips on the dev hub after the value is already cached locally.
Returns Promise<boolean>
- Defined in src/org/org.ts:629

determineIfSandbox

determineIfSandbox(): Promise<boolean>
Returns true if the org is a sandbox.

Use a cached value. If the cached value is not set, then check Organization.IsSandbox == true && Organization.TrialExpirationDate == null using Org.retrieveOrganizationInformation.

Returns Promise<boolean>
- Defined in src/org/org.ts:735

determineIfScratch

determineIfScratch(): Promise<boolean>
Returns true if the org is a scratch org.

Use a cached value. If the cached value is not set, then check Organization.IsSandbox == true && Organization.TrialExpirationDate != null using Org.retrieveOrganizationInformation.

Returns Promise<boolean>
- Defined in src/org/org.ts:719

getConfigAggregator

getConfigAggregator(): ConfigAggregator
Returns for the config aggregator.

Returns ConfigAggregator
- Defined in src/org/org.ts:954

getConnection

getConnection(apiVersion?): Connection<Schema>
Returns the JSForce connection for the org. side effect: If you pass it an apiVersion, it will set it on the Org so that future calls to getConnection() will also use that version.
Parameters
- Optional apiVersion: string
  The API version to use for the connection.
Returns Connection<Schema>
- Defined in src/org/org.ts:985

getDevHubOrg

getDevHubOrg(): Promise<undefined | Org>
Returns the Org object or null if this org is not affiliated with a Dev Hub (according to the local config).

Returns Promise<undefined | Org>
- Defined in src/org/org.ts:549

getField

getField<T>(key): T
Returns an org field. Returns undefined if the field is not set or invalid.
Type Parameters
- T = AnyJson
Parameters
- key: Org.Fields
Returns T
- Defined in src/org/org.ts:961

getFields

getFields(keys): JsonMap
Returns a map of requested fields.
Parameters
- keys: Org.Fields[]
Returns JsonMap
- Defined in src/org/org.ts:974

getOrgId

getOrgId(): string
Returns the orgId for this org.

Returns string
- Defined in src/org/org.ts:947

getSandboxConfig

getSandboxConfig(orgId): Promise<Nullable<SandboxFields>>
get the sandbox config for the given orgId
Parameters
- orgId: string
  {string} orgId of the sandbox
Returns Promise<Nullable<SandboxFields>>
- Defined in src/org/org.ts:924

getUsername

getUsername(): undefined | string
Returns the admin username used to create the org.

Returns undefined | string
- Defined in src/org/org.ts:940

isDevHubOrg

isDevHubOrg(): boolean
Returns true if the org is a Dev Hub.

Note This relies on a cached value in the auth file. If that property is not cached, this method will always return false even if the org is a dev hub. If you need accuracy, use the Org.determineIfDevHubOrg method.

Returns boolean
- Defined in src/org/org.ts:569

isSandbox

isSandbox(): Promise<boolean>
Check if org is a sandbox org by checking its SandboxOrgConfig.

Returns Promise<boolean>
- Defined in src/org/org.ts:505

isScratch

isScratch(): boolean
Returns true if the org is a scratch org.

Note This relies on a cached value in the auth file. If that property is not cached, this method will always return false even if the org is a scratch org. If you need accuracy, use the Org.determineIfScratch method.

Returns boolean
- Defined in src/org/org.ts:662

querySandboxProcessById

querySandboxProcessById(id): Promise<SandboxProcessObject>
query SandboxProcess via Id
Parameters
- id: string
  SandboxProcessId to query for
Returns Promise<SandboxProcessObject>
- Defined in src/org/org.ts:1035

querySandboxProcessByOrgId

querySandboxProcessByOrgId(sandboxOrgId): Promise<SandboxProcessObject>
query SandboxProcess via SandboxOrganization (sandbox Org ID)
Parameters
- sandboxOrgId: string
  SandboxOrganization ID to query for
Returns Promise<SandboxProcessObject>
- Defined in src/org/org.ts:1044

querySandboxProcessBySandboxInfoId

querySandboxProcessBySandboxInfoId(id): Promise<SandboxProcessObject>
query SandboxProcess via SandboxInfoId
Parameters
- id: string
  SandboxInfoId to query for
Returns Promise<SandboxProcessObject>
- Defined in src/org/org.ts:1026

querySandboxProcessBySandboxName

querySandboxProcessBySandboxName(name): Promise<SandboxProcessObject>
query SandboxProcess via sandbox name
Parameters
- name: string
  SandboxName to query for
Returns Promise<SandboxProcessObject>
- Defined in src/org/org.ts:1017

readUserAuthFiles

readUserAuthFiles(): Promise<AuthInfo[]>
Reads and returns the content of all user auth files for this org as an array.

Returns Promise<AuthInfo[]>
- Defined in src/org/org.ts:808

refreshAuth

refreshAuth(): Promise<void>
Refreshes the auth for this org's instance by calling HTTP GET on the baseUrl of the connection object.

Returns Promise<void>
- Defined in src/org/org.ts:795

refreshSandbox

refreshSandbox(sandboxInfo, options?): Promise<SandboxProcessObject>
Refresh (update) a sandbox from a production org. 'this' needs to be a production org with sandbox licenses available
Parameters
- sandboxInfo: SandboxInfo
  SandboxInfo to update the sandbox with
- options: {
      async?: boolean;
      interval?: Duration;
      wait?: Duration;
  } = ...
  Wait: The amount of time to wait before timing out, Interval: The time interval between polling
  - Optional async?: boolean
  - Optional interval?: Duration
  - Optional wait?: Duration
Returns Promise<SandboxProcessObject>
- Defined in src/org/org.ts:271

remove

remove(throwWhenRemoveFails?): Promise<void>
Cleans up all org related artifacts including users, sandbox config (if a sandbox), source tracking files, and auth file.
Parameters
- throwWhenRemoveFails: boolean = false
  Determines if the call should throw an error or fail silently.
Returns Promise<void>
- Defined in src/org/org.ts:484

removeUsername

removeUsername(auth): Promise<Org>
Removes a username from the user config for this object. For convenience this object is returned.

Throws SfError{ name: 'MissingAuthInfoError' } Auth info is missing.
Parameters
- auth: string | AuthInfo
  The AuthInfo containing the username to remove.
Returns Promise<Org>
- Defined in src/org/org.ts:887

resumeSandbox

resumeSandbox(resumeSandboxRequest, options?): Promise<SandboxProcessObject>
Resume a sandbox create or refresh from a production org. this needs to be a production org with sandbox licenses available.
Parameters
- resumeSandboxRequest: ResumeSandboxRequest
  SandboxRequest options to create/refresh the sandbox with
- options: {
      async?: boolean;
      interval?: Duration;
      wait?: Duration;
  } = ...
  Wait: The amount of time to wait (default: 0 minutes) before timing out, Interval: The time interval (default: 30 seconds) between polling
  - Optional async?: boolean
  - Optional interval?: Duration
  - Optional wait?: Duration
Returns Promise<SandboxProcessObject>
- Defined in src/org/org.ts:345

retrieveMaxApiVersion

retrieveMaxApiVersion(): Promise<string>
Retrieves the highest api version that is supported by the target server instance. If the apiVersion configured for Sfdx is greater than the one returned in this call an api version mismatch occurs. In the case of the CLI that results in a warning.

Returns Promise<string>
- Defined in src/org/org.ts:933

retrieveOrganizationInformation

retrieveOrganizationInformation(): Promise<OrganizationInformation>
Retrieve a handful of fields from the Organization table in Salesforce. If this does not have the data you need, just use Connection.singleRecordQuery with SELECT <needed fields> FROM Organization.

Returns Promise<OrganizationInformation>
org information
- Defined in src/org/org.ts:750

sandboxStatus

sandboxStatus(sandboxname, options): Promise<SandboxProcessObject>
Reports sandbox org creation status. If the org is ready, authenticates to the org.
Parameters
- sandboxname: string
- options: {
  interval?: Duration;
  wait?: Duration;
  }
  Wait: The amount of time to wait before timing out, Interval: The time interval between polling
  - Optional interval?: Duration
  - Optional wait?: Duration
Returns Promise<SandboxProcessObject>
the sandbox process object
- Defined in src/org/org.ts:440

scratchOrgCreate

scratchOrgCreate(options): Promise<ScratchOrgCreateResult>
Creates a scratchOrg 'this' needs to be a valid dev-hub
Parameters
- options: ScratchOrgRequest
Returns Promise<ScratchOrgCreateResult>
- Defined in src/org/org.ts:429

setSandboxConfig

setSandboxConfig(orgId, config): Promise<Org>
set the sandbox config related to this given org
Parameters
- orgId: string
  {string} orgId of the sandbox
- config: SandboxFields
  {SandboxFields} config of the sandbox
Returns Promise<Org>
- Defined in src/org/org.ts:914

setTracksSource

setTracksSource(value): Promise<void>
Set the tracking property on the org's auth file
Parameters
- value: boolean
  true or false (whether the org should use source tracking or not)
Returns Promise<void>
- Defined in src/org/org.ts:703

supportsSourceTracking

supportsSourceTracking(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/org/org.ts:997

tracksSource

tracksSource(): Promise<boolean>
Returns true if the org uses source tracking. Side effect: updates files where the property doesn't currently exist

Returns Promise<boolean>
- Defined in src/org/org.ts:675

updateLocalInformation

updateLocalInformation(): Promise<undefined | Pick<AuthFields, NAME | NAMESPACE_PREFIX | INSTANCE_NAME | TRIAL_EXPIRATION_DATE | IS_SCRATCH | IS_SANDBOX>>
Some organization information is locally cached, such as if the org name or if it is a scratch org. This method populates/updates the filesystem from information retrieved from the org.

Returns Promise<undefined | Pick<AuthFields, NAME | NAMESPACE_PREFIX | INSTANCE_NAME | TRIAL_EXPIRATION_DATE | IS_SCRATCH | IS_SANDBOX>>
- Defined in src/org/org.ts:760

Class Org

Hierarchy

Index

Methods

Methods

addUsername

Parameters

Returns Promise<Org>

checkScratchOrg

Parameters

Returns Promise<Partial<AuthFields>>

cleanLocalOrgData

Parameters

Returns Promise<void>

cloneSandbox

Parameters

Optional interval?: Duration

Optional wait?: Duration

Returns Promise<SandboxProcessObject>

createSandbox

Parameters

Optional async?: boolean

Optional interval?: Duration

Optional wait?: Duration

Returns Promise<SandboxProcessObject>

delete

Returns Promise<void>

deleteFrom

Parameters

Returns Promise<void>

determineIfDevHubOrg

Parameters

Returns Promise<boolean>

determineIfSandbox

Returns Promise<boolean>

determineIfScratch

Returns Promise<boolean>

getConfigAggregator

Returns ConfigAggregator

getConnection

Parameters

Returns Connection<Schema>

getDevHubOrg

Returns Promise<undefined | Org>

getField

Type Parameters

Parameters

Returns T

getFields

Parameters

Returns JsonMap

getOrgId

Returns string

getSandboxConfig

Parameters

Returns Promise<Nullable<SandboxFields>>

getUsername

Returns undefined | string

isDevHubOrg

Returns boolean

isSandbox

Returns Promise<boolean>

isScratch

Returns boolean

querySandboxProcessById

Parameters

Returns Promise<SandboxProcessObject>

querySandboxProcessByOrgId

Parameters

Returns Promise<SandboxProcessObject>

querySandboxProcessBySandboxInfoId

Parameters

Returns Promise<SandboxProcessObject>

querySandboxProcessBySandboxName

Parameters

Returns Promise<SandboxProcessObject>

readUserAuthFiles

Returns Promise<AuthInfo[]>

refreshAuth

Returns Promise<void>

`Optional` interval?: Duration

`Optional` wait?: Duration

`Optional` async?: boolean

`Optional` interval?: Duration

`Optional` wait?: Duration

`Optional` async?: boolean

`Optional` interval?: Duration

`Optional` wait?: Duration

`Optional` async?: boolean

`Optional` interval?: Duration

`Optional` wait?: Duration

`Optional` interval?: Duration

`Optional` wait?: Duration