Deployment policies

List deployable tenant organizations

Returns a paginated list of tenant organizations that the calling organization can deploy to.

  • Parent organizations: Returns all tenant organizations.
  • Tenant organizations: Returns tenant organizations that the calling tenant has been granted deployment capabilities to.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned an account type with the Manage deployment policies permission enabled.
get/v2/deploymentPolicies/tenants

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Query parameters

pageTokenstring

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeinteger

Number of results to return per page, with a maximum of 500. Defaults to 50.

searchstring

Search term to filter tenant organizations by name or slug.

Response

The response body.

nextPageTokenstring

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.

Changes

No recorded changes to this operation across all 1 revision of this API.