Sign in
Branch

Retrieve role details

Retrieves details about the specified role. In Neon, the terms "role" and "user" are synonymous. For related information, see Manage roles.

get/projects/{project_id}/branches/{branch_id}/roles/{role_name}

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/roles/{role_name}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Response

Returned details for the specified role

Example response

{
  "role": {
    "branch_id": "br-wispy-meadow-118737",
    "name": "casey",
    "protected": false,
    "created_at": "2022-11-23T17:42:25Z",
    "updated_at": "2022-11-23T17:42:25Z"
  }
}

Changes

No recorded changes to this operation across all 15 revisions of this API.