API Keys
Developer Portal
Accessing the Developer Portal
1.
2.
1. Click on Sign In
2. Under Admin Panel in the Sidebar, Click on API Keys
3. Here is the Developer Portal Section
Creating New API Key
1. Click on "Create new secret key"
2. Name your key in this field
3. Here, you can see different permission scopes: All, Read Only, and Restricted
4. Permission: All
The user gets access to all the APIs
5. Permission: Read Only
The user gets access to only GET requests
6. Permission: Restricted
Category level Permissions:
None: No access to any operations in the category.
Read: Access to only GET requests under that category
Write: Access to all the APIs under that category (GET, POST, PUT, DELETE, etc.)
7. Select Permission for each category
8. Click on Create
9. A popup with a key activation link appears
10. Click here to follow the link
11. In the new tab, Click on Allow access to activate your key
12. Copy your secret key and click on "Done"
13. Your new key will appear in the list of API keys.
Testing API Key in the REST API Playground
1. Click on View API documentation, you'll be redirected to REST API documentation
2. The list of all endpoints can be seen in the sidebar
3. Choose one of the endpoints to test your new key
4. Paste your new key in the Ocp-Apim-Subscription-Key field.
5. Click on Send API Request
6. The response from the API can be seen here
Deleting API Key
1.
2.
3.
1. Navigate to the API Keys List
2. Click the delete icon next to the key you want to remove
Click on "Revoke"
The key has been removed from the API Keys List
