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
FusionAuth

FusionAuth Entity API

The Entity API from FusionAuth — 10 operation(s) for entity.

Documentation Provider Profile APIs.io OpenAPI GitHub

FusionAuth Entity API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 24 operations across 10 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.66.0.

Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.

24 operations 10 paths 25 schemas 4 DELETE4 GET3 PATCH10 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.66.0
Base URL
https://sandbox.fusionauth.io
Authentication
API Key, HTTP Bearer
License
Apache2
Resource Areas
1

Authentication & Security 2

FusionAuth Entity API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 24

Across 10 paths, the API surfaces 24 operations — 4 DELETE, 4 GET, 3 PATCH, 10 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Entity 24
POST
/api/entity
Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
createEntity 1 param body → 200default
POST
/api/entity/grant/search
Searches Entity Grants with the specified criteria and pagination.
searchEntityGrantsWithId body → 200default
POST
/api/entity/search
Searches entities with the specified criteria and pagination.
searchEntitiesWithId body → 200default
GET
/api/entity/search
Retrieves the entities for the given Ids. If any Id is invalid, it is ignored.
searchEntitiesByIdsWithId 1 param → 200default
POST
/api/entity/type
Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
createEntityType body → 200default
POST
/api/entity/type/search
Searches the entity types with the specified criteria and pagination.
searchEntityTypesWithId body → 200default
POST
/api/entity/type/{entityTypeId}
Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
createEntityTypeWithId 1 param body → 200default
DELETE
/api/entity/type/{entityTypeId}
Deletes the Entity Type for the given Id.
deleteEntityTypeWithId 1 param → 200default
PATCH
/api/entity/type/{entityTypeId}
Updates, via PATCH, the Entity Type with the given Id.
patchEntityTypeWithId 1 param body → 200default
GET
/api/entity/type/{entityTypeId}
Retrieves the Entity Type for the given Id.
retrieveEntityTypeWithId 1 param → 200default
PUT
/api/entity/type/{entityTypeId}
Updates the Entity Type with the given Id.
updateEntityTypeWithId 1 param body → 200default
POST
/api/entity/type/{entityTypeId}/permission
Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for. You can optionally specify an Id for the permission inside the EntityTypeP…
createEntityTypePermission 1 param body → 200default
POST
/api/entity/type/{entityTypeId}/permission/{permissionId}
Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for. You can optionally specify an Id for the permission inside the EntityTypeP…
createEntityTypePermissionWithId 2 params body → 200default
DELETE
/api/entity/type/{entityTypeId}/permission/{permissionId}
Hard deletes a permission. This is a dangerous operation and should not be used in most circumstances. This permanently removes the given permission from all grants that had it.
deleteEntityTypePermissionWithId 2 params → 200default
PATCH
/api/entity/type/{entityTypeId}/permission/{permissionId}
Patches the permission with the given Id for the entity type.
patchEntityTypePermissionWithId 2 params body → 200default
PUT
/api/entity/type/{entityTypeId}/permission/{permissionId}
Updates the permission with the given Id for the entity type.
updateEntityTypePermissionWithId 2 params body → 200default
POST
/api/entity/{entityId}
Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
createEntityWithId 2 params body → 200default
DELETE
/api/entity/{entityId}
Deletes the Entity for the given Id.
deleteEntityWithId 2 params → 200default
PATCH
/api/entity/{entityId}
Updates, via PATCH, the Entity with the given Id.
patchEntityWithId 2 params body → 200default
GET
/api/entity/{entityId}
Retrieves the Entity for the given Id.
retrieveEntityWithId 2 params → 200default
PUT
/api/entity/{entityId}
Updates the Entity with the given Id.
updateEntityWithId 2 params body → 200default
DELETE
/api/entity/{entityId}/grant
Deletes an Entity Grant for the given User or Entity.
deleteEntityGrantWithId 4 params → 200default
GET
/api/entity/{entityId}/grant
Retrieves an Entity Grant for the given Entity and User/Entity.
retrieveEntityGrantWithId 4 params → 200default
POST
/api/entity/{entityId}/grant
Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
upsertEntityGrantWithId 2 params body → 200default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Entity (10 properties), EntityGrant (8 properties), EntityType (7 properties), EntityTypePermission (7 properties). Each schema is shown below with its type and property counts.

EntityJWTConfiguration
object
JWT Configuration for entities.
3 properties
EntityTypeRequest
object
Entity Type API request object.
2 properties
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
Entity
object
Models an entity that a user can be granted permissions to. Or an entity that can be granted permissions to another entity.
10 properties
EntityRequest
object
Entity API request object.
1 property
EntitySearchRequest
object
Search request for entities
1 property
EntityTypeSearchCriteria
object
Search criteria for entity types.
4 properties
EntityTypeSearchResponse
object
Search response for entity types.
2 properties
EntityResponse
object
Entity API response object.
1 property
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
EntityType
object
Models an entity type that has a specific set of permissions. These are global objects and can be used across tenants.
7 properties
EntityTypePermission
object
Models a specific entity type permission. This permission can be granted to users or other entities.
7 properties
EntityGrantResponse
object
Entity grant API response object.
2 properties
Sort
string
EntityGrantSearchCriteria
object
Search criteria for entity grants.
6 properties
EntitySearchCriteria
object
This class is the entity query. It provides a build pattern as well as public fields for use on forms and in actions.
6 properties
EntityGrant
object
A grant for an entity to a user or another entity.
8 properties
EntityTypeResponse
object
Entity Type API response object.
3 properties
SortField
object
3 properties
EntityGrantSearchResponse
object
Search request for entity grants.
2 properties
Error
object
Defines an error.
3 properties
EntitySearchResponse
object
Search request for entities
3 properties
EntityGrantSearchRequest
object
Search request for entity grants.
1 property
EntityGrantRequest
object
Entity grant API request object.
1 property
EntityTypeSearchRequest
object
Search request for entity types.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-entity-api-openapi.yml Raw ↑

Other APIs FusionAuth publishes across the network.

FusionAuth Api Key API
AE Profile APIs.io
FusionAuth Application API
AE Profile APIs.io
FusionAuth Connector API
AE Profile APIs.io
FusionAuth Consent API
AE Profile APIs.io
FusionAuth Email API
AE Profile APIs.io
FusionAuth Form API
AE Profile APIs.io
FusionAuth Group API
AE Profile APIs.io
FusionAuth Health API
AE Profile APIs.io
FusionAuth Identity API
AE Profile APIs.io
FusionAuth Identity Provider API
AE Profile APIs.io
FusionAuth Integration API
AE Profile APIs.io
FusionAuth Ip Acl API
AE Profile APIs.io
#Entity
← Back to F APIs
API Details
ID
fusionauth:fusionauth-entity-api
Base URL
https://sandbox.fusionauth.io
Docs
https://fusionauth.io/docs/
Provider
FusionAuth
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=fusionauth-entity-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/fusionauth-entity-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 FusionAuth Entity 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.