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	시크릿 아이디 Get Secret List 또는 Get Secret Logs 참조 트리거를 실행한 애플리케이션에 자동 주입되며, 환경 변수로 확인 가능 시크릿 교체 액션 예제 코드 참조
`jobToken`	String	Required	작업 토큰 Get Secret Logs 참조 트리거를 실행한 애플리케이션에 자동 주입되며, 환경 변수로 확인 가능 시크릿 교체 액션 예제 코드 참조

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`length`	Integer	Required	랜덤 문자열 길이(자) 5~32 (기본값: 12)
`excludeCharacters`	String	Optional	제외 문자들 여러 개인 경우, 구분자 없이 하나의 문자열로 이어서 나열
`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"
}