Generate Random Secret

VPC環境で利用できます。

シークレット値として使用可能なランダム文字列を作成します。ランダム文字列は、英数字、記号、スペースを含めるかどうかなどの条件を追加して作成でき、作成後は、 Update Pending Stageで Pendingステージのシークレット値として指定できます。シークレットローテーション対象の値を自動的に埋めて Pendingステージとして登録する方法の詳細は、Add Pending Stageをご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/action/v1/secrets/{secretId}/jobs/{jobToken}/generate-random-secret

リクエストヘッダ

Secret Manager APIで共通して使用されるヘッダの詳細は、Secret Managerのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`secretId`	String	Required	シークレット ID Get Secret ListまたはGet Secret Logsを参照トリガーを実行したアプリケーションに自動的に注入され、環境変数で確認可能 {target="_blank"}
`jobToken`	String	Required	ジョブトークン Get Secret Logsを参照トリガーを実行したアプリケーションに自動的に注入され、環境変数で確認可能シークレットローテーションアクションのサンプルコード

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`length`	Integer	Required	ランダム文字列の長さ 5~32(デフォルト: 12)
`excludeCharacters`	String	Optional	除外文字複数の場合は、区切り文字なしで1つの文字列で並べる
`excludeNumbers`	Boolean	Optional	数字を除外するか `true` \| `false` (デフォルト) `true`: 除外 `false`: 除外しない
`excludePunctuation`	Boolean	Optional	記号を除外するか `true` \| `false` (デフォルト) `true`: 除外 `false`: 除外しない
`excludeUppercase`	Boolean	Optional	大文字を除外するか `true` \| `false` (デフォルト) `true`: 除外 `false`: 除外しない
`excludeLowercase`	Boolean	Optional	小文字を除外するか `true` \| `false` (デフォルト) `true`: 除外 `false`: 除外しない
`includeSpace`	Boolean	Optional	スペースを含めるか `true` (デフォルト) \| `false` `true`: 含める `false`: 含めない
`requireEachIncludedType`	Boolean	Optional	除外しない文字タイプ(大文字、小文字、数字、記号、スペース)をすべてを含めるか `true` (デフォルト) \| `false` `true`: すべてを含める `false`: すべて含めない

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://secretmanager.apigw.ntruss.com/action/v1/secrets/{secretId}/jobs/{jobToken}/generate-random-secret' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "length": 5,
    "excludeCharacters": "",
    "excludeNumbers": false,
    "excludePunctuation": false,
    "excludeUppercase": false,
    "excludeLowercase": false,
    "includeSpace": false,
    "requireEachIncludedType": true
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`randomString`	String	-	ランダム文字列

レスポンスステータスコード

Secret Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Secret Managerのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "randomString": "2!?xY"
}