Package-level declarations

Types

Link copied to clipboard
@Serializable
data class AdministrationDeletion(val deleted: Boolean, val id: String? = null, val objectType: String? = null)

Deletion result returned by an administration resource.

Link copied to clipboard
@Serializable
data class AdministrationPage<T>(val data: List<T>, val hasMore: Boolean, val next: String? = null, val firstId: String? = null, val lastId: String? = null, val objectType: String? = null) : List<T>

A page of administration resources with either ID cursors or a next cursor.

Link copied to clipboard
sealed interface AdministrationValue<out T>

A nullable administration field. Unspecified omits the field; Set supplies a value and Clear writes an explicit JSON null.

Link copied to clipboard
@Serializable
data class OrganizationAdminAPIKey(val id: String, val createdAt: Long, val expiresAt: Long?, val objectType: String, val owner: OrganizationAdminKeyOwner, val redactedValue: String, val lastUsedAt: Long? = null, val name: String? = null)

Administrative key metadata; retrieval does not reveal its secret.

Link copied to clipboard
@Serializable
data class OrganizationAdminAPIKeyCreation(val value: String, val id: String? = null, val createdAt: Long? = null, val expiresAt: Long? = null, val objectType: String? = null, val owner: OrganizationAdminKeyOwner? = null, val redactedValue: String? = null, val lastUsedAt: Long? = null, val name: String? = null)

An administrative key secret returned only at creation, with available key metadata.

Link copied to clipboard
@Serializable
data class OrganizationAdminAPIKeyRequest(val name: String, val expiresInSeconds: Long? = null)

Creates an administrative API key.

Link copied to clipboard
@Serializable
data class OrganizationAdminKeyOwner(val id: String? = null, val createdAt: Long? = null, val name: String? = null, val objectType: String? = null, val role: String? = null, val type: String? = null)

Administrative key ownership information.

Link copied to clipboard
@Serializable
data class OrganizationAssignedRole(val id: String, val assignmentSources: List<OrganizationRoleAssignmentSource>?, val createdAt: Long?, val createdBy: String?, val createdByUserObj: JsonObject?, val description: String?, val metadata: JsonObject?, val name: String, val permissions: List<String>, val predefinedRole: Boolean, val resourceType: String, val updatedAt: Long?)

An effective role with assignment-source and audit metadata.

Link copied to clipboard
@Serializable
data class OrganizationGroup(val id: String, val createdAt: Long, val isScimManaged: Boolean, val name: String, val groupType: String? = null)

An organization group, which may be managed by SCIM.

Link copied to clipboard
@Serializable
data class OrganizationGroupMemberRequest(val userId: String)

Adds a user to a group.

Link copied to clipboard
@Serializable
data class OrganizationGroupMembership(val groupId: String, val objectType: String, val userId: String)

Result of adding a user to a group.

Link copied to clipboard
@Serializable
data class OrganizationGroupRequest(val name: String)

Creates or renames an organization group.

Link copied to clipboard
@Serializable
data class OrganizationGroupRoleAssignment(val group: OrganizationRoleGroup, val objectType: String, val role: OrganizationRole)

Result of assigning a role to a group.

Link copied to clipboard
@Serializable
data class OrganizationGroupUser(val id: String, val email: String?, val name: String, val isServiceAccount: Boolean? = null, val picture: String? = null, val userType: String? = null)

A user listed in or retrieved from a group.

Link copied to clipboard
@Serializable
data class OrganizationInvite(val id: String, val createdAt: Long, val email: String, val objectType: String, val projects: List<OrganizationInviteProject>, val role: String, val status: String, val acceptedAt: Long? = null, val expiresAt: Long? = null)

An invitation to join an organization.

Link copied to clipboard
@Serializable
data class OrganizationInviteProject(val id: String, val role: String)

Initial project access attached to an invitation.

Link copied to clipboard
@Serializable
data class OrganizationInviteRequest(val email: String, val role: String, val projects: List<OrganizationInviteProject>? = null)

Invites an email address with organization and optional project roles.

Link copied to clipboard
@Serializable
data class OrganizationProject(val id: String, val createdAt: Long, val objectType: String, val archivedAt: Long? = null, val externalKeyId: String? = null, val name: String? = null, val residency: String? = null, val status: String? = null)

An organization project and its lifecycle settings.

Link copied to clipboard
@Serializable
data class OrganizationProjectAPIKey(val id: String, val createdAt: Long, val lastUsedAt: Long?, val name: String, val objectType: String, val owner: OrganizationProjectKeyOwner, val ownerProjectAccess: String, val redactedValue: String, val expiresAt: Long? = null)

Project key metadata, ownership and effective project access.

Link copied to clipboard
@Serializable
data class OrganizationProjectAPIKeyUpdateRequest(val expiresInSeconds: Long? = null, val scopes: List<String>? = null)

Updates a project key. Empty scopes restores all permissions; omitted fields stay unchanged.

Link copied to clipboard
@Serializable
data class OrganizationProjectGroup(val createdAt: Long, val groupId: String, val groupName: String, val groupType: String, val objectType: String, val projectId: String)

A group membership in a project.

Link copied to clipboard
@Serializable
data class OrganizationProjectGroupRequest(val groupId: String, val role: String)

Grants a group project access with the selected role.

Link copied to clipboard
@Serializable
data class OrganizationProjectKeyOwner(val type: String? = null, val serviceAccount: OrganizationProjectKeyServiceAccount? = null, val user: OrganizationProjectKeyUser? = null)

The user or service account owning a project key.

Link copied to clipboard
@Serializable
data class OrganizationProjectKeyServiceAccount(val id: String, val createdAt: Long, val name: String, val role: String)

Service-account owner details returned with a project key.

Link copied to clipboard
@Serializable
data class OrganizationProjectKeyUser(val id: String, val createdAt: Long, val email: String, val name: String, val role: String)

User owner details returned with a project key.

Link copied to clipboard
@Serializable
data class OrganizationProjectRequest(val name: String, val externalKeyId: String? = null, val geography: String? = null, val residency: String? = null)

Creates an organization project.

Link copied to clipboard
@Serializable
data class OrganizationProjectUpdateRequest(val externalKeyId: AdministrationValue<String> = AdministrationValue.Unspecified, val geography: AdministrationValue<String> = AdministrationValue.Unspecified, val name: AdministrationValue<String> = AdministrationValue.Unspecified)

Updates supplied project fields; Clear sends an explicit JSON null.

Link copied to clipboard
@Serializable
data class OrganizationProjectUser(val id: String, val addedAt: Long, val objectType: String, val role: String, val email: String? = null, val name: String? = null)

A user membership in a project.

Link copied to clipboard
@Serializable
data class OrganizationProjectUserRequest(val role: String, val email: String? = null, val userId: String? = null)

Adds a project user by user ID or email with a role.

Link copied to clipboard
@Serializable
data class OrganizationProjectUserUpdateRequest(val role: AdministrationValue<String> = AdministrationValue.Unspecified)

Updates a project user role, preserving omission versus explicit null.

Link copied to clipboard
@Serializable
data class OrganizationRole(val id: String, val description: String?, val name: String, val objectType: String, val permissions: List<String>, val predefinedRole: Boolean, val resourceType: String)

A role and its granted permissions.

Link copied to clipboard
@Serializable
data class OrganizationRoleAssignmentRequest(val roleId: String)

Assigns a role to a user or group.

Link copied to clipboard
@Serializable
data class OrganizationRoleAssignmentSource(val principalId: String, val principalType: String)

Principal responsible for an effective role assignment.

Link copied to clipboard
@Serializable
data class OrganizationRoleGroup(val id: String, val createdAt: Long, val name: String, val objectType: String, val scimManaged: Boolean)

Group summary returned with a role assignment.

Link copied to clipboard
@Serializable
data class OrganizationRoleRequest(val permissions: List<String>, val roleName: String, val description: String? = null)

Creates a role bound to an organization or project.

Link copied to clipboard
@Serializable
data class OrganizationRoleUpdateRequest(val description: AdministrationValue<String> = AdministrationValue.Unspecified, val permissions: AdministrationValue<List<String>> = AdministrationValue.Unspecified, val roleName: AdministrationValue<String> = AdministrationValue.Unspecified)

Updates only supplied role fields; Clear sends an explicit JSON null.

Link copied to clipboard
@Serializable
data class OrganizationServiceAccount(val id: String, val createdAt: Long, val name: String, val objectType: String, val role: String, val apiKey: OrganizationServiceAccountAPIKey? = null)

A project service account; creation may include a one-time API key.

Link copied to clipboard
@Serializable
data class OrganizationServiceAccountAPIKey(val id: String, val createdAt: Long, val name: String, val objectType: String, val value: String, val expiresAt: Long? = null)

A newly created service-account key. Its value is returned only at creation.

Link copied to clipboard
@Serializable
data class OrganizationServiceAccountAPIKeyRequest(val expiresInSeconds: Long? = null, val name: String? = null, val scopes: List<String>? = null)

Creates a named service-account API key with optional scopes and expiration.

Link copied to clipboard
@Serializable
data class OrganizationServiceAccountRequest(val name: String, val createServiceAccountOnly: Boolean? = null, val expiresInSeconds: Long? = null)

Creates a service account and optionally its initial API key.

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

Renames a service account or updates its project role.

Link copied to clipboard
@Serializable
data class OrganizationUser(val id: String, val addedAt: Long, val objectType: String, val apiKeyLastUsedAt: Long? = null, val created: Long? = null, val developerPersona: String? = null, val email: String? = null, val isDefault: Boolean? = null, val isScaleTierAuthorizedPurchaser: Boolean? = null, val isScimManaged: Boolean? = null, val isServiceAccount: Boolean? = null, val name: String? = null, val projects: OrganizationUserProjects? = null, val role: String? = null, val technicalLevel: String? = null, val user: OrganizationUserDetails? = null)

A user membership in an organization.

Link copied to clipboard
@Serializable
data class OrganizationUserDetails(val id: String, val objectType: String, val banned: Boolean? = null, val bannedAt: Long? = null, val email: String? = null, val enabled: Boolean? = null, val name: String? = null, val picture: String? = null)

Nested user account information.

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

A project associated with an organization user.

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

Projects returned with an organization user.

Link copied to clipboard
@Serializable
data class OrganizationUserRoleAssignment(val objectType: String, val role: OrganizationRole, val user: OrganizationUser)

Result of assigning a role to a user.

Link copied to clipboard
@Serializable
data class OrganizationUserUpdateRequest(val developerPersona: AdministrationValue<String> = AdministrationValue.Unspecified, val role: AdministrationValue<String> = AdministrationValue.Unspecified, val roleId: AdministrationValue<String> = AdministrationValue.Unspecified, val technicalLevel: AdministrationValue<String> = AdministrationValue.Unspecified)

Updates only supplied organization-user fields; Clear sends an explicit JSON null.

Link copied to clipboard
@Serializable
data class SpendAlert(val id: String, val thresholdAmount: Long, val currency: String, val interval: String, val notificationChannel: SpendAlertEmailChannel, val objectType: String)

Organization or project spend alert metadata.

Link copied to clipboard
@Serializable
data class SpendAlertDeleted(val id: String, val deleted: Boolean, val objectType: String)

Confirmation that an organization or project spend alert was deleted.

Link copied to clipboard
@Serializable
data class SpendAlertEmailChannel(val recipients: List<String>, val subjectPrefix: String? = null, val type: String = "email")

Email notification settings for a spend alert.

Link copied to clipboard
@Serializable
data class SpendAlertPage(val data: List<SpendAlert>, val hasMore: Boolean, val firstId: String? = null, val lastId: String? = null, val objectType: String = "list") : List<SpendAlert>

A complete cursor page of organization or project spend alerts.

Link copied to clipboard
@Serializable
data class SpendAlertRequest(val thresholdAmount: Long, val notificationChannel: SpendAlertEmailChannel, val currency: String = "USD", val interval: String = "month")

Creates or replaces an organization or project spend alert.

Link copied to clipboard

Builder for a complete spend alert configuration.

Link copied to clipboard
@Serializable
data class SpendLimit(val thresholdAmount: Long, val currency: String, val interval: String, val enforcement: SpendLimitEnforcement, val objectType: String)

A hard spend limit and its current enforcement state.

Link copied to clipboard
@Serializable
data class SpendLimitDeleted(val deleted: Boolean, val objectType: String)

Confirmation that an organization or project hard spend limit was deleted.

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

Enforcement state returned by the service, such as inactive or enforcing.

Link copied to clipboard
@Serializable
data class SpendLimitRequest(val thresholdAmount: Long, val currency: String = "USD", val interval: String = "month")

Creates or replaces an organization or project hard spend limit.

Link copied to clipboard

Builder for a hard spend limit replacement.

Functions

Link copied to clipboard

Creates a complete spend alert creation or replacement request.

Link copied to clipboard

Creates a complete hard spend limit replacement request.