Authenticating APIs
Updated
Knowledge Hub APIs use Bearer token authentication with a Boomi Platform JWT. Every request must include the token in the Authorization header.
Authorization: Bearer <JWT>
Generate a JWT
Generate a JWT for your Boomi account in the environment you want to use. Replace <env> with your environment's domain and <boomi_account_id> with your account ID.
https://<env>.boomi.com/auth/jwt/generate/<boomi_account_id>
For more information about JWT authentication tokens, refer to Platform API and Partner API authentication.
Token behavior
Keep the following in mind when you use JWTs:
- Tokens are short-lived. Generate a new token when a request returns an authentication error.
- Tokens are scoped to a single account. A token for one account used on another account's resources returns a
404 Not Foundresponse, not a403 Forbiddenresponse. - Use a token only in the environment where you generated it.
Missing or invalid tokens
If a request has no token or an invalid token, the API returns a 401 Unauthorized response:
{
"error": "unauthorized",
"message": "Missing or invalid Authorization header"
}
Next steps
After you have a token, refer to Making API calls to start calling the Knowledge Hub APIs.
Was this topic helpful?