Complete the tenant's first-run setup
Work through the Get started checklist on your tenant's Dashboard until every step is done, so the checklist is retired for everyone in the tenant.
Who can do it
A tenant administrator, or a platform super administrator working inside the tenant on a customer-operated deployment. Anyone who can read the tenant's analytics, list its users, and read its exchanges (STANDARD tenant) or internal use cases (SIMPLE tenant) sees the checklist; only a person who also holds the permission to complete the first run records it as complete. Each step's action is offered only to a person who holds that action's own permission.
Before you start
- The checklist is not offered on a RapidAPI marketplace tenant.
- Nothing on the card is a setting: each step completes itself from what the server counts.
Steps
- Open Dashboard. While the tenant is not yet set up, Get started is the first card on the page.
- Complete the steps in order. A step's action is withheld until the step before it is done:
- Activate your first cryptographic exchange (STANDARD tenant): select New exchange and activate the exchange. A draft or ready exchange does not complete the step.
- Create your first key (SIMPLE tenant): select Generate key.
- Create your first internal use case (SIMPLE tenant): select New use case.
- Connect your application: select See how for the guide to getting a token and running a first operation. The step completes when the tenant records its first use of a key.
- Invite your team: select Invite and add a second person. An invitation not yet accepted counts.
- Return to Dashboard. Each visit reads the steps again, so a step done on another screen shows as done.
- When every step is done, the console records the first run as complete for your tenant. You do not select anything to do so.
To put the card away before then, select Hide. That applies only to you, in this browser; Get started in the Help menu reopens it while a step is still open.
What you see when it worked
The card is replaced by Needs attention, and a person who saw the checklist incomplete is shown a one-time bar: You're set up. Your application is running protected operations, and every one of them is signed. From then on the card is not shown to anyone in the tenant, including a person who joins later. Recording the completion creates no audit event: it only stops the card from being shown.
If it fails
| What you see | Cause | What to do |
|---|---|---|
| This tenant's setup could not be determined | A read the checklist depends on failed | Reload the Dashboard, or retry the read the card offers |
| A step's action is unavailable and names the permission it needs, for example You do not have permission to invite users. Ask a tenant administrator for it. | You lack the permission for that action | Ask a tenant administrator, or let one complete the step |
| Every step is done but the card is still shown to other people | Nobody holding the permission to complete the first run has opened the Dashboard since | A tenant administrator opens the Dashboard |
| No Get started card at all | The tenant is already set up, it is a marketplace tenant, or you lack one of the reads the checklist needs | Nothing to do; the Dashboard shows Needs attention instead |
Without the console
| Surface | How |
|---|---|
| API: read | GET /api/v3/admin/tenants/{tenantId}/first-run (operation getTenantFirstRun) answers completedAt, null until the first run is recorded |
| API: complete | POST /api/v3/admin/tenants/{tenantId}/first-run/complete (operation completeTenantFirstRun), no body. The server does not check the steps; repeating the call returns the first recorded completedAt |
Related
- Dashboard: what the screen shows and every decision you make on it.