K-OTP

템플릿 목록

GET /v1/templates

GET https://api.k-otp.dev/v1/templates

개요

Returns the whitelisted message templates that POST /issue accepts via templateId, plus the default template id used when templateId is omitted. The list is small and not paginated. Every template body contains the #{code} placeholder; new templates are registered operationally, not through the API.

Requires an sk_ secret key; pk_ public keys are rejected with 403.

인증

허용 키필요 scope대체 허용 scope
sk_otp:templatesotp:read, *

응답 (200)

All available templates.

필드타입필수설명
defaultTemplateIdstring예Template used when POST /v1/issue omits templateId.
templatesobject[]예
notestring예Human-readable policy note.

오류 응답

모든 오류는 { defined, code, status, message, data? } 형태입니다. 자세한 내용은 오류를 참고하세요.

상태code설명
400BAD_REQUESTthe request failed input validation. message describes the first failing constraint.
401UNAUTHORIZEDthe Authorization: Bearer credential is missing, malformed, inactive, or rejected by introspection.
403FORBIDDENthe credential lacks otp:templates (or an accepted alias), or a pk_ public key was used. Public keys are limited to issue/verify.
409CONFLICTthe request conflicts with the current state of the resource.
500INTERNAL_SERVER_ERRORunexpected server failure. Undefined errors (defined: false) use the same envelope.
503SERVICE_UNAVAILABLEcredential introspection or a downstream dependency is temporarily unavailable. Retry with backoff.

요청 예시

curl "https://api.k-otp.dev/v1/templates" \
  -H "Authorization: Bearer $KOTP_SECRET_KEY"

이 페이지의 내용