Configure the authentication required to test the Knowledge Base API or connect an application to it.
Knowledge Base API requests use bearer-token authentication. Use an authenticated user token for short-term testing, or configure a technical account for an application or integration.
Before you begin
Make sure that:
- Your organization has access to Knowledge Base.
- You have access to the API resources required for your workflow.
- You can access Adobe Developer Console if you're setting up an application integration.
API access does not override Knowledge Base permissions. The authenticated identity must have access to the collections, documents, and operations requested by the application.
Choose an authentication method
Use the authentication method that matches your development stage.
| Use case | Authentication |
|---|---|
| Test requests or explore the API | Authenticated user bearer token |
| Build an application or integration | Technical account |
User bearer token
An authenticated user bearer token is useful for testing API requests, including requests made through the API reference.
The token represents the signed-in user and is valid for 24 hours. Requests made with the token have the same Knowledge Base access available to that user.
After obtaining a user bearer token, include it with each request:
Authorization: Bearer <access-token>
You can also use the token with the interactive Knowledge Base API reference to test available endpoints.
Start with an operation that retrieves a resource you already have access to. A successful response confirms that the token is accepted and the authenticated identity can access that resource.
Do not build a persistent application integration around a user bearer token.
Technical account
Use a technical account for applications and integrations that need to authenticate without an interactive user session.
Technical accounts are configured through Adobe Developer Console. Follow the technical-account setup process to create the credentials required by your application.
After creating the technical account, return to this page to validate your access to the Knowledge Base API.
Understand API permissions
Authentication establishes the identity making the API request. Authorization determines what that identity can do.
For example, an authenticated identity may be able to retrieve one collection but not another, or may not have access to an administrator-level resource.
If authentication succeeds but an operation is rejected, verify that the authenticated identity has permission to access the requested resource before treating the response as an authentication failure.
Validate your API access
After authentication is configured:
- Obtain an access token.
- Submit a request to a resource the authenticated identity can access.
- Confirm that the API returns the expected response.
- Continue with the API getting-started workflow.
