Reference 2026-05-20 06:35 UTC to 2026-05-22 06:33 UTC

38 38 

39 Unix timestamp (in seconds) when the group was created.39 Unix timestamp (in seconds) when the group was created.

40 40 

41 - `group_type: string`41 - `group_type: "group" or "tenant_group"`

42 42 

43 The type of the group.43 The type of the group.

44 44 

45 - `"group"`

46 

47 - `"tenant_group"`

48 

45 - `is_scim_managed: boolean`49 - `is_scim_managed: boolean`

46 50 

47 Whether the group is managed through SCIM and controlled by your identity provider.51 Whether the group is managed through SCIM and controlled by your identity provider.

79 {83 {

80 "id": "id",84 "id": "id",

81 "created_at": 0,85 "created_at": 0,

82 "group_type": "group_type",86 "group_type": "group",

83 "is_scim_managed": true,87 "is_scim_managed": true,

84 "name": "name"88 "name": "name"

85 }89 }

143 147 

144 Unix timestamp (in seconds) when the group was created.148 Unix timestamp (in seconds) when the group was created.

145 149 

146 - `group_type: string`150 - `group_type: "group" or "tenant_group"`

147 151 

148 The type of the group.152 The type of the group.

149 153 

154 - `"group"`

155 

156 - `"tenant_group"`

157 

150 - `is_scim_managed: boolean`158 - `is_scim_managed: boolean`

151 159 

152 Whether the group is managed through SCIM and controlled by your identity provider.160 Whether the group is managed through SCIM and controlled by your identity provider.

172{180{

173 "id": "id",181 "id": "id",

174 "created_at": 0,182 "created_at": 0,

175 "group_type": "group_type",183 "group_type": "group",

176 "is_scim_managed": true,184 "is_scim_managed": true,

177 "name": "name"185 "name": "name"

178}186}

201}209}

202```210```

203 211 

212## Retrieve group

213 

214**get** `/organization/groups/{group_id}`

215 

216Retrieves a group.

217 

218### Path Parameters

219 

220- `group_id: string`

221 

222### Returns

223 

224- `Group object { id, created_at, group_type, 2 more }`

225 

226 Details about an organization group.

227 

228 - `id: string`

229 

230 Identifier for the group.

231 

232 - `created_at: number`

233 

234 Unix timestamp (in seconds) when the group was created.

235 

236 - `group_type: "group" or "tenant_group"`

237 

238 The type of the group.

239 

240 - `"group"`

241 

242 - `"tenant_group"`

243 

244 - `is_scim_managed: boolean`

245 

246 Whether the group is managed through SCIM and controlled by your identity provider.

247 

248 - `name: string`

249 

250 Display name of the group.

251 

252### Example

253 

254```http

255curl https://api.openai.com/v1/organization/groups/$GROUP_ID \

256 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

257```

258 

259#### Response

260 

261```json

262{

263 "id": "id",

264 "created_at": 0,

265 "group_type": "group",

266 "is_scim_managed": true,

267 "name": "name"

268}

269```

270 

271### Example

272 

273```http

274curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ \

275 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

276 -H "Content-Type: application/json"

277```

278 

279#### Response

280 

281```json

282{

283 "id": "group_01J1F8ABCDXYZ",

284 "name": "Support Team",

285 "created_at": 1711471533,

286 "is_scim_managed": false,

287 "group_type": "group"

288}

289```

290 

204## Update group291## Update group

205 292 

206**post** `/organization/groups/{group_id}`293**post** `/organization/groups/{group_id}`

357 444 

358 Unix timestamp (in seconds) when the group was created.445 Unix timestamp (in seconds) when the group was created.

359 446 

360 - `group_type: string`447 - `group_type: "group" or "tenant_group"`

361 448 

362 The type of the group.449 The type of the group.

363 450 

451 - `"group"`

452 

453 - `"tenant_group"`

454 

364 - `is_scim_managed: boolean`455 - `is_scim_managed: boolean`

365 456 

366 Whether the group is managed through SCIM and controlled by your identity provider.457 Whether the group is managed through SCIM and controlled by your identity provider.

596}687}

597```688```

598 689 

690## Retrieve group user

691 

692**get** `/organization/groups/{group_id}/users/{user_id}`

693 

694Retrieves a user in a group.

695 

696### Path Parameters

697 

698- `group_id: string`

699 

700- `user_id: string`

701 

702### Returns

703 

704- `id: string`

705 

706 Identifier for the user.

707 

708- `email: string`

709 

710 Email address of the user, or `null` for users without an email.

711 

712- `is_service_account: boolean`

713 

714 Whether the user is a service account.

715 

716- `name: string`

717 

718 Display name of the user.

719 

720- `picture: string`

721 

722 URL of the user's profile picture, if available.

723 

724- `user_type: "user" or "tenant_user"`

725 

726 The type of user.

727 

728 - `"user"`

729 

730 - `"tenant_user"`

731 

732### Example

733 

734```http

735curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users/$USER_ID \

736 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

737```

738 

739#### Response

740 

741```json

742{

743 "id": "id",

744 "email": "email",

745 "is_service_account": true,

746 "name": "name",

747 "picture": "picture",

748 "user_type": "user"

749}

750```

751 

752### Example

753 

754```http

755curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users/user_abc123 \

756 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

757 -H "Content-Type: application/json"

758```

759 

760#### Response

761 

762```json

763{

764 "id": "user_abc123",

765 "name": "Ada Lovelace",

766 "email": "ada@example.com",

767 "picture": null,

768 "is_service_account": false,

769 "user_type": "user"

770}

771```

772 

599## Remove group user773## Remove group user

600 774 

601**delete** `/organization/groups/{group_id}/users/{user_id}`775**delete** `/organization/groups/{group_id}/users/{user_id}`

694 868 

695 Identifier of the user that was added.869 Identifier of the user that was added.

696 870 

871### User Retrieve Response

872 

873- `UserRetrieveResponse object { id, email, is_service_account, 3 more }`

874 

875 Details about a user returned from an organization group membership lookup.

876 

877 - `id: string`

878 

879 Identifier for the user.

880 

881 - `email: string`

882 

883 Email address of the user, or `null` for users without an email.

884 

885 - `is_service_account: boolean`

886 

887 Whether the user is a service account.

888 

889 - `name: string`

890 

891 Display name of the user.

892 

893 - `picture: string`

894 

895 URL of the user's profile picture, if available.

896 

897 - `user_type: "user" or "tenant_user"`

898 

899 The type of user.

900 

901 - `"user"`

902 

903 - `"tenant_user"`

904 

697### User Delete Response905### User Delete Response

698 906 

699- `UserDeleteResponse object { deleted, object }`907- `UserDeleteResponse object { deleted, object }`

742 950 

743### Returns951### Returns

744 952 

745- `data: array of object { id, created_at, created_by, 8 more }`953- `data: array of object { id, assignment_sources, created_at, 9 more }`

746 954 

747 Role assignments returned in the current page.955 Role assignments returned in the current page.

748 956 

750 958 

751 Identifier for the role.959 Identifier for the role.

752 960 

961 - `assignment_sources: array of object { principal_id, principal_type }`

962 

963 Principals from which the role assignment is inherited, when available.

964 

965 - `principal_id: string`

966 

967 - `principal_type: string`

968 

753 - `created_at: number`969 - `created_at: number`

754 970 

755 When the role was created.971 When the role was created.

818 "data": [1034 "data": [

819 {1035 {

820 "id": "id",1036 "id": "id",

1037 "assignment_sources": [

1038 {

1039 "principal_id": "principal_id",

1040 "principal_type": "principal_type"

1041 }

1042 ],

821 "created_at": 0,1043 "created_at": 0,

822 "created_by": "created_by",1044 "created_by": "created_by",

823 "created_by_user_obj": {1045 "created_by_user_obj": {

1041}1263}

1042```1264```

1043 1265 

1266## Retrieve group organization role

1267 

1268**get** `/organization/groups/{group_id}/roles/{role_id}`

1269 

1270Retrieves an organization role assigned to a group.

1271 

1272### Path Parameters

1273 

1274- `group_id: string`

1275 

1276- `role_id: string`

1277 

1278### Returns

1279 

1280- `id: string`

1281 

1282 Identifier for the role.

1283 

1284- `assignment_sources: array of object { principal_id, principal_type }`

1285 

1286 Principals from which the role assignment is inherited, when available.

1287 

1288 - `principal_id: string`

1289 

1290 - `principal_type: string`

1291 

1292- `created_at: number`

1293 

1294 When the role was created.

1295 

1296- `created_by: string`

1297 

1298 Identifier of the actor who created the role.

1299 

1300- `created_by_user_obj: map[unknown]`

1301 

1302 User details for the actor that created the role, when available.

1303 

1304- `description: string`

1305 

1306 Description of the role.

1307 

1308- `metadata: map[unknown]`

1309 

1310 Arbitrary metadata stored on the role.

1311 

1312- `name: string`

1313 

1314 Name of the role.

1315 

1316- `permissions: array of string`

1317 

1318 Permissions associated with the role.

1319 

1320- `predefined_role: boolean`

1321 

1322 Whether the role is predefined by OpenAI.

1323 

1324- `resource_type: string`

1325 

1326 Resource type the role applies to.

1327 

1328- `updated_at: number`

1329 

1330 When the role was last updated.

1331 

1332### Example

1333 

1334```http

1335curl https://api.openai.com/v1/organization/groups/$GROUP_ID/roles/$ROLE_ID \

1336 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

1337```

1338 

1339#### Response

1340 

1341```json

1342{

1343 "id": "id",

1344 "assignment_sources": [

1345 {

1346 "principal_id": "principal_id",

1347 "principal_type": "principal_type"

1348 }

1349 ],

1350 "created_at": 0,

1351 "created_by": "created_by",

1352 "created_by_user_obj": {

1353 "foo": "bar"

1354 },

1355 "description": "description",

1356 "metadata": {

1357 "foo": "bar"

1358 },

1359 "name": "name",

1360 "permissions": [

1361 "string"

1362 ],

1363 "predefined_role": true,

1364 "resource_type": "resource_type",

1365 "updated_at": 0

1366}

1367```

1368 

1369### Example

1370 

1371```http

1372curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8ROLE01 \

1373 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

1374 -H "Content-Type: application/json"

1375```

1376 

1377#### Response

1378 

1379```json

1380{

1381 "id": "role_01J1F8ROLE01",

1382 "name": "API Group Manager",

1383 "permissions": [

1384 "api.groups.read",

1385 "api.groups.write"

1386 ],

1387 "resource_type": "api.organization",

1388 "predefined_role": false,

1389 "description": "Allows managing organization groups",

1390 "created_at": 1711471533,

1391 "updated_at": 1711472599,

1392 "created_by": "user_abc123",

1393 "created_by_user_obj": null,

1394 "metadata": {},

1395 "assignment_sources": null

1396}

1397```

1398 

1044## Unassign organization role from group1399## Unassign organization role from group

1045 1400 

1046**delete** `/organization/groups/{group_id}/roles/{role_id}`1401**delete** `/organization/groups/{group_id}/roles/{role_id}`

1101 1456 

1102### Role List Response1457### Role List Response

1103 1458 

1104- `RoleListResponse object { id, created_at, created_by, 8 more }`1459- `RoleListResponse object { id, assignment_sources, created_at, 9 more }`

1105 1460 

1106 Detailed information about a role assignment entry returned when listing assignments.1461 Detailed information about a role assignment entry returned when listing assignments.

1107 1462 

1109 1464 

1110 Identifier for the role.1465 Identifier for the role.

1111 1466 

1467 - `assignment_sources: array of object { principal_id, principal_type }`

1468 

1469 Principals from which the role assignment is inherited, when available.

1470 

1471 - `principal_id: string`

1472 

1473 - `principal_type: string`

1474 

1112 - `created_at: number`1475 - `created_at: number`

1113 1476 

1114 When the role was created.1477 When the role was created.

1221 1584 

1222 Resource type the role is bound to (for example `api.organization` or `api.project`).1585 Resource type the role is bound to (for example `api.organization` or `api.project`).

1223 1586 

1587### Role Retrieve Response

1588 

1589- `RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more }`

1590 

1591 Detailed information about a role assignment entry returned when listing assignments.

1592 

1593 - `id: string`

1594 

1595 Identifier for the role.

1596 

1597 - `assignment_sources: array of object { principal_id, principal_type }`

1598 

1599 Principals from which the role assignment is inherited, when available.

1600 

1601 - `principal_id: string`

1602 

1603 - `principal_type: string`

1604 

1605 - `created_at: number`

1606 

1607 When the role was created.

1608 

1609 - `created_by: string`

1610 

1611 Identifier of the actor who created the role.

1612 

1613 - `created_by_user_obj: map[unknown]`

1614 

1615 User details for the actor that created the role, when available.

1616 

1617 - `description: string`

1618 

1619 Description of the role.

1620 

1621 - `metadata: map[unknown]`

1622 

1623 Arbitrary metadata stored on the role.

1624 

1625 - `name: string`

1626 

1627 Name of the role.

1628 

1629 - `permissions: array of string`

1630 

1631 Permissions associated with the role.

1632 

1633 - `predefined_role: boolean`

1634 

1635 Whether the role is predefined by OpenAI.

1636 

1637 - `resource_type: string`

1638 

1639 Resource type the role applies to.

1640 

1641 - `updated_at: number`

1642 

1643 When the role was last updated.

1644 

1224### Role Delete Response1645### Role Delete Response

1225 1646 

1226- `RoleDeleteResponse object { deleted, object }`1647- `RoleDeleteResponse object { deleted, object }`

24 24 

25 Unix timestamp (in seconds) when the group was created.25 Unix timestamp (in seconds) when the group was created.

26 26 

27 - `group_type: string`27 - `group_type: "group" or "tenant_group"`

28 28 

29 The type of the group.29 The type of the group.

30 30 

31 - `"group"`

32 

33 - `"tenant_group"`

34 

31 - `is_scim_managed: boolean`35 - `is_scim_managed: boolean`

32 36 

33 Whether the group is managed through SCIM and controlled by your identity provider.37 Whether the group is managed through SCIM and controlled by your identity provider.

53{57{

54 "id": "id",58 "id": "id",

55 "created_at": 0,59 "created_at": 0,

56 "group_type": "group_type",60 "group_type": "group",

57 "is_scim_managed": true,61 "is_scim_managed": true,

58 "name": "name"62 "name": "name"

59}63}

36 36 

37 Unix timestamp (in seconds) when the group was created.37 Unix timestamp (in seconds) when the group was created.

38 38 

39 - `group_type: string`39 - `group_type: "group" or "tenant_group"`

40 40 

41 The type of the group.41 The type of the group.

42 42 

43 - `"group"`

44 

45 - `"tenant_group"`

46 

43 - `is_scim_managed: boolean`47 - `is_scim_managed: boolean`

44 48 

45 Whether the group is managed through SCIM and controlled by your identity provider.49 Whether the group is managed through SCIM and controlled by your identity provider.

77 {81 {

78 "id": "id",82 "id": "id",

79 "created_at": 0,83 "created_at": 0,

80 "group_type": "group_type",84 "group_type": "group",

81 "is_scim_managed": true,85 "is_scim_managed": true,

82 "name": "name"86 "name": "name"

83 }87 }

183}183}

184```184```

185 185 

186## Retrieve group user

187 

188**get** `/organization/groups/{group_id}/users/{user_id}`

189 

190Retrieves a user in a group.

191 

192### Path Parameters

193 

194- `group_id: string`

195 

196- `user_id: string`

197 

198### Returns

199 

200- `id: string`

201 

202 Identifier for the user.

203 

204- `email: string`

205 

206 Email address of the user, or `null` for users without an email.

207 

208- `is_service_account: boolean`

209 

210 Whether the user is a service account.

211 

212- `name: string`

213 

214 Display name of the user.

215 

216- `picture: string`

217 

218 URL of the user's profile picture, if available.

219 

220- `user_type: "user" or "tenant_user"`

221 

222 The type of user.

223 

224 - `"user"`

225 

226 - `"tenant_user"`

227 

228### Example

229 

230```http

231curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users/$USER_ID \

232 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

233```

234 

235#### Response

236 

237```json

238{

239 "id": "id",

240 "email": "email",

241 "is_service_account": true,

242 "name": "name",

243 "picture": "picture",

244 "user_type": "user"

245}

246```

247 

248### Example

249 

250```http

251curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users/user_abc123 \

252 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

253 -H "Content-Type: application/json"

254```

255 

256#### Response

257 

258```json

259{

260 "id": "user_abc123",

261 "name": "Ada Lovelace",

262 "email": "ada@example.com",

263 "picture": null,

264 "is_service_account": false,

265 "user_type": "user"

266}

267```

268 

186## Remove group user269## Remove group user

187 270 

188**delete** `/organization/groups/{group_id}/users/{user_id}`271**delete** `/organization/groups/{group_id}/users/{user_id}`

281 364 

282 Identifier of the user that was added.365 Identifier of the user that was added.

283 366 

367### User Retrieve Response

368 

369- `UserRetrieveResponse object { id, email, is_service_account, 3 more }`

370 

371 Details about a user returned from an organization group membership lookup.

372 

373 - `id: string`

374 

375 Identifier for the user.

376 

377 - `email: string`

378 

379 Email address of the user, or `null` for users without an email.

380 

381 - `is_service_account: boolean`

382 

383 Whether the user is a service account.

384 

385 - `name: string`

386 

387 Display name of the user.

388 

389 - `picture: string`

390 

391 URL of the user's profile picture, if available.

392 

393 - `user_type: "user" or "tenant_user"`

394 

395 The type of user.

396 

397 - `"user"`

398 

399 - `"tenant_user"`

400 

284### User Delete Response401### User Delete Response

285 402 

286- `UserDeleteResponse object { deleted, object }`403- `UserDeleteResponse object { deleted, object }`

1079 1079 

1080### Returns1080### Returns

1081 1081 

1082- `data: array of object { id, created_at, created_by, 8 more }`1082- `data: array of object { id, assignment_sources, created_at, 9 more }`

1083 1083 

1084 Role assignments returned in the current page.1084 Role assignments returned in the current page.

1085 1085 

1087 1087 

1088 Identifier for the role.1088 Identifier for the role.

1089 1089 

1090 - `assignment_sources: array of object { principal_id, principal_type }`

1091 

1092 Principals from which the role assignment is inherited, when available.

1093 

1094 - `principal_id: string`

1095 

1096 - `principal_type: string`

1097 

1090 - `created_at: number`1098 - `created_at: number`

1091 1099 

1092 When the role was created.1100 When the role was created.

1155 "data": [1163 "data": [

1156 {1164 {

1157 "id": "id",1165 "id": "id",

1166 "assignment_sources": [

1167 {

1168 "principal_id": "principal_id",

1169 "principal_type": "principal_type"

1170 }

1171 ],

1158 "created_at": 0,1172 "created_at": 0,

1159 "created_by": "created_by",1173 "created_by": "created_by",

1160 "created_by_user_obj": {1174 "created_by_user_obj": {

1484}1498}

1485```1499```

1486 1500 

1501## Retrieve project user role

1502 

1503**get** `/projects/{project_id}/users/{user_id}/roles/{role_id}`

1504 

1505Retrieves a project role assigned to a user.

1506 

1507### Path Parameters

1508 

1509- `project_id: string`

1510 

1511- `user_id: string`

1512 

1513- `role_id: string`

1514 

1515### Returns

1516 

1517- `id: string`

1518 

1519 Identifier for the role.

1520 

1521- `assignment_sources: array of object { principal_id, principal_type }`

1522 

1523 Principals from which the role assignment is inherited, when available.

1524 

1525 - `principal_id: string`

1526 

1527 - `principal_type: string`

1528 

1529- `created_at: number`

1530 

1531 When the role was created.

1532 

1533- `created_by: string`

1534 

1535 Identifier of the actor who created the role.

1536 

1537- `created_by_user_obj: map[unknown]`

1538 

1539 User details for the actor that created the role, when available.

1540 

1541- `description: string`

1542 

1543 Description of the role.

1544 

1545- `metadata: map[unknown]`

1546 

1547 Arbitrary metadata stored on the role.

1548 

1549- `name: string`

1550 

1551 Name of the role.

1552 

1553- `permissions: array of string`

1554 

1555 Permissions associated with the role.

1556 

1557- `predefined_role: boolean`

1558 

1559 Whether the role is predefined by OpenAI.

1560 

1561- `resource_type: string`

1562 

1563 Resource type the role applies to.

1564 

1565- `updated_at: number`

1566 

1567 When the role was last updated.

1568 

1569### Example

1570 

1571```http

1572curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles/$ROLE_ID \

1573 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

1574```

1575 

1576#### Response

1577 

1578```json

1579{

1580 "id": "id",

1581 "assignment_sources": [

1582 {

1583 "principal_id": "principal_id",

1584 "principal_type": "principal_type"

1585 }

1586 ],

1587 "created_at": 0,

1588 "created_by": "created_by",

1589 "created_by_user_obj": {

1590 "foo": "bar"

1591 },

1592 "description": "description",

1593 "metadata": {

1594 "foo": "bar"

1595 },

1596 "name": "name",

1597 "permissions": [

1598 "string"

1599 ],

1600 "predefined_role": true,

1601 "resource_type": "resource_type",

1602 "updated_at": 0

1603}

1604```

1605 

1606### Example

1607 

1608```http

1609curl https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles/role_01J1F8PROJ \

1610 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

1611 -H "Content-Type: application/json"

1612```

1613 

1614#### Response

1615 

1616```json

1617{

1618 "id": "role_01J1F8PROJ",

1619 "name": "API Project Key Manager",

1620 "permissions": [

1621 "api.organization.projects.api_keys.read",

1622 "api.organization.projects.api_keys.write"

1623 ],

1624 "resource_type": "api.project",

1625 "predefined_role": false,

1626 "description": "Allows managing API keys for the project",

1627 "created_at": 1711471533,

1628 "updated_at": 1711472599,

1629 "created_by": "user_abc123",

1630 "created_by_user_obj": null,

1631 "metadata": {},

1632 "assignment_sources": null

1633}

1634```

1635 

1487## Unassign project role from user1636## Unassign project role from user

1488 1637 

1489**delete** `/projects/{project_id}/users/{user_id}/roles/{role_id}`1638**delete** `/projects/{project_id}/users/{user_id}/roles/{role_id}`

1546 1695 

1547### Role List Response1696### Role List Response

1548 1697 

1549- `RoleListResponse object { id, created_at, created_by, 8 more }`1698- `RoleListResponse object { id, assignment_sources, created_at, 9 more }`

1550 1699 

1551 Detailed information about a role assignment entry returned when listing assignments.1700 Detailed information about a role assignment entry returned when listing assignments.

1552 1701 

1554 1703 

1555 Identifier for the role.1704 Identifier for the role.

1556 1705 

1706 - `assignment_sources: array of object { principal_id, principal_type }`

1707 

1708 Principals from which the role assignment is inherited, when available.

1709 

1710 - `principal_id: string`

1711 

1712 - `principal_type: string`

1713 

1557 - `created_at: number`1714 - `created_at: number`

1558 1715 

1559 When the role was created.1716 When the role was created.

1740 1897 

1741 - `picture: optional string`1898 - `picture: optional string`

1742 1899 

1900### Role Retrieve Response

1901 

1902- `RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more }`

1903 

1904 Detailed information about a role assignment entry returned when listing assignments.

1905 

1906 - `id: string`

1907 

1908 Identifier for the role.

1909 

1910 - `assignment_sources: array of object { principal_id, principal_type }`

1911 

1912 Principals from which the role assignment is inherited, when available.

1913 

1914 - `principal_id: string`

1915 

1916 - `principal_type: string`

1917 

1918 - `created_at: number`

1919 

1920 When the role was created.

1921 

1922 - `created_by: string`

1923 

1924 Identifier of the actor who created the role.

1925 

1926 - `created_by_user_obj: map[unknown]`

1927 

1928 User details for the actor that created the role, when available.

1929 

1930 - `description: string`

1931 

1932 Description of the role.

1933 

1934 - `metadata: map[unknown]`

1935 

1936 Arbitrary metadata stored on the role.

1937 

1938 - `name: string`

1939 

1940 Name of the role.

1941 

1942 - `permissions: array of string`

1943 

1944 Permissions associated with the role.

1945 

1946 - `predefined_role: boolean`

1947 

1948 Whether the role is predefined by OpenAI.

1949 

1950 - `resource_type: string`

1951 

1952 Resource type the role applies to.

1953 

1954 - `updated_at: number`

1955 

1956 When the role was last updated.

1957 

1743### Role Delete Response1958### Role Delete Response

1744 1959 

1745- `RoleDeleteResponse object { deleted, object }`1960- `RoleDeleteResponse object { deleted, object }`

2064}2279}

2065```2280```

2066 2281 

2067## Delete project service account2282## Update project service account

2068 

2069**delete** `/organization/projects/{project_id}/service_accounts/{service_account_id}`

2070 2283 

2071Deletes a service account from the project.2284**post** `/organization/projects/{project_id}/service_accounts/{service_account_id}`

2072 2285 

2073Returns confirmation of service account deletion, or an error if the project2286Updates a service account in the project.

2074is archived (archived projects have no service accounts).

2075 2287 

2076### Path Parameters2288### Path Parameters

2077 2289 

2079 2291 

2080- `service_account_id: string`2292- `service_account_id: string`

2081 2293 

2082### Returns2294### Body Parameters

2083 

2084- `id: string`

2085 

2086- `deleted: boolean`

2087 

2088- `object: "organization.project.service_account.deleted"`

2089 

2090 - `"organization.project.service_account.deleted"`

2091 

2092### Example

2093 

2094```http

2095curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \

2096 -X DELETE \

2097 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

2098```

2099 

2100#### Response

2101 2295 

2102```json2296- `name: optional string`

2103{

2104 "id": "id",

2105 "deleted": true,

2106 "object": "organization.project.service_account.deleted"

2107}

2108```

2109 2297 

2110### Example2298 The updated service account name.

2111 2299 

2112```http2300- `role: optional "member" or "owner"`

2113curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc \

2114 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

2115 -H "Content-Type: application/json"

2116```

2117 2301 

2118#### Response2302 The updated service account role.

2119 2303 

2120```json2304 - `"member"`

2121{

2122 "object": "organization.project.service_account.deleted",

2123 "id": "svc_acct_abc",

2124 "deleted": true

2125}

2126```

2127 2305 

2128## Domain Types2306 - `"owner"`

2129 2307 

2130### Project Service Account2308### Returns

2131 2309 

2132- `ProjectServiceAccount object { id, created_at, name, 2 more }`2310- `ProjectServiceAccount object { id, created_at, name, 2 more }`

2133 2311 

2159 2337 

2160 - `"member"`2338 - `"member"`

2161 2339 

2162### Service Account Create Response2340### Example

2163 

2164- `ServiceAccountCreateResponse object { id, api_key, created_at, 3 more }`

2165 2341 

2166 - `id: string`2342```http

2343curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \

2344 -H 'Content-Type: application/json' \

2345 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

2346 -d '{}'

2347```

2167 2348 

2168 - `api_key: object { id, created_at, name, 2 more }`2349#### Response

2169 2350 

2170 - `id: string`2351```json

2352{

2353 "id": "id",

2354 "created_at": 0,

2355 "name": "name",

2356 "object": "organization.project.service_account",

2357 "role": "owner"

2358}

2359```

2171 2360 

2172 - `created_at: number`2361### Example

2173 2362 

2174 - `name: string`2363```http

2364curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc \

2365 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

2366 -H "Content-Type: application/json" \

2367 -d '{

2368 "name": "Updated service account",

2369 "role": "member"

2370 }'

2371```

2372 

2373#### Response

2374 

2375```json

2376{

2377 "object": "organization.project.service_account",

2378 "id": "svc_acct_abc",

2379 "name": "Updated service account",

2380 "role": "member",

2381 "created_at": 1711471533

2382}

2383```

2384 

2385## Delete project service account

2386 

2387**delete** `/organization/projects/{project_id}/service_accounts/{service_account_id}`

2388 

2389Deletes a service account from the project.

2390 

2391Returns confirmation of service account deletion, or an error if the project

2392is archived (archived projects have no service accounts).

2393 

2394### Path Parameters

2395 

2396- `project_id: string`

2397 

2398- `service_account_id: string`

2399 

2400### Returns

2401 

2402- `id: string`

2403 

2404- `deleted: boolean`

2405 

2406- `object: "organization.project.service_account.deleted"`

2407 

2408 - `"organization.project.service_account.deleted"`

2409 

2410### Example

2411 

2412```http

2413curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \

2414 -X DELETE \

2415 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

2416```

2417 

2418#### Response

2419 

2420```json

2421{

2422 "id": "id",

2423 "deleted": true,

2424 "object": "organization.project.service_account.deleted"

2425}

2426```

2427 

2428### Example

2429 

2430```http

2431curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc \

2432 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

2433 -H "Content-Type: application/json"

2434```

2435 

2436#### Response

2437 

2438```json

2439{

2440 "object": "organization.project.service_account.deleted",

2441 "id": "svc_acct_abc",

2442 "deleted": true

2443}

2444```

2445 

2446## Domain Types

2447 

2448### Project Service Account

2449 

2450- `ProjectServiceAccount object { id, created_at, name, 2 more }`

2451 

2452 Represents an individual service account in a project.

2453 

2454 - `id: string`

2455 

2456 The identifier, which can be referenced in API endpoints

2457 

2458 - `created_at: number`

2459 

2460 The Unix timestamp (in seconds) of when the service account was created

2461 

2462 - `name: string`

2463 

2464 The name of the service account

2465 

2466 - `object: "organization.project.service_account"`

2467 

2468 The object type, which is always `organization.project.service_account`

2469 

2470 - `"organization.project.service_account"`

2471 

2472 - `role: "owner" or "member"`

2473 

2474 `owner` or `member`

2475 

2476 - `"owner"`

2477 

2478 - `"member"`

2479 

2480### Service Account Create Response

2481 

2482- `ServiceAccountCreateResponse object { id, api_key, created_at, 3 more }`

2483 

2484 - `id: string`

2485 

2486 - `api_key: object { id, created_at, name, 2 more }`

2487 

2488 - `id: string`

2489 

2490 - `created_at: number`

2491 

2492 - `name: string`

2175 2493 

2176 - `object: "organization.project.service_account.api_key"`2494 - `object: "organization.project.service_account.api_key"`

2177 2495 

3705 4023 

3706 Display name of the group.4024 Display name of the group.

3707 4025 

3708 - `group_type: string`4026 - `group_type: "group" or "tenant_group"`

3709 4027 

3710 The type of the group.4028 The type of the group.

3711 4029 

4030 - `"group"`

4031 

4032 - `"tenant_group"`

4033 

3712 - `object: "project.group"`4034 - `object: "project.group"`

3713 4035 

3714 Always `project.group`.4036 Always `project.group`.

3749 "created_at": 0,4071 "created_at": 0,

3750 "group_id": "group_id",4072 "group_id": "group_id",

3751 "group_name": "group_name",4073 "group_name": "group_name",

3752 "group_type": "group_type",4074 "group_type": "group",

3753 "object": "project.group",4075 "object": "project.group",

3754 "project_id": "project_id"4076 "project_id": "project_id"

3755 }4077 }

3825 4147 

3826 Display name of the group.4148 Display name of the group.

3827 4149 

3828 - `group_type: string`4150 - `group_type: "group" or "tenant_group"`

3829 4151 

3830 The type of the group.4152 The type of the group.

3831 4153 

4154 - `"group"`

4155 

4156 - `"tenant_group"`

4157 

3832 - `object: "project.group"`4158 - `object: "project.group"`

3833 4159 

3834 Always `project.group`.4160 Always `project.group`.

3858 "created_at": 0,4184 "created_at": 0,

3859 "group_id": "group_id",4185 "group_id": "group_id",

3860 "group_name": "group_name",4186 "group_name": "group_name",

3861 "group_type": "group_type",4187 "group_type": "group",

3862 "object": "project.group",4188 "object": "project.group",

3863 "project_id": "project_id"4189 "project_id": "project_id"

3864}4190}

3888}4214}

3889```4215```

3890 4216 

4217## Retrieve project group

4218 

4219**get** `/organization/projects/{project_id}/groups/{group_id}`

4220 

4221Retrieves a project's group.

4222 

4223### Path Parameters

4224 

4225- `project_id: string`

4226 

4227- `group_id: string`

4228 

4229### Query Parameters

4230 

4231- `group_type: optional "group" or "tenant_group"`

4232 

4233 The type of group to retrieve.

4234 

4235 - `"group"`

4236 

4237 - `"tenant_group"`

4238 

4239### Returns

4240 

4241- `ProjectGroup object { created_at, group_id, group_name, 3 more }`

4242 

4243 Details about a group's membership in a project.

4244 

4245 - `created_at: number`

4246 

4247 Unix timestamp (in seconds) when the group was granted project access.

4248 

4249 - `group_id: string`

4250 

4251 Identifier of the group that has access to the project.

4252 

4253 - `group_name: string`

4254 

4255 Display name of the group.

4256 

4257 - `group_type: "group" or "tenant_group"`

4258 

4259 The type of the group.

4260 

4261 - `"group"`

4262 

4263 - `"tenant_group"`

4264 

4265 - `object: "project.group"`

4266 

4267 Always `project.group`.

4268 

4269 - `"project.group"`

4270 

4271 - `project_id: string`

4272 

4273 Identifier of the project.

4274 

4275### Example

4276 

4277```http

4278curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups/$GROUP_ID \

4279 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

4280```

4281 

4282#### Response

4283 

4284```json

4285{

4286 "created_at": 0,

4287 "group_id": "group_id",

4288 "group_name": "group_name",

4289 "group_type": "group",

4290 "object": "project.group",

4291 "project_id": "project_id"

4292}

4293```

4294 

4295### Example

4296 

4297```http

4298curl https://api.openai.com/v1/organization/projects/proj_abc123/groups/group_01J1F8ABCDXYZ \

4299 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

4300 -H "Content-Type: application/json"

4301```

4302 

4303#### Response

4304 

4305```json

4306{

4307 "object": "project.group",

4308 "project_id": "proj_abc123",

4309 "group_id": "group_01J1F8ABCDXYZ",

4310 "group_name": "Support Team",

4311 "group_type": "group",

4312 "created_at": 1711471533

4313}

4314```

4315 

3891## Remove project group4316## Remove project group

3892 4317 

3893**delete** `/organization/projects/{project_id}/groups/{group_id}`4318**delete** `/organization/projects/{project_id}/groups/{group_id}`

3966 4391 

3967 Display name of the group.4392 Display name of the group.

3968 4393 

3969 - `group_type: string`4394 - `group_type: "group" or "tenant_group"`

3970 4395 

3971 The type of the group.4396 The type of the group.

3972 4397 

4398 - `"group"`

4399 

4400 - `"tenant_group"`

4401 

3973 - `object: "project.group"`4402 - `object: "project.group"`

3974 4403 

3975 Always `project.group`.4404 Always `project.group`.

4030 4459 

4031### Returns4460### Returns

4032 4461 

4033- `data: array of object { id, created_at, created_by, 8 more }`4462- `data: array of object { id, assignment_sources, created_at, 9 more }`

4034 4463 

4035 Role assignments returned in the current page.4464 Role assignments returned in the current page.

4036 4465 

4038 4467 

4039 Identifier for the role.4468 Identifier for the role.

4040 4469 

4470 - `assignment_sources: array of object { principal_id, principal_type }`

4471 

4472 Principals from which the role assignment is inherited, when available.

4473 

4474 - `principal_id: string`

4475 

4476 - `principal_type: string`

4477 

4041 - `created_at: number`4478 - `created_at: number`

4042 4479 

4043 When the role was created.4480 When the role was created.

4106 "data": [4543 "data": [

4107 {4544 {

4108 "id": "id",4545 "id": "id",

4546 "assignment_sources": [

4547 {

4548 "principal_id": "principal_id",

4549 "principal_type": "principal_type"

4550 }

4551 ],

4109 "created_at": 0,4552 "created_at": 0,

4110 "created_by": "created_by",4553 "created_by": "created_by",

4111 "created_by_user_obj": {4554 "created_by_user_obj": {

4331}4774}

4332```4775```

4333 4776 

4334## Unassign project role from group4777## Retrieve project group role

4335 4778 

4336**delete** `/projects/{project_id}/groups/{group_id}/roles/{role_id}`4779**get** `/projects/{project_id}/groups/{group_id}/roles/{role_id}`

4337 4780 

4338Unassigns a project role from a group within a project.4781Retrieves a project role assigned to a group.

4339 4782 

4340### Path Parameters4783### Path Parameters

4341 4784 

4347 4790 

4348### Returns4791### Returns

4349 4792 

4350- `deleted: boolean`4793- `id: string`

4351 4794 

4352 Whether the assignment was removed.4795 Identifier for the role.

4353 4796 

4354- `object: string`4797- `assignment_sources: array of object { principal_id, principal_type }`

4355 4798 

4356 Identifier for the deleted assignment, such as `group.role.deleted` or `user.role.deleted`.4799 Principals from which the role assignment is inherited, when available.

4357 4800 

4358### Example4801 - `principal_id: string`

4359 4802 

4360```http4803 - `principal_type: string`

4361curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \

4362 -X DELETE \

4363 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

4364```

4365 4804 

4366#### Response4805- `created_at: number`

4367 4806 

4368```json4807 When the role was created.

4369{

4370 "deleted": true,

4371 "object": "object"

4372}

4373```

4374 4808 

4375### Example4809- `created_by: string`

4810 

4811 Identifier of the actor who created the role.

4812 

4813- `created_by_user_obj: map[unknown]`

4814 

4815 User details for the actor that created the role, when available.

4816 

4817- `description: string`

4818 

4819 Description of the role.

4820 

4821- `metadata: map[unknown]`

4822 

4823 Arbitrary metadata stored on the role.

4824 

4825- `name: string`

4826 

4827 Name of the role.

4828 

4829- `permissions: array of string`

4830 

4831 Permissions associated with the role.

4832 

4833- `predefined_role: boolean`

4834 

4835 Whether the role is predefined by OpenAI.

4836 

4837- `resource_type: string`

4838 

4839 Resource type the role applies to.

4840 

4841- `updated_at: number`

4842 

4843 When the role was last updated.

4844 

4845### Example

4846 

4847```http

4848curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \

4849 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

4850```

4851 

4852#### Response

4853 

4854```json

4855{

4856 "id": "id",

4857 "assignment_sources": [

4858 {

4859 "principal_id": "principal_id",

4860 "principal_type": "principal_type"

4861 }

4862 ],

4863 "created_at": 0,

4864 "created_by": "created_by",

4865 "created_by_user_obj": {

4866 "foo": "bar"

4867 },

4868 "description": "description",

4869 "metadata": {

4870 "foo": "bar"

4871 },

4872 "name": "name",

4873 "permissions": [

4874 "string"

4875 ],

4876 "predefined_role": true,

4877 "resource_type": "resource_type",

4878 "updated_at": 0

4879}

4880```

4881 

4882### Example

4883 

4884```http

4885curl https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8PROJ \

4886 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

4887 -H "Content-Type: application/json"

4888```

4889 

4890#### Response

4891 

4892```json

4893{

4894 "id": "role_01J1F8PROJ",

4895 "name": "API Project Key Manager",

4896 "permissions": [

4897 "api.organization.projects.api_keys.read",

4898 "api.organization.projects.api_keys.write"

4899 ],

4900 "resource_type": "api.project",

4901 "predefined_role": false,

4902 "description": "Allows managing API keys for the project",

4903 "created_at": 1711471533,

4904 "updated_at": 1711472599,

4905 "created_by": "user_abc123",

4906 "created_by_user_obj": null,

4907 "metadata": {},

4908 "assignment_sources": null

4909}

4910```

4911 

4912## Unassign project role from group

4913 

4914**delete** `/projects/{project_id}/groups/{group_id}/roles/{role_id}`

4915 

4916Unassigns a project role from a group within a project.

4917 

4918### Path Parameters

4919 

4920- `project_id: string`

4921 

4922- `group_id: string`

4923 

4924- `role_id: string`

4925 

4926### Returns

4927 

4928- `deleted: boolean`

4929 

4930 Whether the assignment was removed.

4931 

4932- `object: string`

4933 

4934 Identifier for the deleted assignment, such as `group.role.deleted` or `user.role.deleted`.

4935 

4936### Example

4937 

4938```http

4939curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \

4940 -X DELETE \

4941 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

4942```

4943 

4944#### Response

4945 

4946```json

4947{

4948 "deleted": true,

4949 "object": "object"

4950}

4951```

4952 

4953### Example

4376 4954 

4377```http4955```http

4378curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8PROJ \4956curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/groups/group_01J1F8ABCDXYZ/roles/role_01J1F8PROJ \

4393 4971 

4394### Role List Response4972### Role List Response

4395 4973 

4396- `RoleListResponse object { id, created_at, created_by, 8 more }`4974- `RoleListResponse object { id, assignment_sources, created_at, 9 more }`

4397 4975 

4398 Detailed information about a role assignment entry returned when listing assignments.4976 Detailed information about a role assignment entry returned when listing assignments.

4399 4977 

4401 4979 

4402 Identifier for the role.4980 Identifier for the role.

4403 4981 

4982 - `assignment_sources: array of object { principal_id, principal_type }`

4983 

4984 Principals from which the role assignment is inherited, when available.

4985 

4986 - `principal_id: string`

4987 

4988 - `principal_type: string`

4989 

4404 - `created_at: number`4990 - `created_at: number`

4405 4991 

4406 When the role was created.4992 When the role was created.

4513 5099 

4514 Resource type the role is bound to (for example `api.organization` or `api.project`).5100 Resource type the role is bound to (for example `api.organization` or `api.project`).

4515 5101 

5102### Role Retrieve Response

5103 

5104- `RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more }`

5105 

5106 Detailed information about a role assignment entry returned when listing assignments.

5107 

5108 - `id: string`

5109 

5110 Identifier for the role.

5111 

5112 - `assignment_sources: array of object { principal_id, principal_type }`

5113 

5114 Principals from which the role assignment is inherited, when available.

5115 

5116 - `principal_id: string`

5117 

5118 - `principal_type: string`

5119 

5120 - `created_at: number`

5121 

5122 When the role was created.

5123 

5124 - `created_by: string`

5125 

5126 Identifier of the actor who created the role.

5127 

5128 - `created_by_user_obj: map[unknown]`

5129 

5130 User details for the actor that created the role, when available.

5131 

5132 - `description: string`

5133 

5134 Description of the role.

5135 

5136 - `metadata: map[unknown]`

5137 

5138 Arbitrary metadata stored on the role.

5139 

5140 - `name: string`

5141 

5142 Name of the role.

5143 

5144 - `permissions: array of string`

5145 

5146 Permissions associated with the role.

5147 

5148 - `predefined_role: boolean`

5149 

5150 Whether the role is predefined by OpenAI.

5151 

5152 - `resource_type: string`

5153 

5154 Resource type the role applies to.

5155 

5156 - `updated_at: number`

5157 

5158 When the role was last updated.

5159 

4516### Role Delete Response5160### Role Delete Response

4517 5161 

4518- `RoleDeleteResponse object { deleted, object }`5162- `RoleDeleteResponse object { deleted, object }`