List jit access | Management API Reference

List all user-id to role mappings for JIT access

get/v1/projects/{ref}/database/jit/list

Mappings of roles a user can assume in the project database

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

database_jit_write

Path parameters

ref
Required
string
Project ref

Response codes

Response (200)

1
{
2
  "items": [
3
    {
4
      "user_id": "00000000-0000-0000-0000-000000000000",
5
      "primary_email": "lorem",
6
      "invite_id": null,
7
      "expires_at": null,
8
      "user_roles": [
9
        {
10
          "role": "lorem",
11
          "expires_at": 42,
12
          "allowed_networks": {
13
            "allowed_cidrs": [
14
              {
15
                "cidr": "144.144.144.144/14"
16
              }
17
            ],
18
            "allowed_cidrs_v6": [
19
              {
20
                "cidr": "::/104"
21
              }
22
            ]
23
          },
24
          "branches_only": true
25
        }
26
      ]
27
    }
28
  ]
29
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "items": {
5
      "type": "array",
6
      "items": {
7
        "anyOf": [
8
          {
9
            "type": "object",
10
            "properties": {
11
              "user_id": {
12
                "type": "string",
13
                "format": "uuid",
14
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
15
              },
16
              "primary_email": {
17
                "type": "string",
18
                "nullable": true
19
              },
20
              "invite_id": {
21
                "type": "null"
22
              },
23
              "expires_at": {
24
                "type": "null"
25
              },
26
              "user_roles": {
27
                "type": "array",
28
                "items": {
29
                  "type": "object",
30
                  "properties": {
31
                    "role": {
32
                      "type": "string"
33
                    },
34
                    "expires_at": {
35
                      "type": "number"
36
                    },
37
                    "allowed_networks": {
38
                      "type": "object",
39
                      "properties": {
40
                        "allowed_cidrs": {
41
                          "type": "array",
42
                          "items": {
43
                            "type": "object",
44
                            "properties": {
45
                              "cidr": {
46
                                "type": "string",
47
                                "format": "cidrv4",
48
                                "pattern": "^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\/([0-9]|[1-2][0-9]|3[0-2])$"
49
                              }
50
                            },
51
                            "required": [
52
                              "cidr"
53
                            ]
54
                          }
55
                        },
56
                        "allowed_cidrs_v6": {
57
                          "type": "array",
58
                          "items": {
59
                            "type": "object",
60
                            "properties": {
61
                              "cidr": {
62
                                "type": "string",
63
                                "format": "cidrv6",
64
                                "pattern": "^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|::|([0-9a-fA-F]{1,4})?::([0-9a-fA-F]{1,4}:?){0,6})\\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$"
65
                              }
66
                            },
67
                            "required": [
68
                              "cidr"
69
                            ]
70
                          }
71
                        }
72
                      }
73
                    },
74
                    "branches_only": {
75
                      "type": "boolean"
76
                    }
77
                  },
78
                  "required": [
79
                    "role"
80
                  ]
81
                }
82
              }
83
            },
84
            "required": [
85
              "user_id",
86
              "primary_email",
87
              "invite_id",
88
              "expires_at",
89
              "user_roles"
90
            ]
91
          },
92
          {
93
            "type": "object",
94
            "properties": {
95
              "user_id": {
96
                "type": "null"
97
              },
98
              "primary_email": {
99
                "type": "string"
100
              },
101
              "invite_id": {
102
                "type": "string",
103
                "format": "uuid",
104
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
105
              },
106
              "expires_at": {
107
                "type": "string"
108
              },
109
              "user_roles": {
110
                "type": "array",
111
                "items": {
112
                  "type": "object",
113
                  "properties": {
114
                    "role": {
115
                      "type": "string"
116
                    },
117
                    "expires_at": {
118
                      "type": "number"
119
                    },
120
                    "allowed_networks": {
121
                      "type": "object",
122
                      "properties": {
123
                        "allowed_cidrs": {
124
                          "type": "array",
125
                          "items": {
126
                            "type": "object",
127
                            "properties": {
128
                              "cidr": {
129
                                "type": "string",
130
                                "format": "cidrv4",
131
                                "pattern": "^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\/([0-9]|[1-2][0-9]|3[0-2])$"
132
                              }
133
                            },
134
                            "required": [
135
                              "cidr"
136
                            ]
137
                          }
138
                        },
139
                        "allowed_cidrs_v6": {
140
                          "type": "array",
141
                          "items": {
142
                            "type": "object",
143
                            "properties": {
144
                              "cidr": {
145
                                "type": "string",
146
                                "format": "cidrv6",
147
                                "pattern": "^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|::|([0-9a-fA-F]{1,4})?::([0-9a-fA-F]{1,4}:?){0,6})\\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$"
148
                              }
149
                            },
150
                            "required": [
151
                              "cidr"
152
                            ]
153
                          }
154
                        }
155
                      }
156
                    },
157
                    "branches_only": {
158
                      "type": "boolean"
159
                    }
160
                  },
161
                  "required": [
162
                    "role"
163
                  ]
164
                }
165
              }
166
            },
167
            "required": [
168
              "user_id",
169
              "primary_email",
170
              "invite_id",
171
              "expires_at",
172
              "user_roles"
173
            ]
174
          }
175
        ]
176
      }
177
    }
178
  },
179
  "required": [
180
    "items"
181
  ]
182
}