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

SuperTokens User Roles API

User role assignment and management

SuperTokens User Roles API is one of 10 APIs that SuperTokens publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

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

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 5.1.

Requests are made against a single base URL, http://{host}:{port}.

5 operations 2 paths 5 schemas 1 DELETE2 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.1
Base URL
https://{supertokens-core-host}:{port}
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

SuperTokens User Roles API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — SuperTokens Core API key (configured in config.yaml or via environment variable)

Paths & Operations 5

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

User Roles 5

User role assignment and management

PUT
/recipe/roles
Create Or Update Role
createOrUpdateRole body → 200
GET
/recipe/roles
List Roles
listRoles → 200
PUT
/recipe/user/roles
Assign Role To User
assignRoleToUser body → 200
GET
/recipe/user/roles
Get User Roles
getUserRoles 1 param → 200
DELETE
/recipe/user/roles
Remove User Role
removeUserRole 2 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AssignRoleRequest (3 properties), CreateRoleRequest (2 properties), ListRolesResponse (2 properties), UserRolesResponse (2 properties). Each schema is shown below with its type and property counts.

UserRolesResponse
object
2 properties
ListRolesResponse
object
2 properties
StatusResponse
object
1 property
CreateRoleRequest
object
2 properties 1 required
AssignRoleRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

supertokens-user-roles-api-openapi.yml Raw ↑

Other APIs SuperTokens publishes across the network.

SuperTokens Email Password API
SuperTokens Email Verification API
SuperTokens Health API
SuperTokens Multi Tenancy API
SuperTokens Passwordless API
SuperTokens Sessions API
SuperTokens Third Party API
SuperTokens User Metadata API
SuperTokens Users API
Where this information came from

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