User Management

This API allows you to manage users within organizations, including retrieving, creating, updating, and deactivating users.

See Full API Reference:

https://docs.scalar.com/editor#/reference/tag/users

OverviewCopied!

This documentation provides a comprehensive guide to the Users API, which enables managing user accounts within an organization. It covers endpoints for retrieving, creating, updating, and deactivating users, ensuring full control over user lifecycle management. All API calls are authenticated via a secure Bearer token, and responses are provided in a consistent JSON format for easy integration. This guide includes request formats, example code snippets, and expected responses to help developers quickly and effectively implement user management functionality into their applications.

Base URLCopied!

https://localhost/api/v1

Endpoints OverviewCopied!

Method

Endpoint

Description

GET

/orgs/{org_id}/users

Retrieve all users for a specific organization.

POST

/orgs/{org_id}/users

Add a new user to an organization.

GET

/users/{user_id}

Retrieve details for a specific user.

PATCH

/users/{user_id}

Update an existing user's details.

DELETE

/users/{user_id}

Deactivate a user account.