/auth-nodejs-cloudbase

name: auth-nodejs-cloudbase
description: CloudBase Node SDK auth guide for server-side identity, user lookup, and custom login tickets. This skill should be used when Node.js code must read caller identity, inspect end users, or bridge an existing user system into CloudBase; not when configuring providers or building client login UI.
version: 2.37.6
license: MIT
alwaysApply: false

Sibling skills (local only)

Sibling CloudBase skills ship beside this skill. Use local relative paths such as `../auth-tool-cloudbase/SKILL.md`.

If a referenced sibling skill file is missing from this environment, ask the user to install the full CloudBase plugin (or the missing skill). Do **not** HTTP-fetch remote skill or protocol markdown into the agent context.

Activation Contract

Use this first when

• Node.js code in cloud functions or backend services must read caller identity, look up users, or issue custom login tickets.
• The backend responsibility is auth / identity, not provider setup or frontend login UI.

Read before writing code if

• The task mentions `@cloudbase/node-sdk`, server-side auth, custom login tickets, or "who is calling".
• The request mixes frontend login with backend identity logic; split the flow and route client-side work elsewhere.

Then also read

• Provider setup / publishable key -> `../auth-tool-cloudbase/SKILL.md`
• Web login UI that consumes custom tickets -> `../auth-web-cloudbase/SKILL.md`
• Raw HTTP auth client -> `../http-api-cloudbase/SKILL.md`

Do NOT use for

• Provider enable/disable or login console configuration.
• Frontend login / sign-up UI.
• Mini program native auth.

Common mistakes / gotchas

• Using this skill as the entry point for every auth request.
• Mixing provider-management work with Node-side identity code.
• Reaching for raw HTTP examples when Node SDK already covers the job.

When to use this skill

Use this skill whenever the task involves **server-side authentication or identity** in a CloudBase project, and the code is running in **Node.js**, for example:

• CloudBase 云函数 (Node runtime) that needs to know **who is calling**
• Node services that use **CloudBase Node SDK** to look up user information
• Backends that issue **custom login tickets** for Web / mobile clients
• Admin or ops tools that need to inspect CloudBase end-user profiles

**Do NOT use this skill for:**

• Frontend Web login / sign-up flows using `@cloudbase/js-sdk` (handle those with the **auth-web** skill, not this Node skill).
• Direct HTTP auth API integrations (this skill does not describe raw HTTP endpoints; use the **http-api** skill instead).
• Database or storage operations that do not involve identity (use database/storage docs or skills).

When the user request mixes frontend and backend concerns (e.g. "build a web login page and a Node API that knows the user"), treat them separately:

• Use Web-side auth docs/skills for client login and UX.
• Use this Node Auth skill for how the backend sees and uses the authenticated user.

---

How to use this skill (for a coding agent)

When you load this skill to work on a task:

1. **Clarify the runtime and responsibility**

Ask the user:

• Where does this Node code run?
• CloudBase 云函数
• Long‑running Node service using CloudBase
• What do they need from auth?
• Just the **caller identity** for authorization?
• **Look up arbitrary users** by UID / login identifier?
• **Bridge their own user system** into CloudBase via custom login?

2. **Confirm CloudBase environment and SDK**

• Ask for:
• `env` – CloudBase environment ID
• Install the latest `@cloudbase/node-sdk` from npm if it is not already available.
• Always initialize the SDK using this pattern (values can change, shape must not):

   import tcb from "@cloudbase/node-sdk";

   const app = tcb.init({ env: "your-env-id" });
   const auth = app.auth();

3. **Pick the relevant scenario from this file**

• For **caller identity inside a function**, use the `getUserInfo` scenarios.
• For **full user profile or admin lookup**, use the `getEndUserInfo` and `queryUserInfo` scenarios.
• For **client systems that already have their own users**, use the **custom login ticket** scenarios built on `createTicket`.
• For **logging / security**, use the `getClientIP` scenario.

4. **Follow Node SDK API shapes exactly**

• Treat all `auth.*` methods and parameter shapes in this file as canonical.
• You may change variable names and framework (e.g. Express vs 云函数 handler), but **do not change SDK method names or parameter fields**.
• If you see a method in older code that is not listed here or in the Node SDK docs mirror, treat it as suspect and avoid using it.

5. **If you are unsure about an API**

• Consult the official CloudBase Auth Node SDK documentation.
• Only use methods and shapes that appear in the official documentation.
• If you cannot find an API you want:
• Prefer composing flows from the documented methods, or
• Explain that this skill only covers Node SDK auth, and suggest using the relevant CloudBase Web or HTTP auth documentation for client-side or raw-HTTP flows.

---

Node auth architecture – how Node fits into CloudBase Auth

CloudBase Auth separates **where users log in** from **where backend code runs**:

• Users log in through the supported auth methods (username/password, SMS, email, WeChat, custom login, anonymous — disabled by default, etc.) using client SDKs or HTTP interfaces, as described in the official CloudBase Auth overview documentation.
• Once logged in, CloudBase attaches the user identity and tokens to the environment.
• Node code then **reads** that identity using the Node SDK, or **bridges** external identities into CloudBase using custom login.

In practice, Node code usually does one or more of:

1. **Identify the current caller**

• In 云函数, use `auth.getUserInfo()` to read `uid`, `openId`, an