Skip to content

Commit 7ff3f7a

Browse files
authored
Merge pull request #30 from code42/chore/add-v3-orgs-endpoints
add v3 orgs endpoints
2 parents 3e16680 + 13c0262 commit 7ff3f7a

File tree

1 file changed

+164
-0
lines changed

1 file changed

+164
-0
lines changed

docs/core.yml

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1274,6 +1274,167 @@ paths:
12741274
value:
12751275
type: string
12761276

1277+
# ORGS - API CLIENTS
1278+
1279+
/api/v3/orgs:
1280+
get:
1281+
tags:
1282+
- orgs
1283+
summary: Get all orgs
1284+
operationId: OrgList_Get
1285+
responses:
1286+
200:
1287+
description: A successful response
1288+
content:
1289+
application/json:
1290+
schema:
1291+
type: object
1292+
properties:
1293+
data:
1294+
type: object
1295+
properties:
1296+
totalCount:
1297+
type: integer
1298+
format: int32
1299+
example: 1
1300+
orgs:
1301+
type: array
1302+
items:
1303+
$ref: '#/components/schemas/OrgResponse_core'
1304+
post:
1305+
tags:
1306+
- orgs
1307+
summary: Create an organization
1308+
operationId: Org_Create
1309+
responses:
1310+
200:
1311+
description: A successful response
1312+
content:
1313+
application/json:
1314+
schema:
1315+
$ref: '#/components/schemas/OrgResponse_core'
1316+
/api/v3/orgs/{orgId}:
1317+
get:
1318+
tags:
1319+
- orgs
1320+
summary: Get an organization
1321+
operationId: Org_Get
1322+
parameters:
1323+
- name: orgId
1324+
in: path
1325+
description: The unique Code42 orgGuid of the org to return.
1326+
required: true
1327+
schema:
1328+
type: string
1329+
responses:
1330+
200:
1331+
description: A successful response
1332+
content:
1333+
application/json:
1334+
schema:
1335+
$ref: '#/components/schemas/OrgResponse_core'
1336+
put:
1337+
tags:
1338+
- orgs
1339+
summary: Get an organization
1340+
operationId: Org_Get
1341+
parameters:
1342+
- name: orgId
1343+
in: path
1344+
description: The unique Code42 orgGuid of the org to update.
1345+
required: true
1346+
schema:
1347+
type: string
1348+
responses:
1349+
200:
1350+
description: A successful response
1351+
content:
1352+
application/json:
1353+
schema:
1354+
type: object
1355+
/api/v3/orgs/{orgId}/block:
1356+
post:
1357+
tags:
1358+
- orgs
1359+
summary: Block an organization
1360+
operationId: OrgBlock_Post
1361+
parameters:
1362+
- name: orgId
1363+
in: path
1364+
description: The unique Code42 orgGuid of the org to block.
1365+
required: true
1366+
schema:
1367+
type: string
1368+
responses:
1369+
200:
1370+
description: A successful response
1371+
content:
1372+
application/json:
1373+
schema:
1374+
type: object
1375+
/api/v3/orgs/{orgId}/unblock:
1376+
post:
1377+
tags:
1378+
- orgs
1379+
summary: Unblock an organization
1380+
operationId: OrgUnblock_Post
1381+
parameters:
1382+
- name: orgId
1383+
in: path
1384+
description: The unique Code42 orgGuid of the org to unblock.
1385+
required: true
1386+
schema:
1387+
type: string
1388+
responses:
1389+
200:
1390+
description: A successful response
1391+
content:
1392+
application/json:
1393+
schema:
1394+
type: object
1395+
/api/v3/orgs/{orgId}/deactivate:
1396+
post:
1397+
tags:
1398+
- orgs
1399+
summary: Deactivate an organization
1400+
operationId: OrgDeactivate_Post
1401+
parameters:
1402+
- name: orgId
1403+
in: path
1404+
description: The unique Code42 orgGuid of the org to deactivate.
1405+
required: true
1406+
schema:
1407+
type: string
1408+
responses:
1409+
200:
1410+
description: A successful response
1411+
content:
1412+
application/json:
1413+
schema:
1414+
type: object
1415+
/api/v3/orgs/{orgId}/activate:
1416+
post:
1417+
tags:
1418+
- orgs
1419+
summary: Reactivate an organization
1420+
operationId: OrgActivate_Post
1421+
parameters:
1422+
- name: orgId
1423+
in: path
1424+
description: The unique Code42 orgGuid of the org to activate.
1425+
required: true
1426+
schema:
1427+
type: string
1428+
responses:
1429+
200:
1430+
description: A successful response
1431+
content:
1432+
application/json:
1433+
schema:
1434+
type: object
1435+
1436+
1437+
12771438
# LEGAL HOLD
12781439

12791440
/api/v4/legal-hold-policy/create:
@@ -2025,6 +2186,9 @@ components:
20252186
OrgResponse_core:
20262187
type: object
20272188
properties:
2189+
orgGuid:
2190+
type: string
2191+
example: "01169311-8b02-4902-897f-f9b5cdec2b53"
20282192
orgUid:
20292193
type: string
20302194
example: "98765432123456789"

0 commit comments

Comments
 (0)