What are the API keys used in Lysis?

API keys provide challenge authorization

To determine which scheme is maximum appropriate, it’s vital to apprehend what API keys and authentication can provide.

Project identification — Identify the software or the venture that is making a name to this API

Project authorization — Check whether or not the calling software has been granted access to name the API and has enabled the API in their task

API keys aren’t as steady as authentication tokens (see Security of API keys), however they perceive the application or challenge it really is calling an API. They are generated on the task making the name, and you can restrict their use to an surroundings including an IP address range, or an Android or iOS app.

By figuring out the calling challenge, you can use API keys to partner utilization statistics with that mission. API keys allow the Extensible Service Proxy (ESP) to reject calls from initiatives that have not been granted get right of entry to or enabled inside the API.

Understanding API keys

An Application programming interface key (API key) is a completely unique code that is surpassed in to an API to identify the calling software or user. API keys are used to music and manipulate how the API is being used, as an example to prevent malicious use or abuse of the API. The API key regularly acts as both a completely unique identifier and a secret token for authentication, and is assigned a hard and fast of get right of entry to that is precise to the identity this is associated with it.

To view your API keys, visit Manage > Access (IAM) > API keys.

IBM Cloud API keys for users

IBM Cloud™ API keys are associated with a person’s identity, and every API key that is created by way of the person has the same get entry to that the person is assigned. The get admission to that the user is assigned can be from rules across more than one bills that the consumer is a member of. Therefore, it’s far viable that a person’s API key can be used to generate a token and get admission to resources that a user has get admission to to out of doors of the account wherein the API key changed into created.

The user API key may be used at once or used to generate a token. Because users may be members of more than one debts and have access to many assets across a couple of money owed, and the API key’s used to identify the person, it can allow get entry to to almost any useful resource, in any account, that the consumer has get right of entry to to. For this reason, the user API key have to be treated much like a username and password and have to in no way be shared.


IBM Cloud API keys for users may be created and associated with a practical ID. A purposeful ID is a person ID created to represent a program, software, or service. The practical ID may be invited to an account and assigned only the get right of entry to for a particular purpose, such as interacting with a selected resource or application. The functional ID should be granted simplest the minimum level get entry to in a unmarried account that is needed for the unique feature for which it changed into created.

If a service requires a user API key for interacting with other offerings or applications, use the functional ID person API key. By using the API key this is associated with the functional ID, you could provide best the get right of entry to that is needed for that carrier. Sharing a actual user ID API key with a service lets in the provider to get entry to any sources that the user can access across multiple debts. Sharing a real person ID API key’s fantastically discouraged.

Only the user for which the API secret’s related and an Administrator for the Identity Service can delete it. You can use the IBM Cloud API keys in the command-line interface (CLI) or as part of automation to log in as your user identification. You can also use IBM Cloud API keys to get right of entry to classic infrastructure APIs.

Authentication of users
By contrast, authentication schemes normally serve two purposes:

  • User authentication — Securely confirm that the calling consumer is who they claim to be.
  • User authorization — Check whether or not the person need to have get entry to to make this request.

Authentication schemes provide a steady way of identifying the calling consumer. Endpoints also checks the authentication token to verify that it has permission to name an API. Based on that authentication, the API server makes a decision on authorizing a request.

If you want the capability to identify the user making the name, see Authenticating users.

While API keys identify the calling venture, they don’t perceive the calling person. For instance, when you have created an utility this is calling an API, an API key can pick out the software this is making the call, however now not the identity of the person who is the use of the utility.


If you want a extra steady way to restrict which tasks or services can call your API, see Authentication between offerings.

Security of API keys

API keys are typically no longer taken into consideration steady; they are normally handy to clients, making it easy for someone to scouse borrow an API key. Once the secret’s stolen, it has no expiration, so it can be used indefinitely, except the venture owner revokes or regenerates the key. While the restrictions you may set on an API key mitigate this, there are higher processes for authorization.

For examples, see Authenticating users.

  • When to apply API keys
    An API may restrict a few or all of its strategies to require API keys. It makes sense to do that if:
  • You do need to dam anonymous traffic. API keys identify an utility’s site visitors for the API producer, in case the utility developer needs to work with the API manufacturer to debug an difficulty or display their software’s utilization.
  • You need to control the quantity of calls made to your API.
  • You want to perceive usage styles for your API’s site visitors. You can see software utilization in APIs & services.
  • You need to filter logs via API key.
  • API keys can’t be used for:
  • Identifying individual users — API keys don’t discover users, they become aware of projects.
  • Secure authorization.
  • Identifying the creators of a venture.

Service Infrastructure does not offer a method to directly appearance up projects from API keys.

Leave a Reply

Your email address will not be published. Required fields are marked *