orchestrator
2024.10
true
- Getting Started
- Swagger Definition
- Read Me
- Authorizing API Calls in Swagger
- Managing Logical Resources
- Orchestrator APIs
- 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
Orchestrator API Guide
Last updated Nov 11, 2024
Authorizing API Calls in Swagger
If you are using Swagger to try our API, just log in to your Orchestrator instance in a separate tab.
The Orchestrator API Swagger definition can be accessed by adding the
/swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_
/swagger/ui/index#/.
Note: The Swagger authentication expires according to the parameters set in your Orchestrator instance. By default, it is set to
30 minutes. You can change it by modifying the value of the
Auth.Cookie.Expire parameter, in the Web.config file.
To authorize API calls via the Swagger UI for Orchestrator services, perform the following steps:
-
Look for the Authorize button at the top right corner of the Orchestrator API page. If the lock is open, you are unauthorized.
-
Click Authorize. The Available authorizations window is displayed.
Note: We currently support one authorization scheme called OAuth2. - All scopes are preselected such that you can experiment with all endpoints in the Orchestrator API. Clear them if you want to restrict access to certain APIs.
- Click Authorize. A new window is displayed confirming you have been authorized.
- Once done, click Close or X to close the Available authorizations window. The Authorize button shows an closed lock meaning you are authorized.
When the access token expires you receive a
401: You are not authenticated! response. The bearer authorization header is still present for your requests, but the access token is expired. When this
happens, you need to invalidate the expired token and generate a new access token:
When you're done working with the Swagger UI, you should invalidate the access token you've used:
- Look for the Authorize button at the top right corner of the Orchestrator API page. The lock should be closed, meaning you are authorized.
- Click Authorize and on the displayed Available authorizations page, click Logout.
- Close the Available authorizations window by clicking Close or X. The Authorize button shows an open lock meaning you are unauthorized.
