Docs API schemas

neoserver 0.1.2

APIKeyWithSecret

APIKeyWithSecret schema for the neoserver management API.

← All schemas

all of
key string

Full API key - only returned on creation

Must match all schemas

Schema 1

object
created_at string · date-time required
expires_at string · date-time
id string required
key_prefix string required
name string required
owner_email string
owner_name string
revoked boolean required
role_id string required
workspace_id string
OpenAPI schema definition
{
  "allOf": [
    {
      "properties": {
        "created_at": {
          "format": "date-time",
          "type": "string"
        },
        "expires_at": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "key_prefix": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "owner_email": {
          "type": "string"
        },
        "owner_name": {
          "type": "string"
        },
        "revoked": {
          "type": "boolean"
        },
        "role_id": {
          "type": "string"
        },
        "workspace_id": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "key_prefix",
        "role_id",
        "name",
        "revoked",
        "created_at"
      ],
      "type": "object"
    }
  ],
  "properties": {
    "key": {
      "description": "Full API key - only returned on creation",
      "type": "string"
    }
  },
  "type": "object"
}

Search documentation

Type to search guides and reference pages.