@1claw/openapi-spec 0.61.49 → 0.61.51

package/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "1Claw API",
-    "version": "0.61.49",
+    "version": "0.61.51",
     "description": "Secure secret management for AI agents. Provides vaults, secrets,\npolicy-based access control, agent identity, Intents API,\nsharing, billing, and audit logging. Automations (workflow_spec,\nwebhook tokens, event triggers, Assist), cloud runtimes with\ninteractive shell sessions, agent memory, and discovery.\n\n## Domains\n\n`api.1claw.co` is canonical: it is the OIDC issuer, the `aud` the API\nmints, and the first entry in `servers` — a generated client takes its\nbase URL from there, and the previous ordering pointed every SDK at the\ndomain the issuer had already left. `api.1claw.xyz` still answers and is\nstill accepted on token validation, because tokens minted before the\nmove carry it; it is never minted now.\n\nOne deliberate exception: the Shroud attestation identity token is\nrequested from GCP with `audience: https://api.1claw.xyz`, so\n`/v1/shroud/attestation` reports that as its `expected_audience`. That\nis accurate rather than stale — the audience is a verification contract\nwith anyone already checking the token, and moving it is a breaking\nchange for them, not a rename.\n\nAll endpoints require JWT Bearer authentication unless marked with\n`security: []`.\n",
     "contact": {
       "email": "ops@1claw.co"
@@ -7026,6 +7026,38 @@
         }
       }
     },
+    "/v1/referrals/me": {
+      "get": {
+        "tags": [
+          "Organization"
+        ],
+        "summary": "Your own referral link and signups",
+        "description": "The caller's referral code, the link to share, how many signups it has\nproduced, and a recent list.\n\nUsers only — a referral link belongs to a person, so an agent principal\ngets 403.\n\nThe link's host comes from the brand the request arrived on, the same\nway the SIWE domain and the WebAuthn rpId do: someone on 1claw.co must\nnot be handed a 1claw.xyz link to post.\n\n`recent[].referred_hint` is masked (`a**@example.com`) — enough to\nrecognise someone you did invite, not enough to contact someone you did\nnot. Neither the referred address nor its user id is returned.\n",
+        "operationId": "getMyReferrals",
+        "responses": {
+          "200": {
+            "description": "The caller's referral code, link and signup count",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MyReferralsResponse"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "The caller is an agent, not a person.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/onboarding/provision": {
       "post": {
         "tags": [
@@ -18334,7 +18366,7 @@
           "OAuth"
         ],
         "summary": "Get authenticated user info (OIDC UserInfo)",
-        "description": "Standard OIDC UserInfo endpoint. Returns claims about the authenticated user\nbased on the granted scopes.\n",
+        "description": "Standard OIDC UserInfo endpoint. Returns claims about the authenticated user\nbased on the granted scopes.\n\nScopes: `profile` for `name`, `email` for `email`, `wallet` for\n`wallet_address`, and `referral` for `referral_code` and `referral_link`.\nA non-OAuth user token sees every field, since it is the user's own data.\n\n`referral` is separate from `profile` deliberately: a referral code is\nsomething the holder is asked to spread, so an app has to request it by name\nand the consent screen names it.\n",
         "operationId": "getOAuthUserInfo",
         "security": [
           {
@@ -32924,6 +32956,63 @@
       }
     },
     "schemas": {
+      "MyReferralsResponse": {
+        "type": "object",
+        "required": [
+          "code",
+          "link",
+          "total",
+          "recent"
+        ],
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "The caller's referral code, created on first read.",
+            "example": "7f3a9c2b"
+          },
+          "link": {
+            "type": "string",
+            "format": "uri",
+            "description": "The URL to share, built for the brand the request arrived on.",
+            "example": "https://1claw.co/?ref=7f3a9c2b"
+          },
+          "total": {
+            "type": "integer",
+            "format": "int64",
+            "description": "Countable signups attributed to this code."
+          },
+          "recent": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ReferralRow"
+            }
+          }
+        }
+      },
+      "ReferralRow": {
+        "type": "object",
+        "required": [
+          "signup_method",
+          "created_at"
+        ],
+        "properties": {
+          "signup_method": {
+            "type": "string",
+            "description": "How the referred person signed up.",
+            "example": "email_otp"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "referred_hint": {
+            "type": "string",
+            "nullable": true,
+            "description": "Masked address — first character, then the domain.",
+            "example": "a**@example.com"
+          }
+        }
+      },
       "OtelTopology": {
         "type": "object",
         "required": [
@@ -43897,6 +43986,22 @@
               "string",
               "null"
             ]
+          },
+          "referral_code": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The user's referral code, returned only under the `referral` scope.\nMinted on first read, so a user signing in to a partner site for the\nfirst time still gets one.\n",
+            "example": "7f3a9c2b"
+          },
+          "referral_link": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The same code as a shareable URL, built for the brand the request\narrived on — returned so a host app never has to assemble it and pick\nthe wrong domain.\n",
+            "example": "https://1claw.co/?ref=7f3a9c2b"
           }
         }
       },

package/openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.1.0
 
 info:
     title: 1Claw API
-    version: "0.61.49"
+    version: "0.61.51"
     description: |
         Secure secret management for AI agents. Provides vaults, secrets,
         policy-based access control, agent identity, Intents API,
@@ -4530,6 +4530,39 @@ paths:
                             schema:
                                 $ref: "#/components/schemas/OnboardingStatus"
 
+    /v1/referrals/me:
+        get:
+            tags: [Organization]
+            summary: Your own referral link and signups
+            description: |
+                The caller's referral code, the link to share, how many signups it has
+                produced, and a recent list.
+
+                Users only — a referral link belongs to a person, so an agent principal
+                gets 403.
+
+                The link's host comes from the brand the request arrived on, the same
+                way the SIWE domain and the WebAuthn rpId do: someone on 1claw.co must
+                not be handed a 1claw.xyz link to post.
+
+                `recent[].referred_hint` is masked (`a**@example.com`) — enough to
+                recognise someone you did invite, not enough to contact someone you did
+                not. Neither the referred address nor its user id is returned.
+            operationId: getMyReferrals
+            responses:
+                "200":
+                    description: The caller's referral code, link and signup count
+                    content:
+                        application/json:
+                            schema:
+                                $ref: "#/components/schemas/MyReferralsResponse"
+                "403":
+                    description: The caller is an agent, not a person.
+                    content:
+                        application/json:
+                            schema:
+                                $ref: "#/components/schemas/ProblemDetails"
+
     /v1/onboarding/provision:
         post:
             tags: [Organization]
@@ -11699,6 +11732,14 @@ paths:
             description: |
                 Standard OIDC UserInfo endpoint. Returns claims about the authenticated user
                 based on the granted scopes.
+
+                Scopes: `profile` for `name`, `email` for `email`, `wallet` for
+                `wallet_address`, and `referral` for `referral_code` and `referral_link`.
+                A non-OAuth user token sees every field, since it is the user's own data.
+
+                `referral` is separate from `profile` deliberately: a referral code is
+                something the holder is asked to spread, so an app has to request it by name
+                and the consent screen names it.
             operationId: getOAuthUserInfo
             security:
                 - BearerAuth: []
@@ -21113,6 +21154,43 @@ components:
                         $ref: "#/components/schemas/ProblemDetails"
 
     schemas:
+        MyReferralsResponse:
+            type: object
+            required: [code, link, total, recent]
+            properties:
+                code:
+                    type: string
+                    description: The caller's referral code, created on first read.
+                    example: 7f3a9c2b
+                link:
+                    type: string
+                    format: uri
+                    description: The URL to share, built for the brand the request arrived on.
+                    example: https://1claw.co/?ref=7f3a9c2b
+                total:
+                    type: integer
+                    format: int64
+                    description: Countable signups attributed to this code.
+                recent:
+                    type: array
+                    items:
+                        $ref: "#/components/schemas/ReferralRow"
+        ReferralRow:
+            type: object
+            required: [signup_method, created_at]
+            properties:
+                signup_method:
+                    type: string
+                    description: How the referred person signed up.
+                    example: email_otp
+                created_at:
+                    type: string
+                    format: date-time
+                referred_hint:
+                    type: string
+                    nullable: true
+                    description: Masked address — first character, then the domain.
+                    example: a**@example.com
         OtelTopology:
             type: object
             required: [nodes, edges, truncated, total_nodes]
@@ -28147,6 +28225,20 @@ components:
                     type: [string, "null"]
                 wallet_address:
                     type: [string, "null"]
+                referral_code:
+                    type: [string, "null"]
+                    description: |
+                        The user's referral code, returned only under the `referral` scope.
+                        Minted on first read, so a user signing in to a partner site for the
+                        first time still gets one.
+                    example: 7f3a9c2b
+                referral_link:
+                    type: [string, "null"]
+                    description: |
+                        The same code as a shareable URL, built for the brand the request
+                        arrived on — returned so a host app never has to assemble it and pick
+                        the wrong domain.
+                    example: https://1claw.co/?ref=7f3a9c2b
 
         # --- Spend Policies ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1claw/openapi-spec",
-  "version": "0.61.49",
+  "version": "0.61.51",
   "description": "OpenAPI 3.1.0 specification for the 1Claw Vault API \u2014 generate clients in any language",
   "license": "MIT",
   "repository": {