Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Unleash Auth API

Manage logins, passwords, etc.

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

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

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

14 operations 11 paths 16 schemas 7 GET7 POST

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 Auth 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 14

Across 11 paths, the API surfaces 14 operations — 7 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Auth 14

Manage logins, passwords, etc.

GET
/api/admin/permissions
Gets Available Permissions
getPermissions → 200
POST
/auth/simple/login
Log in
login body → 200401
GET
/api/admin/auth/saml/settings
Get SAML Auth Settings
getSamlSettings → 200400401403
POST
/api/admin/auth/saml/settings
Update SAML Auth Settings
setSamlSettings body → 200400401403415
GET
/api/admin/auth/oidc/settings
Get OIDC Auth Settings
getOidcSettings → 200400401403
POST
/api/admin/auth/oidc/settings
Set OIDC Settings
setOidcSettings body → 200400401403415
GET
/api/admin/auth/simple/settings
Get Simple Auth Settings
getSimpleSettings → 200401403
POST
/api/admin/auth/simple/settings
Update Simple Auth Settings
setSimpleSettings body → 200400401403415
GET
/api/admin/service-account/{id}/permissions
Returns the List of Permissions for the Service Account.
getServiceAccountPermissions 3 params → 200401403415
GET
/api/admin/access/overview
Gets Access Overview
getAccessOverview → 200401403415
GET
/auth/reset/validate
Validates a Token
validateToken → 200401415
POST
/auth/reset/password
Changes a User Password
changePassword body → 200401403415
POST
/auth/reset/validate-password
Validates Password
validatePassword body → 200400415
POST
/auth/reset/password-email
Reset Password
sendResetPasswordEmail body → 200401404415

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are userSchema (17 properties), oidcSettingsResponseSchema (15 properties), samlSettingsResponseSchema (12 properties), userAccessSchema (8 properties). Each schema is shown below with its type and property counts.

emailSchema
object
Represents the email of a user. Used to send email communication (reset password, welcome mail etc)
1 property 1 required
tokenUserSchema
object
A user identified by a token
6 properties 5 required
passwordAuthSchema
object
Does the server allow username/password authentication
1 property
validatePasswordSchema
object
Used to validate passwords obeying [Unleash password guidelines](https://docs.getunleash.io/using-unleash/deploy/configuring-unleashsecuring-unleash)
1 property 1 required
samlSettingsSchema
object
Settings used to authenticate via SAML
accessOverviewSchema
object
Data containing an overview of all the projects and groups users have access to
1 property
oidcSettingsResponseSchema
object
Response for OpenID Connect settings
15 properties
oidcSettingsSchema
object
Settings for configuring OpenID Connect as a login provider for Unleash
changePasswordSchema
object
Change password as long as the token is a valid token
2 properties 2 required
samlSettingsResponseSchema
object
Response for SAML settings
12 properties
userAccessSchema
object
Describes a single set of access for a user
8 properties 5 required
loginSchema
object
A username/password login request
2 properties 2 required
adminPermissionSchema
object
Describes a single permission
5 properties 4 required
userSchema
object
An Unleash user
17 properties 1 required
adminPermissionsSchema
object
What kind of permissions are available
2 properties 2 required
roleSchema
object
A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unleash-auth-api-openapi.yml Raw ↑

Other APIs Unleash publishes across the network.

Unleash Client API
Unleash Addons API
Unleash Admin UI API
Unleash API tokens API
Unleash Archive API
Unleash Banners API
Unleash Change Requests API
Unleash Context API
Unleash Dependencies API
Unleash Environments API
Unleash Events API
Unleash Feature Types API