guides/admin-apis.md +28 −22
68import com.openai.client.OpenAIClient;68import com.openai.client.OpenAIClient;
69import com.openai.client.okhttp.OpenAIOkHttpClient;69import com.openai.client.okhttp.OpenAIOkHttpClient;
70 70
7171OpenAIClient client = OpenAIOkHttpClient.builder()OpenAIClient client =
7272 .adminApiKey(System.getenv("OPENAI_ADMIN_KEY")) OpenAIOkHttpClient.builder().adminApiKey(System.getenv("OPENAI_ADMIN_KEY")).build();
73 .build();
74```73```
75 74
76 75
133import com.openai.models.admin.organization.projects.modelpermissions.ProjectModelPermissions;132import com.openai.models.admin.organization.projects.modelpermissions.ProjectModelPermissions;
134import java.util.List;133import java.util.List;
135 134
136135ProjectModelPermissions modelPermissions = client.admin()ProjectModelPermissions modelPermissions =
136 client
137 .admin()
137 .organization()138 .organization()
138 .projects()139 .projects()
139 .modelPermissions()140 .modelPermissions()
142 ModelPermissionUpdateParams.builder()143 ModelPermissionUpdateParams.builder()
143 .mode(ModelPermissionUpdateParams.Mode.ALLOW_LIST)144 .mode(ModelPermissionUpdateParams.Mode.ALLOW_LIST)
144 .modelIds(List.of("gpt-4.1", "o3"))145 .modelIds(List.of("gpt-4.1", "o3"))
145146 .build() .build());
146 );
147 147
148System.out.println(modelPermissions.mode());148System.out.println(modelPermissions.mode());
149```149```
231import com.openai.models.admin.organization.projects.spendalerts.ProjectSpendAlert;231import com.openai.models.admin.organization.projects.spendalerts.ProjectSpendAlert;
232import com.openai.models.admin.organization.projects.spendalerts.SpendAlertCreateParams;232import com.openai.models.admin.organization.projects.spendalerts.SpendAlertCreateParams;
233 233
234234ProjectSpendAlert spendAlert = client.admin()ProjectSpendAlert spendAlert =
235 client
236 .admin()
235 .organization()237 .organization()
236 .projects()238 .projects()
237 .spendAlerts()239 .spendAlerts()
244 SpendAlertCreateParams.NotificationChannel.builder()246 SpendAlertCreateParams.NotificationChannel.builder()
245 .addRecipient("billing@example.com")247 .addRecipient("billing@example.com")
246 .subjectPrefix("[OpenAI spend]")248 .subjectPrefix("[OpenAI spend]")
247249 .build() .build())
248 )
249 .thresholdAmount(50000L)250 .thresholdAmount(50000L)
250251 .build() .build());
251 );
252 252
253System.out.println(spendAlert.id());253System.out.println(spendAlert.id());
254```254```
308import com.openai.models.admin.organization.projects.dataretention.DataRetentionUpdateParams;308import com.openai.models.admin.organization.projects.dataretention.DataRetentionUpdateParams;
309import com.openai.models.admin.organization.projects.dataretention.ProjectDataRetention;309import com.openai.models.admin.organization.projects.dataretention.ProjectDataRetention;
310 310
311311ProjectDataRetention dataRetention = client.admin()ProjectDataRetention dataRetention =
312 client
313 .admin()
312 .organization()314 .organization()
313 .projects()315 .projects()
314 .dataRetention()316 .dataRetention()
316 "proj_abc",318 "proj_abc",
317 DataRetentionUpdateParams.builder()319 DataRetentionUpdateParams.builder()
318 .retentionType(DataRetentionUpdateParams.RetentionType.ORGANIZATION_DEFAULT)320 .retentionType(DataRetentionUpdateParams.RetentionType.ORGANIZATION_DEFAULT)
319321 .build() .build());
320 );
321 322
322System.out.println(dataRetention.type());323System.out.println(dataRetention.type());
323```324```
374import com.openai.models.admin.organization.invites.Invite;375import com.openai.models.admin.organization.invites.Invite;
375import com.openai.models.admin.organization.invites.InviteCreateParams;376import com.openai.models.admin.organization.invites.InviteCreateParams;
376 377
377378Invite invite = client.admin().organization().invites().create(Invite invite =
379 client
380 .admin()
381 .organization()
382 .invites()
383 .create(
378 InviteCreateParams.builder()384 InviteCreateParams.builder()
379 .email("user@example.com")385 .email("user@example.com")
380 .role(InviteCreateParams.Role.READER)386 .role(InviteCreateParams.Role.READER)
381387 .build() .build());
382);
383 388
384System.out.println(invite.id());389System.out.println(invite.id());
385```390```
432```java437```java
433import com.openai.models.admin.organization.auditlogs.AuditLogListParams;438import com.openai.models.admin.organization.auditlogs.AuditLogListParams;
434 439
435440var page = client.admin().organization().auditLogs().list(var page =
436441 AuditLogListParams.builder() client
437442 .limit(10L) .admin()
438443 .build() .organization()
439444); .auditLogs()
445 .list(AuditLogListParams.builder().limit(10L).build());
440 446
441page.data().forEach(auditLog -> System.out.println(auditLog.id()));447page.data().forEach(auditLog -> System.out.println(auditLog.id()));
442```448```