orchestrator
2022.10
false
- Getting Started
- Authentication
- 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
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
- Platform Management APIs
Authorizing API Calls in Swagger
Orchestrator API Guide
Last updated Dec 9, 2024
Authorizing API Calls in Swagger
To access the Orchestrator API Swagger, append
/swagger/index.html
to the
Orchestrator URL. For example, https://{yourDomain}/swagger/index.html
.
The API you see in Swagger is directly dependent on the Orchestrator instance you use. To easily make requests directly in Swagger, log in to Orchestrator in another tab.
To authorize API calls via the Swagger UI in your Orchestrator instance, perform the following steps:
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 (
OrchestratorURL/swagger
). 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.