To understand this API's various URL resources and the data it exchanges, it helps to be familiar with the following concepts:

  • API client. Primarily employed to make authenticated requests against the Identity Cloud REST APIs. Typically, these clients are used for login and registration. When a user logs on to or registers with a website, that logon or registration is managed by an API client. API clients are also involved when administering a website. Access to site resources (such as user profiles) is dictated, in part, by the property used to make a management request.

  • Allowlist. Specifies the range of IP addresses allowed to call operations. For example, suppose you set an allowlist to 192.168.0.0/30. If your computer has the IP address 10.10.1.1 you won't be able to call the API operations associated with the allowlist. That's because the address 10.01.1.1 isn't in the allowed range.

  • Client features. Properties of an API client that control the base level of read and write access the client has to user records and application management functionality. See API clients and permissions for more information.

  • Published settings. Custom client settings (maintained in JSON files) used with the JavaScript SDK.