Core User Manager APIs (3.0.0)

Download OpenAPI specification:Download

Authentication

Authentication is required. Refer below table, as authentication varies based on actor.

Actor Authentication
Global / Department User The user must be logged in to call this API.
Client Application Only authenticated client applications of type 'API' are allowed to access this API.

Licenses

The logged in user must have the following licenses:

  • If logged in user is a department user, the user must have any of the User Licenses.
  • If logged in user is a global user, any of the User Licenses must be installed.

Service Level Agreement (SLA)

This API has different rate limits and quotas based on your subscription plan.

Available Plans

Developer Plan

  • Cost: $1/month
  • Rate Limits:
    • /user:
      • POST: 0.16 requests per second
      • Burst: 3 concurrent requests
      • PATCH: 0.16 requests per second
      • Burst: 3 concurrent requests
    • /user/{id}:
      • DELETE: 0.16 requests per second
      • Burst: 3 concurrent requests
    • /user/ext-id/{id}:
      • DELETE: 0.16 requests per second
      • Burst: 3 concurrent requests
    • default:
      • GET: 1 requests per second
      • Burst: 20 concurrent requests
  • Quotas:
    • /user:
      • POST: 1000 requests per month
      • PATCH: 1000 requests per month
    • /user/{id}:
      • DELETE: 1000 requests per month
    • /user/ext-id/{id}:
      • DELETE: 1000 requests per month
    • default:
      • GET: 10000 requests per month

Basic Plan

  • Cost: $1/month
  • Rate Limits:
    • /user:
      • POST: 0.16 requests per second
      • Burst: 3 concurrent requests
      • PATCH: 0.16 requests per second
      • Burst: 3 concurrent requests
    • /user/{id}:
      • DELETE: 0.16 requests per second
      • Burst: 3 concurrent requests
    • /user/ext-id/{id}:
      • DELETE: 0.16 requests per second
      • Burst: 3 concurrent requests
    • default:
      • GET: 10 requests per second
      • Burst: 200 concurrent requests
  • Quotas:
    • /user:
      • POST: 10000 requests per month
      • PATCH: 10000 requests per month
    • /user/{id}:
      • DELETE: 10000 requests per month
    • /user/ext-id/{id}:
      • DELETE: 10000 requests per month
    • default:
      • GET: 100000 requests per month

Enterprise Plan

  • Cost: $1/month
  • Rate Limits:
    • /user:
      • POST: 0.5 requests per second
      • Burst: 10 concurrent requests
      • PATCH: 0.5 requests per second
      • Burst: 10 concurrent requests
    • /user/{id}:
      • DELETE: 0.5 requests per second
      • Burst: 10 concurrent requests
    • /user/ext-id/{id}:
      • DELETE: 0.5 requests per second
      • Burst: 10 concurrent requests
    • default:
      • GET: 60 requests per second
      • Burst: 1200 concurrent requests
  • Quotas:
    • /user:
      • POST: 50000 requests per month
      • PATCH: 50000 requests per month
    • /user/{id}:
      • DELETE: 50000 requests per month
    • /user/ext-id/{id}:
      • DELETE: 50000 requests per month
    • default:
      • GET: 500000 requests per month

Internal Plan

  • Cost: $1/month
  • Rate Limits:
    • /user:
      • POST: 0.5 requests per second
      • Burst: 10 concurrent requests
      • PATCH: 0.5 requests per second
      • Burst: 10 concurrent requests
    • /user/{id}:
      • DELETE: 0.5 requests per second
      • Burst: 10 concurrent requests
    • /user/ext-id/{id}:
      • DELETE: 0.5 requests per second
      • Burst: 10 concurrent requests
    • default:
      • GET: 60 requests per second
      • Burst: 1200 concurrent requests
  • Quotas:
    • /user:
      • POST: 50000 requests per month
      • PATCH: 50000 requests per month
    • /user/{id}:
      • DELETE: 50000 requests per month
    • /user/ext-id/{id}:
      • DELETE: 50000 requests per month
    • default:
      • GET: 500000 requests per month