Skip Navigation

System level guidelines

Throttling limits
  • There are throttling limits in place when calling the API. Try to optimize the workflow of calls to the API to achieve the maximum work within the number of allowed calls.
  • Your calls may be blocked if they exceed the defined limits of your system or organization.
Dates and times
  • Dates and times will be in the organization time zone unless otherwise specified.
User synchronization
  • Use batches to update multiple users in one request instead of single-user updates in each call.
  • Do not exceed more than 1000 users in each call because the SyncBy endpoints are in real-time. If you need to synchronize more than 1000 users in a call, use the background job CSV import endpoint.
  • Don't store UserIDs inside your application. The identifier for the user is username or mapping ID.
Attributes
  • The API GET method does not retrieve CommonName attributes when they contain the following special characters : + @ #
  • Common names may be optional in the user interface.
  • The following APIs do not support attributes whose common name {commonName} or attribute value common name {valueCommonName} contains the forward slash (/) character:
    HTTP type
    URL
    GET
    /orgs/{orgCode}/attributes/{commonName}
    GET
    /orgs/{orgCode}/attributes/{commonName}/Values
    GET
    /orgs/{orgCode}/attributes/{commonName}/Values/{valueCommonName}
    DELETE
    /orgs/{orgCode}/attributes/{commonName}/values
    POST
    /orgs/{orgCode}/attributes/{commonName}/values
    PUT
    /orgs/{orgCode}/attributes/{commonName}/values
    PUT
    /orgs/{orgCode}/attributes/{commonName}/values/{ValueCommonName}
    DELETE
    /orgs/{orgCode}/attributes/{commonName}/Values/{valueCommonName}/Users
    PUT
    /orgs/{orgCode}/attributes/{commonName}/Values/{valueCommonName}/Users