API Clients
What is an API Client?
An API Client is your gateway to KORE's APIs. It is an application that holds all the settings and security of your integration with KORE, giving you the flexibility to be as open or restrictive as possible.
Viewing API Clients
You can see all of the API clients associated with your account by going to Client Management in the developer portal.
If your client is locked, you will see a Lock icon beside your Client Name
Any user who has access to the developer portal can view the clients, but only those with the right roles and permissions can create or modify clients.
Creating a Client
To access any KORE API, you must create an API Client, which you can do in Client Management.
Your API Client will be enabled by default, which you can change later.
Client Owner
The user who creates the client is assigned theClient Owner, which gives them complete control of the API Client.
Locking the client
If you wish to restrict who can make edits to your API client, you have the option to Lock your client either at the time of creation or after.
If locked, the only users who can make edits are
Account Owner
Account Admins
Client Owner
Account
When you create a client, the account you are currently in identifies which account the Client targets.
If you have child accounts, you will need to switch to the account and create a client for that account
Token Expiry Time
When you create an API client, you are given API Credentials, which you use to obtain a token. This token will expire, which you can configure when creating your API Client.
For more details, review our page on how our APIs are authorized.
When selecting an expiry time for your token, consult your organization about their policies.
Client Type
There are two types of clients. Your role defines the type of API Client you can create.
Admin
It grants your client access to global and product resources to scope your client.
Users with the role of Account Owner or Account Admin can create an admin client.
Standard
It grants your client access to product resources so you can scope your client.
Users with the role of Account Owner, Account Admin or Developer can create a standard client.
Client Scopes
Each API Client has scopes which control which resources the client has access to. There are two types of scopes, which the client type unlocks.
Global Resources
These resources grant you access to resources to manage global resources for your account.
For example, one type of global resource is API Client, which, if selected, allows your API Client to manage your API Clients through an API.
Products
These are the products that, if selected, allow your API Client to make API calls against the product.
Edit a Client
You can edit the client by clicking on the client name then use the drop down for the list the actions you can perform on the API Client.
When changing scopes of an API client, remember to re-authorize your client using your Client ID/Secret to obtain a new token with the new scopes.
OAuth tokens issued for clients are tied to the specific scopes defined when the token is generated. Your previous tokens, if they haven't already expired, will still be authorized but with the scopes defined at the time of their creation.
The properties that requires re-authorizing to obtain a new updated token are:
Token Expiry Time
Scopes
Client Type
Global Resources
Products
Enable/Disable
An API Client can be enabled or disabled.
Disabling a client temporarily disables access to any resources. When re-enabled, the same Client Credentials can continue to work. Your API Credentials will never change.
An API client is enabled by default when you create one.
Renew Key
You can renew your keys if your API Client credentials have been compromised. Doing this invalidates your existing credentials, presenting you with new ones.
Your prior token will be invalid, requiring you to obtain a new one.
This operation can not be undone.
Transfer Ownership
If the API Client owner no longer wishes to own the resource, they can transfer ownership to another user with access to the developer portal.
Delete
You can delete the API client, invalidating all existing tokens and invalidating your current API Client Credentials.
This operation can not be undone.
Last updated