Confirm a just-issued hosted gateway key was received (the key itself)

Called with the key the token endpoint returned, as Bearer, before confirm_by. The key then no longer expires, and in the same transaction the tenant's earlier keys it replaces are revoked (revoked_key_ids). Idempotent: a second call revokes nothing more. A key no sign-on issued answers 404 HOSTED_GATEWAY_KEY_NOT_FOUND. A key that is revoked (superseded, disconnected, revoked by itself) or past confirm_by is refused by the org-key authentication before this route runs: 401 UNAUTHORIZED ("Invalid API key"). The 409s HOSTED_GATEWAY_KEY_RETIRED and HOSTED_GATEWAY_KEY_INACTIVE answer only a race with a concurrent retirement.

post/v1/hosted-gateway/keys/confirm

Request

  • Base URL: https://api.decionis.com
  • URL: https://api.decionis.com/v1/hosted-gateway/keys/confirm
  • Auth: HTTP bearer

Request body

object required

Response

Delivery confirmed

key_idstring uuid required
org_idstring uuid required
tenant_labelstring required
delivered_atstring date-time required
expires_atunknown required
already_confirmedboolean required
revoked_key_idsstring[] required

The tenant's earlier keys this confirmation revoked (the token answer's replaced_key_ids still live); empty when already confirmed.

Changes

No recorded changes to this operation across all 1 revision of this API.