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

SigNoz users API

The users API from SigNoz — 16 operation(s) for users.

SigNoz users API is one of 29 APIs that SigNoz 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, API documentation, an API reference, a GitHub repository, pricing, and a getting-started guide.

This API exposes 22 operations across 16 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

22 operations 16 paths 17 schemas 2 DELETE10 GET5 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://{host}:{port}
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

SigNoz users API declares 2 security schemes for authenticating requests. An API key is passed in the header as SigNoz-Api-Key (api_key). It accepts HTTP bearer tokens (Tokenizer) (tokenizer).

  • api_key — API Keys
  • tokenizer — Tokens generated by the tokenizer

Paths & Operations 22

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

users 22
GET
/api/v1/getResetPasswordToken/{id}deprecated
Get reset password token
GetResetPasswordTokenDeprecated 1 param → 200400401403404500
POST
/api/v1/invite
Create invite
CreateInvite body → 201400401403409500
POST
/api/v1/invite/bulk
Create bulk invite
CreateBulkInvite body → 201400401403409500
POST
/api/v1/resetPassword
Reset password
ResetPassword body → 204400409500
GET
/api/v1/user
List users
ListUsersDeprecated → 200401403500
DELETE
/api/v1/user/{id}
Delete user
DeleteUser 1 param → 204401403404500
GET
/api/v1/user/{id}
Get user
GetUserDeprecated 1 param → 200401403404500
PUT
/api/v1/user/{id}
Update user
UpdateUserDeprecated 1 param body → 200400401403404500
GET
/api/v1/user/me
Get my user
GetMyUserDeprecated → 200401403500
POST
/api/v2/factor_password/forgot
Forgot password
ForgotPassword body → 204400422500
GET
/api/v2/roles/{id}/users
Get users by role id
GetUsersByRoleID 1 param → 200401403404500
GET
/api/v2/users
List users v2
ListUsers → 200401403500
GET
/api/v2/users/{id}
Get user by user id
GetUser 1 param → 200401403404500
PUT
/api/v2/users/{id}
Update user v2
UpdateUser 1 param body → 204400401403404500
GET
/api/v2/users/{id}/reset_password_tokens
Get reset password token for a user
GetResetPasswordToken 1 param → 200401403404500
PUT
/api/v2/users/{id}/reset_password_tokens
Create or regenerate reset password token for a user
CreateResetPasswordToken 1 param → 201400401403404500
GET
/api/v2/users/{id}/roles
Get user roles
GetRolesByUserID 1 param → 200401403404500
POST
/api/v2/users/{id}/roles
Set user roles
SetRoleByUserID 1 param body → 200401403404500
DELETE
/api/v2/users/{id}/roles/{roleId}
Remove a role from user
RemoveUserRoleByUserIDAndRoleID 2 params → 204401403404500
GET
/api/v2/users/me
Get my user v2
GetMyUser → 200401403500
PUT
/api/v2/users/me
Update my user v2
UpdateMyUserV2 body → 204401403500
PUT
/api/v2/users/me/factor_password
Updates my password
UpdateMyPassword body → 204400401403404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are AuthtypesUserWithRoles (9 properties), TypesInvite (9 properties), TypesDeprecatedUser (9 properties), TypesUser (8 properties). Each schema is shown below with its type and property counts.

TypesPostableInvite
object
4 properties
TypesPostableBulkInviteRequest
object
1 property 1 required
RenderErrorResponse
object
2 properties 2 required
ErrorsResponseerroradditional
object
1 property
TypesResetPasswordToken
object
4 properties 1 required
AuthtypesUserWithRoles
object
9 properties 1 required
TypesPostableResetPassword
object
2 properties
TypesInvite
object
9 properties 1 required
TypesUser
object
8 properties 1 required
TypesDeprecatedUser
object
9 properties 1 required
TypesUpdatableUser
object
1 property 1 required
ErrorsJSON
object
4 properties 2 required
TypesPostableForgotPassword
object
3 properties 2 required
TypesPostableRole
object
1 property 1 required
AuthtypesUserRole
object
6 properties 6 required
TypesChangePasswordRequest
object
2 properties
AuthtypesRole
object
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signoz-users-api-openapi.yml Raw ↑

Other APIs SigNoz publishes across the network.

SigNoz alerts API
SigNoz authdomains API
SigNoz authz API
SigNoz channels API
SigNoz cloudintegration API
SigNoz dashboard API
SigNoz downtimeschedules API
SigNoz features API
SigNoz fields API
SigNoz gateway API
SigNoz global API
SigNoz health API
Where this information came from

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