User Management

Comprehensive user lifecycle management including invitations, profiles, authentication, and deprovisioning.

User Lifecycle

Invite

Send invitations via email

Provision

Create via SCIM or API

Manage

Update roles and settings

Deprovision

Disable or delete users

Inviting Users

Send email invitations to add users to an organization:

Invite User APIbash

curl -X POST https://api.accessiq.io/v1/organizations/acme-corp/invitations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "roles": ["member"],
    "expiresIn": 604800,
    "customMessage": "Welcome to Acme Corp! Click the link to set up your account."
  }'

Creating Users

Directly create users via the API:

Create User APIbash

curl -X POST https://api.accessiq.io/v1/organizations/acme-corp/users \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john@acme.com",
    "name": "John Smith",
    "roles": ["admin"],
    "profile": {
      "title": "Engineering Manager",
      "department": "Engineering",
      "phone": "+1-555-0123"
    },
    "metadata": {
      "employeeId": "EMP001",
      "startDate": "2024-01-15"
    }
  }'

User Properties

User Schematypescript

interface User {
  id: string
  email: string
  emailVerified: boolean
  name: string
  picture?: string

  // Authentication
  mfaEnabled: boolean
  mfaMethods: string[]
  lastLogin: Date
  loginCount: number

  // Profile (extensible)
  profile: {
    title?: string
    department?: string
    phone?: string
    timezone?: string
    locale?: string
    [key: string]: any
  }

  // Custom data
  metadata: Record<string, any>

  // Status
  status: 'active' | 'inactive' | 'suspended' | 'pending'
  createdAt: Date
  updatedAt: Date
}

SCIM 2.0 Provisioning

Enable automatic user provisioning from identity providers that support SCIM 2.0:

SCIM Endpoint

https://api.accessiq.io/scim/v2/organizations/{org_id}

Supported Operations

AccessIQ's SCIM implementation supports: Create, Read, Update, Delete users, Group management, and bulk operations.

User Search & Filtering

Search Usersbash

# Search by email
curl "https://api.accessiq.io/v1/organizations/acme-corp/users?email=john@" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Filter by role
curl "https://api.accessiq.io/v1/organizations/acme-corp/users?role=admin" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Filter by status
curl "https://api.accessiq.io/v1/organizations/acme-corp/users?status=active" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Pagination
curl "https://api.accessiq.io/v1/organizations/acme-corp/users?page=1&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

Deprovisioning Users

Safely remove user access while maintaining audit trails:

Suspend

Temporarily disable access. User data is preserved and can be reactivated.

Deactivate

Permanently disable access. User data is retained for compliance.

Delete

Remove user data. Subject to data retention policies.