List all tenant service groups
GET/tenancy/v1/tenant_service_groups
Get a list of all the tenant service groups that are available to the service account used to authenticate this request.
Request
Query Parameters
Indicates whether the response structure lists groups in their hierarchy, or as an array of TSGs without regard to hierarchy. Default is false (don't show hierarchy).
If false, the order of the TSGs in the result array is not guaranteed.
Responses
- 200
- 401
- 403
- 404
- 500
Successful response.
- application/json
- Schema
- Example (from schema)
- tenant_service_groups
- tenant_service_groups?hierarchy=true
Schema
- Array [
- ]
Total count of the items
items object[]required
The tenant service group's display name.
Possible values: >= 10 characters
and <= 10 characters
, Value must match regular expression ^1[0-9]+$
The tenant service group's ID.
Possible values: >= 10 characters
and <= 10 characters
, Value must match regular expression ^1[0-9]+$
The TSG ID for this tenant service group's parent.
The email address of the person or organization that should be contacted for support of this TSG.
Possible values: [High Tech
, Education
, Manufacturing
, Hospitality
, Professional & Legal Services
, Wholesale & Retail
, Finance
, Telecommunications
, State & Local Government
, Transportation & Logistics
, Federal Government
, Media & Entertainment
, Nonclassifiable Establishments
, Healthcare
, Utilities & Energy
, Insurance
, Agriculture
, Pharma & Life Sciences
, Construction
, Aerospace & Defense
, Real Estate
, Restaurant/Food Industry
, Other
]
A token that identifies the business vertical supported by the SASE products managed by this TSG.
{
"count": 1
}
{
"count": "5",
"items": [
{
"display_name": "Parent TSG",
"id": "1374575467",
"vertical": "High Tech"
},
{
"display_name": "Child1",
"id": "1957242655",
"parent_id": "1374575467",
"support_contact": "user@example.com",
"vertical": "High Tech"
},
{
"display_name": "Child2",
"id": "1995877003",
"parent_id": "1374575467",
"vertical": "High Tech"
},
{
"id": "1739543876",
"name": "grandChild1",
"parent_id": "1957242655",
"support_contact": "user@example.com"
},
{
"display_name": "Parent TSG 2",
"id": "1335787597",
"vertical": "Utilities & Energy"
}
]
}
{
"count": "5",
"items": [
{
"children": [
{
"children": [
{
"id": "1739543876",
"name": "grandChild1",
"parent_id": "1957242655",
"support_contact": "user@example.com"
}
],
"display_name": "Child1",
"id": "1957242655",
"parent_id": "1374575467",
"support_contact": "user@example.com",
"vertical": "High Tech"
},
{
"display_name": "Child2",
"id": "1995877003",
"parent_id": "1374575467",
"vertical": "High Tech"
}
],
"display_name": "Parent TSG",
"id": "1374575467",
"vertical": "High Tech"
},
{
"display_name": "Parent TSG 2",
"id": "1335787597",
"vertical": "Utilities & Energy"
}
]
}
JWT Expired
- text/plain
- Schema
- Jwt Expired
Schema
- any
Jwt is expired
Forbidden
- application/json
- Schema
- Forbidden
Schema
- any
{
"error": "Forbidden",
"message": "Forbidden",
"statusCode": 403
}
Not Found
- application/json
- Schema
- Tenant Service Group Not Found
Schema
- any
{
"error": "Not Found",
"message": "Not Found",
"statusCode": 404
}
Internal Error
- application/json
- Schema
- Internal Error
Schema
- any
{
"error": "Internal Server Error",
"message": "An internal server error occurred",
"statusCode": 500
}