- Getting Started
- Authentication
- Authentication methods
- External Applications (OAuth)
- ROPC (not recommended)
- Swagger Definition
- Examples using the Orchestrator API
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
- Platform Management
Authentication methods
Our API supports various authentication methods, each tailored to different scenarios and use cases. Here's an overview of the authentication methods available:
-
OAuth 2.0 for External Apps: OAuth 2.0 is designed for third-party applications seeking access to our platform on behalf of users. It facilitates secure authorization without exposing user credentials. External apps can register with us, obtaining client credentials that identify them. This method is recommended for larger integrations and applications accessing multiple users' data.
-
ROPC (not recommended): Resource Owner Password Credentials (ROPC) is an authentication method that allows users to provide their username and password directly to the authorization server to obtain an access token. It is less secure and not recommended compared to token-based methods like OAuth or personal access tokens.
