API authentication

The Applications feature allows you to create and manage API access keys.

About applications

Applications allow you to logically group your access keys. For example, if you have more than one integration with the Connectivity Management API, you can create two separate applications to group your access keys by integration. Access keys must belong to an application, therefore you must create an application before you can create an access key.

Note: You can create a maximum of ten applications. Only active applications count towards the permitted total.

About access keys

The Connectivity Management API uses access keys to validate that calls originate from permitted sources. To validate that you have permission to access the Connectivity Management API, you must create an access key and include it in your calls.

Note: You can create a maximum of ten access keys per application. Only active access keys count towards the permitted total.

Access key scopes

Access key scopes allow you to specify the level of access your application has to the Connectivity Management API. The scopes that you can grant to an access key mirror the permissions that your user has. You cannot grant an access key with permissions that your user does not have. You can only configure an access key's scopes when you create it. You cannot edit an access key's scopes after you have created it.

Create an application

1. Go to the Applications page.

Result: The platform displays the Applications page.

2. Select the New button.

Result: The platform displays the New application form.

3. Complete the fields in the New application form, and select the Create button.

Result: The platform creates your application, and displays it in the Applications table.

Note: API access keys and applications are bound to the user that created them. When you delete a user, any API access keys or applications that they created will stop working.

Create an access key

1. Go to the Applications page.

Result: The platform displays the Applications page.

2. Select the application for which you want to create an access key.

Result: The platform displays the application's Summary page.

3. Select the Access keys tab.

Result: The platform displays the application's Access keys page.

4. Select the New button.

Result: The platform displays the New access key form.

5. Complete the fields in the New access key form, and select the Create button.

Result: The platform creates your access, and displays it in the Access key created table.

6. Securely record your access key, and select the I have copied my access key - Close button.

Result: The platform closes the modal and returns you to the Access keys table.

Note: API access keys and applications are bound to the user that created them. When you delete a user, any API access keys or applications that they created will stop working.

Use your access key

To validate that you have permission to access the Connectivity Management API, you must include your access key as a bearer credential in your call's HTTP authorization header.

The following illustration shows an example of how to include an access key in a call.

POST "https://api.connectivity-us.pelion.com/path/to/resource" -H "Authorization: Bearer d567fde24865df35defff57862dw2r42"

Manage your access keys

You can control whether calls made using an access key will be accepted by the Connectivity Management API by editing its status. The following table describes the access key status that are available in the Connectivity Management platform.

Status Description
Active

  • Access key is active

  • API calls made using an active key will be accepted by the Connectivity Management API
Revoked

  • Access key is not active

  • API calls made using a revoked key will be rejected by the Connectivity Management API

  • Revoked keys do not count towards your access key limit

  • Revoked keys are deleted from an application's Access keys table and are not visible in the user interface
Expired

  • Access key has exceeded its expiration date

  • API calls made using an expired key will be rejected by the Connectivity Management API

  • Expired keys do not count towards your access key limit

Manage your applications

You can control whether calls made using the access keys within an application will be accepted by the Connectivity Management API by editing its status. The following table describes the application status that are available in the Connectivity Management platform.

Status Description
Active

  • Application is active

  • API calls made using this application's access keys will be accepted by the Connectivity Management API
Revoked

  • Access key is not active

  • API calls made using this application's access keys will be rejected by the Connectivity Management API

  • Revoked applications do not count towards your application limit

  • Revoked applications are deleted from the Applications table and are not visible in the user interface

Permissions for this feature

Info: If you do not have access to this feature or some of its functionality you may require your administrator to update your user account's permissions. For more information about managing user permissions, see the topic Administrate users .

The following table describes the permissions that control the level of access that your user has to this feature.

Permission name Allows you to ...
View applications

  • Allows you to view the Applications feature
Create application

  • Allows you to view the Applications feature

  • Allows you to create applications
Edit application

  • Allows you to view the Applications feature

  • Allows you to edit an application's name and description
Revoke application

  • Allows you to view the Applications feature

  • Allows you to change an application's status to revoked
View access keys for any application

  • Allows you to view access keys within any application
View access keys for my applications

  • Allows you to only view access keys within applications you have created
Create access keys for any application

  • Allows you to create access keys within any application
Create access keys for my application

  • Allows you to only create access keys within applications you have created
Edit access keys for any application

  • Allows you to edit an access key's name and description for access keys within any application
Edit access keys for my application

  • Allows you to only edit an access key's name and description for access keys within applications you have created
Revoke access keys for any application

  • Allows you to change an access key's status to revoked within any application
Revoke access keys for my applications

  • Allows you to only change an access key's status to revoked within applications you have created