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

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • email
    Required
    string
  • roles
    Required
    Array<object>

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

1
{
2
  "email": "jon.snow@targaryen.com",
3
  "invite_id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
4
  "user_roles": [
5
    {
6
      "role": "lorem",
7
      "expires_at": 42,
8
      "allowed_networks": {
9
        "allowed_cidrs": [
10
          {
11
            "cidr": "lorem"
12
          }
13
        ],
14
        "allowed_cidrs_v6": [
15
          {
16
            "cidr": "lorem"
17
          }
18
        ]
19
      },
20
      "branches_only": true
21
    }
22
  ]
23
}