Skip to content

Create an exchange context

Create the business frame that cryptographic exchanges with third parties operate in: its purpose, how sensitive its data is and, when one applies, its regulatory regime. Every exchange and every capability grant belongs to exactly one context. This page also covers changing a context's details and deleting a context that has been closed.

Who can do it

A tenant administrator or a tenant key manager. The console offers New exchange context only to a person who holds the permission to create exchange contexts. Changing a context needs the permission to update it, and deleting a closed context needs the permission to delete it; both roles hold all three.

The screen is for STANDARD tenants. A SIMPLE tenant does not see it and the platform refuses to create a context there: its contexts are created by its internal use cases. On a RAPIDAPI tenant the platform creates the contexts, and the console does not offer to create one.

Before you start

  • Choose a name. It must be lowercase letters, digits and hyphens, starting and ending with a letter or digit, for example embossing-visa. It is unique among the tenant's live contexts and cannot be changed later.
  • Decide how sensitive the data exchanged under the context is. Sensitivity is a label for the people reading the console; no algorithm, policy or authorization decision reads it.

Steps

  1. Open Exchange Contexts from the tenant's navigation.
  2. Select New exchange context.
  3. Fill in the dialog:
    1. The name (marked as the slug). It is required.
    2. Sensitivity: Low, Medium, High or Critical. The default is Medium.
    3. Regulatory regime (optional), for example PCI DSS. At most 120 characters.
    4. Display Name (optional): a readable name, for example Card Embossing — VISA.
    5. Business Purpose (optional): why the exchanges in this context exist.
  4. Select Create.

To change a context later, select its row, open the Edit tab, change the display name, description, business purpose, sensitivity or regulatory regime, and select Save changes. Clearing the regulatory regime removes it. The name never changes.

To delete a context, close it first (see the related task). Then select its row, open the Lifecycle tab, select Delete (permanent), type the context's name to confirm, and select Delete.

What you see when it worked

The console shows Exchange Context "<name>" created, and the context appears in the list as ACTIVE: it is active as soon as it is created. Selecting its row opens the Info tab, which shows the context's identifier, its fields and its Owner, This tenant.

The context can now be chosen in the Exchange Context step of the exchange editor, and capability grants can be placed in it. After an edit the console shows Exchange context updated; after a delete, "<name>" deleted, and the context leaves the list.

If it fails

What you see Cause What to do
The name is refused as invalid It is blank, or it is not a lowercase slug of letters, digits and hyphens Correct the name
The name is refused as already in use A live context of the tenant already carries that name Choose another name
At most 120 characters. under the regulatory regime The regime is longer than 120 characters Shorten it
Create stays unavailable The name is empty, or a field is over its size limit (the counter under the field shows it) Fill in the name, or shorten the field
Exchange Context cannot be deleted while it still has dependents: … Active capability grants or exchanges still reference the context; the message counts them Revoke the dependents it names, then retry

Without the console

Surface How
Key management CLI ankasecure-km exchange-contexts create --body-file <file>; exchange-contexts update --id <uuid> --body-file <file>; exchange-contexts delete --id <uuid>
Admin SDK ExchangeContextOperations.create(CreateExchangeContextRequest), ExchangeContextOperations.update(UUID, UpdateExchangeContextRequest), ExchangeContextOperations.delete(UUID)
API POST /api/v3/admin/tenants/{tenantId}/exchange-contexts (operation createExchangeContext); PATCH /api/v3/admin/tenants/{tenantId}/exchange-contexts/{contextId} (operation updateExchangeContext); DELETE /api/v3/admin/tenants/{tenantId}/exchange-contexts/{contextId} (operation deleteExchangeContext)