Package-level declarations

Types

Link copied to clipboard
@Serializable(with = AuditLogSerializer::class)
data class AuditLog(val id: String, val effectiveAt: Long, val type: String, val actor: AuditLogActor? = null, val project: AuditLogProject? = null, val rawData: JsonObject = JsonObject(emptyMap()))

One audit event with typed common fields and its complete original JSON payload.

Link copied to clipboard
@Serializable
data class AuditLogActor(val type: String? = null, val apiKey: AuditLogApiKeyActor? = null, val session: AuditLogSessionActor? = null)

Actor information common to audit event variants.

Link copied to clipboard
@Serializable
data class AuditLogApiKeyActor(val id: String? = null, val type: String? = null, val user: AuditLogUser? = null, val serviceAccount: AuditLogServiceAccount? = null)

API-key actor metadata.

Link copied to clipboard
@Serializable
data class AuditLogProject(val id: String? = null, val name: String? = null)

Project details associated with an audit event.

Link copied to clipboard
data class AuditLogQuery(val actorEmails: List<String>? = null, val actorIds: List<String>? = null, val after: String? = null, val before: String? = null, val effectiveAt: AuditLogTimeRange? = null, val eventTypes: List<String>? = null, val limit: Int? = null, val projectIds: List<String>? = null, val resourceIds: List<String>? = null, val tenantOnly: Boolean? = null)

Audit-log filters and cursor controls. Null fields leave the server's defaults unchanged.

Link copied to clipboard
@Serializable
data class AuditLogServiceAccount(val id: String? = null)

Service-account details returned with an audit actor.

Link copied to clipboard
@Serializable
data class AuditLogSessionActor(val ipAddress: String? = null, val user: AuditLogUser? = null)

User-session actor metadata.

Link copied to clipboard
data class AuditLogTimeRange(val gt: Long? = null, val gte: Long? = null, val lt: Long? = null, val lte: Long? = null)

Inclusive or exclusive event-time boundaries, in Unix seconds.

Link copied to clipboard
@Serializable
data class AuditLogUser(val id: String? = null, val email: String? = null)

User details returned with an audit actor.

Link copied to clipboard
@Serializable
data class CertificateActivationRequest(val certificateIds: List<String>)

Atomically activates or deactivates one to ten certificates at a scope.

Link copied to clipboard
@Serializable
data class CertificateActivationResult(val data: List<OrganizationCertificate>, val objectType: String)

Activation/deactivation result, preserving its scope-specific response envelope.

Link copied to clipboard
@Serializable
data class CertificateDeletion(val id: String, val objectType: String = "certificate.deleted")

Confirms deletion of a certificate; this endpoint does not return a deleted boolean.

Link copied to clipboard
@Serializable
data class CertificateDetails(val content: String? = null, val expiresAt: Long? = null, val validAt: Long? = null)

Available certificate content and validity information.

Link copied to clipboard
data class CertificateListQuery(val after: String? = null, val limit: Int? = null, val order: SortOrder? = null)

Certificate-list pagination and ordering.

Link copied to clipboard
@Serializable
data class CertificateUpdateRequest(val name: String? = null)

Updates the certificate name when supplied.

Link copied to clipboard
@Serializable
data class CertificateUploadRequest(val certificate: String, val name: String? = null)

Uploads PEM content without activating the certificate.

Link copied to clipboard
@Serializable
data class DataRetentionSetting(val objectType: String, val type: String)

Current organization or project retention setting.

Link copied to clipboard
@Serializable
data class ExternalKey(val id: String, val apiProjectIds: List<String>, val createdAt: Long, val name: String, val objectType: String, val type: String, val workspaceId: String, val audience: String? = null, val externalId: String? = null, val keyName: String? = null, val keyVersion: String? = null, val kmsArn: String? = null, val kmsKeyLocation: String? = null, val kmsKeyName: String? = null, val kmsKeyRingName: String? = null, val kmsKeyVersion: String? = null, val kmsProjectId: String? = null, val purpose: String? = null, val roleArn: String? = null, val tenantId: String? = null, val vaultUri: String? = null, val workloadIdentityPoolId: String? = null, val workloadIdentityProjectNumber: String? = null, val workloadIdentityProviderId: String? = null)

Registered customer-managed key configuration and provider metadata.

Link copied to clipboard
data class ExternalKeyListQuery(val after: String? = null, val limit: Int? = null, val order: SortOrder? = null, val purpose: String? = null)

External-key registration filters and pagination.

Link copied to clipboard
@Serializable
sealed interface ExternalKeyRequest

Provider-specific customer-managed key registration.

Link copied to clipboard
@Serializable
data class ExternalKeyValidation(val status: String)

Validation status returned by an external-key validation request.

Link copied to clipboard
@Serializable
data class ExternalStorageConfiguration(val id: String, val createdAt: Long, val geography: String, val projectId: String, val provider: ExternalStorageProvider, val status: String, val objectType: String = "organization.external_storage")

Registered external storage with validation state and provider metadata.

Link copied to clipboard
@Serializable
data class ExternalStorageDeletion(val id: String, val deleted: Boolean, val objectType: String = "organization.external_storage.deleted")

External-storage deletion confirmation.

Link copied to clipboard
data class ExternalStorageListQuery(val after: String? = null, val limit: Int? = null, val order: SortOrder? = null, val projectId: String? = null)

External-storage registration filters and pagination.

Link copied to clipboard
@Serializable
sealed interface ExternalStorageProvider

Resolved provider metadata returned by the API.

Link copied to clipboard
@Serializable
sealed interface ExternalStorageProviderRequest

Provider-specific registration parameters.

Link copied to clipboard
@Serializable
data class ExternalStorageRequest(val projectId: String, val provider: ExternalStorageProviderRequest)

Registers a customer-managed storage configuration for a project.

Link copied to clipboard

Hosted tools with independently configurable project permissions.

Link copied to clipboard
@Serializable
data class HostedToolPermission(val enabled: Boolean)

Enablement state of one hosted tool.

Link copied to clipboard

Whether a model policy allows or denies the listed models.

Link copied to clipboard
@Serializable
data class OrganizationCertificate(val id: String, val certificateDetails: CertificateDetails, val createdAt: Long, val name: String? = null, val objectType: String = "certificate", val active: Boolean? = null)

An organization certificate, optionally annotated with its activation state at a scope.

Link copied to clipboard
@Serializable
data class OrganizationRetentionRequest(val retentionType: OrganizationRetentionType)

Updates organization retention controls.

Link copied to clipboard

Organization retention policies supported by the API.

Link copied to clipboard
@Serializable
data class ProjectHostedToolPermissions(val codeInterpreter: HostedToolPermission, val fileSearch: HostedToolPermission, val imageGeneration: HostedToolPermission, val mcp: HostedToolPermission, val webSearch: HostedToolPermission)

Current hosted-tool permissions for a project.

Link copied to clipboard
data class ProjectHostedToolPermissionsRequest(val codeInterpreter: HostedToolPermission? = null, val fileSearch: HostedToolPermission? = null, val imageGeneration: HostedToolPermission? = null, val mcp: HostedToolPermission? = null, val webSearch: HostedToolPermission? = null, val nullFields: Set<HostedTool> = emptySet())

Updates supplied tool states; nullFields explicitly sends JSON null for selected tools.

Link copied to clipboard
@Serializable
data class ProjectModelPermissions(val mode: ModelPermissionMode, val modelIds: List<String>, val objectType: String = "project.model_permissions")

A project's explicit model permission policy.

Link copied to clipboard
@Serializable
data class ProjectModelPermissionsDeletion(val deleted: Boolean, val objectType: String = "project.model_permissions.deleted")

Model-policy deletion confirmation.

Link copied to clipboard
@Serializable
data class ProjectModelPermissionsRequest(val mode: ModelPermissionMode, val modelIds: List<String>)

Replaces a project's explicit model permission policy.

Link copied to clipboard
@Serializable
data class ProjectRateLimit(val id: String, val maxRequestsPerMinute: Long, val maxTokensPerMinute: Long, val model: String, val objectType: String = "project.rate_limit", val batchInputTokensPerDay: Long? = null, val maxAudioMegabytesPerMinute: Long? = null, val maxImagesPerMinute: Long? = null, val maxRequestsPerDay: Long? = null)

Per-model rate limit returned for a project.

Link copied to clipboard
data class ProjectRateLimitQuery(val after: String? = null, val before: String? = null, val limit: Int? = null)

Project rate-limit cursor controls.

Link copied to clipboard
@Serializable
data class ProjectRateLimitRequest(val maxRequestsPerMinute: Long? = null, val maxTokensPerMinute: Long? = null, val batchInputTokensPerDay: Long? = null, val maxAudioMegabytesPerMinute: Long? = null, val maxImagesPerMinute: Long? = null, val maxRequestsPerDay: Long? = null)

Updates only supplied project rate-limit values.

Link copied to clipboard
@Serializable
data class ProjectRetentionRequest(val retentionType: ProjectRetentionType)

Updates project retention controls.

Link copied to clipboard

Project retention policies, including inheritance and no retention override.