Tenants

List tenant deployment capabilities

Retrieve a paginated list of tenant organizations that the specified tenant organization can deploy to.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • Retrieve the tenantOrganizationId by calling the /v2/tenants endpoint.
  • Use pageToken and pageSize to paginate results.
get/v2/tenants/{tenantOrganizationId}/capabilities/deployments

Request

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

Path parameters

tenantOrganizationIdstring required

Unique identifier of the tenant organization whose deployment capabilities are being managed.

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 1000. Defaults to 50.

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.