Skip to main content

Generate Random String

Overview​

Use the generate random string transform as an out-of-the-box rule transform provided through SailPoint's Cloud Services Utility rule. The transform allows you to generate a random string of any length, using true/false flags to denote whether the string includes numbers and/or special characters.

Other Considerations
  • The generate random string transform shares some common features with two other transforms: random numeric and random alphanumeric. In most cases, either of these other two out-of-the-box transforms are recommended. However, the one advantage of the generate random string transform is its support for special characters, so a common use for this transform is generating random passwords that meet basic complexity requirements.

Transform structure​

The structure of a generate random string transform requires the name of the referenced rule to be the "Cloud Services Deployment Utility" rule built by SailPoint. You must also must set operation to generateRandomString, provide a length, and provide the true/false attributes for includeNumbers and includeSpecialChars. Last, you must include the type and name attributes required for all transforms:

{
  "attributes": {
    "name": "Cloud Services Deployment Utility",
    "operation": "generateRandomString",
    "includeNumbers": "true",
    "includeSpecialChars": "true",
    "length": "16"
  },
  "type": "rule",
  "name": "Generate Random String Transform"
}

Top-level properties (required)​

  • type string (required)
    Must be set to rule.

  • name string (required)
    The name of the transform as it will appear in the UI's dropdown menus.

  • requiresPeriodicRefresh boolean (optional)
    Whether the transform logic should be reevaluated every evening as part of the identity refresh process. Default is false.

Attributes​

The generate random string transform uses the following structure:

{
  "type": "rule",
  "name": "Transform Name",
  "attributes": {
    "name": "Cloud Services Deployment Utility",
    "operation": "generateRandomString",
    "includeNumbers": "true",
    "includeSpecialChars": "true",
    "length": "16"
  }
}

attributes (required)​

The attributes object contains the rule configuration.

Required​

  • name string (required)
    Must be set to Cloud Services Deployment Utility.

  • operation string (required)
    Must be set to generateRandomString.

  • includeNumbers string (required)
    Set to "true" or "false" to indicate whether the generator includes numbers.

  • includeSpecialChars string (required)
    Set to "true" or "false" to indicate whether the generator includes special characters (!, @, #, $, %, &, *, (, ), +, <, >, ?).

  • length string (required)
    The required length of the randomly generated string. Maximum allowable value is 450 characters.

Examples​

This transform generates a 16-character random string containing letters, numbers and special characters.

Transform request body:

{
  "attributes": {
    "name": "Cloud Services Deployment Utility",
    "operation": "generateRandomString",
    "includeNumbers": "true",
    "includeSpecialChars": "true",
    "length": "16"
  },
  "type": "rule",
  "name": "Generate Random String Transform"
}

 

This transform generates an 8-character random string containing only letters and numbers.

Transform request body:

{
  "attributes": {
    "name": "Cloud Services Deployment Utility",
    "operation": "generateRandomString",
    "includeNumbers": "true",
    "includeSpecialChars": "false",
    "length": "8"
  },
  "type": "rule",
  "name": "Generate Random String Transform"
}