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

Elastic Stack (ELK Stack) Organizations API

The Organizations API from Elastic Stack (ELK Stack) — 15 operation(s) for organizations.

Elastic Stack (ELK Stack) Organizations 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 Organization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 23 operations across 15 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.

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

23 operations 15 paths 34 schemas 6 DELETE9 GET4 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) Organizations 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 23

Across 15 paths, the API surfaces 23 operations — 6 DELETE, 9 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Organizations 23
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

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are OrganizationIdp (8 properties), OrganizationInvitation (8 properties), Organization (7 properties), OrganizationMembership (6 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
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
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
OrganizationMembership
object
A user's membership to an organization
6 properties 3 required
EmptyResponse
object
UpdateOrganizationRoleMappingRequest
object
1 property 1 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
OrganizationMemberships
object
All user memberships to an organization
1 property 1 required
ProjectRoleAssignments
object
Assignments for roles with project scope.
5 properties
BasicFailedReply
object
1 property 1 required
OrganizationIdp
object
The organization's IdP info
8 properties 8 required
OrganizationList
object
A collection of Organizations
2 properties 1 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-organizations-api-openapi.yml Raw ↑

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

Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Organizations 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.