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

Tyk Users API

The admin portion of the users API gives you the ability to manage password reset policies for your Dashboard users.

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

This API exposes 1 JSON Schema definition.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, a changelog, and 1 JSON Schema.

This API exposes 13 operations across 9 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: http://localhost/, https://localhost/, https://{tenant}.

13 operations 9 paths 7 schemas 1 DELETE4 GET3 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://tyk.io/
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Tyk Users API declares 2 security schemes for authenticating requests. An API key is passed in the header as Admin-Auth (ApiKeyAuth). It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — The Tyk Dashboard API Access Credentials

Paths & Operations 13

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

Users 13

The admin portion of the users API gives you the ability to manage password reset policies for your Dashboard users.

PUT
/admin/users/{USER_ID}/actions/allow_reset_passwords
Allow password reset for a User
allowResetPassword 2 params → 200
PUT
/admin/users/{USER_ID}/actions/disallow_reset_passwords
Disallow password reset for a User
disallowResetPassword 2 params → 200
GET
/api/users
List users
getUsers 1 param → 200401403404500
POST
/api/users
Add user.
addUser body → 200400401403500
DELETE
/api/users/{userId}
Delete a user.
deleteUser 1 param → 200400401403404500
GET
/api/users/{userId}
Get user details.
getUser 1 param → 200401403404500
PUT
/api/users/{userId}
Update user.
updateUser 1 param body → 200400401403500
PUT
/api/users/{userId}/actions/key/reset
Reset user Dashboard API access credentials.
resetUserKey 1 param → 200400401403404500
POST
/api/users/{userId}/actions/reset
Set user password.
setUserPassword 1 param body → 200401403500
PUT
/api/users/{userId}/actions/revoke
Revoke user.
revokeUser 1 param → 200400401403500
GET
/api/users/me
Get current user.
currentUserDetail 1 param → 200401403404500
GET
/api/users/searchdeprecated
Search Users(Deprecated)
searchUserGet 2 params → 200401403404
POST
/api/users/search
Search user with email.
searchUser 1 param body → 200400401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), ApiResponse (4 properties), UserPassword (3 properties), Users (2 properties). Each schema is shown below with its type and property counts.

Users
object
2 properties
ApiModel
object
UserPassword
object
3 properties
User
object
14 properties 4 required
UserSearchPayload
object
1 property
ApiResponse
object
4 properties
UserPermissionObject
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tyk-users-api-openapi.yml Raw ↑

Other APIs Tyk publishes across the network.

Tyk Additional Permissions API
Tyk Analytics API
Tyk APIs API
Tyk Assets API
Tyk AuditLogs API
Tyk Basic Authentication API
Tyk Batch Requests API
Tyk Cache Invalidation API
Tyk Certificates API
Tyk Certs API
Tyk CertsTag API
Tyk Config API
Where this information came from

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