Spectro Cloud tenants API

swagger: '2.0'
info:
  title: Local Management APIs activations tenants API
  version: v1
servers:
- url: https://edge-host-ip:5080
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: tenants
  x-displayName: Tenants
paths:
  /v1/tenants:
    get:
      operationId: v1TenantsList
      parameters:
      - description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
        in: query
        name: fields
        type: string
      - description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws


          Server will be restricted to certain fields based on the indexed data for each resource.'
        in: query
        name: filters
        type: string
      - description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
        in: query
        name: orderBy
        type: string
      - default: 50
        description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.

          If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
        format: int64
        in: query
        name: limit
        type: integer
      - description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
        format: int64
        in: query
        name: offset
        type: integer
      - description: continue token to paginate the subsequent data items
        in: query
        name: continue
        type: string
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        type: string
      responses:
        '200':
          description: An array of tenants
          schema:
            $ref: '#/definitions/v1Tenants'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Retrieves a list of tenants
      tags:
      - tenants
    post:
      operationId: v1TenantsCreate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantEntity'
      - description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
        in: header
        name: ProjectUid
        type: string
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
          schema:
            $ref: '#/definitions/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Creates a tenant
      tags:
      - tenants
  /v1/tenants/marketplace/aws/setup:
    post:
      consumes:
      - application/x-www-form-urlencoded
      operationId: v1MarketplaceAwsSetup
      parameters:
      - description: Temporary registration token from AWS Marketplace
        in: formData
        name: x-amzn-marketplace-token
        required: true
        type: string
      responses:
        '303':
          description: Redirects to the UI setup page with an encrypted token
      security:
      - ApiKey: []
      - Authorization: []
      summary: Validates the AWS Marketplace token and redirects the browser to the UI setup page
      tags:
      - tenants
  /v1/tenants/marketplace/register:
    post:
      description: 'Called after a user completes a SaaS contract purchase on a marketplace (e.g., AWS Marketplace) and is redirected to the Palette registration landing page. The flow resolves the temporary registration token to obtain the user''s account identifier and product code, fetches the user''s entitlements and creates a new tenant with the corresponding plan and admin user. The registration token is short-lived and must be resolved promptly.

        '
      operationId: v1MarketplaceRegister
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1MarketplaceRegisterEntity'
      responses:
        '201':
          description: Registration completed — tenant provisioned, entitlements applied to plan
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
          schema:
            $ref: '#/definitions/v1MarketplaceRegisterResponse'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Registers a marketplace user by resolving the registration token, verifying entitlements, and provisioning a tenant
      tags:
      - tenants
  /v1/tenants/signup:
    post:
      operationId: v1TenantsSelfSignUp
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantSelfSignUpSpec'
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Self signing up
      tags:
      - tenants
  /v1/tenants/signup/{signupToken}/activate:
    parameters:
    - in: path
      name: signupToken
      required: true
      type: string
    post:
      operationId: v1TenantsSelfSignUpActivate
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Activates the self signed tenant using the password token
      tags:
      - tenants
  /v1/tenants/validate:
    post:
      operationId: v1TenantsValidate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantBasicEntity'
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Validate tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    delete:
      operationId: v1TenantsDelete
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the specified tenant
      tags:
      - tenants
    get:
      operationId: v1TenantsGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1Tenant'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/activate:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    patch:
      operationId: V1TenantsUidActivate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantActivate'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: activates the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/address:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    patch:
      operationId: v1PatchTenantAddress
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantAddressPatch'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant address
      tags:
      - tenants
  /v1/tenants/{tenantUid}/assets/certs:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: V1TenantUIdAssetsCertsList
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1TenantAssetCerts'
      security:
      - ApiKey: []
      - Authorization: []
      summary: lists the certificates for the tenant
      tags:
      - tenants
    post:
      operationId: V1TenantUidAssetsCertsCreate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantAssetCert'
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
          schema:
            $ref: '#/definitions/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create the tenant certificate
      tags:
      - tenants
  /v1/tenants/{tenantUid}/assets/certs/{certificateUid}:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    - in: path
      name: certificateUid
      required: true
      type: string
    delete:
      operationId: V1TenantUidAssetsCertsUidDelete
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: deletes the tenant certificate
      tags:
      - tenants
    get:
      operationId: V1TenantUidAssetsCertsUidGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1TenantAssetCert'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the ca certificate for the tenant
      tags:
      - tenants
    put:
      operationId: V1TenantUidAssetsCertsUidUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantAssetCert'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: updates the tenant certificate
      tags:
      - tenants
  /v1/tenants/{tenantUid}/assets/dataSinks:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    delete:
      operationId: V1TenantUidAssetsDataSinksDelete
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: deletes the tenant data sink config
      tags:
      - tenants
    get:
      operationId: V1TenantUidAssetsDataSinksGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1DataSinkConfig'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns data sink config of tenant
      tags:
      - tenants
    post:
      operationId: V1TenantUidAssetsDataSinksCreate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1DataSinkConfig'
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
          schema:
            $ref: '#/definitions/v1Uid'
      security:
      - ApiKey: []
      - Authorization: []
      summary: create data sink config
      tags:
      - tenants
    put:
      operationId: V1TenantUidAssetsDataSinksUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1DataSinkConfig'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: updates the tenant data sink config
      tags:
      - tenants
  /v1/tenants/{tenantUid}/authTokenSettings:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: v1TenantUidAuthTokenSettingsGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1AuthTokenSettings'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get tenant auth token settings
      tags:
      - tenants
    put:
      operationId: v1TenantUidAuthTokenSettingsUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1AuthTokenSettings'
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant auth token settings
      tags:
      - tenants
  /v1/tenants/{tenantUid}/cleanUp:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    - in: query
      name: useTenantCtx
      type: boolean
    - in: query
      name: forceDelete
      type: boolean
    delete:
      operationId: v1TenantsCleanUp
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Clean up tenant resources
      tags:
      - tenants
  /v1/tenants/{tenantUid}/contract:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    put:
      operationId: v1TenantsUidContractUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantContractSpec'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Updates the tenant contract settings
      tags:
      - tenants
  /v1/tenants/{tenantUid}/contract/accept:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    patch:
      operationId: v1TenantsUidContractAccept
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Tenant to accept the contract agreement
      tags:
      - tenants
  /v1/tenants/{tenantUid}/creditAccount/aws:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    delete:
      operationId: v1TenantsCreditAccountDelete
      parameters:
      - default: false
        in: query
        name: forceDelete
        type: boolean
      responses:
        '204':
          description: The resource was deleted successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the aws credit account for tenants
      tags:
      - tenants
    get:
      operationId: v1TenantsCreditAccountGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1AwsCreditAccountEntity'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get the credit accounts for the tenants with free tier access
      tags:
      - tenants
  /v1/tenants/{tenantUid}/datasinks/splunk:
    post:
      operationId: V1TenantUidDatasinksSplunkCreate
      parameters:
      - in: path
        name: tenantUid
        required: true
        type: string
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1SplunkSinkEntity'
      responses:
        '201':
          description: Created successfully
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
          schema:
            $ref: '#/definitions/v1Uid'
        '400':
          description: Invalid request data
          schema:
            $ref: '#/definitions/v1Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/v1Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '409':
          description: Sink already exists for tenant + kind (runtime code=SinkAlreadyExists)
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Creates the Splunk HEC data sink for the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/datasinks/splunk/validate:
    post:
      operationId: V1TenantUidDatasinksSplunkValidate
      parameters:
      - in: path
        name: tenantUid
        required: true
        type: string
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1SplunkSinkSpec'
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
        '400':
          description: Invalid request data
          schema:
            $ref: '#/definitions/v1Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/v1Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '504':
          description: Network/TLS/timeout error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Validates the Splunk HEC data sink connection for the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/datasinks/splunk/{uid}:
    delete:
      operationId: V1TenantUidDatasinksSplunkDelete
      parameters:
      - in: path
        name: tenantUid
        required: true
        type: string
      - in: path
        name: uid
        required: true
        type: string
      responses:
        '204':
          description: The resource was deleted successfully
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/v1Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '404':
          description: The specified resource was not found
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Deletes the Splunk HEC data sink for the specified tenant
      tags:
      - tenants
    get:
      operationId: V1TenantUidDatasinksSplunkGet
      parameters:
      - in: path
        name: tenantUid
        required: true
        type: string
      - in: path
        name: uid
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1SplunkSink'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/v1Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '404':
          description: The specified resource was not found
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the Splunk HEC data sink for the specified tenant
      tags:
      - tenants
    put:
      operationId: V1TenantUidDatasinksSplunkUpdate
      parameters:
      - in: path
        name: tenantUid
        required: true
        type: string
      - in: path
        name: uid
        required: true
        type: string
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/v1SplunkSinkEntity'
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
        '400':
          description: Invalid request data
          schema:
            $ref: '#/definitions/v1Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/v1Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '404':
          description: The specified resource was not found
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Updates the Splunk HEC data sink for the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/datasinks/summary:
    get:
      operationId: V1TenantUidDatasinksSummaryGet
      parameters:
      - in: path
        name: tenantUid
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1DataSinksSummary'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/v1Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns a summary of all data sinks configured for the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/domains:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: V1TenantUidDomainsGet
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1TenantDomains'
      security:
      - ApiKey: []
      - Authorization: []
      summary: retrieves the domains for tenant
      tags:
      - tenants
    post:
      operationId: V1TenantUidDomainsUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantDomains'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: creates or updates domains for tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/emailId:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    patch:
      operationId: v1PatchTenantEmailId
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantEmailPatch'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant emailId
      tags:
      - tenants
  /v1/tenants/{tenantUid}/freemium:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: v1TenantFreemiumGet
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1TenantFreemium'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get tenant level freemium configuration
      tags:
      - tenants
    put:
      operationId: v1TenantFreemiumUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantFreemium'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant freemium configuration
      tags:
      - tenants
  /v1/tenants/{tenantUid}/freemiumUsage:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: v1TenantFreemiumUsageGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1TenantFreemiumUsage'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get tenant freemium usage
      tags:
      - tenants
  /v1/tenants/{tenantUid}/idp/palette/config:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: V1TenantUidIdpPaletteConfigGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1TenantPaletteIdpConfigSpec'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the Palette IDP config for the tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/invoices/{invoiceUid}:
    parameters:
    - description: Specify the tenant uid
      in: path
      name: tenantUid
      required: true
      type: string
    - description: Specify the invoice uid
      in: path
      name: invoiceUid
      required: true
      type: string
    get:
      operationId: v1InvoicesUidGet
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1Invoice'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns a specified invoice
      tags:
      - tenants
  /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/invoice/pdf:
    parameters:
    - description: Specify the tenant uid
      in: path
      name: tenantUid
      required: true
      type: string
    - description: Specify the invoice uid
      in: path
      name: invoiceUid
      required: true
      type: string
    get:
      operationId: V1InvoiceUidReportInvoicePdf
      produces:
      - application/octet-stream
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              type: string
            Content-Type:
              type: string
          schema:
            type: file
      security:
      - ApiKey: []
      - Authorization: []
      summary: Downloads the specified invoice report
      tags:
      - tenants
  /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/pdf:
    parameters:
    - description: Specify the tenant uid
      in: path
      name: tenantUid
      required: true
      type: string
    - description: Specify the invoice uid
      in: path
      name: invoiceUid
      required: true
      type: string
    get:
      operationId: V1InvoiceUidReportPdf
      produces:
      - application/octet-stream
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              type: string
            Content-Type:
              type: string
          schema:
            type: file
      security:
      - ApiKey: []
      - Authorization: []
      summary: Downloads the specified monthly invoice report
      tags:
      - tenants
  /v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/usage/pdf:
    parameters:
    - description: Specify the tenant uid
      in: path
      name: tenantUid
      required: true
      type: string
    - description: Specify the invoice uid
      in: path
      name: invoiceUid
      required: true
      type: string
    get:
      operationId: V1InvoiceUidReportUsagePdf
      produces:
      - application/octet-stream
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              type: string
            Content-Type:
              type: string
          schema:
            type: file
      security:
      - ApiKey: []
      - Authorization: []
      summary: Downloads the specified tenant usage
      tags:
      - tenants
  /v1/tenants/{tenantUid}/isCleanedUp:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: v1TenantsIsCleanedUp
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1CleanUpResource'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get cleaned up tenant resources
      tags:
      - tenants
  /v1/tenants/{tenantUid}/loginBanner:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: v1TenantUidLoginBannerGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1LoginBannerSettings'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Get tenant login banner settings
      tags:
      - tenants
    put:
      operationId: v1TenantUidLoginBannerUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1LoginBannerSettings'
      responses:
        '204':
          description: Ok response without content
          headers:
            AuditUid:
              description: Audit uid for the request
              type: string
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update tenant login banner settings
      tags:
      - tenants
  /v1/tenants/{tenantUid}/macros:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    delete:
      operationId: v1TenantsUidMacrosDeleteByMacroName
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1Macros'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Delete the macros for the specified tenant by given macro name
      tags:
      - tenants
    get:
      operationId: v1TenantsUidMacrosList
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1Macros'
      security:
      - ApiKey: []
      - Authorization: []
      summary: List the macros of the specified tenant
      tags:
      - tenants
    patch:
      operationId: v1TenantsUidMacrosUpdateByMacroName
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1Macros'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update the macros for the specified tenant by given macro name
      tags:
      - tenants
    post:
      operationId: v1TenantsUidMacrosCreate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1Macros'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Create or add new macros for the specified tenant
      tags:
      - tenants
    put:
      operationId: v1TenantsUidMacrosUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1Macros'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Update the macros of the specified tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/oidc/config:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: V1TenantUidOidcConfigGet
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1TenantOidcClientSpec'
      security:
      - ApiKey: []
      - Authorization: []
      summary: Returns the oidc Spec for tenant
      tags:
      - tenants
    post:
      operationId: V1TenantUidOidcConfigUpdate
      parameters:
      - in: body
        name: body
        schema:
          $ref: '#/definitions/v1TenantOidcClientSpec'
      responses:
        '204':
          description: The resource was updated successfully
      security:
      - ApiKey: []
      - Authorization: []
      summary: Associates the  oidc Spec for the tenant
      tags:
      - tenants
  /v1/tenants/{tenantUid}/password/policy:
    parameters:
    - in: path
      name: tenantUid
      required: true
      type: string
    get:
      operationId: V1TenantUidPasswordPolicyGet
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/de

# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-tenants-api-openapi.yml