Types API Reference

This page documents the core data types used throughout BWS SDK.

Core Types

`bws_sdk.bws_types.Region`

Bases: BaseModel

Represents a region configuration with associated API and identity service URLs.

This class defines the endpoints for a specific Bitwarden region, including the main API URL and the identity service URL used for authentication.

Attributes:

Name	Type	Description
`api_url`	`str`	The base URL for the region's API endpoint
`identity_url`	`str`	The URL for the region's identity service

Example

region = Region(
    api_url="https://api.bitwarden.com",
    identity_url="https://identity.bitwarden.com"
)

`bws_sdk.bws_types.BitwardenSecret`

Bases: BaseModel

Model representing a Bitwarden secret.

This class represents a secret stored in Bitwarden's Secrets Manager, containing both metadata and the encrypted/decrypted secret data.

Attributes:

Name	Type	Description
`id`	`str`	Unique identifier for the secret
`organizationId`	`str`	ID of the organization that owns the secret
`key`	`str`	The secret's key/name (encrypted when retrieved, decrypted after processing)
`value`	`str`	The secret's value (encrypted when retrieved, decrypted after processing)
`creationDate`	`datetime`	When the secret was created
`revisionDate`	`datetime`	When the secret was last modified

Note

The key and value fields are typically encrypted when first retrieved from the API and are automatically decrypted by the BWSecretClient before being returned to the user.