create-session

Create an exchange code valid for 15 minutes and exchangeable exactly once for a 24-hour portal access token. Redirect the end user to the returned URL.

Usage

unkey api portal create-session [flags]

Flags

string

required

Portal configuration ID or slug.

string

required

The end user’s identifier in your system.

string[]

required

Capabilities: keys:read and keys:reroll. Rerolling is reached from the keys page, so keys:reroll requires keys:read in the same session.

bool

default:"false"

Create a preview session for testing.

string

Absolute URL to return the end user to when they leave the portal.

Global Flags

Flag	Type	Description
`--root-key`	string	Override root key (`$UNKEY_ROOT_KEY`)
`--api-url`	string	Override API base URL (default: `https://api.unkey.com`)
`--config`	string	Path to config file (default: `~/.unkey/config.toml`)
`--output`	string	Output format, use `json` for raw JSON
`--body`	string	Send this JSON string as the request body. You cannot combine it with request-building flags.

Examples

unkey api portal create-session --portal=my-portal --external-id=user_123 \
  --scopes=keys:read,keys:reroll \
  --return-url=https://app.example.com/settings/api-keys

Getting Started

Platform

Build & Deploy

Networking

Observability

CLI

Security

Keyspaces

AI Code Gen

Audit Logs

Log Drains

CLI

Errors

Usage

Flags

Global Flags

Examples

​Usage

​Flags

​Global Flags

​Examples

Usage

Flags

Global Flags

Examples