create-session - Unkey Docs

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#

--portalstringrequired#

Portal configuration ID or slug.

--external-idstringrequired#

The end user's identifier in your system.

--scopesstring[]required#

Capabilities: keys:read, keys:create, keys:reroll, and analytics:read.

--previewbool#

Create a preview session for testing.

Default: "false"

--return-urlstring#

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