Skip to content
Management API Reference

Invites an external user to a database for JIT access

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

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

The fine-grained token must include the following permissions to access this endpoint:

  • database_jit_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • email
    Required
    string
  • roles
    Required
    Array<object>

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "email": "hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhg@effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.effffffffffffffffffffffffffffffffffffffffffffffffff.ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ",
  "invite_id": "00000000-0000-0000-0000-000000000000",
  "user_roles": [
    {
      "role": "lorem",
      "expires_at": 42,
      "allowed_networks": {
        "allowed_cidrs": [
          {
            "cidr": "144.144.144.144/14"
          }
        ],
        "allowed_cidrs_v6": [
          {
            "cidr": "::/104"
          }
        ]
      },
      "branches_only": true
    }
  ]
}