# Account

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

`$ cadenya account retrieve`

**get** `/v1/account`

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

### Returns

- `account: object { info, metadata, spec }`

  Account is an account resource.

  - `info: object { webhookEventsHmacSecret }`

    AccountInfo contains information about the account.

    - `webhookEventsHmacSecret: optional 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: object { id, accountId, name, 3 more }`

    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: optional string`

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

    - `labels: optional map[string]`

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

  - `spec: object { billingEmail, description, domain, workspaces }`

    AccountSpec contains the specification for an account.

    - `billingEmail: optional string`

    - `description: optional string`

    - `domain: optional string`

    - `workspaces: optional array of Workspace`

      - `metadata: object { id, accountId, name, 3 more }`

        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: optional string`

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

        - `labels: optional map[string]`

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

      - `spec: object { description }`

        - `description: optional string`

### Example

```cli
cadenya account retrieve \
  --api-key 'My API Key'
```

#### 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

`$ cadenya account rotate-webhook-signing-key`

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

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

### Returns

- `rotate_webhook_signing_key_response: object { webhookEventsHmacSecret }`

  RotateWebhookEventsHmacSecretResponse is a response to a RotateWebhookEventsHmacSecretRequest.

  - `webhookEventsHmacSecret: optional string`

### Example

```cli
cadenya account rotate-webhook-signing-key \
  --api-key 'My API Key'
```

#### Response

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

## Domain Types

### Account

- `account: object { info, metadata, spec }`

  Account is an account resource.

  - `info: object { webhookEventsHmacSecret }`

    AccountInfo contains information about the account.

    - `webhookEventsHmacSecret: optional 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: object { id, accountId, name, 3 more }`

    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: optional string`

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

    - `labels: optional map[string]`

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

  - `spec: object { billingEmail, description, domain, workspaces }`

    AccountSpec contains the specification for an account.

    - `billingEmail: optional string`

    - `description: optional string`

    - `domain: optional string`

    - `workspaces: optional array of Workspace`

      - `metadata: object { id, accountId, name, 3 more }`

        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: optional string`

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

        - `labels: optional map[string]`

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

      - `spec: object { description }`

        - `description: optional string`

### Account Spec

- `account_spec: object { billingEmail, description, domain, workspaces }`

  AccountSpec contains the specification for an account.

  - `billingEmail: optional string`

  - `description: optional string`

  - `domain: optional string`

  - `workspaces: optional array of Workspace`

    - `metadata: object { id, accountId, name, 3 more }`

      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: optional string`

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

      - `labels: optional map[string]`

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

    - `spec: object { description }`

      - `description: optional string`

### Profile

- `profile: object { metadata, spec }`

  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: object { id, accountId, name, 3 more }`

    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: optional string`

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

    - `labels: optional map[string]`

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

  - `spec: object { type, email, name }`

    ProfileSpec contains the profile-specific fields

    - `type: "PROFILE_TYPE_USER" or "PROFILE_TYPE_API_KEY" or "PROFILE_TYPE_SYSTEM"`

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

      - `"PROFILE_TYPE_USER"`

      - `"PROFILE_TYPE_API_KEY"`

      - `"PROFILE_TYPE_SYSTEM"`

    - `email: optional string`

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

    - `name: optional string`

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

### Profile Spec

- `profile_spec: object { type, email, name }`

  ProfileSpec contains the profile-specific fields

  - `type: "PROFILE_TYPE_USER" or "PROFILE_TYPE_API_KEY" or "PROFILE_TYPE_SYSTEM"`

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

    - `"PROFILE_TYPE_USER"`

    - `"PROFILE_TYPE_API_KEY"`

    - `"PROFILE_TYPE_SYSTEM"`

  - `email: optional string`

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

  - `name: optional string`

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

### Rotate Webhook Signing Key Response

- `rotate_webhook_signing_key_response: object { webhookEventsHmacSecret }`

  RotateWebhookEventsHmacSecretResponse is a response to a RotateWebhookEventsHmacSecretRequest.

  - `webhookEventsHmacSecret: optional string`