MENU
      Generate Random Secret

        Generate Random Secret


        Article summary

        Overview

        Generate a random string that can be used as a confidential value. (Consists of English letters, numbers, and special characters)
        You can add conditions to the randomization.

        POST https://secretmanager.apigw.ntruss.com/action/v1/secrets/{secretId}/jobs/{jobToken}/generate-random-secret
        HTTP

        Request

        Request parameter

        Parameter nameTypeDescription
        secretIdStringSecret ID (automatically injected via trigger, can be obtained as an environment variable: Replace secret action example code)
        jobTokenStringJob action token (automatically injected via trigger, can be obtained as an environment variable: Replace secret action example code)

        Request body

        {
          "length": 32,
          "excludeCharacters": "string",
          "excludeNumbers": true,
          "excludePunctuation": true,
          "excludeUppercase": true,
          "excludeLowercase": true,
          "includeSpace": true,
          "requireEachIncludedType": true
        }
        JSON
        Parameter nameTypeDescription
        lengthIntegerRandom string length (up to 32 characters)
        excludeCharactersStringCharacters to exclude
        excludeNumbersBooleanWhether to exclude numbers
        excludePunctuationBooleanWhether to exclude special characters
        excludeUppercaseBooleanWhether to exclude uppercase letters
        excludeLowercaseBooleanWhether to exclude lowercase letters
        includeSpaceBooleanWhether to include spaces
        requireEachIncludedTypeBooleanWhether to require a type that includes each of them

        Response

        Response body

        {
          "code": "SUCCESS",
          "data": {
            "randomString": "string"
          }
        }
        JSON
        Parameter nameTypeDescription
        randomStringStringRandom string

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.