openapi: 3.0.3 info: contact: email: support@signoz.io name: SigNoz Support url: https://signoz.io description: OpenTelemetry-Native Logs, Metrics and Traces in a single pane termsOfService: https://signoz.io/terms-of-service/ title: SigNoz alerts users API version: '' servers: - description: The fully qualified URL to the SigNoz APIServer. url: https://{host}:{port}{base_path} variables: base_path: default: / description: The base path of the SigNoz APIServer host: default: localhost description: The host of the SigNoz APIServer port: default: '8080' description: The port of the SigNoz APIServer tags: - name: users paths: /api/v1/getResetPasswordToken/{id}: get: deprecated: true description: This endpoint returns the reset password token by id operationId: GetResetPasswordTokenDeprecated parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/TypesResetPasswordToken' status: type: string required: - status - data type: object description: OK '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Get reset password token tags: - users /api/v1/invite: post: deprecated: false description: This endpoint creates an invite for a user operationId: CreateInvite requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesPostableInvite' responses: '201': content: application/json: schema: properties: data: $ref: '#/components/schemas/TypesInvite' status: type: string required: - status - data type: object description: Created '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '409': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Create invite tags: - users /api/v1/invite/bulk: post: deprecated: false description: This endpoint creates a bulk invite for a user operationId: CreateBulkInvite requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesPostableBulkInviteRequest' responses: '201': description: Created '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '409': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Create bulk invite tags: - users /api/v1/resetPassword: post: deprecated: false description: This endpoint resets the password by token operationId: ResetPassword requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesPostableResetPassword' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '409': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Conflict '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error summary: Reset password tags: - users /api/v1/user: get: deprecated: false description: This endpoint lists all users operationId: ListUsersDeprecated responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/TypesDeprecatedUser' type: array status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: List users tags: - users /api/v1/user/{id}: delete: deprecated: false description: This endpoint deletes the user by id operationId: DeleteUser parameters: - in: path name: id required: true schema: type: string responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Delete user tags: - users get: deprecated: false description: This endpoint returns the user by id operationId: GetUserDeprecated parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/TypesDeprecatedUser' status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Get user tags: - users put: deprecated: false description: This endpoint updates the user by id operationId: UpdateUserDeprecated parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesDeprecatedUser' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/TypesDeprecatedUser' status: type: string required: - status - data type: object description: OK '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Update user tags: - users /api/v1/user/me: get: deprecated: false description: This endpoint returns the user I belong to operationId: GetMyUserDeprecated responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/TypesDeprecatedUser' status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - tokenizer: [] summary: Get my user tags: - users /api/v2/factor_password/forgot: post: deprecated: false description: This endpoint initiates the forgot password flow by sending a reset password email operationId: ForgotPassword requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesPostableForgotPassword' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '422': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error summary: Forgot password tags: - users /api/v2/roles/{id}/users: get: deprecated: false description: This endpoint returns the users having the role by role id operationId: GetUsersByRoleID parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/TypesUser' type: array status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Get users by role id tags: - users /api/v2/users: get: deprecated: false description: This endpoint lists all users for the organization operationId: ListUsers responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/TypesUser' type: array status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: List users v2 tags: - users /api/v2/users/{id}: get: deprecated: false description: This endpoint returns the user by id operationId: GetUser parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/AuthtypesUserWithRoles' status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Get user by user id tags: - users put: deprecated: false description: This endpoint updates the user by id operationId: UpdateUser parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesUpdatableUser' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Update user v2 tags: - users /api/v2/users/{id}/reset_password_tokens: get: deprecated: false description: This endpoint returns the existing reset password token for a user. operationId: GetResetPasswordToken parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/TypesResetPasswordToken' status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Get reset password token for a user tags: - users put: deprecated: false description: This endpoint creates or regenerates a reset password token for a user. If a valid token exists, it is returned. If expired, a new one is created. operationId: CreateResetPasswordToken parameters: - in: path name: id required: true schema: type: string responses: '201': content: application/json: schema: properties: data: $ref: '#/components/schemas/TypesResetPasswordToken' status: type: string required: - status - data type: object description: Created '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Create or regenerate reset password token for a user tags: - users /api/v2/users/{id}/roles: get: deprecated: false description: This endpoint returns the user roles by user id operationId: GetRolesByUserID parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/AuthtypesRole' type: array status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Get user roles tags: - users post: deprecated: false description: This endpoint assigns the role to the user roles by user id operationId: SetRoleByUserID parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesPostableRole' responses: '200': description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Set user roles tags: - users /api/v2/users/{id}/roles/{roleId}: delete: deprecated: false description: This endpoint removes a role from the user by user id and role id operationId: RemoveUserRoleByUserIDAndRoleID parameters: - in: path name: id required: true schema: type: string - in: path name: roleId required: true schema: type: string responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Remove a role from user tags: - users /api/v2/users/me: get: deprecated: false description: This endpoint returns the user I belong to operationId: GetMyUser responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/AuthtypesUserWithRoles' status: type: string required: - status - data type: object description: OK '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - tokenizer: [] summary: Get my user v2 tags: - users put: deprecated: false description: This endpoint updates the user I belong to operationId: UpdateMyUserV2 requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesUpdatableUser' responses: '204': description: No Content '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - tokenizer: [] summary: Update my user v2 tags: - users /api/v2/users/me/factor_password: put: deprecated: false description: This endpoint updates the password of the user I belong to operationId: UpdateMyPassword requestBody: content: application/json: schema: $ref: '#/components/schemas/TypesChangePasswordRequest' responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/RenderErrorResponse' description: Internal Server Error security: - api_key: - ADMIN - tokenizer: - ADMIN summary: Updates my password tags: - users components: schemas: AuthtypesUserRole: properties: createdAt: format: date-time type: string id: type: string role: $ref: '#/components/schemas/AuthtypesRole' roleId: type: string updatedAt: format: date-time type: string userId: type: string required: - id - userId - roleId - createdAt - updatedAt - role type: object RenderErrorResponse: properties: error: $ref: '#/components/schemas/ErrorsJSON' status: type: string required: - status - error type: object TypesPostableResetPassword: properties: password: type: string token: type: string type: object AuthtypesUserWithRoles: properties: createdAt: format: date-time type: string displayName: type: string email: type: string id: type: string isRoot: type: boolean orgId: type: string status: type: string updatedAt: format: date-time type: string userRoles: items: $ref: '#/components/schemas/AuthtypesUserRole' nullable: true type: array required: - id type: object TypesPostableInvite: properties: email: type: string frontendBaseUrl: type: string name: type: string role: type: string type: object TypesResetPasswordToken: properties: expiresAt: format: date-time type: string id: type: string passwordId: type: string token: type: string required: - id type: object TypesPostableForgotPassword: properties: email: type: string frontendBaseURL: type: string orgId: type: string required: - orgId - email type: object TypesPostableBulkInviteRequest: properties: invites: items: $ref: '#/components/schemas/TypesPostableInvite' type: array required: - invites type: object ErrorsJSON: properties: code: type: string errors: items: $ref: '#/components/schemas/ErrorsResponseerroradditional' type: array message: type: string url: type: string required: - code - message type: object ErrorsResponseerroradditional: properties: message: type: string type: object TypesInvite: properties: createdAt: format: date-time type: string email: type: string id: type: string inviteLink: type: string name: type: string orgId: type: string role: type: string token: type: string updatedAt: format: date-time type: string required: - id type: object TypesUser: properties: createdAt: format: date-time type: string displayName: type: string email: type: string id: type: string isRoot: type: boolean orgId: type: string status: type: string updatedAt: format: date-time type: string required: - id type: object TypesUpdatableUser: properties: displayName: type: string required: - displayName type: object TypesPostableRole: properties: name: type: string required: - name type: object TypesChangePasswordRequest: properties: newPassword: type: string oldPassword: type: string type: object AuthtypesRole: properties: createdAt: format: date-time type: string description: type: string id: type: string name: type: string orgId: type: string type: type: string updatedAt: format: date-time type: string required: - id - name - description - type - orgId type: object TypesDeprecatedUser: properties: createdAt: format: date-time type: string displayName: type: string email: type: string id: type: string isRoot: type: boolean orgId: type: string role: type: string status: type: string updatedAt: format: date-time type: string required: - id type: object securitySchemes: api_key: description: API Keys in: header name: SigNoz-Api-Key type: apiKey tokenizer: bearerFormat: Tokenizer description: Tokens generated by the tokenizer scheme: bearer type: http