Skip to content
English
  • There are no suggestions because the search field is empty.

Getting Started with the Provisioning API

In this article, learn how to use the Provisioning API with Orchestry

The Provisioning API is a great way to integrate with Orchestry via other system. 

What Can It Do

Create Provisioning Request

POST provisioning/requests 

Accepts request information to create a new provisioning request. There are a lot of checks and balances with a request - for this reason we recommend to POST your request object to the /request/validation endpoint first before a creation attempt.

Before you create a request it's highly recommended to retrieve the underlying template from /templates first as a request may require information that you need to understand before submission. A couple examples of this required metadata fields, a security selection, a classification or sensitivity label. If you try to submit a request without the required information it will fail.

For more information see https://app.orchestry.com/client-api/documentation

Validate Provisioning Request Before Creation

POST provisioning/requests/validate 

Used to validate a creation request before final submission. Includes detailed information on the request's failure.

For more information see https://app.orchestry.com/client-api/documentation

Retrieve (GET) a Specific Request

GET provisioning/requests/[requestId] 

Used to retrieve a single request using the supplied [requestId] in the URL.

For more information see https://app.orchestry.com/client-api/documentation

Create Provisioning Request

GET provisioning/requests/[requestId]/jobstatus 

Used to retrieve the status of the request [requestId] in the URL.

For more information see https://app.orchestry.com/client-api/documentation

Request Approval 

POST provisioning/requests/[requestId]/approval

Used to provide approval or rejection for the request [requestId] in the URL.

For more information see https://app.orchestry.com/client-api/documentation

Query Requests

GET provisioning/requests/view/[viewName] 

For more information see https://app.orchestry.com/client-api/documentation

Query Templates

GET provisioning/templates 

Provides a list of all templates for the tenant. If you are going to present a list of templates to a user please filter the templates based on their configuration.

How Can it be Used?

Currently the Orchestry API can be used in three primary ways:

  1. Via the Test Bench
  2. Via PowerShell (see Using PowerShell to Call the Orchestry API : Orchestry Software)
  3. Via Power Automate Custom Actions (see Using Power Automate (or Azure Logic Apps) to Call the API : Orchestry Software)