Tokens on Layer5 Documentation

Create and Use an API Token

Mon, 01 Jan 0001 00:00:00 +0000

An API token lets a script, a CI job, or a Meshery client act as your user account against Layer5 Cloud. This guide creates one, uses it, rotates it, and revokes it. For what a token can reach and why it never expires, read the Tokens concept.

Before you start 🔗

You need the Create Token permission to create a token in the interface. Organization Admin and Provider Admin hold it by default. A user without it sees the create control disabled.
You need View Tokens to open the Tokens tab. Every default user role holds it.
Decide which consumer gets this token. Create one token per consumer so you can revoke one without breaking the others.

Create a token 🔗

Open the Tokens tab under Security and start a new token. Enter a name and a purpose. Both are labels that appear in the token list: name the consumer (“ci-snapshots”), and state what it does in the purpose.

Security Reference

Mon, 01 Jan 0001 00:00:00 +0000

This page states how keys, keychains, tokens, and sessions behave, exactly, as of Layer5 Cloud v1.0.278. For the model, read the Keys, Keychains, Sessions, and Tokens concepts. For tasks, use the security guides. For base URL, authentication, and the organization header, see the Cloud API. All paths below sit under /api unless noted.

Permission keys 🔗

Provider Admin holds every key. The table lists the default holders of the other roles. “Interface” means the control or tab is disabled or replaced by a permission error screen. “Server” means the Layer5 Cloud server refuses the request with HTTP 403.

Security

Mon, 01 Jan 0001 00:00:00 +0000

These guides cover the security tasks in Layer5 Cloud. For how keys, keychains, and roles combine into permissions, read the Keys and Keychains concepts. For defaults, lifetimes, and endpoints in one place, see the Security Reference.

I want to	Go to	Permission needed
Authenticate a script or CI job to Layer5 Cloud	Create and Use an API Token	Create Token, Download Token
Stop a leaked or retired token from working	Revoke an API Token	Delete Token
Rotate a token without breaking a pipeline	Rotate a token	Create Token, Delete Token
See where I am signed in and end a session	Review and Sign Out Sessions	View Sessions, Delete Token
Group keys into a custom keychain	Build a Custom Keychain	Create Keychain, Edit Keychain, Delete Keychain