Neon API (unofficial showcase)
POST/projects/{project_id}/permissions

Grant project access

Grants project access to the account associated with an email address. Supply the recipient's email in the request body to create a project permission. The response includes the new permission's identifier and grant details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
project_idstringrequired
The identifier of the project to grant access to. Must contain 1 to 60 lowercase letters, digits, or hyphens.

The project access grant details. Include the recipient's email address.

emailstringrequired
Email address of the user to grant project access to.

2 status codes
200Returns the created permission with its ID, granted-to email address, grant timestamp, and revocation timestamp when applicable.
idstringrequired
The project permission's ID.
granted_to_emailstringrequired
Email address of the user who has been granted access to the project.
granted_atstringrequired
Timestamp when the permission was granted.
revoked_atstringoptional
Timestamp when the permission was revoked. Null if the permission is still active.
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.
request_idstringoptional
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.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

The email field is required and must be a valid email address between 1 and 256 characters. The project_id path parameter must contain 1 to 60 lowercase letters, digits, or hyphens and identify the project to grant access to.