search
apis

Postman Variables

When using Postman, you’ll often discover that you use the same information in multiple REST calls. With variables, you can reuse the same value in those REST calls. For Express, we’ve set up these variables in the following file from our public Postman Repository: Express Environment Variables.postman_environment.json.

These variables are listed in alphabetical order:

  • accessToken: Credentials used to access protected resources
  • amUrl: URL of the ForgeRock Access Manager deployment for your tenant
  • authId: A JSON Web Token (JWT) that uniquely identifies the authentication context; used as an access_token
  • authorizationCode: Used by confidential and public clients; may be exchanged for an access token
  • clientId: Unique identifier for an app
  • comparator: An operator that compares JSON values; for examples, see the section on Querying Users
  • defaultAppClientId: Client ID for an app
  • defaultAppScopes: Scopes for an app
  • defaultAppSecret: Client secret for an app
  • idToken: A JWT token that contains claims about the authentication of an end-user; for more information, see the section on Tokens.
  • loginUrl: The URL to redirect a user when signing into an app
  • logoutUrl: The URL to redirect a user when signing out of an app
  • m2mClientId: Client ID for an M2M (Service) app
  • m2mScopes: Scopes for an M2M (Service) app
  • m2mSecret: Client secret for an M2M (Service) app
  • natspaClientId: Client ID for a Native/Single Page app
  • m2mScopes: Scopes for a Native/Single Page app
  • oauth2Url: URL of the OAuth2 ForgeRock Access Manager deployment for your tenant
  • parameter: An variable for searches; for examples, see the section on Querying Users
  • refreshToken: Credential used to obtain an access token
  • sessionToken: Unique identifier after successful authentication; for ForgeRock, may also be known as an iPlanetDirectoryPro token
  • smtpHost: Hostname or IP address of an SMTP server
  • smtpPassword: Password for the account used to connect to the SMTP server
  • smtpPort: Port number of the SMTP server
  • smtpUsername: Username for the account used to connect to the SMTP server
  • teamMemberName: Username of an administrator of your tenant
  • teamMemberPassword: Password of an administrator of your tenant
  • tenantApiV1Url: URL for your tenant; versioned
  • tenantName: Name of your tenant
  • userId: User ID of a regular user of your tenant
  • userName: Username of a regular user of your tenant
  • userPassword: Password of a regular user of your tenant
  • userProperty: An variable for user searches; for examples, see the section on Querying Users
  • value: A search term for identifying users; for examples, see the section on Querying Users
  • webAppClientId: Client ID for a Web app
  • webAppClientSecret: Client Secret for a Web app
  • webClientId: Client ID for a Web app
  • webScopes: Scopes for a web app
  • webSecret: Client secret for a web app

For questions or feedback, contact us.