Sign in

v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Keys

Create Key

post/console/v1/keys

Request body

descriptionstring required
type'SERVER' | 'CLIENT' | 'CONSOLE' | 'SCIM' | 'ORG' required
scopesstring[]
environmentsstring[]
targetAppIDstring
secondaryTargetAppIDsstring[]

Response

Key created successfully

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Key created successfully.",
  "data": {
    "key": "secret-123",
    "type": "SERVER",
    "description": "Server secret key",
    "scopes": [],
    "environments": [
      "production"
    ],
    "primaryTargetApp": "primaryApp",
    "secondaryTargetApps": [
      "secondaryApp"
    ],
    "status": "active"
  }
}