API - OpenCatapult Docs

Search…
API
Architecture
Architecture
Endpoints
The following sections explain the details for each endpoints:
​Account​
​Catapult Engine​
​External Service​
​External Service Type​
​Health​
​Job Definition​
​Job Queue​
​Project​
​Project Data Model​
​Project Member​
​Provider​
​Token​
​Version​
Note: In general usage, users don't need to access the API endpoints directly. They are meant to be accessed by the other OpenCatapult components. The endpoint list is maintained here for developer reference only.
Endpoint Authorization
Each endpoint is defined with certain access authorization. Following are the authorizations available in the API:
ProjectAccess: The user is a member in the current project, regardless of its role
ProjectOwnerAccess: The user is a member with Owner role in the current project
ProjectMaintainerAccess: The user is a member with Maintainer or higher role in the current project
ProjectContributorAccess: The user is a member with Contributor or higher role in the current project
ProjectMemberAccess: The user is a member in the current project
UserRoleAdminAccess: The user have an Administrator user role
UserRoleBasicAccess: The user have Basic user role or higher
UserRoleGuestAccess: The user have Guest user role or higher
UserRoleEngineAccess: The endpoint can only be invoked by catapult engine
Authenticated: The request to the API require any authenticated user
Anonymous: The endpoint does not require authentication
Further Reference
A more detailed documentation about each endpoints request and response is available within API's swagger page. Simply open the API base url in the browser to navigate the the swagger page.
Task
Account
Last modified 2yr ago
Copy link
Contents
Architecture
Endpoints
Endpoint Authorization
Further Reference