Vercel REST API Interfaces

1
{
2
  "type": "string",
3
  "enum": ["create", "delete", "read", "update", "list"],
4
  "description": "Enum containing the actions that can be performed against a resource. Group operations are included."
5
}

1
{
2
  "properties": {
3
    "id": {
4
      "type": "string",
5
      "description": "The unique identifier of the token.",
6
      "example": "5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391"
7
    },
8
    "name": {
9
      "type": "string",
10
      "description": "The human-readable name of the token."
11
    },
12
    "type": {
13
      "type": "string",
14
      "description": "The type of the token.",
15
      "example": "oauth2-token"
16
    },
17
    "origin": {
18
      "type": "string",
19
      "description": "The origin of how the token was created.",
20
      "example": "github"
21
    },
22
    "scopes": {
23
      "items": {
24
        "oneOf": [
25
          {
26
            "properties": {
27
              "type": { "type": "string", "enum": ["user"] },
28
              "sudo": {
29
                "properties": {
30
                  "origin": {
31
                    "type": "string",
32
                    "enum": ["totp", "webauthn", "recovery-code"],
33
                    "description": "Possible multi-factor origins"
34
                  },
35
                  "expiresAt": { "type": "number" }
36
                },
37
                "required": ["origin", "expiresAt"],
38
                "type": "object"
39
              },
40
              "origin": {
41
                "type": "string",
42
                "enum": [
43
                  "saml",
44
                  "github",
45
                  "gitlab",
46
                  "bitbucket",
47
                  "email",
48
                  "manual",
49
                  "passkey",
50
                  "otp",
51
                  "sms",
52
                  "invite"
53
                ]
54
              },
55
              "createdAt": { "type": "number" },
56
              "expiresAt": { "type": "number" }
57
            },
58
            "required": ["type", "origin", "createdAt"],
59
            "type": "object",
60
            "description": "The access scopes granted to the token."
61
          },
62
          {
63
            "properties": {
64
              "type": { "type": "string", "enum": ["team"] },
65
              "teamId": { "type": "string" },
66
              "origin": {
67
                "type": "string",
68
                "enum": [
69
                  "saml",
70
                  "github",
71
                  "gitlab",
72
                  "bitbucket",
73
                  "email",
74
                  "manual",
75
                  "passkey",
76
                  "otp",
77
                  "sms",
78
                  "invite"
79
                ]
80
              },
81
              "createdAt": { "type": "number" },
82
              "expiresAt": { "type": "number" }
83
            },
84
            "required": ["type", "teamId", "origin", "createdAt"],
85
            "type": "object",
86
            "description": "The access scopes granted to the token."
87
          }
88
        ]
89
      },
90
      "type": "array",
91
      "description": "The access scopes granted to the token."
92
    },
93
    "expiresAt": {
94
      "type": "number",
95
      "description": "Timestamp (in milliseconds) of when the token expires.",
96
      "example": 1632816536002
97
    },
98
    "activeAt": {
99
      "type": "number",
100
      "description": "Timestamp (in milliseconds) of when the token was most recently used.",
101
      "example": 1632816536002
102
    },
103
    "createdAt": {
104
      "type": "number",
105
      "description": "Timestamp (in milliseconds) of when the token was created.",
106
      "example": 1632816536002
107
    }
108
  },
109
  "required": ["id", "name", "type", "activeAt", "createdAt"],
110
  "type": "object",
111
  "description": "Authentication token metadata."
112
}

1
{
2
  "properties": {
3
    "createdAt": {
4
      "type": "number",
5
      "description": "UNIX timestamp (in milliseconds) when the User account was created.",
6
      "example": 1630748523395
7
    },
8
    "softBlock": {
9
      "nullable": true,
10
      "properties": {
11
        "blockedAt": { "type": "number" },
12
        "reason": {
13
          "type": "string",
14
          "enum": [
15
            "SUBSCRIPTION_CANCELED",
16
            "SUBSCRIPTION_EXPIRED",
17
            "UNPAID_INVOICE",
18
            "ENTERPRISE_TRIAL_ENDED",
19
            "FAIR_USE_LIMITS_EXCEEDED",
20
            "BLOCKED_FOR_PLATFORM_ABUSE"
21
          ]
22
        },
23
        "blockedDueToOverageType": {
24
          "type": "string",
25
          "enum": [
26
            "aiCredits",
27
            "analyticsUsage",
28
            "artifacts",
29
            "bandwidth",
30
            "blobTotalAdvancedRequests",
31
            "blobTotalAvgSizeInBytes",
32
            "blobTotalGetResponseObjectSizeInBytes",
33
            "blobTotalSimpleRequests",
34
            "dataCacheRead",
35
            "dataCacheWrite",
36
            "edgeConfigRead",
37
            "edgeConfigWrite",
38
            "edgeFunctionExecutionUnits",
39
            "edgeMiddlewareInvocations",
40
            "edgeRequestAdditionalCpuDuration",
41
            "edgeRequest",
42
            "elasticConcurrencyBuildSlots",
43
            "fastDataTransfer",
44
            "fastOriginTransfer",
45
            "functionDuration",
46
            "functionInvocation",
47
            "imageOptimizationCacheRead",
48
            "imageOptimizationCacheWrite",
49
            "imageOptimizationTransformation",
50
            "logDrainsVolume",
51
            "monitoringMetric",
52
            "objectDataTransfer",
53
            "observabilityEvent",
54
            "postgresComputeTime",
55
            "postgresDataStorage",
56
            "postgresDataTransfer",
57
            "postgresDatabase",
58
            "postgresWrittenData",
59
            "serverlessFunctionExecution",
60
            "sourceImages",
61
            "storageRedisTotalBandwidthInBytes",
62
            "storageRedisTotalCommands",
63
            "storageRedisTotalDailyAvgStorageInBytes",
64
            "storageRedisTotalDatabases",
65
            "wafOwaspExcessBytes",
66
            "wafOwaspRequests",
67
            "wafRateLimitRequest",
68
            "webAnalyticsEvent"
69
          ]
70
        }
71
      },
72
      "required": ["blockedAt", "reason"],
73
      "type": "object",
74
      "description": "When the User account has been \"soft blocked\", this property will contain the date when the restriction was enacted, and the identifier for why."
75
    },
76
    "billing": {
77
      "nullable": true,
78
      "type": "object",
79
      "description": "An object containing billing infomation associated with the User account."
80
    },
81
    "resourceConfig": {
82
      "properties": {
83
        "nodeType": {
84
          "type": "string",
85
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
86
        },
87
        "concurrentBuilds": {
88
          "type": "number",
89
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
90
        },
91
        "awsAccountType": {
92
          "type": "string",
93
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
94
        },
95
        "awsAccountIds": {
96
          "items": { "type": "string" },
97
          "type": "array",
98
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
99
        },
100
        "cfZoneName": {
101
          "type": "string",
102
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
103
        },
104
        "imageOptimizationType": {
105
          "type": "string",
106
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
107
        },
108
        "edgeConfigs": {
109
          "type": "number",
110
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
111
        },
112
        "edgeConfigSize": {
113
          "type": "number",
114
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
115
        },
116
        "edgeFunctionMaxSizeBytes": {
117
          "type": "number",
118
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
119
        },
120
        "edgeFunctionExecutionTimeoutMs": {
121
          "type": "number",
122
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
123
        },
124
        "serverlessFunctionDefaultMaxExecutionTime": {
125
          "type": "number",
126
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
127
        },
128
        "kvDatabases": {
129
          "type": "number",
130
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
131
        },
132
        "postgresDatabases": {
133
          "type": "number",
134
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
135
        },
136
        "blobStores": {
137
          "type": "number",
138
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
139
        },
140
        "integrationStores": {
141
          "type": "number",
142
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
143
        },
144
        "cronJobs": {
145
          "type": "number",
146
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
147
        },
148
        "cronJobsPerProject": {
149
          "type": "number",
150
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
151
        },
152
        "microfrontendGroupsPerTeam": {
153
          "type": "number",
154
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
155
        },
156
        "microfrontendProjectsPerGroup": {
157
          "type": "number",
158
          "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
159
        }
160
      },
161
      "type": "object",
162
      "description": "An object containing infomation related to the amount of platform resources may be allocated to the User account."
163
    },
164
    "stagingPrefix": {
165
      "type": "string",
166
      "description": "Prefix that will be used in the URL of \"Preview\" deployments created by the User account."
167
    },
168
    "activeDashboardViews": {
169
      "items": {
170
        "properties": {
171
          "scopeId": { "type": "string" },
172
          "viewPreference": {
173
            "nullable": true,
174
            "type": "string",
175
            "enum": ["list", "cards"]
176
          },
177
          "favoritesViewPreference": {
178
            "nullable": true,
179
            "type": "string",
180
            "enum": ["open", "closed"]
181
          },
182
          "recentsViewPreference": {
183
            "nullable": true,
184
            "type": "string",
185
            "enum": ["open", "closed"]
186
          }
187
        },
188
        "required": ["scopeId"],
189
        "type": "object",
190
        "description": "set of dashboard view preferences (cards or list) per scopeId"
191
      },
192
      "type": "array",
193
      "description": "set of dashboard view preferences (cards or list) per scopeId"
194
    },
195
    "importFlowGitNamespace": {
196
      "nullable": true,
197
      "oneOf": [{ "type": "string" }, { "type": "number" }]
198
    },
199
    "importFlowGitNamespaceId": {
200
      "nullable": true,
201
      "oneOf": [{ "type": "string" }, { "type": "number" }]
202
    },
203
    "importFlowGitProvider": {
204
      "nullable": true,
205
      "type": "string",
206
      "enum": ["github", "gitlab", "bitbucket"]
207
    },
208
    "preferredScopesAndGitNamespaces": {
209
      "items": {
210
        "properties": {
211
          "scopeId": { "type": "string" },
212
          "gitNamespaceId": {
213
            "nullable": true,
214
            "oneOf": [{ "type": "string" }, { "type": "number" }]
215
          }
216
        },
217
        "required": ["scopeId", "gitNamespaceId"],
218
        "type": "object"
219
      },
220
      "type": "array"
221
    },
222
    "dismissedToasts": {
223
      "items": {
224
        "properties": {
225
          "name": { "type": "string" },
226
          "dismissals": {
227
            "items": {
228
              "properties": {
229
                "scopeId": { "type": "string" },
230
                "createdAt": { "type": "number" }
231
              },
232
              "required": ["scopeId", "createdAt"],
233
              "type": "object"
234
            },
235
            "type": "array"
236
          }
237
        },
238
        "required": ["name", "dismissals"],
239
        "type": "object",
240
        "description": "A record of when, under a certain scopeId, a toast was dismissed"
241
      },
242
      "type": "array",
243
      "description": "A record of when, under a certain scopeId, a toast was dismissed"
244
    },
245
    "favoriteProjectsAndSpaces": {
246
      "items": {
247
        "oneOf": [
248
          {
249
            "properties": {
250
              "projectId": { "type": "string" },
251
              "scopeSlug": { "type": "string" },
252
              "scopeId": { "type": "string" },
253
              "teamId": { "type": "string" }
254
            },
255
            "required": ["projectId", "scopeSlug", "scopeId"],
256
            "type": "object",
257
            "description": "A list of projects and spaces across teams that a user has marked as a favorite."
258
          },
259
          {
260
            "properties": {
261
              "spaceId": { "type": "string" },
262
              "scopeSlug": { "type": "string" },
263
              "scopeId": { "type": "string" },
264
              "teamId": { "type": "string" }
265
            },
266
            "required": ["spaceId", "scopeSlug", "scopeId"],
267
            "type": "object",
268
            "description": "A list of projects and spaces across teams that a user has marked as a favorite."
269
          }
270
        ]
271
      },
272
      "type": "array",
273
      "description": "A list of projects and spaces across teams that a user has marked as a favorite."
274
    },
275
    "hasTrialAvailable": {
276
      "type": "boolean",
277
      "description": "Whether the user has a trial available for a paid plan subscription."
278
    },
279
    "remoteCaching": {
280
      "properties": { "enabled": { "type": "boolean" } },
281
      "type": "object",
282
      "description": "remote caching settings"
283
    },
284
    "dataCache": {
285
      "properties": { "excessBillingEnabled": { "type": "boolean" } },
286
      "type": "object",
287
      "description": "data cache settings"
288
    },
289
    "featureBlocks": {
290
      "properties": {
291
        "webAnalytics": {
292
          "properties": {
293
            "blockedFrom": { "type": "number" },
294
            "blockedUntil": { "type": "number" },
295
            "isCurrentlyBlocked": { "type": "boolean" }
296
          },
297
          "required": ["isCurrentlyBlocked"],
298
          "type": "object"
299
        }
300
      },
301
      "type": "object",
302
      "description": "Feature blocks for the user"
303
    },
304
    "northstarMigration": {
305
      "properties": {
306
        "teamId": {
307
          "type": "string",
308
          "description": "The ID of the team we created for this user."
309
        },
310
        "projects": {
311
          "type": "number",
312
          "description": "The number of projects migrated for this user."
313
        },
314
        "stores": {
315
          "type": "number",
316
          "description": "The number of stores migrated for this user."
317
        },
318
        "integrationConfigurations": {
319
          "type": "number",
320
          "description": "The number of integration configurations migrated for this user."
321
        },
322
        "integrationClients": {
323
          "type": "number",
324
          "description": "The number of integration clients migrated for this user."
325
        },
326
        "startTime": {
327
          "type": "number",
328
          "description": "The migration start time timestamp for this user."
329
        },
330
        "endTime": {
331
          "type": "number",
332
          "description": "The migration end time timestamp for this user."
333
        }
334
      },
335
      "required": [
336
        "teamId",
337
        "projects",
338
        "stores",
339
        "integrationConfigurations",
340
        "integrationClients",
341
        "startTime",
342
        "endTime"
343
      ],
344
      "type": "object"
345
    },
346
    "id": {
347
      "type": "string",
348
      "description": "The User's unique identifier.",
349
      "example": "AEIIDYVk59zbFF2Sxfyxxmua"
350
    },
351
    "email": {
352
      "type": "string",
353
      "description": "Email address associated with the User account.",
354
      "example": "me@example.com"
355
    },
356
    "name": {
357
      "nullable": true,
358
      "type": "string",
359
      "description": "Name associated with the User account, or `null` if none has been provided.",
360
      "example": "John Doe"
361
    },
362
    "username": {
363
      "type": "string",
364
      "description": "Unique username associated with the User account.",
365
      "example": "jdoe"
366
    },
367
    "avatar": {
368
      "nullable": true,
369
      "type": "string",
370
      "description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
371
      "example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
372
    },
373
    "defaultTeamId": {
374
      "nullable": true,
375
      "type": "string",
376
      "description": "The user's default team."
377
    },
378
    "version": {
379
      "type": "string",
380
      "enum": ["northstar"],
381
      "description": "The user's version. Will always be `northstar`."
382
    }
383
  },
384
  "required": [
385
    "createdAt",
386
    "softBlock",
387
    "billing",
388
    "resourceConfig",
389
    "stagingPrefix",
390
    "hasTrialAvailable",
391
    "id",
392
    "email",
393
    "name",
394
    "username",
395
    "avatar",
396
    "defaultTeamId",
397
    "version"
398
  ],
399
  "type": "object",
400
  "description": "Data for the currently authenticated User."
401
}

1
{
2
  "properties": {
3
    "limited": {
4
      "type": "boolean",
5
      "description": "Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges."
6
    },
7
    "id": {
8
      "type": "string",
9
      "description": "The User's unique identifier.",
10
      "example": "AEIIDYVk59zbFF2Sxfyxxmua"
11
    },
12
    "email": {
13
      "type": "string",
14
      "description": "Email address associated with the User account.",
15
      "example": "me@example.com"
16
    },
17
    "name": {
18
      "nullable": true,
19
      "type": "string",
20
      "description": "Name associated with the User account, or `null` if none has been provided.",
21
      "example": "John Doe"
22
    },
23
    "username": {
24
      "type": "string",
25
      "description": "Unique username associated with the User account.",
26
      "example": "jdoe"
27
    },
28
    "avatar": {
29
      "nullable": true,
30
      "type": "string",
31
      "description": "SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image.",
32
      "example": "22cb30c85ff45ac4c72de8981500006b28114aa1"
33
    },
34
    "defaultTeamId": {
35
      "nullable": true,
36
      "type": "string",
37
      "description": "The user's default team."
38
    },
39
    "version": {
40
      "type": "string",
41
      "enum": ["northstar"],
42
      "description": "The user's version. Will always be `northstar`."
43
    }
44
  },
45
  "required": [
46
    "limited",
47
    "id",
48
    "email",
49
    "name",
50
    "username",
51
    "avatar",
52
    "defaultTeamId",
53
    "version"
54
  ],
55
  "type": "object",
56
  "description": "A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data."
57
}

1
{
2
  "properties": {
3
    "key": { "type": "string" },
4
    "value": { "$ref": "#/components/schemas/EdgeConfigItemValue" },
5
    "description": { "type": "string" },
6
    "edgeConfigId": { "type": "string" },
7
    "createdAt": { "type": "number" },
8
    "updatedAt": { "type": "number" }
9
  },
10
  "required": ["key", "value", "edgeConfigId", "createdAt", "updatedAt"],
11
  "type": "object",
12
  "description": "The EdgeConfig."
13
}

1
{
2
  "nullable": true,
3
  "oneOf": [
4
    { "type": "string" },
5
    { "type": "number" },
6
    { "type": "boolean" },
7
    {
8
      "additionalProperties": {
9
        "$ref": "#/components/schemas/EdgeConfigItemValue"
10
      },
11
      "type": "object"
12
    },
13
    {
14
      "items": { "$ref": "#/components/schemas/EdgeConfigItemValue" },
15
      "type": "array"
16
    }
17
  ]
18
}

1
{
2
  "properties": {
3
    "token": { "type": "string" },
4
    "label": { "type": "string" },
5
    "id": {
6
      "type": "string",
7
      "description": "This is not the token itself, but rather an id to identify the token by"
8
    },
9
    "edgeConfigId": { "type": "string" },
10
    "createdAt": { "type": "number" }
11
  },
12
  "required": ["token", "label", "id", "edgeConfigId", "createdAt"],
13
  "type": "object",
14
  "description": "The EdgeConfig."
15
}

1
{
2
  "properties": {
3
    "name": {
4
      "type": "string",
5
      "description": "The name of the file tree entry",
6
      "example": "my-file.json"
7
    },
8
    "type": {
9
      "type": "string",
10
      "enum": [
11
        "directory",
12
        "file",
13
        "symlink",
14
        "lambda",
15
        "middleware",
16
        "invalid"
17
      ],
18
      "description": "String indicating the type of file tree entry.",
19
      "example": "file"
20
    },
21
    "uid": {
22
      "type": "string",
23
      "description": "The unique identifier of the file (only valid for the `file` type)",
24
      "example": "2d4aad419917f15b1146e9e03ddc9bb31747e4d0"
25
    },
26
    "children": {
27
      "items": { "$ref": "#/components/schemas/FileTree" },
28
      "type": "array",
29
      "description": "The list of children files of the directory (only valid for the `directory` type)"
30
    },
31
    "contentType": {
32
      "type": "string",
33
      "description": "The content-type of the file (only valid for the `file` type)",
34
      "example": "application/json"
35
    },
36
    "mode": {
37
      "type": "number",
38
      "description": "The file \"mode\" indicating file type and permissions."
39
    },
40
    "symlink": {
41
      "type": "string",
42
      "description": "Not currently used. See `file-list-to-tree.ts`."
43
    }
44
  },
45
  "required": ["name", "type", "mode"],
46
  "type": "object",
47
  "description": "A deployment file tree entry"
48
}

1
{
2
  "nullable": true,
3
  "oneOf": [
4
    { "type": "string" },
5
    { "type": "number" },
6
    { "type": "boolean" },
7
    {
8
      "items": { "$ref": "#/components/schemas/FlagJSONValue" },
9
      "type": "array",
10
      "description": "TODO: The following types will eventually be exported by a more relevant package."
11
    },
12
    {
13
      "additionalProperties": { "$ref": "#/components/schemas/FlagJSONValue" },
14
      "type": "object"
15
    }
16
  ]
17
}

1
{
2
  "properties": {
3
    "count": {
4
      "type": "number",
5
      "description": "Amount of items in the current page.",
6
      "example": 20
7
    },
8
    "next": {
9
      "nullable": true,
10
      "type": "number",
11
      "description": "Timestamp that must be used to request the next page.",
12
      "example": 1540095775951
13
    },
14
    "prev": {
15
      "nullable": true,
16
      "type": "number",
17
      "description": "Timestamp that must be used to request the previous page.",
18
      "example": 1540095775951
19
    }
20
  },
21
  "required": ["count", "next", "prev"],
22
  "type": "object",
23
  "description": "This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data."
24
}

1
{ "type": "object", "description": "Data representing a Team." }

1
{
2
  "properties": {
3
    "limited": {
4
      "type": "boolean",
5
      "description": "Property indicating that this Team data contains only limited information, due to the authentication token missing privileges to read the full Team data. Re-login with the Team's configured SAML Single Sign-On provider in order to upgrade the authentication token with the necessary privileges."
6
    },
7
    "saml": {
8
      "properties": {
9
        "connection": {
10
          "properties": {
11
            "type": {
12
              "type": "string",
13
              "description": "The Identity Provider \"type\", for example Okta.",
14
              "example": "OktaSAML"
15
            },
16
            "status": {
17
              "type": "string",
18
              "description": "Current status of the connection.",
19
              "example": "linked"
20
            },
21
            "state": {
22
              "type": "string",
23
              "description": "Current state of the connection.",
24
              "example": "active"
25
            },
26
            "connectedAt": {
27
              "type": "number",
28
              "description": "Timestamp (in milliseconds) of when the configuration was connected.",
29
              "example": 1611796915677
30
            },
31
            "lastReceivedWebhookEvent": {
32
              "type": "number",
33
              "description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
34
              "example": 1611796915677
35
            }
36
          },
37
          "required": ["type", "status", "state", "connectedAt"],
38
          "type": "object",
39
          "description": "Information for the SAML Single Sign-On configuration."
40
        },
41
        "directory": {
42
          "properties": {
43
            "type": {
44
              "type": "string",
45
              "description": "The Identity Provider \"type\", for example Okta.",
46
              "example": "OktaSAML"
47
            },
48
            "state": {
49
              "type": "string",
50
              "description": "Current state of the connection.",
51
              "example": "active"
52
            },
53
            "connectedAt": {
54
              "type": "number",
55
              "description": "Timestamp (in milliseconds) of when the configuration was connected.",
56
              "example": 1611796915677
57
            },
58
            "lastReceivedWebhookEvent": {
59
              "type": "number",
60
              "description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.",
61
              "example": 1611796915677
62
            }
63
          },
64
          "required": ["type", "state", "connectedAt"],
65
          "type": "object",
66
          "description": "Information for the Directory Sync configuration."
67
        },
68
        "enforced": {
69
          "type": "boolean",
70
          "description": "When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider."
71
        }
72
      },
73
      "required": ["enforced"],
74
      "type": "object",
75
      "description": "When \"Single Sign-On (SAML)\" is configured, this object contains information that allows the client-side to identify whether or not this Team has SAML enforced."
76
    },
77
    "id": {
78
      "type": "string",
79
      "description": "The Team's unique identifier.",
80
      "example": "team_nllPyCtREAqxxdyFKbbMDlxd"
81
    },
82
    "slug": {
83
      "type": "string",
84
      "description": "The Team's slug, which is unique across the Vercel platform.",
85
      "example": "my-team"
86
    },
87
    "name": {
88
      "nullable": true,
89
      "type": "string",
90
      "description": "Name associated with the Team account, or `null` if none has been provided.",
91
      "example": "My Team"
92
    },
93
    "avatar": {
94
      "nullable": true,
95
      "type": "string",
96
      "description": "The ID of the file used as avatar for this Team.",
97
      "example": "6eb07268bcfadd309905ffb1579354084c24655c"
98
    },
99
    "membership": {
100
      "properties": {
101
        "uid": { "type": "string" },
102
        "entitlements": {
103
          "items": {
104
            "properties": { "entitlement": { "type": "string" } },
105
            "required": ["entitlement"],
106
            "type": "object"
107
          },
108
          "type": "array"
109
        },
110
        "confirmed": { "type": "boolean" },
111
        "confirmedAt": { "type": "number" },
112
        "accessRequestedAt": { "type": "number" },
113
        "role": {
114
          "type": "string",
115
          "enum": [
116
            "OWNER",
117
            "MEMBER",
118
            "DEVELOPER",
119
            "SECURITY",
120
            "BILLING",
121
            "VIEWER",
122
            "CONTRIBUTOR"
123
          ]
124
        },
125
        "teamRoles": {
126
          "items": {
127
            "type": "string",
128
            "enum": [
129
              "OWNER",
130
              "MEMBER",
131
              "DEVELOPER",
132
              "SECURITY",
133
              "BILLING",
134
              "VIEWER",
135
              "CONTRIBUTOR"
136
            ]
137
          },
138
          "type": "array"
139
        },
140
        "teamPermissions": {
141
          "items": {
142
            "type": "string",
143
            "enum": ["CreateProject", "FullProductionDeployment", "UsageViewer"]
144
          },
145
          "type": "array"
146
        },
147
        "teamId": { "type": "string" },
148
        "createdAt": { "type": "number" },
149
        "created": { "type": "number" },
150
        "joinedFrom": {
151
          "properties": {
152
            "origin": {
153
              "type": "string",
154
              "enum": [
155
                "link",
156
                "saml",
157
                "github",
158
                "gitlab",
159
                "bitbucket",
160
                "mail",
161
                "import",
162
                "teams",
163
                "dsync",
164
                "feedback",
165
                "organization-teams"
166
              ]
167
            },
168
            "commitId": { "type": "string" },
169
            "repoId": { "type": "string" },
170
            "repoPath": { "type": "string" },
171
            "gitUserId": {
172
              "oneOf": [{ "type": "string" }, { "type": "number" }]
173
            },
174
            "gitUserLogin": { "type": "string" },
175
            "ssoUserId": { "type": "string" },
176
            "ssoConnectedAt": { "type": "number" },
177
            "idpUserId": { "type": "string" },
178
            "dsyncUserId": { "type": "string" },
179
            "dsyncConnectedAt": { "type": "number" }
180
          },
181
          "required": ["origin"],
182
          "type": "object"
183
        }
184
      },
185
      "required": ["confirmed", "confirmedAt", "role", "createdAt", "created"],
186
      "type": "object",
187
      "description": "The membership of the authenticated User in relation to the Team."
188
    },
189
    "created": {
190
      "type": "string",
191
      "description": "Will remain undocumented. Remove in v3 API."
192
    },
193
    "createdAt": {
194
      "type": "number",
195
      "description": "UNIX timestamp (in milliseconds) when the Team was created.",
196
      "example": 1630748523395
197
    }
198
  },
199
  "required": [
200
    "limited",
201
    "id",
202
    "slug",
203
    "name",
204
    "avatar",
205
    "membership",
206
    "created",
207
    "createdAt"
208
  ],
209
  "type": "object",
210
  "description": "A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data."
211
}