Skip to content

Suspend, resume or close an exchange context

Stop every exchange and grant in one business scenario at once, bring them back, or end the scenario for good. Suspending is reversible; closing is not.

Who can do it

A tenant administrator or a tenant key manager. Suspending, reactivating and closing are three separate permissions, and the console shows each button only to a person who holds its permission. Both roles hold all three.

Before you start

  • Decide which you need. Suspend when the scenario will resume: every grant in the context is refused until you reactivate it, and nothing is revoked. Close when the scenario has ended: every exchange in the context that has not ended is revoked and every grant in force is retired, whatever owns it.
  • Prepare a reason. Suspending and closing both require one, and it is recorded in the audit trail against your account.
  • A context that an internal use case owns ends only when that use case is revoked. Its Owner on the Info tab names the use case.

Steps

  1. Open Exchange Contexts from the tenant's navigation and select the context's row.
  2. Open the Lifecycle tab.
  3. To suspend an active context:
    1. Select Suspend.
    2. Under Reason for suspension, say why.
    3. Select Suspend in the confirmation.
  4. To reactivate a suspended context, select Reactivate, then Reactivate again in the confirmation.
  5. To close a context:
    1. Select Close (terminal).
    2. Read What closing ends: the exchanges that will be revoked and how many grants in force will be retired.
    3. Type the context's name to confirm.
    4. Under Reason for closing, say why.
    5. Select Close (terminal).

What you see when it worked

The console confirms with "<name>" suspended, "<name>" reactivated or "<name>" closed (terminal — irreversible), and the context's status in the list changes to SUSPENDED, ACTIVE or CLOSED. The transition is recorded in the context's Activity tab.

A suspended context's grants authorize nothing until it is reactivated; they authorize again, unchanged, once it is. A closed context can never be reactivated. Its exchanges, grants and history stay readable, and the Lifecycle tab then says This context is closed. Lifecycle transitions are no longer available.

If it fails

What you see Cause What to do
The confirm button stays unavailable The reason is empty, or the typed name does not match Give a reason, and type the name exactly as shown
This exchange context belongs to internal crypto use case <id>, and only that use case can use or change it. Choose another context. An internal use case owns the context Revoke the internal use case to end the context
Suspend is not offered The context is not active, or you lack the permission to suspend it Check the context's status, or ask a tenant administrator
Reactivate is not offered The context is not suspended, or you lack the permission to reactivate it A closed context cannot be reactivated; create a new one

Without the console

Surface How
Key management CLI ankasecure-km exchange-contexts suspend --id <uuid> --reason <text>; exchange-contexts resume --id <uuid>; exchange-contexts close --id <uuid> --reason <text>
Admin SDK ExchangeContextOperations.suspend(UUID, SuspendExchangeContextRequest), ExchangeContextOperations.resume(UUID), ExchangeContextOperations.close(UUID, CloseExchangeContextRequest)
API POST /api/v3/admin/tenants/{tenantId}/exchange-contexts/{contextId}/suspend (operation suspendExchangeContext); POST /api/v3/admin/tenants/{tenantId}/exchange-contexts/{contextId}/resume (operation resumeExchangeContext); POST /api/v3/admin/tenants/{tenantId}/exchange-contexts/{contextId}/close (operation closeExchangeContext)