younifyd
Menu

Retrieve Pwd Action Template

Retrieve/get a password action template.

GET/tenants/{tenantId}/clients/{clientId}/password-action-templates

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Retrieve Pwd Action Template action (under Auth Admin).
  3. Fill in the fields below, then reference the result from later steps as {{retrievePwdActionTemplate.response.data}}.

Request

Path parameters

clientIdstringrequired
tenantIdstringrequired

Query parameters

channelIdstringrequired
actionTypestringrequired

Describes the type of action that the password action template will be used for. Here are the actions that each enumerated string refers to: - `PWDLESS_LOGIN`: Passwordless login - `PWD_RESET_ACTION`: Password reset - `PWD_RESET_CROSS_DEVICE_ACTION`: Password reset for cross-device flow

One ofPWDLESS_LOGINPWD_RESET_ACTIONPWD_RESET_CROSS_DEVICE_ACTION

templateTypestringrequired

One ofEMAILSMS

Response

Returns 200 with an object. Read it in later steps with {{retrievePwdActionTemplate.response.data.<field>}}.

channelIdstring
namestring
subjectstring
linkstring
localestring

Identifies the locale of the template. Must be one of the [language tag strings supported by JDK 11](https://www.oracle.com/java/technologies/javase/jdk11-suported-locales.html). The string is stored in all lowercase.

actionTypestring

Describes the type of action that the password action template will be used for. Here are the actions that each enumerated string refers to: - `PWDLESS_LOGIN`: Passwordless login - `PWD_RESET_ACTION`: Password reset - `PWD_RESET_CROSS_DEVICE_ACTION`: Password reset for cross-device flow - `WEBAUTHN_AUTHORIZE_USER`: WebAuthn authorize user

One ofPWDLESS_LOGINPWD_RESET_ACTIONPWD_RESET_CROSS_DEVICE_ACTIONWEBAUTHN_AUTHORIZE_USER

templateTypestring

Identifies the type of mode that the password action template will be used for.

One ofSMSEMAIL

templatestring
json
{
  "channelId": "SiteGenesis",
  "name": "Password Action Email Template",
  "subject": "Password Action Token Request",
  "link": "This is your password action token: ${token}",
  "locale": "en-us",
  "actionType": "PWDLESS_LOGIN",
  "templateType": "EMAIL",
  "template": "Passwordless Login Token Request\nYou're receiving this because you requested a passwordless login token for your account. ${link}"
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.