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

FusionAuth Group API

The Group API from FusionAuth — 5 operation(s) for group.

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

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

This API exposes 11 operations across 5 paths, and defines 17 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.

11 operations 5 paths 17 schemas 2 DELETE1 GET1 PATCH5 POST2 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 Group 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 11

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

Group 11
POST
/api/group
Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
createGroup 1 param body → 200default
POST
/api/group/member
Creates a member in a group.
createGroupMembersWithId body → 200default
DELETE
/api/group/member
Removes users as members of a group.
deleteGroupMembersWithId body → 200default
PUT
/api/group/member
Creates a member in a group.
updateGroupMembersWithId body → 200default
POST
/api/group/member/search
Searches group members with the specified criteria and pagination.
searchGroupMembersWithId body → 200default
POST
/api/group/search
Searches groups with the specified criteria and pagination.
searchGroupsWithId body → 200default
POST
/api/group/{groupId}
Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
createGroupWithId 2 params body → 200default
DELETE
/api/group/{groupId}
Deletes the group for the given Id.
deleteGroupWithId 2 params → 200default
PATCH
/api/group/{groupId}
Updates, via PATCH, the group with the given Id.
patchGroupWithId 2 params body → 200default
GET
/api/group/{groupId}
Retrieves the group for the given Id.
retrieveGroupWithId 2 params → 200default
PUT
/api/group/{groupId}
Updates the group with the given Id.
updateGroupWithId 2 params body → 200default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ApplicationRole (7 properties), Group (7 properties), GroupMemberSearchCriteria (6 properties), GroupSearchCriteria (5 properties). Each schema is shown below with its type and property counts.

GroupMemberSearchRequest
object
Search request for Group Members.
1 property
ApplicationRole
object
A role given to a user for a specific application.
7 properties
GroupSearchResponse
object
Search response for Groups
2 properties
GroupMemberSearchResponse
object
Search response for Group Members
2 properties
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
GroupResponse
object
Group API response object.
2 properties
GroupRequest
object
Group API request object.
2 properties
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
GroupSearchCriteria
object
Search criteria for Groups
5 properties
MemberRequest
object
Group Member Request
1 property
Group
object
7 properties
MemberResponse
object
Group Member Response
1 property
GroupMember
object
A User's membership into a Group
5 properties
GroupSearchRequest
object
Search request for Groups.
1 property
GroupMemberSearchCriteria
object
Search criteria for Group Members
6 properties
Error
object
Defines an error.
3 properties
MemberDeleteRequest
object
Group Member Delete Request
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-group-api-openapi.yml Raw ↑

Other APIs FusionAuth publishes across the network.

FusionAuth Api Key API
FusionAuth Application API
FusionAuth Connector API
FusionAuth Consent API
FusionAuth Email API
FusionAuth Entity API
FusionAuth Form API
FusionAuth Health API
FusionAuth Identity API
FusionAuth Identity Provider API
FusionAuth Integration API
FusionAuth Ip Acl API
Where this information came from

This is an independent, third-party profile of FusionAuth Group 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.