User API

Manage users and authentication in your Gconv Prune application

Overview

The User API provides endpoints for managing user accounts, authentication, and user-specific settings. This guide covers user management, profile updates, and access control.

User Management

POST /v1/users

Create a new user:

{
  "email": "[email protected]",
  "password": "secure_password",
  "name": "John Doe",
  "metadata": {
    "company": "Acme Inc",
    "role": "developer"
  }
}

GET /v1/users/{id}

Retrieve user details:

{
  "id": "usr_123",
  "email": "[email protected]",
  "name": "John Doe",
  "created_at": "2024-01-20T10:00:00Z",
  "metadata": {
    "company": "Acme Inc",
    "role": "developer"
  },
  "settings": {
    "theme": "dark",
    "notifications_enabled": true
  }
}

Profile Management

PATCH /v1/users/{id}

Update user profile:

{
  "name": "John Smith",
  "metadata": {
    "company": "New Corp",
    "role": "senior developer"
  },
  "settings": {
    "theme": "light"
  }
}

Access Control

Manage user permissions:

POST /v1/users/{id}/permissions

{
  "permissions": [
    "read:documents",
    "write:documents",
    "admin:settings"
  ],
  "role": "admin"
}

Need Help?

For more detailed information about the User API, check our API reference or contact our support team.