
cloud-onboarding
Onboard an Elastic Cloud organization: configure the elastic CLI's Cloud context and API key, establish a default region, then invite users, assign predefined or custom Serverless project roles, and create or revoke Cloud API keys. Use when setting up Cloud authentication or when granting, modifying, or auditing user access to an organization and its projects.
- Installs
- 1K
- Last 24h
- +20
- Trending rank
- #5892
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/elastic/agent-skills --skill cloud-onboarding- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads cloud-onboarding automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
Cloud Onboarding
Stand up access to an Elastic Cloud organization end to end: configure the elastic CLI so it can operate the control
plane, then manage identity and access — invite users, assign predefined or custom roles to Serverless projects, and
manage Cloud API keys. For creating and operating projects and deployments, use the cloud-provisioning skill.
Environment Configuration
This skill configures the elastic CLI itself, so its setup lives here rather than being assumed. If the
elastic CLI is not installed, tell the user what it is needed for.
Cloud control-plane access is authenticated by an Elastic Cloud API key (organization scope), stored in a CLI context. Register it without ever having the user paste the secret into the chat:
- Only Organization owners can create Cloud API keys. Direct the user to generate one at Elastic Cloud API keys with Project Admin privileges or higher so it can manage serverless projects.
- If the user has no Elastic Cloud account, propose the free Elastic Cloud trial (14 days, no credit card). Once registered, continue with key generation.
- Add the key to a context (the secret is stored in the OS keychain, not echoed):
elastic config context add cloud --cloud-url https://api.elastic-cloud.com --cloud-api-key <KEY>, then make it active withelastic config current-context set cloud.
Do not guess credentials, bypass the CLI to call the HTTP API directly, or ask the user to reveal the key. This skill
references control-plane operations in HTTP-shorthand form with the cloud: prefix (for example,
GET cloud:/api/v1/organizations); the Operations table maps each to the equivalent elastic cloud
command.
For detailed API schemas (role assignments, Cloud API keys, custom roles), see references/api-reference.md. For Elasticsearch-level role management beyond Cloud roles (native users, role mappings, DLS/FLS) see elasticsearch-authz.
Jobs to be done
- Configure and validate a Cloud context; establish a default region for later project creation
- Invite a user and assign a Serverless project role; list members and their roles; update or remove access
- Create, list, and revoke Cloud API keys, optionally with Elasticsearch/Kibana API access on projects
- Create a custom role in a Serverless project and assign it via the Cloud API's
application_roles - Translate a natural-language access request into invite, role, and API key tasks
Process: validate the environment
-
Validate the Cloud context. Confirm the active context can reach the control plane by calling
GET cloud:/api/v1/organizations. A successful response lists the organizations the key belongs to and yields the organization ID other steps need. If it returns an authentication error, the context is missing or the key is invalid or expired — return to Environment Configuration and register a valid key. Do not proceed until validation succeeds, and never ask the user for the organization ID — discover it here. -
Establish a default region (optional). When the user plans to create projects, list the available regions with
GET cloud:/api/v1/serverless/regionsand confirm a default. Default togcp-us-central1unless the user requests otherwise; only regions withproject_creation_enabled: trueaccept new projects. Region choice is permanent per project, so surface it early.
Permissions
This skill does not pre-check roles; it attempts the operation and lets the API enforce authorization. On a 403, stop
and ask the user to verify the API key's permissions.
| Operation | Required permission |
|---|---|
| Invite / remove members | Organization owner (organization-admin) |
| Assign or remove roles | Organization owner (organization-admin) |
| Create / revoke Cloud API keys | Organization owner (organization-admin) |
| List members, invitations, or keys | Any organization member |
| Create / delete custom roles | manage_security cluster privilege on the project ES endpoint |
Predefined roles
Prefer predefined roles; only create a custom role when they lack the required granularity.
Organization: organization-admin (full admin), billing-admin (billing only).
Serverless project roles (assign at invitation or via role-assignment update):
| Role | role_id | Available on |
|---|---|---|
| Admin | admin | Search, Obs, Security |
| Developer | developer | Search |
| Viewer | viewer | Search, Obs, Security |
| Editor | editor | Obs, Security |
| Analysts | t1_analyst, t2_analyst, t3_analyst, soc_manager, rule_author | Security |
See references/api-reference.md for the full role_assignments schema (organization,
deployment, and project scopes) and the complete Security role list.
Process: decompose an access request
When the user describes access in natural language (for example, "add Alice to my search project as a developer"), break it down before executing.
-
Identify components. Who (new invite vs existing member), what (which project or org-level), access level (predefined vs custom role), and whether an API key is also needed.
-
Check existing state first. List members with
GET cloud:/api/v1/organizations/{org_id}/membersand, for key requests, existing keys withGET cloud:/api/v1/users/auth/keys. If the user is already a member, update their roles instead of inviting. If an active key already exists for the same purpose with the right roles and enough remaining lifetime, reuse it. -
Execute the smallest sufficient change.
- Invite a new member with
POST cloud:/api/v1/organizations/{org_id}/invitations(include project role assignments, or invite without roles when a custom role will follow). - Update an existing member's roles with
POST cloud:/api/v1/users/{user_id}/role_assignments; remove with theDELETEvariant. - Remove a member with
DELETE cloud:/api/v1/organizations/{org_id}/members/{user_ids}(confirm first). - Create a Cloud API key with
POST cloud:/api/v1/users/auth/keys; revoke withDELETE cloud:/api/v1/users/auth/keys(confirm first). Confirm destructive actions (remove member, revoke key) with the user before executing.
- Invite a new member with
-
Verify. List members or keys again to confirm the change took effect.
Custom roles (Serverless)
When predefined roles lack the granularity, create a custom role in the project via the Elasticsearch security API and
assign it through the Cloud API's application_roles:
- Create the role in the project with
PUT /_security/role/{name}(runs against the project's Elasticsearch endpoint; requiresmanage_security). Role names must start with a letter or digit and contain only letters, digits,_,-,.. Run-as privileges are not available in Serverless. - Invite the user if needed — without project role assignments (the custom role handles project access).
- Assign the custom role by setting
application_roleson a project-scoped role assignment (POST cloud:/api/v1/users/{user_id}/role_assignments) withrole_idset to the project-type viewer (elasticsearch-viewer,observability-viewer,security-viewer).
Do not also assign a predefined Cloud role for the same project. A custom role already grants Viewer-level Cloud access; adding
viewer(or another predefined role) gives the user the union of both, widening access beyond what the custom role intends.
Cloud API keys with stack access
Cloud API keys can also call Elasticsearch and Kibana APIs on Serverless projects by including application_roles in
their role_assignments. Unlike users, API keys never inherit stack roles from role_id — without
application_roles the key has Cloud-API-only access and receives 403 on ES/Kibana calls.
- Default to project-scoped assignments (
projectkey) so the key only reaches named projects or all projects of a type. - Organization-scoped assignments (
organizationkey) grant ES/Kibana access to all current and future projects — the broadest data-plane scope. Only use it for genuine cross-project automation, and confirm with the user first. - Custom role names in
application_rolesmust exist in each target project, or the key silently gets no access there. Predefined roles (admin,developer,viewer) exist in every project by default.
Examples
"Set up my cloud environment" — verify a Cloud context exists, then validate it with
GET cloud:/api/v1/organizations. If it fails, walk the user through generating an Organization-level Cloud API key and
registering it as a context (never in chat), then re-validate and report the discovered organization.
"Set up cloud in the EU region" — after validating the context, list regions with
GET cloud:/api/v1/serverless/regions, pick an EU region (for example aws-eu-west-1), and confirm it as the default
for subsequent project creation.
"Add alice@example.com to my search project with read-only access" — check members with
GET cloud:/api/v1/organizations/{org_id}/members; if Alice is new,
POST cloud:/api/v1/organizations/{org_id}/invitations with a project-scoped viewer role for the Elasticsearch
project.
"Create a 30-day CI key that can index into our search projects" — list keys with
GET cloud:/api/v1/users/auth/keys to avoid duplicates, then POST cloud:/api/v1/users/auth/keys with a project-scoped
developer role assignment including application_roles: ["developer"] and expiration: "30d". The secret is shown
once — never repeat it in chat.
"Give bob@example.com read-only access to marketing-* on my search project" — create a custom role with
PUT /_security/role/marketing-reader (read on marketing-*), invite Bob without project roles, then assign the custom
role via application_roles on POST cloud:/api/v1/users/{user_id}/role_assignments. Do not also assign viewer.
"Show who has access to my organization" — GET cloud:/api/v1/organizations/{org_id}/members and present each
member's ID, email, and roles.
Guidelines
- Validate the Cloud context first; discover the organization ID from
GET cloud:/api/v1/organizations— do not ask for it. - Never receive, echo, or log credentials in chat. Register the Cloud API key into a CLI context so the secret goes to the OS keychain; if the user offers to paste a key, decline and point them to context registration instead. A created key's secret is shown only once — tell the user to store it securely; never repeat it.
- Default region is
gcp-us-central1— only change it when the user requests a different region. - Confirm destructive actions (remove member, revoke key) before executing.
- Prefer predefined roles; reach for custom roles only when needed, and never stack a predefined Cloud role on the same project as a custom role.
- API key hygiene: check existing keys before creating; set an
expirationmatching the task lifetime; prompt the user to revoke keys no longer needed. Each organization supports up to 500 active keys; default expiration is 3 months. Invitations expire after 72 hours by default. Cloud API keys inherit roles at creation and cannot be updated — revoke and recreate to change roles. - For creating and operating projects, traffic filters, and deployments, see cloud-provisioning; for ES-level role management see elasticsearch-authz.
Operations
| HTTP API (shorthand) | elastic CLI command |
|---|---|
GET cloud:/api/v1/organizations | elastic cloud orgs list-organizations |
GET cloud:/api/v1/serverless/regions | elastic cloud serverless regions list-regions |
GET cloud:/api/v1/organizations/{org_id}/members | elastic cloud orgs list-organization-members --organization-id <org_id> |
POST cloud:/api/v1/organizations/{org_id}/invitations | elastic cloud orgs create-organization-invitations --organization-id <org_id> --input-file <json> |
GET cloud:/api/v1/organizations/{org_id}/invitations | elastic cloud orgs list-organization-invitations --organization-id <org_id> |
DELETE cloud:/api/v1/organizations/{org_id}/invitations/{tokens} | elastic cloud orgs delete-organization-invitations --organization-id <org_id> --invitation-tokens <csv> |
DELETE cloud:/api/v1/organizations/{org_id}/members/{user_ids} | elastic cloud orgs delete-organization-memberships --organization-id <org_id> --user-ids <csv> |
POST cloud:/api/v1/users/{user_id}/role_assignments | elastic cloud users add-role-assignments --user-id <user_id> --input-file <json> |
DELETE cloud:/api/v1/users/{user_id}/role_assignments | elastic cloud users remove-role-assignments --user-id <user_id> --input-file <json> |
POST cloud:/api/v1/users/auth/keys | elastic cloud auth create-api-key --input-file <json> |
GET cloud:/api/v1/users/auth/keys | elastic cloud auth get-api-keys |
DELETE cloud:/api/v1/users/auth/keys | elastic cloud auth delete-api-keys --input-file <json> |
PUT /_security/role/{name} | elastic es security put-role --name <name> --input-file <json> |
GET /_security/role | elastic es security get-role |
DELETE /_security/role/{name} | elastic es security delete-role --name <name> |
FAQ
What does the cloud-onboarding skill do?
Onboard an Elastic Cloud organization: configure the elastic CLI's Cloud context and API key, establish a default region, then invite users, assign predefined or custom Serverless project roles, and create or revoke Cloud API keys. Use when setting up Cloud authentication or when granting, modifying, or auditing user access to an organization and its projects.
How do I install cloud-onboarding?
Run npx skills add https://github.com/elastic/agent-skills --skill cloud-onboarding in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/cloud-onboarding/ (personal) or .claude/skills/cloud-onboarding/ (project).
Which AI agents can use cloud-onboarding?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is cloud-onboarding safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains cloud-onboarding?
It is published by elastic in elastic/agent-skills. It has 1,024 recorded installs.
More from elastic/agent-skills
elasticsearch-esql
elastic/agent-skills
Execute ESQL (Elasticsearch Query Language) queries, use when the user wants to query Elasticsearch data, analyze logs, aggregate metrics, explore data, or create charts and dashboards from ESQL results.
elasticsearch-onboarding
elastic/agent-skills
Help developers new to Elasticsearch get from zero to a working search experience. Guide them through understanding their intent, mapping their data, and building a search experience with best practices baked in. Use this when the user shows intent to build search-related functionality, asks about Elasticsearch-related concepts for their use case, or expresses the need for help getting started with Elasticsearch.
kibana-dashboards
elastic/agent-skills
Create and manage Kibana Dashboards and Lens visualizations. Use when you need to define dashboards and visualizations declaratively, version control them, or automate their deployment.
security-case-management
elastic/agent-skills
Create, search, update, and manage SOC cases via the Kibana Cases API. Use when tracking incidents, linking alerts to cases, adding investigation notes, or managing triage output.
kibana-alerting-rules
elastic/agent-skills
Create and manage Kibana alerting rules. Use when creating, updating, or managing rule lifecycle (enable, disable, mute, snooze), choosing metric threshold rule types and params, or read-only find/list with tag filters.
kibana-agent-builder
elastic/agent-skills
Create and manage Kibana Agent Builder agents and custom tools. Use when asked to create, update, delete, test, or inspect agents or tools in Agent Builder, or when the user wants to understand what agents or tools already exist.
Popular backend & apis skills
find-skills
vercel-labs/skills
Helps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skill should be used when the user is looking for functionality that might exist as an installable skill.
entra-app-registration
microsoft/azure-skills
Guides Microsoft Entra ID app registration, OAuth 2.0 authentication, and MSAL integration. USE FOR: create app registration, register Azure AD app, configure OAuth, set up authentication, add API permissions, generate service principal, MSAL example, console app auth, Entra ID setup, Azure AD authentication. DO NOT USE FOR: Key Vault secrets (use azure-keyvault-expiration-audit), general Azure resource security guidance.
google-agents-cli-adk-code
google/agents-cli
This skill should be used when the user wants to "write agent code", "build an agent with ADK", "add a tool", "create a callback", "define an agent", "use state management" — in a project that needs ADK (Agent Development Kit) API patterns and code examples. It provides a quick reference for agent types, tool definitions, orchestration patterns, callbacks, state management, the graph Workflow API, and reference recipes to study. Do NOT use for scaffolding (use google-agents-cli-scaffold) or deployment (use google-agents-cli-deploy).
embedded-captions
heygen-com/hyperframes
Add captions or subtitles to an existing single-subject talking-head video without editing the footage. Use for plain verbatim captions, cinematic captions embedded behind the subject, VFX captions, “炸/特效/酷炫字幕,” or a named identity from the 35-style catalog. Route by visual identity, not by backend engine. The quiet anchor rail is the default; embed every word only when the user explicitly wants a fully cinematic treatment. The workflow runs locally end to end, including transcription and subject matting; split multi-shot footage before applying it.
entra-agent-id
microsoft/azure-skills
Provision Microsoft Entra Agent Identity Blueprints, BlueprintPrincipals, and per-instance Agent Identities via Microsoft Graph, and configure OAuth 2.0 token exchange (fmipath, OBO, cross-tenant) including the Microsoft Entra SDK for AgentID sidecar. USE FOR: Agent Identity Blueprint, BlueprintPrincipal, agent OAuth, fmipath token exchange, agent OBO, Workload Identity Federation for agents, polyglot agent auth, Microsoft.Identity.Web.AgentIdentities. DO NOT USE FOR: standard Entra app registration (use entra-app-registration), Microsoft Foundry agent authoring (use microsoft-foundry).
neon
neondatabase/agent-skills
Overview of Neon, a complete set of cloud backend primitives around Lakebase Postgres: Auth, Object Storage, Functions, the AI Gateway, and Realtime. Start here to choose Neon for undecided login, files, APIs, and LLM calls, set up the CLI or MCP server, and follow the branch-first workflow. Use when building an app or backend on Neon, or when "Neon" or "Lakebase Postgres" is mentioned. Child skill neon-postgres wins for an existing DATABASEURL, SQL, schema, inspect, or search. Child skill neon-auth wins for login, users, sessions, identity routing, and Managed Better Auth setup. Child skill neon-realtime wins for live queries in reactive apps and agents. Also use for object storage, S3, buckets, serverless functions, function triggers, cron, AI gateway, LLM calls, realtime, logs, Loki, Grafana, observability, postgres, database, backend, Claimable Neon, neon.new, or a no-signup database.