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
Unleash

Unleash Users API

Manage users and passwords.

Documentation Provider Profile APIs.io OpenAPI GitHub

Unleash Users API is one of 36 APIs that Unleash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 30 operations across 21 paths, and defines 43 schemas. It is described by OpenAPI 3.0.3, at version 7.4.1.

Requests are made against a single base URL, https://app.unleash-instance.example.com.

30 operations 21 paths 43 schemas 5 DELETE13 GET9 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.4.1
Base URL
https://app.unleash-instance.example.com
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Unleash Users API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKey). It accepts HTTP bearer tokens (bearerToken). By default, every request must be authenticated.

  • apiKey — API key needed to access this API
  • bearerToken — API key needed to access this API, in Bearer token format

Paths & Operations 30

Across 21 paths, the API surfaces 30 operations — 5 DELETE, 13 GET, 9 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 30

Manage users and passwords.

GET
/api/admin/groups
Get a List of Groups
getGroups → 200401403
POST
/api/admin/groups
Create a New Group
createGroup body → 201400401403409
GET
/api/admin/groups/{groupId}
Get a Single Group
getGroup 1 param → 200400401403404
PUT
/api/admin/groups/{groupId}
Update a Group
updateGroup 1 param body → 200400401403404409
DELETE
/api/admin/groups/{groupId}
Delete a Single Group
deleteGroup 1 param → 200400401403
DELETE
/api/admin/groups/scim-groups
Delete All SCIM Groups
deleteScimGroups → 200401403
GET
/api/admin/roles
Get a List of Roles
getRoles → 200401403
POST
/api/admin/roles
Create a New Role
createRole body → 200400401403409
GET
/api/admin/roles/{roleId}
Get a Single Role
getRoleById 1 param → 200400401404
PUT
/api/admin/roles/{roleId}
Update a Role
updateRole 1 param body → 200400401403404409
DELETE
/api/admin/roles/{roleId}
Delete a Custom Role
deleteRole 1 param → 200400401403404
POST
/api/admin/roles/validate
Validate a Role
validateRole body → 200400401
GET
/api/admin/user
Get Your Own User Details
getMe → 200401
GET
/api/admin/user/profile
Get Your Own User Profile
getProfile → 200401
POST
/api/admin/user/change-password
Change Your Own Password
changeMyPassword body → 200400401
GET
/api/admin/user/roles
Get Roles for Currently Logged in User
getUserRoles 1 param → 200401403
GET
/api/admin/user-admin/inactive
Gets Inactive Users
getInactiveUsers → 200
POST
/api/admin/user-admin/inactive/delete
Deletes Inactive Users
deleteInactiveUsers body → 200400401403
POST
/api/admin/user-admin/validate-password
Validate Password for a User
validateUserPassword body → 200400401415
POST
/api/admin/user-admin/{id}/change-password
Change Password for a User
changeUserPassword 1 param body → 200400401403
POST
/api/admin/user-admin/reset-password
Reset User Password
resetUserPassword body → 200400401403404
GET
/api/admin/user-admin
Get All Users and [root Roles](https://docs.getunleash.io/concepts/rbacpredefined-roles)
getUsers → 200401403
POST
/api/admin/user-admin
Create a New User
createUser body → 201400401403
GET
/api/admin/user-admin/search
Search Users
searchUsers 1 param → 200401
GET
/api/admin/user-admin/access
Get Basic User and Group Information
getBaseUsersAndGroups → 200401
GET
/api/admin/user-admin/admin-count
Get Total Count of Admin Accounts
getAdminCount → 200401403
GET
/api/admin/user-admin/{id}
Get User
getUser 1 param → 200400401404
PUT
/api/admin/user-admin/{id}
Update a User
updateUser 1 param body → 200400401403404
DELETE
/api/admin/user-admin/{id}
Delete a User
deleteUser 1 param → 200401403404
DELETE
/api/admin/user-admin/scim-users
Delete All SCIM Users
deleteScimUsers → 200401403

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are featureSchema (22 properties), featureEnvironmentSchema (19 properties), createUserResponseSchema (17 properties), userSchema (17 properties). Each schema is shown below with its type and property counts.

constraintSchema
object
A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategi…
6 properties 2 required
featureSchema
object
A feature flag definition
22 properties 1 required
usersSchema
object
Users and root roles
2 properties 1 required
featureStrategySchema
object
A single activation strategy configuration schema for a feature
10 properties 1 required
adminPermissionSchema
object
Describes a single permission
5 properties 4 required
userSchema
object
An Unleash user
17 properties 1 required
groupsSchema
object
A list of [user groups](https://docs.getunleash.io/concepts/rbacuser-groups)
1 property
profileSchema
object
User profile overview
4 properties 4 required
variantSchema
object
A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/concepts/feature-flag-variantswhat…
6 properties 2 required
releasePlanMilestoneStrategySchema
object
Schema representing the creation of a release plan milestone strategy.
9 properties 4 required
createRoleWithPermissionsSchema
object
A write model for the custom role and permissions to allow Unleash to decide what actions a role holder is allowed to perform
resetPasswordSchema
object
Data used to provide users a way to reset their passwords.
1 property 1 required
roleWithPermissionsSchema
object
A read model for the role and permissions to allow Unleash to decide what actions a role holder is allowed to perform
5 properties 4 required
groupUserModelSchema
object
Details for a single user belonging to a group
3 properties 1 required
overrideSchema
object
An override for deciding which variant should be assigned to a user based on the context name
2 properties 2 required
passwordSchema
object
Fields used to create new password or update old password
3 properties 1 required
adminCountSchema
object
Contains total admin counts for an Unleash instance.
3 properties 3 required
createUserResponseSchema
object
An Unleash user after creation
17 properties 1 required
permissionSchema
object
Project and environment permissions
3 properties 1 required
releasePlanMilestoneSchema
object
Schema representing the creation of a release plan milestone.
9 properties 4 required
releasePlanSchema
object
Schema representing the creation of a release plan.
12 properties 9 required
idSchema
object
Email id used for password reset
1 property 1 required
safeguardSchema
object
A safeguard configuration for a release plan.
4 properties 4 required
inactiveUserSchema
object
A Unleash user that has been flagged as inactive
7 properties 1 required
featureEnvironmentSchema
object
A detailed description of the feature environment
19 properties 2 required
feedbackResponseSchema
object
User feedback information about a particular feedback item.
4 properties
updateUserSchema
object
All fields that can be directly changed for the user
3 properties
meSchema
object
Detailed user information
4 properties 4 required
usersGroupsBaseSchema
object
An overview of user groups and users.
2 properties
roleSchema
object
A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform
5 properties 3 required
rolesSchema
object
A list of roles
2 properties 2 required
inactiveUsersSchema
object
A list of users that has been flagged as inactive
2 properties 2 required
rolesWithVersionSchema
object
A collection of user roles
2 properties 2 required
tagSchema
object
Representation of a [tag](https://docs.getunleash.io/concepts/feature-flagstags)
3 properties 2 required
createUserSchema
object
The payload must contain at least one of the name and email properties, though which one is up to you. For the user to be able to log in to the system, the use…
6 properties 1 required
groupSchema
object
A detailed information about a user group
11 properties 1 required
parametersSchema
object
A list of parameters for a strategy
idsSchema
object
Used for bulk deleting multiple ids
1 property 1 required
roleWithVersionSchema
object
A single user role received after creation or update of a role
2 properties 2 required
safeguardTriggerConditionSchema
object
The condition that triggers the safeguard.
2 properties 2 required
strategyVariantSchema
object
This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data…
5 properties 4 required
createGroupSchema
object
A detailed information about a user group
5 properties 1 required
createStrategyVariantSchema
object
This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data…
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unleash-users-api-openapi.yml Raw ↑

Other APIs Unleash publishes across the network.

Unleash Client API
AE Profile APIs.io
Unleash Addons API
AE Profile APIs.io
Unleash Admin UI API
AE Profile APIs.io
Unleash API tokens API
AE Profile APIs.io
Unleash Archive API
AE Profile APIs.io
Unleash Auth API
AE Profile APIs.io
Unleash Banners API
AE Profile APIs.io
Unleash Change Requests API
AE Profile APIs.io
Unleash Context API
AE Profile APIs.io
Unleash Dependencies API
AE Profile APIs.io
Unleash Environments API
AE Profile APIs.io
Unleash Events API
AE Profile APIs.io
#User
← Back to U APIs
API Details
ID
unleash:unleash-users-api
Base URL
https://app.unleash-instance.example.com
Docs
https://docs.getunleash.io/api
Provider
Unleash
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=unleash-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/unleash-users-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 Unleash Users 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.