List deployable tenant organizations (Beta)

GET

/v2/deploymentPolicies/tenants

GET

/v2/deploymentPolicies/tenants

$ curl https://api.sigmacomputing.com/v2/deploymentPolicies/tenants \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "tenantOrganizationId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "tenantOrganizationSlug": "acme-corp",
6       "tenantOrganizationName": "Acme Corporation"
7     },
8     {
9       "tenantOrganizationId": "f0e1d2c3-b4a5-6789-0abc-def123456789",
10       "tenantOrganizationSlug": "globex-inc",
11       "tenantOrganizationName": "Globex Inc."
12     },
13     {
14       "tenantOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
15       "tenantOrganizationSlug": "initech",
16       "tenantOrganizationName": "Initech"
17     }
18   ],
19   "nextPageToken": "eyJwYWdlIjoxfQ=="
20 }

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.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

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.

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. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### 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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pageTokenstringOptional

pageSizeintegerOptional

searchstringOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

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.