Skip to content
Management API Reference

Authorize user-id to role mappings for JIT access

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

Authorizes the request to assume a role in the project database

OAuth scopes

  • database:read

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

  • database_jit_read

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • role
    Required
    string
  • rhost
    Required
    any of the following options

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

1
{
2
  "user_id": "00000000-0000-0000-0000-000000000000",
3
  "user_role": {
4
    "role": "lorem",
5
    "expires_at": 42,
6
    "allowed_networks": {
7
      "allowed_cidrs": [
8
        {
9
          "cidr": "144.144.144.144/14"
10
        }
11
      ],
12
      "allowed_cidrs_v6": [
13
        {
14
          "cidr": "::/104"
15
        }
16
      ]
17
    },
18
    "branches_only": true
19
  }
20
}