openapi: 3.2.0
info:
  title: Palo Alto Networks Tenant Service Group API
  version: '1.0'
  contact: {}
  description: 'Operations tagged TenantServiceGroup across 2 of this provider''s published API definitions: palo-alto-sase-tenancy-tenantservicegroup-openapi.yaml, palo-alto-scm-tenancy-tenantservicegroup-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sase.paloaltonetworks.com
tags:
- name: TenantServiceGroup
paths:
  /tenancy/v1/tenant_service_groups:
    get:
      description: 'Get a list of all the tenant service groups

        that are available to the service account used to

        authenticate this request.

        '
      operationId: get-tenancy-v1-tenant_service_groups
      parameters:
      - description: '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.

          '
        in: query
        name: hierarchy
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/tenant_service_groups_response'
        '401':
          $ref: '#/components/responses/jwt_expired'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
      - Bearer: []
      summary: List all tenant service groups
      tags:
      - TenantServiceGroup
    post:
      description: 'Create a tenant service group.

        The service account used to authenticate this request

        is granted `msp_superuser` access to the new tenant

        service group.

        '
      operationId: post-tenancy-v1-tenant_service_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tenant_service_group_create'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/tenant_service_group_response'
        '400':
          $ref: '#/components/responses/tenant_service_groups_create_bad_request'
        '401':
          $ref: '#/components/responses/jwt_expired'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
      - Bearer: []
      summary: Create a tenant service group
      tags:
      - TenantServiceGroup
    servers:
    - url: https://api.sase.paloaltonetworks.com
  /tenancy/v1/tenant_service_groups/{tsg_id}:
    delete:
      description: 'Delete 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.

        '
      operationId: delete-tenancy-v1-tenant_service_groups-tsg_id
      parameters:
      - $ref: '#/components/parameters/tsg_id'
      responses:
        '200':
          $ref: '#/components/responses/tenant_service_group_response'
        '401':
          $ref: '#/components/responses/jwt_expired'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
      - Bearer: []
      summary: Delete a tenant service group
      tags:
      - TenantServiceGroup
    get:
      description: 'Get a tenant service group by TSG ID.

        '
      operationId: get-tenancy-v1-tenant_service_groups-tsg_id
      parameters:
      - $ref: '#/components/parameters/tsg_id'
      responses:
        '200':
          $ref: '#/components/responses/tenant_service_group_response'
        '401':
          $ref: '#/components/responses/jwt_expired'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
      - Bearer: []
      summary: Get a tenant service group
      tags:
      - TenantServiceGroup
    put:
      description: "Update a tenant service group. If the TSG ID supplied \nin this API's path does not match the TSG ID contained in\nthe access token used to authenticate this request, this \nrequest will fail.\n"
      operationId: put-tenancy-v1-tenant_service_groups-tsg_id
      parameters:
      - $ref: '#/components/parameters/tsg_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tenant_service_group_update'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/tenant_service_group_response'
        '401':
          $ref: '#/components/responses/jwt_expired'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
      - Bearer: []
      summary: Update a tenant service group
      tags:
      - TenantServiceGroup
    servers:
    - url: https://api.sase.paloaltonetworks.com
  /tenancy/v1/tenant_service_groups/{tsg_id}/operations/list_ancestors:
    post:
      description: 'List the ancestor tenants of the tenant service group

        specified in this request. 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.

        '
      operationId: post-tenancy-v1-tenant_service_groups-tsg_id-operations-list_ancestors
      parameters:
      - description: 'Identifies the response structure''s sort order:


          * `asc` : From root to leaf.

          * `desc` : From leaf to root.

          '
        in: query
        name: sort
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
      - description: 'Indicates if the TSG used to generate this hierarchy is

          included in the resulting TSG list. `true` to include

          self. Default is `false`.

          '
        in: query
        name: include_self
        required: false
        schema:
          type: boolean
      - $ref: '#/components/parameters/tsg_id'
      - description: 'Provide a comma-separated list of fields you want returned.

          '
        in: query
        name: fields
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/tenant_service_group_ancestors_response'
        '401':
          $ref: '#/components/responses/jwt_expired'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
      - Bearer: []
      summary: List tenant service group ancestors
      tags:
      - TenantServiceGroup
    servers:
    - url: https://api.sase.paloaltonetworks.com
  /tenancy/v1/tenant_service_groups/{tsg_id}/operations/list_children:
    post:
      description: 'List the child tenants of the tenant service group

        specified in this request. 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.

        '
      operationId: post-tenancy-v1-tenant_service_groups-tsg_id-operations-list_children
      parameters:
      - $ref: '#/components/parameters/tsg_id'
      - description: 'If `true`, return the entire descendent hierarchy.

          If `false`, return only the immediate children of the

          TSG identified in this call''s path. Default is

          `false`.

          '
        in: query
        name: hierarchy
        schema:
          type: boolean
      - description: 'Indicates if the TSG used to generate this hierarchy is

          included in the resulting TSG list. `true` to include

          self. Default is `false`.

          '
        in: query
        name: include_self
        required: false
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/tenant_service_group_children_response'
        '401':
          $ref: '#/components/responses/jwt_expired'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
      - Bearer: []
      summary: List tenant service group children
      tags:
      - TenantServiceGroup
    servers:
    - url: https://api.sase.paloaltonetworks.com
components:
  responses:
    jwt_expired:
      content:
        text/plain:
          examples:
            Jwt Expired:
              value: Jwt is expired
      description: JWT Expired
    tenant_service_groups_create_bad_request:
      content:
        application/json:
          examples:
            Children Limit:
              value:
                error: Bad Request
                message: A Tenant Service Group can have at most {integer} direct children.
                statusCode: 400
            Depth Limit:
              value:
                error: Bad Request
                message: A Tenant Service Group can be at most {integer} levels deep.
                statusCode: 400
            Name Conflict:
              value:
                error: Bad Request
                message: A Tenant Service Group of that name already exists.
                statusCode: 400
            Size Limit:
              value:
                error: Bad Request
                message: One Tenant Service Group Hierarchy can have at most {integer} children.
                statusCode: 400
      description: ''
    tenant_service_group_response:
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/tenant_service_group'
      description: Successful response.
    internal_error:
      content:
        application/json:
          examples:
            Internal Error:
              value:
                error: Internal Server Error
                message: An internal server error occurred
                statusCode: 500
      description: Internal Error
    forbidden:
      content:
        application/json:
          examples:
            Forbidden:
              value:
                error: Forbidden
                message: Forbidden
                statusCode: 403
      description: Forbidden
    tenant_service_groups_response:
      content:
        application/json:
          examples:
            tenant_service_groups:
              value:
                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
            tenant_service_groups?hierarchy=true:
              value:
                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
          schema:
            allOf:
            - $ref: '#/components/schemas/items_object_wrapper'
            - example:
                count: 1
            - properties:
                items:
                  items:
                    $ref: '#/components/schemas/tenant_service_group'
                  type: array
              type: object
      description: Successful response.
    not_found:
      content:
        application/json:
          examples:
            Tenant Service Group Not Found:
              value:
                error: Not Found
                message: Not Found
                statusCode: 404
      description: Not Found
    tenant_service_group_ancestors_response:
      content:
        application/json:
          examples:
            include_self=false&sort=asc:
              value:
                count: 4
                items:
                - display_name: Root TSG
                  id: '1809106289'
                - display_name: Org TSG
                  id: '1179022506'
                  parent_id: '1809106289'
                  vertical: High Tech
                - display_name: Suborg TSG
                  id: '1957242655'
                  parent_id: '1179022506'
                - display_name: ParentTSG
                  id: '1739543876'
                  parent_id: '1957242655'
                  support_contact: user@example.com
                  vertical: High Tech
            include_self=true&sort=asc:
              value:
                count: 5
                items:
                - display_name: Root TSG
                  id: '1809106289'
                - display_name: Org TSG
                  id: '1179022506'
                  parent_id: '1809106289'
                  vertical: High Tech
                - display_name: Suborg TSG
                  id: '1957242655'
                  parent_id: '1179022506'
                - display_name: ParentTSG
                  id: '1739543876'
                  parent_id: '1957242655'
                  support_contact: user@example.com
                  vertical: High Tech
                - display_name: TargetTSG
                  id: '1995877003'
                  parent_id: '1739543876'
                  support_contact: user@example.com
                  vertical: High Tech
            include_self=true&sort=desc:
              value:
                count: 5
                items:
                - display_name: TargetTSG
                  id: '1995877003'
                  parent_id: '1739543876'
                  support_contact: user@example.com
                  vertical: High Tech
                - display_name: ParentTSG
                  id: '1739543876'
                  parent_id: '1957242655'
                  support_contact: user@example.com
                  vertical: High Tech
                - display_name: Suborg TSG
                  id: '1957242655'
                  parent_id: '1179022506'
                - display_name: Org TSG
                  id: '1179022506'
                  parent_id: '1809106289'
                  vertical: High Tech
                - display_name: Root TSG
                  id: '1809106289'
          schema:
            allOf:
            - $ref: '#/components/schemas/items_object_wrapper'
            - example:
                count: 1
            - properties:
                items:
                  items:
                    $ref: '#/components/schemas/tenant_service_group'
                  type: array
              type: object
      description: Successful response.
    tenant_service_group_children_response:
      content:
        application/json:
          examples:
            list_children:
              value:
                count: '2'
                items:
                - display_name: Child TSG 1
                  id: '1957242655'
                  parent_id: '1374575467'
                  support_contact: user@example.com
                  vertical: High Tech
                - display_name: Child TSG 1
                  id: '1739543876'
                  parent_id: '1374575467'
            list_children?fields=id:
              value:
                count: '2'
                items:
                - id: '1957242655'
                - id: '1739543876'
            list_children?hierarchy=true:
              value:
                count: '3'
                items:
                - children:
                  - id: '1626857948'
                    name: Grandchild TSG
                    parent_id: '1957242655'
                    support_contact: user@example.com
                  display_name: Child TSG 1
                  id: '1957242655'
                  parent_id: '1374575467'
                  support_contact: user@example.com
                  vertical: High Tech
                - display_name: Child TSG 1
                  id: '1739543876'
                  parent_id: '1374575467'
            list_children?hierarchy=true&include_self=true:
              value:
                count: '4'
                items:
                - children:
                  - children:
                    - id: '1626857948'
                      name: Grandchild TSG
                      parent_id: '1957242655'
                      support_contact: user@example.com
                    display_name: Child TSG 1
                    id: '1957242655'
                    parent_id: '1374575467'
                    support_contact: user@example.com
                    vertical: High Tech
                  - display_name: Child TSG 1
                    id: '1739543876'
                    parent_id: '1374575467'
                  display_name: Parent TSG
                  id: '1374575467'
                  vertical: High Tech
          schema:
            allOf:
            - $ref: '#/components/schemas/items_object_wrapper'
            - example:
                count: 1
            - properties:
                items:
                  items:
                    $ref: '#/components/schemas/tenant_service_group'
                  type: array
              type: object
      description: Successful response.
  schemas:
    tenant_service_group:
      allOf:
      - properties:
          display_name:
            description: 'The tenant service group''s display name.

              '
            example: Example TSG
            type: string
          id:
            allOf:
            - $ref: '#/components/schemas/_id'
            description: The tenant service group's ID.
            readOnly: true
          parent_id:
            allOf:
            - $ref: '#/components/schemas/_reference_id'
            description: 'The TSG ID for this tenant service group''s parent.

              '
          support_contact:
            description: 'The email address of the person or organization that should

              be contacted for support of this TSG.

              '
            example: user@example.com
            type: string
          vertical:
            description: 'A token that identifies the business vertical supported by the SASE

              products managed by this TSG.

              '
            enum:
            - 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
            example: High Tech
            type: string
        required:
        - id
        type: object
      type: object
    tenant_service_group_update:
      properties:
        display_name:
          description: 'The tenant service group''s display name.

            '
          example: Example TSG
          type: string
        support_contact:
          description: 'The email address of the person or organization that should

            be contacted for support of this TSG.

            '
          example: user@example.com
          type: string
        vertical:
          description: 'A token that identifies the business vertical supported by the SASE

            products managed by this TSG.

            '
          enum:
          - 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
          example: High Tech
          type: string
      type: object
    _reference_id:
      allOf:
      - $ref: '#/components/schemas/_id'
      example: 1995877003
      readOnly: false
      type: string
    items_object_wrapper:
      properties:
        count:
          description: Total count of the items
          type: integer
      required:
      - count
      - items
      type: object
    tenant_service_group_create:
      allOf:
      - properties:
          display_name:
            description: 'The tenant service group''s display name.

              '
            example: Example TSG
            type: string
          parent_id:
            allOf:
            - $ref: '#/components/schemas/_reference_id'
            description: 'The TSG ID for this tenant service group''s parent.

              '
          support_contact:
            description: 'The email address of the person or organization that should

              be contacted for support of this TSG.

              '
            example: user@example.com
            type: string
          vertical:
            description: 'A token that identifies the business vertical supported by the SASE

              products managed by this TSG.

              '
            enum:
            - 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
            example: High Tech
            type: string
        required:
        - display_name
        type: object
      type: object
    _id:
      description: A unique identifier.
      example: '1378242802'
      maxLength: 10
      minLength: 10
      pattern: ^1[0-9]+$
      readOnly: true
      type: string
    tenant_service_group_2:
      allOf:
      - properties:
          display_name:
            description: 'The tenant service group''s display name.

              '
            example: Example TSG
            type: string
          id:
            allOf:
            - $ref: '#/components/schemas/_id'
            description: The tenant service group's ID.
            readOnly: true
          parent_id:
            allOf:
            - $ref: '#/components/schemas/_reference_id'
            description: 'The TSG ID for this tenant service group''s parent.

              '
          support_contact:
            description: 'The email address of the person or organization that should

              be contacted for support of this TSG.

              '
            example: user@example.com
            type: string
          vertical:
            description: 'A token that identifies the business vertical supported by the Strata Cloud Manager

              products managed by this TSG.

              '
            enum:
            - 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
            example: High Tech
            type: string
        required:
        - id
        type: object
      type: object
    tenant_service_group_update_2:
      properties:
        display_name:
          description: 'The tenant service group''s display name.

            '
          example: Example TSG
          type: string
        support_contact:
          description: 'The email address of the person or organization that should

            be contacted for support of this TSG.

            '
          example: user@example.com
          type: string
        vertical:
          description: 'A token that identifies the business vertical supported by the Strata Cloud Manager

            products managed by this TSG.

            '
          enum:
          - 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
          example: High Tech
          type: string
      type: object
    tenant_service_group_create_2:
      allOf:
      - properties:
          display_name:
            description: 'The tenant service group''s display name.

              '
            example: Example TSG
            type: string
          parent_id:
            allOf:
            - $ref: '#/components/schemas/_reference_id'
            description: 'The TSG ID for this tenant service group''s parent.

              '
          support_contact:
            description: 'The email address of the person or organization that should

              be contacted for support of this TSG.

              '
            example: user@example.com
            type: string
          vertical:
            description: 'A token that identifies the business vertical supported by the Strata Cloud Manager

              products managed by this TSG.

              '
            enum:
            - 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
            example: High Tech
            type: string
        required:
        - display_name
        type: object
      type: object
  parameters:
    tsg_id:
      description: 'A unique identifier for the tenant service group.

        '
      in: path
      name: tsg_id
      required: true
      schema:
        $ref: '#/components/schemas/_id'
  securitySchemes:
    Bearer:
      scheme: bearer
      type: http
x-refined-from:
- palo-alto-sase-tenancy-tenantservicegroup-openapi.yaml
- palo-alto-scm-tenancy-tenantservicegroup-openapi.yaml