OVERVIEW

This document is written to provide instructions for managing Application Programming Interface (API) connection credentials within CERTInext / InCommon Certificate Manager program

REQUIREMENTS

• Technician must have access to:
  • CERTInext/InCommon Certificate Manager with Elevated Privileges
• An appropriate & approved request to build new API connection credentials. Request must include:
  • Existing user account in CERTInext/InCommon Certificate Manager that matches the requestor's Career Account(CA) username.
  • API Type
    NOTE: If requesting ACME API type - User must include appropriate product(s) list that the API should be granted access to
  • Form completed by user with business appropriate need for accessing the CERTInext/InCommon Certificate Manager via API connection
  • List of Groups API will have management capabilities over in CERTInext/InCommon Certificate Manager
• Access to Filelocker

PROCEDURES

Create API Credentials

1. Log Into CERTInext Platform:
   1. See Article "Signing Into CERTInext (InCommon Certificate Manager)" for instructions for logging into the CERTInext platform
2. Click the "INTEGRATIONS" dropdown menu on the left hand side of the dashboard
3. Click the "APIs" item under the "INTEGRATIONS" dropdown menu
4. Click the "+Create API Credentials" button in the top right portion of the "APIs" window
5. In the "Create API Credentials" window select the appropriate API from the "API Type" dropdown menu
   NOTE: At time of article the only two(2) options IAMO is providing for users is "ACME" or "REST" APIs
6. If user requests ACME:
   1. Enter Identifier provided by user for the API connection in the "Identifier" textbox
   2. Select the user's CA username email in the "User" dropdown menu
   3. Select the Group(s) the user provided from the "Groups" dropdown menu
   4. Select the appropriate Product(s) the user provided from the "Products" dropdown menu
   5. Click "Generate" button at the bottom right of the "Create API Credentials" window
7. If user requests REST:
   1. Enter Identifier provided by user for the API connection in the "Identifier" textbox
   2. Select the user's CA username email in the "User" dropdown menu
   3. Select the Group(s) the user provided from the "Groups" dropdown menu
   4. Click "Generate" button at the bottom right of the "Create API Credentials" window
8. Locate the newly generated API credentials in the APIs table
9. Click the "View" link in the "API key credentials" for the newly created API
10. Copy the Key ID, Mac Key, & Directory URL from the "View API key credentials" window
11. Exit the "View API key credentials" window
12. Share the Key ID, Mac Key, & Directory URL with the user via filelocker
13. Resolve the ticket & inform the user that the API information is shared with them via filelocker

Revoke API Credentials

1. Log Into CERTInext Platform:
   1. See Article "Signing Into CERTInext (InCommon Certificate Manager)" for instructions for logging into the CERTInext platform
2. Click the "INTEGRATIONS" dropdown menu on the left hand side of the dashboard
3. Click the "APIs" item under the "INTEGRATIONS" dropdown menu
4. In the APIs screen locate the entry that needs to be revoked in the table of API credentials
5. Click the "Select" dropdown menu in the "Action" column on the right of the table of API credentials
6. Select "Revoke" from the "Select dropdown menu
7. Click the "Yes" button in the bottom right corner of the "Are you sure you want to Revoke?" window
8. Confirm that the API credentials are showing "Revoked" in the "Status" column of the table of API credentials
9. Resolve the ticket & inform the requester that the API credentials have been revoked

Delete API Credentials

1. Log Into CERTInext Platform:
   1. See Article "Signing Into CERTInext (InCommon Certificate Manager)" for instructions for logging into the CERTInext platform
2. Click the "INTEGRATIONS" dropdown menu on the left hand side of the dashboard
3. Click the "APIs" item under the "INTEGRATIONS" dropdown menu
4. In the APIs screen locate the entry that needs to be deleted in the table of API credentials
5. Click the "Select" dropdown menu in the "Action" column on the right of the table of API credentials
6. Select "Delete" from the "Select dropdown menu
7. Click the "Yes" button in the bottom right corner of the "Confirm Delete" window
8. Confirm that the API credentials are no longer showing up in the table of API credentials
9. Resolve the ticket & inform the requester that the API credentials have been deleted

GLOSSARY

• API: Application Programming Interface
• CA: Career Account

RESOURCES

• https://us.certinext.io/
• https://us.certinext.io/acmeApi
• https://filelocker.purdue.edu/
• https://docs.certinext.io/api-reference