This article clarifies whether the Application Notes field can be updated via the Okta API.
- Okta API
- Okta Integration Network (OIN)
- Postman
The Application Notes field can be updated via the Okta API. This means a solution can be scripted to bulk update the notes for the applications, saving significant time and effort compared to manual updates through the Admin Console.
Below is a breakdown of how this can be achieved, focusing on using the Okta API and the Postman PUT method.
- Identify the Application ID
Locate the unique identifier of the Okta application that should be updated. - Perform a GET call on with the AppId and copy the body of the request
For Example:GET /api/v1/apps/{appId}. -
Prepare the PUT Request
Construct a PUT request with the copied response from step 2 to the Okta API endpoint for updating applications.
For example:
PUT /api/v1/apps/{appId}.
- Include the Application Notes. In the request body, include the new application notes as part of the updated application data.
For more information, please check the Add notes to an app integration documentation. -
Execute the Request. Send the PUT request to the Okta API endpoint using Postman.
-
Verify the Update. Check that the application notes have been updated successfully in the Okta Admin Console.
