Generated banner for Cloud Onboarding
Generated logo for Cloud Onboarding

Cloud Onboarding

ElasticOfficialCreated by elastic

  • Skill
  • Tool integration
  • Cloud and DevOps
  • Apache-2.0
  • No issues found

From the author

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.
— the description by elastic

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

Cloud Onboarding provides a structured workflow for managing identity and access within an Elastic Cloud organization. It enables users to configure the elastic CLI, validate control-plane connectivity, invite team members, assign predefined or custom Serverless project roles, and manage Cloud API keys. The skill emphasizes secure credential handling by leveraging CLI contexts and OS keychains, ensuring that sensitive API keys are never exposed in chat.

What it does

  • Configures and validates the elastic CLI cloud context for control-plane operations.
  • Invites new users to an organization with specific project-level role assignments.
  • Manages Cloud API keys, including creation, listing, and revocation.
  • Creates custom Serverless project roles via the Elasticsearch security API.
  • Assigns granular access using application_roles for both users and API keys.
  • Audits organization membership and existing API key configurations.

When to use it

  • When setting up a new Elastic Cloud organization or onboarding new team members.
  • When you need to grant or modify access to specific Serverless projects.
  • When creating API keys for automation tasks requiring data-plane access.
  • When predefined roles are insufficient and custom security roles are required.
  • When auditing current organization members and their assigned permissions.

Advantages

  • Promotes secure practices by avoiding manual handling of API secrets in chat.
  • Provides a consistent interface for complex identity and access management tasks.
  • Automates the discovery of organization IDs and regional configurations.
  • Supports granular access control through custom role integration.
  • Ensures API key hygiene by checking for existing keys and managing expirations.

Usage examples

“Set up my cloud environment.”
The agent validates the current CLI context, discovers the organization ID, and confirms connectivity to the Elastic Cloud control plane.
“Add [email removed] to my search project with read-only access.”
The agent checks if Alice is an existing member, then sends an invitation with the appropriate viewer role assigned to the specified project.
“Create a 30-day CI key that can index into our search projects.”
The agent lists existing keys to avoid duplicates, generates a new project-scoped API key with developer roles, and provides the secret once.
“Give [email removed] read-only access to marketing-* on my search project.”
The agent creates a custom security role for the marketing index pattern and assigns it to Bob via the Cloud API's application_roles.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/elastic/cloud-onboarding/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip cloud-onboarding.zip -d .agents/skills

Documentation by elastic

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 with elastic 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

  1. 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.

  2. Establish a default region (optional). When the user plans to create projects, list the available regions with GET cloud:/api/v1/serverless/regions and confirm a default. Default to gcp-us-central1 unless the user requests otherwise; only regions with project_creation_enabled: true accept 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.

OperationRequired permission
Invite / remove membersOrganization owner (organization-admin)
Assign or remove rolesOrganization owner (organization-admin)
Create / revoke Cloud API keysOrganization owner (organization-admin)
List members, invitations, or keysAny organization member
Create / delete custom rolesmanage_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):

Rolerole_idAvailable on
AdminadminSearch, Obs, Security
DeveloperdeveloperSearch
ViewerviewerSearch, Obs, Security
EditoreditorObs, Security
Analystst1_analyst, t2_analyst, t3_analyst, soc_manager, rule_authorSecurity

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.

  1. 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.

  2. Check existing state first. List members with GET cloud:/api/v1/organizations/{org_id}/members and, for key requests, existing keys with GET 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.

  3. 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 the DELETE variant.

    • 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 with DELETE cloud:/api/v1/users/auth/keys (confirm first). Confirm destructive actions (remove member, revoke key) with the user before executing.

  4. 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:

  1. Create the role in the project with PUT /_security/role/{name} (runs against the project's Elasticsearch endpoint; requires manage_security). Role names must start with a letter or digit and contain only letters, digits, _, -, .. Run-as privileges are not available in Serverless.

  2. Invite the user if needed — without project role assignments (the custom role handles project access).

  3. Assign the custom role by setting application_roles on a project-scoped role assignment (POST cloud:/api/v1/users/{user_id}/role_assignments) with role_id set 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 (project key) so the key only reaches named projects or all projects of a type.

  • Organization-scoped assignments (organization key) 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_roles must 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 [email protected] 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 [email protected] 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 expiration matching 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/organizationselastic cloud orgs list-organizations
GET cloud:/api/v1/serverless/regionselastic cloud serverless regions list-regions
GET cloud:/api/v1/organizations/{org_id}/memberselastic cloud orgs list-organization-members --organization-id <org_id>
POST cloud:/api/v1/organizations/{org_id}/invitationselastic cloud orgs create-organization-invitations --organization-id <org_id> --input-file <json>
GET cloud:/api/v1/organizations/{org_id}/invitationselastic 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_assignmentselastic cloud users add-role-assignments --user-id <user_id> --input-file <json>
DELETE cloud:/api/v1/users/{user_id}/role_assignmentselastic cloud users remove-role-assignments --user-id <user_id> --input-file <json>
POST cloud:/api/v1/users/auth/keyselastic cloud auth create-api-key --input-file <json>
GET cloud:/api/v1/users/auth/keyselastic cloud auth get-api-keys
DELETE cloud:/api/v1/users/auth/keyselastic cloud auth delete-api-keys --input-file <json>
PUT /_security/role/{name}elastic es security put-role --name <name> --input-file <json>
GET /_security/roleelastic es security get-role
DELETE /_security/role/{name}elastic es security delete-role --name <name>

Files

LICENSE

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright 2026 Elasticsearch BV

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs an API key

The author says: Requires the `elastic` CLI (>= 0.2) with `cloud` support and network access to the Elastic Cloud API (api.elastic-cloud.com). Custom-role operations additionally need an Elasticsearch context on the target Serverless project with `manage_security`. Targets the Elastic Cloud control plane; not applicable to self-managed clusters.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
elastic
Publisher
Elastic (Official)
Source
elastic/agent-skills · skills/cloud/onboarding · commit 09d879d
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Also distributed in
elastic/agent-skills

AutoGineer is not affiliated with or endorsed by elastic or Elastic.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download cloud-onboarding.zip