v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Database

Invites an external user to a database for JIT access

Invites the external user and sets initial roles that can be assumed and for how long

post/v1/projects/{ref}/database/jit/invite

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

Request body

emailstring email required

Example request

{
  "email": "external-user@somedomain.xyz",
  "roles": [
    {
      "role": "postgres",
      "expires_at": 1740787200,
      "allowed_networks": {
        "allowed_cidrs": [
          {
            "cidr": "203.0.113.0/24"
          }
        ]
      },
      "branches_only": false
    }
  ]
}

Response

emailstring email required
invite_idstring uuid required