Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The service API key is a unique identifier that is used to facilitate API authentication in an API request initiated by a service user. Service users are not allowed to sign in to the Cloud Services Portal. They are service accounts that are used by applications to access the Cloud Services Portal through the API. Each service API key is associated with a service account user. A service account user can be associated up to 10 service API keys. 

You can create service API keys for specific purposes. For example, you can use a service API key to authenticate an API call to automate a process to generate reports on the Cloud Services Portal and send the report to yourself via email. The service API key is the token key that you use in your command when executing the API call. You can also create service users and service API keys for user management purposes. For example, you can create a service user called "SCIM delete user" and associate it with a service API key, so you can use the key to execute an API call to delete invalid users safely and to automate the cleanup process of invalid users. In this case, invalid users can be those who have left your company or those who are not allowed to log in to your system for specific reasons.

...