Skip to main content
POST
/
api
/
user
/
psk
Create a new PSK for the current user
curl --request POST \
  --url https://api.example.com/api/user/psk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "psk": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "message": "<string>",
  "description": "<string>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request model for creating a user PSK.

description
string | null

Optional description for the PSK.

Response

PSK created successfully.

Response model for PSK creation/regeneration (includes the raw PSK).

id
string<uuid>
required

Unique ID of the user PSK.

psk
string
required

The raw pre-shared key. Store this securely - it cannot be retrieved again.

created_at
string<date-time>
required

Timestamp when the PSK was created.

message
string
required

Important information about the PSK.

description
string | null

Optional description for the PSK.