Managing API authentication task

You can manage API authentication using the Platform Automation API endpoints for operations including:

• Creating an API authentication
• Listing all API authentications
• Retrieving an API authentication
• Updating an API authentication
• Deleting an API authentication

Creating an API authentication

You can use this endpoint to add an authentication method to an API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication

Listing all API authentications

You can use this endpoint to list all authentication methods available for an API.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication

Retrieving an API authentication

You can use this endpoint to retrieve a specific authentication method for an API.

Endpoint URL : https://test-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication/{id}

Updating an API authentication

You can use this endpoint to edit one or more authentication method details.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication/{id}

Deleting an API authentication

You can use this endpoint to delete a specific API authentication method.

Endpoint URL: https://test-apimanagement.education.gov.uk/api/tasks/apis/{apiId}/authentication/{id}

Example

An example showing how to use a Platform Automation API endpoint for automation can found in the Example automation using an api endpoint section.