List roles | Neon Docs

GET/projects/{project_id}/branches/{branch_id}/rolesList roles

Retrieves a list of Postgres roles from the specified branch. For related information, see Manage roles.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The branch ID

pattern ^[a-z0-9-]{1,60}$

Responses

objectRolesResponse

rolesarray of objectrequired

Roles belonging to the branch. Each role includes fields such as `branch_id`, `name`, `protected`, `created_at`, and `updated_at`.

Show child attributes

Show array items

authentication_methodstring

Authentication method configured for this role: `password`, `oauth`, or `no_login`.

branch_idstringrequired

The ID of the branch this role belongs to.

pattern ^[a-z0-9-]{1,60}$

created_atstring · date-timerequired

A timestamp indicating when the role was created

namestringrequired

Postgres role name within the branch.

passwordstring

The role password

protectedboolean

Whether or not the role is system-protected

updated_atstring · date-timerequired

A timestamp indicating when the role was last updated

Example response

{
  "roles": [
    {
      "branch_id": "br-aged-salad-637688",
      "created_at": "2022-11-23T17:42:25Z",
      "name": "casey",
      "protected": false,
      "updated_at": "2022-11-23T17:42:25Z"
    },
    {
      "branch_id": "br-aged-salad-637688",
      "created_at": "2022-10-22T17:38:21Z",
      "name": "thomas",
      "protected": false,
      "updated_at": "2022-10-22T17:38:21Z"
    }
  ]
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

curl -X GET 'https://console.neon.tech/api/v2/projects/string/branches/string/roles'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/roles', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/roles', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/projects/string/branches/string/roles")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/projects/string/branches/string/roles", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/roles");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/roles"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/roles")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/projects/string/branches/string/roles");
using var response = await client.SendAsync(request);

{
  "roles": [
    {
      "branch_id": "br-aged-salad-637688",
      "created_at": "2022-11-23T17:42:25Z",
      "name": "casey",
      "protected": false,
      "updated_at": "2022-11-23T17:42:25Z"
    },
    {
      "branch_id": "br-aged-salad-637688",
      "created_at": "2022-10-22T17:38:21Z",
      "name": "thomas",
      "protected": false,
      "updated_at": "2022-10-22T17:38:21Z"
    }
  ]
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}