Intro to admin API keys
Summarize
Summary of Intro to Admin API Keys
The Admin API keys enable access to admin functionalities without using the Admin UI, allowing ServiceNow customers to perform tasks through API calls. This functionality is particularly useful for automating processes and integrating with other systems.
Show less
Key Features
- Adding Admin API Keys: Access the Admin API Keys page via the Utilities section in CPQ Admin. Click "New" to create a key, providing required parameters such as name, user ID, expiration date, and permissions.
- Permissions: Different levels of access can be assigned:
- Read: Default read-only access.
- Edit: Full CRUD (Create, Read, Update, Delete) permissions.
- Deploy: Permissions for deploying blueprints.
- Bulk: Import and export data capabilities.
- Admin: Full access to all admin functions.
- End User Data: Access to end user data APIs.
- API Key Usage: Admin API keys must be used with Bearer Token authentication in API requests.
Key Outcomes
After creating an admin API key, you can utilize it for various admin API endpoints, improving efficiency in managing and accessing admin functionalities. Ensure to securely store the key upon creation, as it cannot be copied later.
Examples of API calls using admin keys are provided for both general admin endpoints and managed table endpoints, illustrating the transition from UI-based calls to API-driven interactions.
You can use admin API calls to access Admin functionality without using the Admin UI interface and a browser.
CPQ provides admin API keys that you can use to access admin functionality via API calls instead of using a browser and the CPQ Admin interface.
For an introduction to CPQ admin API keys, view the following video:
Admin API keys page
To get to the Admin API Keys page in CPQ, click the arrow to expand the Utilities section in CPQ Admin. The Admin API Keys tab appears in the menu.
Add a new admin API key
To add a new admin API key, click New at the top of the screen.
All parameters are required.
- Name: the name of the admin API key
- User ID
- Expiration Date: the expiration date of the key
- Permissions: the permissions assigned to the key
Choose the permissions that fit your use case before clicking Save.
Admin API key permissions
- Read (required, default): read-only access, typically for GET requests
- Edit: create, read, update, and delete access for most objects, including fields and rules
- Deploy: allows the deployment of blueprints and access to deployment history
- Bulk: allows importing and exporting data, such as managed tables, to and from CPQ
- Admin: full permissions to all Admin functionality
- End User Data: access to end user data APIs
When you are finished assigning permissions, click Save. The dialog box updates to show the new admin API key.
- View the admin API key
- Copy the key to the clipboard
- Close the dialog box
Accessing admin APIs by using API keys
To use an admin API key in API requests, use the API key with Bearer Token authentication.
- Header: Authorization Header
- Key: authorization
- Value: Bearer <Admin API key>
Example header:
authorization: Bearer Qda_UdoiYipb15Le11En8axEuN71FA6Vt_cw
When you use an admin API key, you use different endpoints to access the admin APIs.
- For general Admin endpoints (
/a/Admin/…) the endpoint to use is (/api/Admin/…).For example (retrieving a list of rules):
- API call in Admin UI:
/a/Admin/v3/rules?page=0&size=100&sort=modified%2CDESC - API call using Admin Keys:
/api/Admin/v3/rules?page=0&size=100&sort=modified%2CDESC
- API call in Admin UI:
- For managed table endpoints (
/a/managed_tables/…) the endpoint to use when accessing with an API key is (/api/managedTables/…)For example (retrieving the schema of a managed table):
- API call in Admin UI:
/a/managed_tables/v1/managedTables/{tableName}/metadata - API call using Admin Keys:
/api/managedTables/v1/managedTables/{tableName}/metadata
- API call in Admin UI: