Update a tenant service group

PUT 
/tenancy/v1/tenant_service_groups/:tsg_id

Update a tenant service group. If the TSG ID supplied in this API's path does not match the TSG ID contained in the access token used to authenticate this request, this request will fail.

Request

Path Parameters

tsg_id _idrequired

Possible values: >= 10 characters and <= 10 characters, Value must match regular expression ^1[0-9]+$

A unique identifier for the tenant service group.

application/json

Body

required

display_name string

The tenant service group's display name.

support_contact string

The email address of the person or organization that should be contacted for support of this TSG.

vertical string

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.

Responses

200

Successful response.

application/json

Schema

Schema

display_name string

The tenant service group's display name.

id _id (string)required

Possible values: >= 10 characters and <= 10 characters, Value must match regular expression ^1[0-9]+$

The tenant service group's ID.

parent_id _reference_id (string)

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.

support_contact string

The email address of the person or organization that should be contacted for support of this TSG.

vertical string

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.

Example (from schema)

{
  "display_name": "Example TSG",
  "id": "1378242802",
  "parent_id": true,
  "support_contact": "user@example.com",
  "vertical": "High Tech"
}

401

JWT Expired

text/plain

Schema

Schema

any

Jwt Expired

Jwt is expired

403

Forbidden

application/json

Schema

Schema

any

Forbidden

{
  "error": "Forbidden",
  "message": "Forbidden",
  "statusCode": 403
}

404

Not Found

application/json

Schema

Schema

any

Tenant Service Group Not Found

{
  "error": "Not Found",
  "message": "Not Found",
  "statusCode": 404
}

500

Internal Error

application/json

Schema

Schema

any

Internal Error

{
  "error": "Internal Server Error",
  "message": "An internal server error occurred",
  "statusCode": 500
}

Loading...