auth.v1.MFAService

ClaimFreshStepUp

Claim a fresh step-up proof for one protected request.

Method

POST

Path

auth.v1.MFAService/ClaimFreshStepUp

Service

auth.v1.MFAService

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

POST

auth.v1.MFAService/ClaimFreshStepUp

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/auth.v1.MFAService/ClaimFreshStepUp' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "actionType": "api_key:create",
  "requestId": "request_01J0EXAMPLE",
  "subject": "api_key:ak_1a3c6de8153d5a5b04cd2a6529779542"
}'

Responses

{
  "claimExpiresAt": "2025-01-01T00:00:00Z",
  "claimNonce": "mfa_55555555555555555555555555555555",
  "stepUpId": "mfa_44444444444444444444444444444444"
}

Request

auth.v1.ClaimFreshStepUpRequest

Response

auth.v1.ClaimFreshStepUpResponse

requestId string 1-128 chars

Client-generated request identifier for the protected request. Maximum 128 characters.

actionType string 1-64 chars /^[a-z0-9._:-]+$/

Product action being protected, such as a withdrawal or security setting change. Maximum 64 characters.

subject string 1-128 chars

Product subject for the protected action, such as the target account, destination, or resource identifier. Maximum 128 characters.

stepUpId string 1-64 chars /^mfa_[…]{32}$/

Fresh step-up proof identifier. Format: "mfa_" followed by 32 lowercase hex characters.

claimNonce string 1-64 chars /^mfa_[…]{32}$/

One-time nonce that must be echoed when consuming or releasing the claim.

claimExpiresAt string (date-time)

Time when this claim expires if it is not consumed or released.

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.