How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Elastic Stack (ELK Stack)

Elastic Stack (ELK Stack) Iam Service API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Elastic Stack (ELK Stack) Iam Service API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IamService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 50 operations across 31 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://{{hostname}}/api/v1.

50 operations 31 paths 52 schemas 13 DELETE20 GET2 PATCH11 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://{elasticsearch_endpoint}
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Elastic Stack (ELK Stack) Iam Service API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKey). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 50

Across 31 paths, the API surfaces 50 operations — 13 DELETE, 20 GET, 2 PATCH, 11 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

IamService 50
GET
/organizations
List organizations
list-organizations → 200401
GET
/organizations/invitations/{invitation_token}
Get organization invitation
get-organization-invitation 1 param → 200404
GET
/organizations/{organization_id}
Fetch organization information
get-organization 1 param → 200401403404
PUT
/organizations/{organization_id}
Update organization
update-organization 1 param body → 200400401403404
GET
/organizations/{organization_id}/domains
Get domain claims
domain-claim-get-domain-claims 1 param → 200404
DELETE
/organizations/{organization_id}/domains
Delete domain claim
domain-claim-delete 1 param body → 200404400409
POST
/organizations/{organization_id}/domains/_generate_verification_code
Generate verification code
domain-claim-generate-verification-code 1 param body → 200404
POST
/organizations/{organization_id}/domains/_verify
Verify domain claim
domain-claim-verify-domain 1 param body → 200449400404409
GET
/organizations/{organization_id}/idp
Get organization IdP
get-organization-idp 1 param → 200404
PUT
/organizations/{organization_id}/idp
Setup organization IdP
setup-organization-idp 1 param body → 200404
DELETE
/organizations/{organization_id}/idp
Tear down organization IdP
teardown-organization-idp 1 param → 200404
GET
/organizations/{organization_id}/idp/metadata.xml
Get organization service provider SAML2 metadata.xml for configuring the identity provider
get-organization-idp-metadata 1 param → 200404
GET
/organizations/{organization_id}/invitations
List organization invitations
list-organization-invitations 1 param → 200404
POST
/organizations/{organization_id}/invitations
Create organization invitations
create-organization-invitations 1 param body → 201400403404429
DELETE
/organizations/{organization_id}/invitations/{invitation_tokens}
Delete organization invitations
delete-organization-invitations 2 params → 200400404
GET
/organizations/{organization_id}/members
List organization members
list-organization-members 1 param → 200404
DELETE
/organizations/{organization_id}/members/{user_ids}
Delete organization memberships
delete-organization-memberships 3 params → 200404
GET
/organizations/{organization_id}/role_mappings
Get role mappings
get-role-mappings 1 param → 200404
POST
/organizations/{organization_id}/role_mappings
Adds role mapping
add-role-mappings-individually 1 param body → 201404400
PUT
/organizations/{organization_id}/role_mappings
Updates role mappings
update-role-mappings 1 param body → 200404400
DELETE
/organizations/{organization_id}/role_mappings
Delete role mappings
delete-role-mappings 1 param → 200404
DELETE
/organizations/{organization_id}/role_mappings/{role_names}
Delete role mapping
delete-role-mappings-individually 2 params → 200404
PUT
/organizations/{organization_id}/role_mappings/{role_name}
Update role mapping
update-role-mapping 2 params body → 200404400
GET
/user
Fetch current user information
get-current-user → 200401404
PATCH
/user
Updates the current user
update-current-user body → 200400401404
GET
/users
Fetch all users
get-users 1 param → 200
POST
/users
Creates a new user
create-user body → 200400409
GET
/users/auth
User authentication information
get-authentication-info → 200
POST
/users/auth/_login
Login to ECE
login body → 200302401501502
POST
/users/auth/_logout
Logout from ECE
logout → 200501502
POST
/users/auth/_refresh
Refresh authentication token
refresh-token → 200401501502
GET
/users/auth/keys
Get all API keys
get-api-keys 1 param → 200
POST
/users/auth/keys
Create API key
create-api-key body → 201400
DELETE
/users/auth/keys
Delete API keys
delete-api-keys body → 200
GET
/users/auth/keys/_all
Get all API keys for all users
get-users-api-keys → 200
DELETE
/users/auth/keys/_all
Delete API keys of multiple users
delete-users-api-keys body → 200
GET
/users/auth/keys/{api_key_id}
Get API key
get-api-key 1 param → 200404
DELETE
/users/auth/keys/{api_key_id}
Delete API key
delete-api-key 1 param → 200404
GET
/users/auth/methods
Available authentication methods
methods → 200
POST
/users/auth/saml/_callback
SAML callback
saml-callback body → 302401501502
GET
/users/auth/saml/_init
Initiate SAML protocol
saml-init 2 params → 302501502
GET
/users/{user_id}/auth/keys
Get API key metadata for all keys created by the user
get-user-api-keys 1 param → 200404
DELETE
/users/{user_id}/auth/keys
Delete API keys for a user
delete-user-api-keys 1 param → 200404
GET
/users/{user_id}/auth/keys/{api_key_id}
Get a user API key
get-user-api-key 2 params → 200404
DELETE
/users/{user_id}/auth/keys/{api_key_id}
Delete an API key for a user
delete-user-api-key 2 params → 200404
POST
/users/{user_id}/role_assignments
Add Role Assignments
add-role-assignments 1 param body → 200400401403
DELETE
/users/{user_id}/role_assignments
Remove Role Assignments
remove-role-assignments 2 params body → 200400401403
GET
/users/{user_name}
Fetch a single user
get-user 1 param → 200404
DELETE
/users/{user_name}
Deletes an existing user
delete-user 1 param → 200400404
PATCH
/users/{user_name}
Updates an existing user
update-user 1 param body → 200400404

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are OrganizationInvitation (8 properties), OrganizationIdp (8 properties), ApiKeyResponse (8 properties), AuthenticationInfo (7 properties). Each schema is shown below with its type and property counts.

RoleMapping
object
4 properties 4 required
DeleteDomainClaimRequest
object
1 property 1 required
OrganizationInvitation
object
An invitation to an organization
8 properties 6 required
OrganizationInvitationRequest
object
A request to create one or more invitations to an organization
3 properties 1 required
VerificationCodeRequest
object
1 property 1 required
OrganizationRequest
object
A request to create or update an organization
5 properties
ProjectRoleAssignment
object
Assignment for a role with project scope.
5 properties 2 required
IdpConfigurationRequest
object
A request to setup an organization IdP
3 properties 3 required
ApiKeysResponse
object
The response model for the API keys.
2 properties 1 required
AddRoleMappingRequest
object
1 property 1 required
UpdateRoleMappingRequest
object
1 property 1 required
OrganizationRoleAssignment
object
Assignment for a role with organization scope.
3 properties 2 required
AvailableAuthenticationMethods
object
Specifies the authentication methods that are enabled on the Elasticsearch cluster. NOTE: When all fields are false, only the Platform admin and Platform viewe…
4 properties 4 required
RoleMappingRule
object
2 properties
SamlIdp
object
SAML2 IdP configuration object
3 properties 3 required
RoleMappingPropertyRule
object
2 properties
OrganizationIdpConfiguration
object
The organization's IdP configuration
3 properties 3 required
BasicFailedReplyElement
object
3 properties 2 required
OrganizationInvitations
object
A collection of invitations to an organization
1 property 1 required
DeleteRoleMappingsResponse
object
1 property 1 required
Organization
object
An organization
7 properties 2 required
UserSecurityRealm
object
The security realm the user belongs to
2 properties 2 required
CreateApiKeyRequest
object
The request payload that creates the API keys.
3 properties 1 required
UserMetadata
object
Metadata for a user
6 properties
AuthenticationInfo
object
A user's authentication info
7 properties 2 required
UserApiKey
object
The model to specify a user and their API key in a delete request.
2 properties 2 required
OrganizationMembership
object
A user's membership to an organization
6 properties 3 required
EmptyResponse
object
UpdateOrganizationRoleMappingRequest
object
1 property 1 required
LoginRequest
object
The body of a login request.
3 properties 2 required
GetOrganizationClaimedDomainsResponse
object
1 property 1 required
PlatformRoleAssignment
object
Assignment for a role with platform scope.
1 property 1 required
DeploymentRoleAssignment
object
Assignment for a role with deployment scope.
5 properties 2 required
RoleAssignments
object
Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.
4 properties
ElevatedPermissions
object
A user's elevated permissions status
2 properties 1 required
OrganizationMemberships
object
All user memberships to an organization
1 property 1 required
UserList
object
A collection of users
1 property 1 required
LoginState
object
Configure how the API responds after a successful login.
1 property
ApiKeyResponse
object
The response model for an API key.
8 properties 3 required
ProjectRoleAssignments
object
Assignments for roles with project scope.
5 properties
User
object
An API user
6 properties 2 required
DeleteUsersApiKeysRequest
object
The request payload that deletes the API keys.
1 property 1 required
BasicFailedReply
object
1 property 1 required
DeleteApiKeysRequest
object
The request payload that deletes the API keys.
1 property 1 required
TokenResponse
object
The response value after a login without redirect configured, or after elevated permissions are enabled or disabled.
2 properties 2 required
OrganizationIdp
object
The organization's IdP info
8 properties 8 required
OrganizationList
object
A collection of Organizations
2 properties 1 required
UserSecurity
object
A user's security information
6 properties
SsoAuthenticationMethodInfo
object
Specifies the authentication methods that are enabled on the Elasticsearch cluster. NOTE: When all fields are false, only the Platform admin and Platform viewe…
3 properties 3 required
DomainVerificationRequest
object
1 property 1 required
GetRoleMappingsResponse
object
1 property 1 required
VerificationCodeResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-iamservice-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
AE Profile APIs.io
Elastic Stack (ELK Stack) Accounts API
AE Profile APIs.io
Elastic Stack (ELK Stack) Actions API
AE Profile APIs.io
Elastic Stack (ELK Stack) agent builder API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting V2 API
AE Profile APIs.io
Elastic Stack (ELK Stack) Analytics API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent configuration API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent keys API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM annotations API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM server schema API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM sourcemaps API
AE Profile APIs.io
#IamService
← Back to E APIs
API Details
ID
elk-stack:elk-stack-iamservice-api
Base URL
https://{elasticsearch_endpoint}
Docs
https://www.elastic.co/docs/api/doc/elasticsearch/
Provider
Elastic Stack (ELK Stack)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=elk-stack-iamservice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/elk-stack-iamservice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Iam Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.