Template Variables

Last updated: May 29, 2025

Introduction

YeshID provides access to the Account and User objects for use in certain parts of the app (i.e. Custom Actions, or Email Tasks). This is the full list

Commonly Used Variables

From our experiences with customers, these are the most commonly used variables for most API integrations:

  • {{.User.Email}} - The user's employee email address

  • {{.Account.ExternalID}} - The user's ID within an application

If performing actions on external applications (i.e. on a DELETE endpoint, you will probably need to use {{.Account.ExternalID}}

i.e. DELETE https://mycoolapp.com/api/user/{{.Account.ExternalID}}

User Object

The User Object describes a Person within YeshID that is usually used in the context of an action (i.e. Onboarding / Offboarding / Access Request)

Variable

Type

Description

Remarks / Values

.User.ID

String

Unique ID within YeshID

.User.OrgID

String

Unique OrgID within YeshID

.User.Name

String

First Name

.User.LastName

String

Last Name

.User.FullName

String

First Name and Last Name

.User.Email

String

YeshID Email address (a.k.a employee email address)

.User.CreatedAt

String

User's creation time in RFC-3339 format

Example 2024-01-23T19:53:20.253714Z

.User.UpdatedAt

String

User's last updated time in YeshID in RFC-3339 format

Example 2024-01-23T19:53:20.253714Z

.User.Type

String

Whether the user is a YeshID admin or not.

  • USER

  • ADMIN

.User.RecoveryEmail

String

Personal email address provided for onboarding

.User.Status

Strings

User's account status within YeshID

  • ACTIVE

  • SUSPENDED

  • DEACTIVATED

.User.Roles

TBD

TBD

TBD

.User.CustomFields

Not implemented yet

TBD

.User.External

Boolean

Indicates whether a user is an external user or not (i.e. contractor)

  • TRUE

  • FALSE

Account Object

The Account Object represents the user's account within the application.

Variable

Type

Description

Remarks / Values

.Account.Id

String

User's ID within YeshID application

.Account.OrgId

String

User's OrgID within an application

.Account.OrgApplicationID

String

The unique ID of the application

.Account.ExternalID

String

The user's ID in the application

.Account.userID

String

The YeshID user ID (the same as the .User.Id if they are mapped)

.Account.AccountType (changing soon)

String

User's role within the application

  • USER

  • ADMIN

.Account.ProvisioningStatus

String

User's current provisioning status within the application (In YeshID's POV)

  • TO_BE_PROVISIONED

  • TO_BE_DEPROVISIONED

  • ACTIVE

  • DEACTIVATED

.Account.LastAccessGivenAt

String

When the user was last provided access (via Access Grid or Task) in RFC-3339 format

Example 2024-01-23T19:53:20.253714Z

.Account.LastAccessRemovedAt

String

When the user was last removed access (via Access Grid or Task) in RFC-3339 format

Example 2024-01-23T19:53:20.253714Z

.Account.License (If supported by application)

String

Whatever license is specified within the application

.Account.LoginType (If supported by application)

String

  • PASSWORD

  • MFA

  • SSO

FAQ