Neon · Schema

Role

A Postgres role within a branch

DatabasesServerlessPostgresInfrastructureAuthenticationEdge

Properties

Name	Type	Description
branch_id	string	The branch ID this role belongs to
name	string	The role name
password	string	The role password. Only returned when creating a role or resetting a password.
protected	boolean	Whether this is a protected system role
created_at	string	Role creation timestamp
updated_at	string	Last update timestamp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Role",
  "title": "Role",
  "type": "object",
  "description": "A Postgres role within a branch",
  "properties": {
    "branch_id": {
      "type": "string",
      "description": "The branch ID this role belongs to"
    },
    "name": {
      "type": "string",
      "description": "The role name"
    },
    "password": {
      "type": "string",
      "description": "The role password. Only returned when creating a role or resetting a password."
    },
    "protected": {
      "type": "boolean",
      "description": "Whether this is a protected system role"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Role creation timestamp"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last update timestamp"
    }
  }
}