# Account

## Retrieves the current account for the token accessing the API

`client.Account.Get(ctx) (*Account, error)`

**get** `/v1/account`

Retrieves the current account for the token accessing the API. Useful to check if the credentials are valid.

### Returns

- `type Account struct{…}`

  Account is an account resource.

  - `Info AccountInfo`

    AccountInfo contains information about the account.

    - `WebhookEventsHmacSecret string`

      The generated secret that will sign all webhooks that are sent to your configured Webhook URL.
      Formatted as "wh_asdf1234" per the https://www.standardwebhooks.com/ format.

  - `Metadata AccountResourceMetadata`

    AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

    - `ID string`

      Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

    - `AccountID string`

      Account this resource belongs to for multi-tenant isolation (prefixed ULID)

    - `Name string`

      Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
      Required for resources that users interact with directly

    - `ProfileID string`

    - `ExternalID string`

      External ID for the resource (e.g., a workflow ID from an external system)

    - `Labels map[string, string]`

      Arbitrary key-value pairs for categorization and filtering
      Examples: {"environment": "production", "team": "platform", "version": "v2"}

  - `Spec AccountSpec`

    AccountSpec contains the specification for an account.

    - `BillingEmail string`

    - `Description string`

    - `Domain string`

    - `Workspaces []Workspace`

      - `Metadata AccountResourceMetadata`

        AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

      - `Spec WorkspaceSpec`

        - `Description string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cadenya/cadenya-go"
  "github.com/cadenya/cadenya-go/option"
)

func main() {
  client := cadenya.NewClient(
    option.WithAPIKey("My API Key"),
  )
  account, err := client.Account.Get(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", account.Info)
}
```

#### Response

```json
{
  "info": {
    "webhookEventsHmacSecret": "webhookEventsHmacSecret"
  },
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "name": "name",
    "profileId": "profileId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "billingEmail": "billingEmail",
    "description": "description",
    "domain": "domain",
    "workspaces": [
      {
        "metadata": {
          "id": "id",
          "accountId": "accountId",
          "name": "name",
          "profileId": "profileId",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        },
        "spec": {
          "description": "description"
        }
      }
    ]
  }
}
```

## Rotates the webhook signing key for the account

`client.Account.RotateWebhookSigningKey(ctx) (*RotateWebhookSigningKeyResponse, error)`

**post** `/v1/account/rotate_webhook_signing_key`

Rotates the webhook signing key for the account. Returns only the new key.

### Returns

- `type RotateWebhookSigningKeyResponse struct{…}`

  RotateWebhookEventsHmacSecretResponse is a response to a RotateWebhookEventsHmacSecretRequest.

  - `WebhookEventsHmacSecret string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cadenya/cadenya-go"
  "github.com/cadenya/cadenya-go/option"
)

func main() {
  client := cadenya.NewClient(
    option.WithAPIKey("My API Key"),
  )
  rotateWebhookSigningKeyResponse, err := client.Account.RotateWebhookSigningKey(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", rotateWebhookSigningKeyResponse.WebhookEventsHmacSecret)
}
```

#### Response

```json
{
  "webhookEventsHmacSecret": "webhookEventsHmacSecret"
}
```

## Domain Types

### Account

- `type Account struct{…}`

  Account is an account resource.

  - `Info AccountInfo`

    AccountInfo contains information about the account.

    - `WebhookEventsHmacSecret string`

      The generated secret that will sign all webhooks that are sent to your configured Webhook URL.
      Formatted as "wh_asdf1234" per the https://www.standardwebhooks.com/ format.

  - `Metadata AccountResourceMetadata`

    AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

    - `ID string`

      Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

    - `AccountID string`

      Account this resource belongs to for multi-tenant isolation (prefixed ULID)

    - `Name string`

      Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
      Required for resources that users interact with directly

    - `ProfileID string`

    - `ExternalID string`

      External ID for the resource (e.g., a workflow ID from an external system)

    - `Labels map[string, string]`

      Arbitrary key-value pairs for categorization and filtering
      Examples: {"environment": "production", "team": "platform", "version": "v2"}

  - `Spec AccountSpec`

    AccountSpec contains the specification for an account.

    - `BillingEmail string`

    - `Description string`

    - `Domain string`

    - `Workspaces []Workspace`

      - `Metadata AccountResourceMetadata`

        AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

      - `Spec WorkspaceSpec`

        - `Description string`

### Account Spec

- `type AccountSpec struct{…}`

  AccountSpec contains the specification for an account.

  - `BillingEmail string`

  - `Description string`

  - `Domain string`

  - `Workspaces []Workspace`

    - `Metadata AccountResourceMetadata`

      AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

      - `ID string`

        Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

      - `AccountID string`

        Account this resource belongs to for multi-tenant isolation (prefixed ULID)

      - `Name string`

        Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
        Required for resources that users interact with directly

      - `ProfileID string`

      - `ExternalID string`

        External ID for the resource (e.g., a workflow ID from an external system)

      - `Labels map[string, string]`

        Arbitrary key-value pairs for categorization and filtering
        Examples: {"environment": "production", "team": "platform", "version": "v2"}

    - `Spec WorkspaceSpec`

      - `Description string`

### Profile

- `type Profile struct{…}`

  Profile represents a human user at the account level.
  Profiles are account-scoped resources that can be associated with multiple workspaces
  through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).

  - `Metadata AccountResourceMetadata`

    AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

    - `ID string`

      Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

    - `AccountID string`

      Account this resource belongs to for multi-tenant isolation (prefixed ULID)

    - `Name string`

      Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
      Required for resources that users interact with directly

    - `ProfileID string`

    - `ExternalID string`

      External ID for the resource (e.g., a workflow ID from an external system)

    - `Labels map[string, string]`

      Arbitrary key-value pairs for categorization and filtering
      Examples: {"environment": "production", "team": "platform", "version": "v2"}

  - `Spec ProfileSpec`

    ProfileSpec contains the profile-specific fields

    - `Type ProfileSpecType`

      Type is the type of profile. User's are humans, API keys are computers. You know the deal.

      - `const ProfileSpecTypeProfileTypeUser ProfileSpecType = "PROFILE_TYPE_USER"`

      - `const ProfileSpecTypeProfileTypeAPIKey ProfileSpecType = "PROFILE_TYPE_API_KEY"`

      - `const ProfileSpecTypeProfileTypeSystem ProfileSpecType = "PROFILE_TYPE_SYSTEM"`

    - `Email string`

      Email address of the user (required, unique per account)

    - `Name string`

      Display name for the user (e.g., "Bobby Tables")

### Profile Spec

- `type ProfileSpec struct{…}`

  ProfileSpec contains the profile-specific fields

  - `Type ProfileSpecType`

    Type is the type of profile. User's are humans, API keys are computers. You know the deal.

    - `const ProfileSpecTypeProfileTypeUser ProfileSpecType = "PROFILE_TYPE_USER"`

    - `const ProfileSpecTypeProfileTypeAPIKey ProfileSpecType = "PROFILE_TYPE_API_KEY"`

    - `const ProfileSpecTypeProfileTypeSystem ProfileSpecType = "PROFILE_TYPE_SYSTEM"`

  - `Email string`

    Email address of the user (required, unique per account)

  - `Name string`

    Display name for the user (e.g., "Bobby Tables")

### Rotate Webhook Signing Key Response

- `type RotateWebhookSigningKeyResponse struct{…}`

  RotateWebhookEventsHmacSecretResponse is a response to a RotateWebhookEventsHmacSecretRequest.

  - `WebhookEventsHmacSecret string`