orchestrator
2023.4
false
Orchestrator API guide
- Getting started
- Authentication
- Swagger definition
- 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
- Platform Management APIs
- About this guide
- Available resources
- API endpoint URL structure
- Enumeration List
Enumerations define a set of distinct and predefined values that serve as accepted options for specific attributes or fields in API requests and responses.
Platform management APIs expose several enums, as follows:
| Enum | Values |
|---|---|
| GroupType | builtIn = 0custom = 1 |
| UserType | userrobotdirectoryUserdirectoryGrouprobotAccount |
| LoginAttemptResult | successinvalidPassworduserIsNotActiveinvalidUserNameTenancyNametenantIsNotActiveuserEmailIsNotConfirmedunknownExternalLoginlockedOutexternalFailedAuthenticationadLogin |