Entity Identifier Reference

Updated 8 months ago by Michael Cretzman

Many Harness entities and resources include a unique Id (entity Identifier) that's immutable once the entity is created.

Identifiers provide a permanent way to refer to an entity, and avoid issues that can arise when a name is changed.

In this topic:

Identifier Limits and Requirements

Identifiers have naming and usage limitations that you should be aware of.

Identifier Creation

When you name an entity, Harness automatically generates its identifier.

You can edit the Identifier when you are creating the entity, but not after the entity is saved.

If you rename the entity, the Identifier remains the same.

The generated Identifier is based on the entity name and meets the identifier naming restrictions.

If an entity name cannot be used because it's already occupied by another entity, Harness automatically adds a prefix in the form of -1, -2, etc.

Identifier Restrictions

Identifiers have the following restrictions:

  • Identifiers must start with a-z, A-Z, _ or . Identifiers can then be followed by 0-9, a-z, A-Z, _ or $.
  • Identifiers shouldn't be any of the following words
    • or
    • and
    • eq
    • ne
    • lt
    • gt
    • le
    • ge
    • div
    • mod
    • not
    • null
    • true
    • false
    • new
    • var
    • return
    • step
    • parallel
    • stepGroup
    • org
    • account

  • Identifiers aren't case-sensitive. For example, the Identifiers myIdentifier and myidentifier are the same.

Identifier Uniqueness

Identifiers are unique for the scope in which they are created.

When you name an entity or a resource and Harness automatically generates an Identifier, the Identifier will be unique.

If you want to edit the Identifier before you save the new entity or resource, you should know the following restrictions:

  • There cannot be 2 or more Organizations with the same Identifier within the Account.
  • There cannot be 2 or more Projects with the same Identifier within the Organization.
  • There cannot be 2 or more Pipelines with the same Identifier within the Project.
  • There cannot be 2 or more Stages with the same Identifier within the Pipeline.
  • There cannot be 2 or more steps with the same Identifier within the Stage.

If you edit an identifier so that it is not unique or invalid, Harness will alert you.

Identifier Reuse

Identifiers cannot be reused within the same scope, even if one entity was deleted.

Identifier Examples

Here's a secret with its Identifier in both the Visual and YAML editors.

YAML Editor:

type: SecretText
name: doc-example-account
identifier: docexampleaccount
tags: {}
description: ""
secretManagerIdentifier: harnessSecretManager
valueType: Inline

Identifier Deletion

Deleting an entity has the following impact on its Identifier:

  • The entity is archived for 6 months. This is the default retention policy. You can ask Harness to extend the retention policy.
  • During the archival period, the Identifier cannot be reused by the same entity in the same scope. If you try to use it, Harness will notify you that the Identifier is already used by an archived entity.
  • After the archival period, the Identifier is available.

Please Provide Feedback