Users

Overview

The Users endpoints enable management of user resources within the SCIM system. These APIs allow you to perform standard CRUD (Create, Read, Update, Delete) operations on user entities. Authentication is required for all user management operations.

Available Operations

List Users

  • Retrieve a paginated list of users
  • Support filtering and sorting capabilities

Create User

  • Add new users to the system
  • Requires basic user information
  • Returns the created user resource

Get User

  • Retrieve detailed information about a specific user
  • Access by unique user identifier

Update User

  • Full update (PUT): Replace all user attributes
  • Partial update (PATCH): Modify specific attributes

Delete User

  • Remove a user from the system

Common User Attributes

  • userName: Unique identifier for the user (email)
  • name: User's full name information
  • active: User's current status
  • id: Email of the user

For detailed API specifications, request/response examples, and implementation guidelines, please refer to the specific API endpoint documentation.