Authentication using a Service Account

For accessing APIs, you can login via two types of accounts:
  • User account

    A user account represents an individual person interacting with the application or the system. User accounts are used for accessing the system on behalf of a user.

    For accessing APIs with a user account, you need to get the session ID by providing a username and password in the login API. This session ID can then be used for accessing other APIs.

    Note: You can also use the username and password in all API calls instead of the sessionId. However, this is not recommended.
  • Service account

    A service account represents a non-human entity such as an application or a service. It is used for automated processes or system-to-system interactions without human intervention.

    For accessing APIs with a service account, you need to get the Access Token by providing Client ID and Client Secret in get-service-token API. This Access Token can then be used for accessing other APIs.

    Note: Access Token Validity is 30 minutes by default and it can be configured in Settings > Authentication > oAuth Settings.

For accessing APIs with a service account, the subsequent sections will help you with instructions to: