References

Building a connector requires the use of the Orchestrator API. The following are the three primary resources that are available to help you during development.

1. Orchestrator API Docs
2. Orchestrator API Swagger Doc
3. Orchestrator API Postman Collection

Because the Orchestrator API includes many different operations, the table below is intended to provide further guidance on the specific operations to use for the more common connector functions.

Function	Operations	References
Authenticate (Cloud Orchestrator)	POST Token	POST Token API Swagger Postman
Authenticate (On-premise Orchestrator)	POST Authenticate	POST Authenticate API Swagger Postman
Authenticate (On-premise Orchestrator) (includes a Folder where username is unknown)	GET GetFolders GET GetCurrentUser GET GetUsersForFolder POST Authenticate	GET GetFolders Swagger GET GetCurrentUser Swagger GET GetUsersForFolder API Swagger POST Authenticate API Swagger Postman
Authenticate (On-premise Orchestrator) (includes a Folder where username is known)	GET GetFolders GET GetUsersForFolder POST Authenticate	GET GetFolders Swagger GET GetUsersForFolder API Swagger POST Authenticate API Swagger Postman
Start a Job (Strategy: JobsCount or All )	GET Releases POST StartJobs	GET Releases API Swagger Postman POST StartJobs API Swagger Postman
Start a Job (Strategy: Specific )	GET Releases GET GetEnvironments POST StartJobs	GET Releases API Swagger Postman GET GetEnvironments API Swagger Postman POST StartJobs API Swagger Postman