auth.v1.MFAService

ReleaseFreshStepUp

Release a claimed fresh step-up proof when the protected request does not complete.

Method

POST

Path

auth.v1.MFAService/ReleaseFreshStepUp

Service

auth.v1.MFAService

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

POST

auth.v1.MFAService/ReleaseFreshStepUp

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/auth.v1.MFAService/ReleaseFreshStepUp' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "actionType": "api_key:create",
  "claimNonce": "mfa_55555555555555555555555555555555",
  "reason": "The protected action was cancelled.",
  "requestId": "request_01J0EXAMPLE",
  "stepUpId": "mfa_44444444444444444444444444444444",
  "subject": "api_key:ak_1a3c6de8153d5a5b04cd2a6529779542"
}'

Responses

{}

Request

auth.v1.ReleaseFreshStepUpRequest

Response

auth.v1.ReleaseFreshStepUpResponse

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

Fresh step-up proof identifier returned by ClaimFreshStepUp.

requestId string 1-128 chars

Client-generated request identifier used when the proof was claimed.

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

Product action type used when the proof was claimed.

subject string 1-128 chars

Product subject used when the proof was claimed.

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

One-time nonce returned by ClaimFreshStepUp.

reason string max 128 chars

Optional product-facing reason for releasing the claim. Maximum 128 characters.

No response fields documented for this type.

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.