Elastic Stack

Elastic Stack (ELK Stack) Iam Service API

The IamService API from Elastic Stack (ELK Stack) — 31 operation(s) for iamservice.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 50

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /organizations List organizations I belong to · List organizations #
Ask an LLM
“Which Elastic Cloud organizations can my user see?”
“Is there a way to list every organization available to my account?”
Tell an agent
List the organizations available to me.
Show all organizations my current user can access.
GET /organizations/invitations/{invitation_token} Look up an organization invitation by token · Get organization invitation #
Ask an LLM
“What organization does this invitation token belong to?”
“Can I check the details of an invite before accepting it?”
Tell an agent
Show the organization invitation for token {invitation_token}.
Look up who invitation {invitation_token} is for and when it expires.
GET /organizations/{organization_id} Get an organization's details · Fetch organization information #
Ask an LLM
“How do I fetch the details of a single organization by its id?”
“What contacts and settings are on my organization?”
Tell an agent
Get organization {organization_id}.
Show the name and contacts for organization {organization_id}.
PUT /organizations/{organization_id} Update an organization's settings · Update organization #
Ask an LLM
“Can I rename my organization or change its billing contacts?”
“How do I restrict which email domains can receive organization notifications?”
Tell an agent
Rename organization {organization_id} to {name}.
Set the billing contacts of organization {organization_id} to {billing_contacts}.
GET /organizations/{organization_id}/domains List an organization's claimed domains · Get domain claims #
Ask an LLM
“Which email domains has my organization claimed?”
“Can I see the domain claims and their status for an organization?”
Tell an agent
List the domain claims for organization {organization_id}.
Show which domains organization {organization_id} has claimed.
DELETE /organizations/{organization_id}/domains Remove a domain claim from an organization · Delete domain claim #
Ask an LLM
“How do I drop a domain my organization no longer owns?”
“Can I release a claimed domain from my organization?”
Tell an agent destructive · confirm first
Delete the domain claim {domain_claim_request} from organization {organization_id}.
Release domain {domain_claim_request} claimed by organization {organization_id}.
POST /organizations/{organization_id}/domains/_generate_verification_code Generate a domain ownership verification code · Generate verification code #
Ask an LLM
“How do I get the verification code to prove my organization owns a domain?”
“What value do I need to publish before a domain claim can be verified?”
Tell an agent
Generate a verification code for domain {domain_claim_request} in organization {organization_id}.
Start a domain claim challenge for {domain_claim_request} on organization {organization_id}.
POST /organizations/{organization_id}/domains/_verify Verify a domain claim challenge · Verify domain claim #
Ask an LLM
“I published the verification code, how do I complete the domain claim?”
“Can I check that my organization's domain challenge now passes?”
Tell an agent
Verify the domain claim for {domain_claim_request} in organization {organization_id}.
Complete the ownership check for domain {domain_claim_request} on organization {organization_id}.
GET /organizations/{organization_id}/idp Get an organization's identity provider setup · Get organization IdP #
Ask an LLM
“Is SAML single sign-on configured for my organization?”
“What identity provider settings does my organization currently use?”
Tell an agent
Show the IdP configuration for organization {organization_id}.
Check whether organization {organization_id} has SSO enabled.
PUT /organizations/{organization_id}/idp Configure SAML SSO for an organization · Setup organization IdP #
Ask an LLM
“How do I connect my company's SAML identity provider to my Elastic organization?”
“Can I require a login identifier prefix when setting up organization SSO?”
Tell an agent
Set up the SAML IdP {saml_idp} for organization {organization_id} with login prefix {login_identifier_prefix}.
Configure SSO for organization {organization_id} and set enabled to {enabled}.
DELETE /organizations/{organization_id}/idp Remove an organization's identity provider · Tear down organization IdP #
Ask an LLM
“How do I turn off SAML SSO entirely for my organization?”
“Can I tear down the identity provider we configured for the organization?”
Tell an agent destructive · confirm first
Tear down the IdP for organization {organization_id}.
Remove SAML single sign-on from organization {organization_id}.
GET /organizations/{organization_id}/idp/metadata.xml Download the organization's SAML SP metadata · Get organization service provider SAML2 metadata.xml for configuring the… #
Ask an LLM
“Where do I get the metadata.xml my identity provider needs for Elastic SSO?”
“Can I download the service provider SAML metadata for my organization?”
Tell an agent
Download the SAML metadata.xml for organization {organization_id}.
Get the service provider metadata to give our IdP for organization {organization_id}.
GET /organizations/{organization_id}/invitations List pending organization invitations · List organization invitations #
Ask an LLM
“Who has been invited to my organization but hasn't joined yet?”
“Can I see all open invitations for an organization?”
Tell an agent
List open invitations for organization {organization_id}.
Show the pending invites to organization {organization_id}.
POST /organizations/{organization_id}/invitations Invite people to an organization · Create organization invitations #
Ask an LLM
“How do I invite teammates by email to my Elastic Cloud organization?”
“Can I set how long an organization invitation stays valid?”
Tell an agent
Invite {emails} to organization {organization_id}.
Invite {emails} to organization {organization_id} with an invitation that expires in {expires_in}.
DELETE /organizations/{organization_id}/invitations/{invitation_tokens} Revoke organization invitations · Delete organization invitations #
Ask an LLM
“How do I cancel an invitation I sent by mistake?”
“Can I withdraw several organization invites at once?”
Tell an agent destructive · confirm first
Delete invitations {invitation_tokens} from organization {organization_id}.
Cancel the pending invites {invitation_tokens} to organization {organization_id}.
GET /organizations/{organization_id}/members List an organization's members · List organization members #
Ask an LLM
“Who are the current members of my organization?”
“Can I list every user belonging to an organization?”
Tell an agent
List the members of organization {organization_id}.
Show everyone who belongs to organization {organization_id}.
DELETE /organizations/{organization_id}/members/{user_ids} Remove members from an organization · Delete organization memberships #
Ask an LLM
“How do I remove a user from my organization?”
“Can I force-remove members even when the removal would otherwise be blocked?”
Tell an agent destructive · confirm first
Remove users {user_ids} from organization {organization_id}.
Force the removal of members {user_ids} from organization {organization_id} with force {force}.
GET /organizations/{organization_id}/role_mappings Get SSO role mappings for an organization · Get role mappings #
Ask an LLM
“Which roles do users get when they sign in through our SSO?”
“Can I view all role mappings configured for my organization?”
Tell an agent
Show the role mappings for organization {organization_id}.
List how SSO groups map to roles in organization {organization_id}.
POST /organizations/{organization_id}/role_mappings Add new SSO role mappings · Adds role mapping #
Ask an LLM
“Can I add a role mapping without touching the existing ones?”
“How do I grant an extra role to SSO users from a new group?”
Tell an agent
Add role mappings {mappings} to organization {organization_id}.
Append the SSO mappings {mappings} to what organization {organization_id} already has.
PUT /organizations/{organization_id}/role_mappings Replace all SSO role mappings · Updates role mappings #
Ask an LLM
“How do I replace the full set of SSO role mappings for my organization?”
“Can I overwrite every role mapping in one request?”
Tell an agent
Replace the role mappings of organization {organization_id} with {mappings}.
Overwrite all SSO role assignments for organization {organization_id} using {mappings}.
DELETE /organizations/{organization_id}/role_mappings Delete all SSO role mappings · Delete role mappings #
Ask an LLM
“How do I clear every role mapping from my organization?”
“Can I wipe out all SSO role assignments at once?”
Tell an agent destructive · confirm first
Delete all role mappings in organization {organization_id}.
Clear every SSO role mapping from organization {organization_id}.
DELETE /organizations/{organization_id}/role_mappings/{role_names} Delete specific SSO role mappings by name · Delete role mapping #
Ask an LLM
“Can I delete just one named role mapping and keep the others?”
“How do I remove a few role mappings by their names?”
Tell an agent destructive · confirm first
Delete role mappings {role_names} from organization {organization_id}.
Remove only the mappings named {role_names} in organization {organization_id}.
PUT /organizations/{organization_id}/role_mappings/{role_name} Update one SSO role mapping by name · Update role mapping #
Ask an LLM
“How do I edit a single existing role mapping?”
“Can I change what one named mapping grants without replacing the rest?”
Tell an agent
Update role mapping {role_name} in organization {organization_id} to {mapping}.
Change the mapping named {role_name} for organization {organization_id}.
GET /user Get my own user profile · Fetch current user information #
Ask an LLM
“Which user am I logged in as right now?”
“What does my own user profile contain?”
Tell an agent
Show my current user information.
Tell me who I'm authenticated as.
PATCH /user Update my own user profile · Updates the current user #
Ask an LLM
“How do I change details on my own user account?”
“Can I edit my profile without admin access to other users?”
Tell an agent
Update my own user profile.
Save changes to the currently logged in user.
GET /users List all platform users · Fetch all users #
Ask an LLM
“What users exist in my Elastic Cloud Enterprise installation?”
“Can I include disabled accounts when listing users?”
Tell an agent
List all users.
List every user, including disabled ones when include_disabled is {include_disabled}.
POST /users Create a new platform user · Creates a new user #
Ask an LLM
“How do I add a new user account to the platform?”
“What security settings are required when creating a user?”
Tell an agent
Create user {user_name} with security settings {security}.
Add a user named {user_name} with full name {full_name} and email {email}, security {security}.
GET /users/auth Check my authentication status · User authentication information #
Ask an LLM
“Do I currently have elevated permissions in my session?”
“Is a TOTP device available for my user?”
Tell an agent
Show my authentication information.
Check whether my session has elevated permissions and a TOTP device.
POST /users/auth/_login Log in with a username and password · Login to ECE #
Ask an LLM
“How do I authenticate to ECE with my username and password?”
“What do I get back after logging in to the platform API?”
Tell an agent
Log in as {username} with password {password}.
Authenticate user {username} using {password} and login state {login_state}.
POST /users/auth/_logout Log out and end my session · Logout from ECE #
Ask an LLM
“How do I end my current ECE session?”
“Can I destroy my login session through the API?”
Tell an agent destructive · confirm first
Log me out.
End my current session now.
POST /users/auth/_refresh Refresh my authentication token · Refresh authentication token #
Ask an LLM
“My token is about to expire, how do I get a fresh one?”
“Can I renew my auth token without logging in again?”
Tell an agent
Refresh my authentication token.
Issue me a new auth token for the current session.
GET /users/auth/keys List API keys I can see · Get all API keys #
Ask an LLM
“Which API keys have I created?”
“How do I page through a long list of API keys?”
Tell an agent
List my API keys.
Show the next page of API keys starting from {next_page}.
POST /users/auth/keys Create an API key · Create API key #
Ask an LLM
“How do I generate a new API key for automation?”
“Can I give an API key an expiration and specific roles?”
Tell an agent
Create an API key described as {description}.
Create an API key {description} that expires in {expiration}.
DELETE /users/auth/keys Delete several of my API keys · Delete API keys #
Ask an LLM
“Can I invalidate a batch of my API keys in one call?”
“How do I revoke multiple API keys at once?”
Tell an agent destructive · confirm first
Delete API keys {keys}.
Invalidate the keys {keys} in a single request.
GET /users/auth/keys/_all List API keys across all users (deprecated) · Get all API keys for all users #
Ask an LLM
“Is there a way to see API keys for every user on the platform?”
“Which endpoint shows all users' API key metadata, even though it's deprecated?”
Tell an agent
List API key metadata for all users using the deprecated endpoint.
Show every user's API keys across the platform.
DELETE /users/auth/keys/_all Delete API keys belonging to multiple users · Delete API keys of multiple users #
Ask an LLM
“How do I revoke API keys owned by several different users?”
“Can an admin invalidate keys for many users in one request?”
Tell an agent destructive · confirm first
Delete these API keys across users: {user_api_keys}.
Invalidate the per-user keys {user_api_keys} for multiple users.
GET /users/auth/keys/{api_key_id} Get one of my API keys · Get API key #
Ask an LLM
“What are the details of a specific API key I own?”
“When does one particular API key of mine expire?”
Tell an agent
Get API key {api_key_id}.
Show metadata for my API key {api_key_id}.
DELETE /users/auth/keys/{api_key_id} Delete one of my API keys · Delete API key #
Ask an LLM
“How do I revoke a single API key I created?”
“Can I invalidate one leaked key without touching the others?”
Tell an agent destructive · confirm first
Delete API key {api_key_id}.
Revoke my key {api_key_id} immediately.
GET /users/auth/methods List available authentication methods · Available authentication methods #
Ask an LLM
“Which login methods does the platform support?”
“Is SAML available as a sign-in option here?”
Tell an agent
List the available authentication methods.
Show which ways users can sign in.
POST /users/auth/saml/_callback Complete SAML sign-in from an IdP response · SAML callback #
Ask an LLM
“What endpoint receives the SAML response from the identity provider?”
“How is a user authenticated once the IdP posts back a SAMLResponse?”
Tell an agent
Authenticate using SAML response {SAMLResponse}.
Process IdP callback {SAMLResponse} with relay state {RelayState}.
GET /users/auth/saml/_init Start SAML single sign-on · Initiate SAML protocol #
Ask an LLM
“How do I kick off the SAML SSO redirect to our identity provider?”
“Can I pick a specific SAML realm when starting sign-on?”
Tell an agent
Initiate SAML sign-on.
Start SAML SSO against realm {realm} with state {state}.
GET /users/{user_id}/auth/keys List a user's API keys · Get API key metadata for all keys created by the user #
Ask an LLM
“Which API keys has a particular user created?”
“Can an admin see all keys belonging to one user?”
Tell an agent
List API keys created by user {user_id}.
Show key metadata for every key owned by {user_id}.
DELETE /users/{user_id}/auth/keys Delete all API keys for a user · Delete API keys for a user #
Ask an LLM
“How do I revoke every API key an offboarded user created?”
“Can I wipe all of one user's keys in one step?”
Tell an agent destructive · confirm first
Delete all API keys for user {user_id}.
Invalidate every key owned by {user_id}.
GET /users/{user_id}/auth/keys/{api_key_id} Get a specific API key of a user · Get a user API key #
Ask an LLM
“What does one particular key belonging to another user look like?”
“Can an admin inspect a single key for a named user?”
Tell an agent
Get API key {api_key_id} of user {user_id}.
Show metadata for user {user_id}'s key {api_key_id}.
DELETE /users/{user_id}/auth/keys/{api_key_id} Delete a specific API key of a user · Delete an API key for a user #
Ask an LLM
“How do I revoke one key belonging to another user?”
“Can an admin invalidate a single key for a named user?”
Tell an agent destructive · confirm first
Delete API key {api_key_id} belonging to user {user_id}.
Revoke user {user_id}'s key {api_key_id}.
POST /users/{user_id}/role_assignments Grant roles to a user · Add Role Assignments #
Ask an LLM
“How do I give a user a deployment or organization role?”
“Can I assign platform-level roles to a user?”
Tell an agent
Add deployment role assignments {deployment} to user {user_id}.
Grant user {user_id} the organization roles {organization}.
DELETE /users/{user_id}/role_assignments Revoke roles from a user · Remove Role Assignments #
Ask an LLM
“How do I take a deployment role away from a user?”
“Can I force-remove a user's role assignments?”
Tell an agent destructive · confirm first
Remove deployment role assignments {deployment} from user {user_id}.
Revoke organization roles {organization} from user {user_id} with force {force}.
GET /users/{user_name} Get a user by username · Fetch a single user #
Ask an LLM
“What details are stored for a given username?”
“Can I look up one user account by name?”
Tell an agent
Get user {user_name}.
Show the account details for {user_name}.
DELETE /users/{user_name} Delete a user account · Deletes an existing user #
Ask an LLM
“How do I permanently remove a user account?”
“Can I delete a user who has left the team?”
Tell an agent destructive · confirm first
Delete user {user_name}.
Remove the account {user_name} from the platform.
PATCH /users/{user_name} Update another user's account · Updates an existing user #
Ask an LLM
“How do I change details on an existing user account?”
“Can an admin edit someone else's user profile?”
Tell an agent
Update user {user_name}.
Edit the account settings for {user_name}.

Documentation

📖
Documentation
https://www.elastic.co/docs/reference/elasticsearch
📖
APIReference
https://www.elastic.co/docs/api/doc/elasticsearch/
📖
Documentation
https://www.elastic.co/docs/reference/kibana
📖
APIReference
https://www.elastic.co/docs/api/doc/kibana/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-iamservice-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/elastic/elasticsearch-specification
🔗
SourceCode
https://github.com/elastic/kibana
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elk-stack:elk-stack-iamservice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elk-stack-iamservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '1'
  title: Elastic Cloud Enterprise Iam Service API
  termsOfService: ''
servers:
- url: https://{{hostname}}/api/v1
security:
- basicAuth: []
- apiKey: []
tags:


# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-iamservice-api-openapi.yml