"Deprecation":  "Mon, 14 July 2025  23:59:59 GMT",
  "Link":         "New version of API link; rel=\"alternate\"",
  "Sunset":       "Mon, 15 Sept 2025  23:59:59 GMT"

"openapi: 3.0.1\ninfo:\n title: Portfolio\n description: |\n The Portfolio APIs retrieve and update information about Portfolios, Portfolio items (Applications), Portfolio Subitems (Projects), Branches and Tags.\n\n **Base path change and deprecation notice**\n\n The base path for the Portfolio service is changing (from `/api/portfolio` to `/api/portfolios`). The `/api/portfolio` base path will continue to function until `Mon, 15 Sept 2025 23:59:59 GMT`.\n\n Additionally, several endpoints are being deprecated. Endpoints that are being deprecated include additional properties in response headers:\n\n ```\n \"Deprecation\": \"Mon, 14 July 2025 23:59:59 GMT\",\n \"Link\": \"New version of API link; rel=\\\"alternate\\\"\",\n \"Sunset\": \"Mon, 15 Sept 2025 23:59:59 GMT\"\n ```\n\n * `Deprecation`: The date and time when a resource will be deprecated. After this date, the resource may be removed from future versions of the API. \n * `Link`: A link to a supported endpoint that replicates the functionality of a deprecated one.\n * `Sunset`: The date and time when a resource will be removed, and no longer be available.\n\n `Note`: Media type names used in Polaris APIs were renamed and no longer include “synopsys”. \n Although media types that include “synopsys” were removed from the API specifications, existing endpoints will continue to support them until September 1, 2025. \n Please update your scripts to use the new media types.\n version: 1.0.0\n contact:\n name: Black Duck, Inc.\n url: https://polaris.blackduck.com\nservers:\n - url: /api/portfolios\n - url: /api/portfolio\ntags:\n - name: Portfolios\n description: |\n Retrieves information about the Portfolios.\n - name: Portfolio items\n description: |\n Retrieves information about Portfolio items.\n - name: Applications\n description: |\n Retrieves information about Applications.\n - name: Portfolio Subitems\n description: |\n Retrieves information about Portfolio subitems.\n - name: Projects\n description: |\n Retrieves information about projects.\n - name: Branches\n description: |\n Retrieves information about branches associated with a portfolio subitem in an organization.\n - name: Profiles\n description: |\n Retrieves information about profiles associated with a portfolio subitem in an organization.\n - name: Artifacts\n description: |\n Retrieves information about artifacts associated with a portfolio item in an organization.\n - name: Portfolio catalog\n description: |\n Retrieves information about the Portfolio catalog.\n - name: Tags\n description: |\n Retrieves information about tags associated with a portfolio item.\n - name: Entitlements\n description: |\n Retrieves information about entitlements allocated to a portfolio item.\n - name: Application Entitlements\n description: |\n Retrieves information about entitlements allocated to an application.\n - name: Application Entitlement Quantity\n description: |\n Retrieves information about number of entitlements assigned to an application.\n - name: Portfolio Entitlements\n description: |\n Retrieves information about entitlements available to a portfolio\nsecurity:\n - ApiKeyAuth: []\npaths:\n /portfolios:\n get:\n operationId: getPortfolios\n tags:\n - Portfolios\n summary: |\n Find all portfolios.\n description: |\n Retrieves a portfolio belonging to an organization. In this release, each organization is limited to one portfolio.\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.portfolio-1+json:\n schema:\n $ref: '#/components/schemas/PortfoliosGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /:\n get:\n operationId: getPortfoliosNew\n tags:\n - Portfolios\n summary: |\n Find All Portfolios.\n description: |\n Retrieves a portfolio belonging to an organization. In this release, each organization is limited to one portfolio.\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios-1+json:\n schema:\n $ref: '#/components/schemas/NewPortfoliosGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /portfolios/{id}/portfolio-items:\n post:\n operationId: createPortfolioItem\n tags:\n - Portfolio items\n summary: |\n Create a portfolio item.\n description: |\n Creates a new portfolio item under the portfolio by portfolio ID for the provided organization.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n parameters:\n - name: id\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n example: 500a24c2-12e2-480c-8529-5c74a1ecf43a\n requestBody:\n description: Portfolio item to add under the organization's portfolio. At present the only acceptable value is `APPLICATION`.\n content:\n application/vnd.pm.portfolio-items-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioItemPayload'\n application/vnd.pm.portfolio-items-2+json:\n schema:\n $ref: '#/components/schemas/PortfolioItemV2Payload'\n required: true\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.portfolio-items-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioItemPayload'\n application/vnd.pm.portfolio-items-2+json:\n schema:\n $ref: '#/components/schemas/PortfolioItemV2Payload'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n get:\n operationId: getPortfolioItems\n tags:\n - Portfolio items\n summary: |\n Find all portfolio items.\n description: |\n Gets all portfolio items for the specified organization matching the filtering criteria.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: id\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: name\n in: query\n description: Portfolio item name.\n example: demo\n schema:\n type: string\n - name: description\n in: query\n description: Portfolio item description\n example: demo portfolio item\n schema:\n type: string\n - name: _filter\n in: query\n description: >-\n Filters the collection of portfolio items belonging to an organization. The filter follows the [RSQL syntax](https://github.com/jirutka/rsql-parser). Acceptable values for filtering are\n `id`, `name`, `itemType` and `description`.\n example: name=='demo'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts portfolio items by attribute. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is `{field_name}|{asc|desc},{field_name}|{asc|desc},...`.\n Acceptable values for sorting are `id`, `name`, `itemType`, and `description`.\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.portfolio-items-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioItemGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /portfolio-items/{id}:\n patch:\n operationId: updatePortfolioItem\n tags:\n - Portfolio items\n summary: |\n Update portfolio item fields.\n description: |\n Updates fields in a portfolio item using portfolio item ID for the specified organization\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n parameters:\n - name: id\n in: path\n description: Portfolio Item UUID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Either or all portfolio item attributes can be updated.\n content:\n application/vnd.pm.portfolio-items-1+json:\n schema:\n $ref: '#/components/schemas/UpdateApplicationPayload'\n responses:\n '200':\n description: Portfolio items successfully updated.\n content:\n application/vnd.pm.portfolio-items-1+json:\n schema:\n $ref: '#/components/schemas/UpdateApplicationPayload'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n get:\n operationId: getPortfolioItemById\n tags:\n - Portfolio items\n summary: |\n Find a portfolio item by ID.\n description: |\n Retrieves a portfolio item by portfolio item ID for the specified organization.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: id\n in: path\n description: Portfolio item UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Portfolio item details.\n content:\n application/vnd.pm.portfolio-items-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioItemResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n deprecated: true\n delete:\n operationId: deletePortfolioItem\n tags:\n - Portfolio items\n summary: |\n Delete a portfolio item.\n description: |\n Deletes a portfolio item by portfolio item ID for specified organization.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n parameters:\n - name: id\n in: path\n description: Portfolio item UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success.\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Forbidden\n status: 403\n detail: The client does not have access to this item.\n '404':\n description: Not Found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Not Found.\n status: 404\n detail: The portfolio item does not exist.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /{portfolioId}/applications:\n post:\n operationId: createApplication\n tags:\n - Applications\n summary: |\n Create an application.\n description: |\n Creates a new application under the portfolio by portfolio ID for the provided organization.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n example: 500a24c2-12e2-480c-8529-5c74a1ecf43a\n requestBody:\n description: Portfolio item to add under the organization's portfolio. At present the only acceptable value is `APPLICATION`.\n content:\n application/vnd.polaris.portfolios.applications-1+json:\n schema:\n $ref: '#/components/schemas/ApplicationPayload'\n required: true\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.applications-1+json:\n schema:\n $ref: '#/components/schemas/ApplicationGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n get:\n operationId: getApplications\n tags:\n - Applications\n summary: |\n Find all Applications.\n description: |\n Gets all applications for the specified portfolio matching the filtering criteria.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: name\n in: query\n description: Application name.\n example: demo\n schema:\n type: string\n - name: description\n in: query\n description: Application description\n example: demo Application\n schema:\n type: string\n - name: _filter\n in: query\n description: >-\n Filters the collection of applications belonging to an organization. The filter follows the [RSQL syntax](https://github.com/jirutka/rsql-parser). Acceptable values for filtering are `id`,\n `name` and `description`.\n example: name=='demo'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts applications by attribute. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is `{field_name}|{asc|desc},{field_name}|{asc|desc},...`.\n Acceptable values for sorting are `id`, `name`, and `description`.\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.applications-1+json:\n schema:\n $ref: '#/components/schemas/ApplicationsGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /{portfolioId}/applications/{id}:\n patch:\n operationId: updateApplication\n tags:\n - Applications\n summary: |\n Update application fields.\n description: |\n Updates fields in a portfolio item using portfolio item ID for the specified organization\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n description: Application UUID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Either or all application attributes can be updated.\n content:\n application/vnd.polaris.portfolios.applications-1+json:\n schema:\n $ref: '#/components/schemas/UpdateApplicationPayload'\n responses:\n '200':\n description: Application successfully updated.\n content:\n application/vnd.polaris.portfolios.applications-1+json:\n schema:\n $ref: '#/components/schemas/ApplicationGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n get:\n operationId: getApplicationById\n tags:\n - Applications\n summary: |\n Find an Application by ID.\n description: |\n Retrieves an Application by application ID for the specified portfolio.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n description: Application UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Application details.\n content:\n application/vnd.polaris.portfolios.applications-1+json:\n schema:\n $ref: '#/components/schemas/ApplicationGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request\n delete:\n operationId: deleteApplication\n tags:\n - Applications\n summary: |\n Delete an application.\n description: |\n Deletes an applicatioin by applicatioin ID for specified portfolio.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n description: Application UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Success.\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Forbidden\n status: 403\n detail: The client does not have access to this item.\n '404':\n description: Not Found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Not Found.\n status: 404\n detail: The portfolio item does not exist.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /portfolio-sub-items:\n get:\n operationId: getPortfolioSubItemsByFilter\n tags:\n - Portfolio Subitems\n summary: |\n Find portfolio subitems using filter throughout organization\n description: |\n Retrieves all portfolio subitems using filters for an organization\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: _filter\n in: query\n description: >-\n Filters the collection of subitems for the specified filters. The filter follows [RSQL syntax](https://github.com/jirutka/rsql-parser). The filter will support id, name, description,\n applicationId, createdAt and updatedAt.\n example: _filter=applicationId=in=('500a24c2-12e2-480c-8529-5c74a1ecf43a','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('473b1817-cf4f-4d0d-a256-8a95f6d33ca0')&_offset=0&_limit=2\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts subitems on the specified attributes. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Accepted values for sorting are `id`, `name`, `subItemType`, and `description`.\n example: name|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.portfolio-subitems-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemsGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /portfolio-items/{id}/portfolio-sub-items:\n post:\n operationId: createPortfolioSubItem\n tags:\n - Portfolio Subitems\n summary: |\n Create a portfolio subitem.\n description: |\n Creates a new portfolio subitem for a portfolio item by providing portfolio item ID for the specified organization.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n parameters:\n - name: id\n in: path\n description: Portfolio item UUID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n required: true\n description: >\n Add a portfolio subitem to a portfolio item for an organization. The property `subItemType` is required and the possible values are `PROJECT` for SAST/SCA projects and `DAST` for DAST\n projects. For creating the DAST projects, profile has to be created at the same time.\n content:\n application/vnd.pm.portfolio-subitems-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastImportSettingPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSettingSimpleFormPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSettingSeleniumPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSettingSamlPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSettingNonePayload'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project sub type\n value:\n name: Sast Project\n description: test sast project\n subItemType: PROJECT\n defaultBranch:\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n DAST-Import:\n description: An example for DAST project sub type\n value:\n name: DastProject\n description: test dast project\n subItemType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: dast import profile\n importSettings:\n settingArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f0\n entryPointPrivate: false\n DAST-Manual-None:\n description: An example for DAST project sub type\n value:\n name: Dast Project\n description: test dast project\n subItemType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: dast manual profile\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n entryPointPrivate: false\n DAST-Manual-Forms:\n description: An example for DAST project sub type\n value:\n name: DastProject\n description: test dast project\n subItemType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: simple form mode profile\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n entryPointPrivate: false\n DAST-Manual-Saml:\n description: An example for DAST project sub type\n value:\n name: Dast Project\n description: test dast project\n subItemType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: saml mode profile\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n entryPointPrivate: false\n DAST-Manual-Selenium:\n description: An example for DAST project sub type\n value:\n name: Dast Project\n description: test dast project\n subItemType: DAST\n entryPointUrl: http://example.com\n profile:\n name: selenium mode profile\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n entryPointPrivate: false\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.portfolio-subitems-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastImportResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualFormsResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSamlResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSeleniumResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualNoneResponse'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project sub type\n value:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n name: Sast Project\n portfolioItemId: b6fedd54-6e06-40f2-b0ec-6f31cbe099dd\n subItemType: PROJECT\n description: test sast project\n defaultBranch:\n id: 2006a516-94e4-49c4-94cc-8a6c2f0ea8ef\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n inTrash: false\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n rel: self\n method: GET\n DAST-Import:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-None:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Forms:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Saml:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Selenium:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n get:\n operationId: getPortfolioSubItems\n tags:\n - Portfolio Subitems\n summary: |\n Find portfolio subitems in a portfolio item.\n description: |\n Retrieves all portfolio subitems in a portfolio item (through portfolio item ID) for the specified organization matching the filtering criteria.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: id\n in: path\n description: Portfolio item ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: name\n in: query\n description: Portfolio subitem name.\n example: name\n schema:\n type: string\n - name: description\n in: query\n description: Portfolio subitem description\n example: description\n schema:\n type: string\n - name: _filter\n in: query\n description: >-\n Filters the collection of subitems for the specified portfolio item. The filter follows [RSQL syntax](https://github.com/jirutka/rsql-parser). Accepted values for filtering are `id`,\n `name`, `subItemType` and `description`.\n example: name=='demo'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts subitems on the specified attributes. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Accepted values for sorting are `id`, `name`, `subItemType`, and `description`.\n example: name|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.portfolio-subitems-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaGetResponse'\n - $ref: '#/components/schemas/PortfolioSubItemsDastImportGetResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualFormsResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSamlResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSeleniumResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualNoneResponse'\n example:\n _items:\n - id: 2aec7fea-3cf8-40b2-bcd0-53ea308bc545\n name: '000'\n description: ''\n subItemType: PROJECT\n inTrash: false\n defaultBranch:\n id: bd6ed7bf-176c-4a8b-874f-0b553025289a\n name: polaris_main\n description: default main branch\n source: USER\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n isDefault: true\n portfolioItemId: 94d1d57d-e3bf-438d-975b-2458d268eb4d\n createdAt: '2023-10-18 15:07:19'\n updatedAt: '2023-10-18 15:07:19'\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n - id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n entryPointPrivate: false\n - id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n entryPointPrivate: false\n _links:\n - href: https://polaris.blackduck.com/portfolio-items/94d1d57d-e3bf-438d-975b-2458d268eb4d/portfolio-sub-items?_offset=0&_limit=100\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/94d1d57d-e3bf-438d-975b-2458d268eb4d/portfolio-sub-items?_offset=0&_limit=100\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/94d1d57d-e3bf-438d-975b-2458d268eb4d/portfolio-sub-items?_offset=0&_limit=100\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/94d1d57d-e3bf-438d-975b-2458d268eb4d/portfolio-sub-items?_offset=0&_limit=100\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/94d1d57d-e3bf-438d-975b-2458d268eb4d/portfolio-sub-items?_offset=0&_limit=100\n rel: self\n method: GET\n _collection:\n itemCount: 3\n currentPage: 1\n pageCount: 1\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /portfolio-sub-items/{id}:\n patch:\n operationId: updatePortfolioSubItem\n tags:\n - Portfolio Subitems\n summary: |\n Update fields in a portfolio subitem.\n description: |\n Updates fields in a portfolio subitem by portfolio subitem ID.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n parameters:\n - name: id\n in: path\n description: Portfolio Subitem ID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any of the following portfolio subitem attributes can be updated.\n content:\n application/vnd.pm.portfolio-subitems-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/UpdatePortfolioSubItemPayload'\n - $ref: '#/components/schemas/UpdatePortfolioSubItemDastPayload'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project sub type\n value:\n name: SastProject\n description: This is a sast project\n DAST:\n description: An example for DAST project sub type\n value:\n name: DastProject\n description: This is a dast project\n entryPointUrl: http://dastPorfile.com\n entryPointPrivate: false\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.portfolio-subitems-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastImportResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualFormsResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSamlResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSeleniumResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualNoneResponse'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project sub type\n value:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n name: Sast Project\n portfolioItemId: b6fedd54-6e06-40f2-b0ec-6f31cbe099dd\n subItemType: PROJECT\n description: test sast project\n defaultBranch:\n id: 2006a516-94e4-49c4-94cc-8a6c2f0ea8ef\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n inTrash: false\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n rel: self\n method: GET\n DAST-Import:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n entryPointPrivate: false\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-None:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n entryPointPrivate: false\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Forms:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n entryPointPrivate: false\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Saml:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n entryPointPrivate: false\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Selenium:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n entryPointPrivate: false\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n get:\n operationId: getPortfolioSubItemById\n tags:\n - Portfolio Subitems\n summary: |\n Find a portfolio subitem by id.\n description: |\n Gets a portfolio subitem by portfolio subitem id.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: id\n in: path\n description: Portfolio Subitem Id UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Portfolio subitem details.\n content:\n application/vnd.pm.portfolio-subitems-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastImportResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualFormsResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSamlResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSeleniumResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualNoneResponse'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project sub type\n value:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n name: Sast Project\n portfolioItemId: b6fedd54-6e06-40f2-b0ec-6f31cbe099dd\n subItemType: PROJECT\n description: test sast project\n defaultBranch:\n id: 2006a516-94e4-49c4-94cc-8a6c2f0ea8ef\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n inTrash: false\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n rel: self\n method: GET\n DAST-Import:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n DAST-Manual-None:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n DAST-Manual-Forms:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n DAST-Manual-Saml:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n DAST-Manual-Selenium:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n delete:\n operationId: deletePortfolioSubItem\n tags:\n - Portfolio Subitems\n summary: |\n Delete a portfolio subitem.\n description: |\n Deletes a portfolio sub-item by portfolio subitem ID.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n parameters:\n - name: id\n in: path\n description: Portfolio Subitem UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Portfolio sub item has been deleted.\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Forbidden\n status: 403\n detail: The client does not have access to this item.\n '404':\n description: Not Found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Not Found.\n status: 404\n detail: The portfolio item does not exist.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /{portfolioId}/projects:\n get:\n operationId: getProjectsByFilter\n tags:\n - Projects\n summary: |\n Find projects using filter throughout organization.\n description: |\n Retrieves all projects using filters for an organization\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: _filter\n in: query\n description: >-\n Filters the collection of projects for the specified filters. The filter follows [RSQL syntax](https://github.com/jirutka/rsql-parser). The filter will support id, name, description,\n applicationId, createdAt and updatedAt.\n example: _filter=applicationId=in=('500a24c2-12e2-480c-8529-5c74a1ecf43a','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('473b1817-cf4f-4d0d-a256-8a95f6d33ca0')&_offset=0&_limit=2\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts projects on the specified attributes. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Accepted values for sorting are `id`, `name`, `subItemType`, and `description`.\n example: name|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.projects-1+json:\n schema:\n $ref: '#/components/schemas/ProjectsGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /{portfolioId}/applications/{applicationId}/projects:\n post:\n operationId: createProject\n tags:\n - Projects\n summary: |\n Create a project.\n description: |\n Creates a new project for an application by providing application ID for the specified organization.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application UUID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n required: true\n description: >\n Add a project to an application for an organization. The property `projectType` is required and the possible values are `PROJECT` for SAST/SCA projects and `DAST` for DAST projects. For\n creating the DAST projects, profile has to be created at the same time.\n content:\n application/vnd.polaris.portfolios.projects-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastImportSettingPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSettingSimpleFormPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSettingSeleniumPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSettingSamlPayload'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSettingNonePayload'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project type\n value:\n name: Sast Project\n description: test sast project\n projectType: PROJECT\n defaultBranch:\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n DAST-Import:\n description: An example for DAST project sub type\n value:\n name: DastProject\n description: test dast project\n projectType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: dast import profile\n importSettings:\n settingArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f0\n entryPointPrivate: false\n DAST-Manual-None:\n description: An example for DAST project type\n value:\n name: Dast Project\n description: test dast project\n projectType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: dast manual profile\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n entryPointPrivate: false\n DAST-Manual-Forms:\n description: An example for DAST project type\n value:\n name: DastProject\n description: test dast project\n projectType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: simple form mode profile\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n entryPointPrivate: false\n DAST-Manual-Saml:\n description: An example for DAST project type\n value:\n name: Dast Project\n description: test dast project\n projectType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: saml mode profile\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n entryPointPrivate: false\n DAST-Manual-Selenium:\n description: An example for DAST project sub type\n value:\n name: Dast Project\n description: test dast project\n projectType: DAST\n entryPointUrl: http://example.com\n profile:\n name: selenium mode profile\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n entryPointPrivate: false\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.projects-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastImportResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualFormsResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSamlResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSeleniumResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualNoneResponse'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project type\n value:\n name: Sast Project\n description: test sast project\n projectType: PROJECT\n defaultBranch:\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n DAST-Import:\n description: An example for DAST project type\n value:\n name: DastProject\n description: test dast project\n projectType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: dast import profile\n importSettings:\n settingArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f0\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-None:\n description: An example for DAST project type\n value:\n name: Dast Project\n description: test dast project\n projectType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: dast manual profile\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Forms:\n description: An example for DAST project type\n value:\n name: DastProject\n description: test dast project\n projectType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: simple form mode profile\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: blackduck\n password: password\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Saml:\n description: An example for DAST project type\n value:\n name: Dast Project\n description: test dast project\n projectType: DAST\n entryPointUrl: http://dastPorfile.com\n profile:\n name: saml mode profile\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n DAST-Manual-Selenium:\n description: An example for DAST project type\n value:\n name: Dast Project\n description: test dast project\n projectType: DAST\n entryPointUrl: http://example.com\n profile:\n name: selenium mode profile\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: 8caa4290-3a6f-458d-bb9d-d5566dffd4f1\n applicationUrl: http://example.com\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n get:\n operationId: getProjects\n tags:\n - Projects\n summary: |\n Find projects in an application.\n description: |\n Retrieves all projects in an application(through applicationId) for the specified organization matching the filtering criteria.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: name\n in: query\n description: Project name.\n example: name\n schema:\n type: string\n - name: description\n in: query\n description: Project description\n example: description\n schema:\n type: string\n - name: _filter\n in: query\n description: >-\n Filters the collection of projects for the specified application. The filter follows [RSQL syntax](https://github.com/jirutka/rsql-parser). Accepted values for filtering are `id`, `name`,\n `projectType` and `description`.\n example: name=='demo'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts projects on the specified attributes. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Accepted values for sorting are `id`, `name`, `projectType`, and `description`.\n example: name|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.projects-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaGetResponse'\n - $ref: '#/components/schemas/PortfolioSubItemsDastImportGetResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualFormsResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSamlResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSeleniumResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualNoneResponse'\n example:\n _items:\n - id: 2aec7fea-3cf8-40b2-bcd0-53ea308bc545\n name: '000'\n description: discription\n projectType: PROJECT\n inTrash: false\n defaultBranch:\n id: bd6ed7bf-176c-4a8b-874f-0b553025289a\n name: polaris_main\n description: default main branch\n source: USER\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n isDefault: true\n applicationId: 94d1d57d-e3bf-438d-975b-2458d268eb4d\n createdAt: '2023-10-18 15:07:19'\n updatedAt: '2023-10-18 15:07:19'\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 20\n autoDeleteSettingsCustomized: true\n - id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n entryPointPrivate: false\n - id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n entryPointPrivate: false\n _links:\n - href: https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects?_offset=0&_limit=100\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects?_offset=0&_limit=100\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects?_offset=0&_limit=100\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects?_offset=0&_limit=100\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects?_offset=0&_limit=100\n rel: self\n method: GET\n _collection:\n itemCount: 3\n currentPage: 1\n pageCount: 1\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /{portfolioId}/applications/{applicationId}/projects/{projectId}:\n patch:\n operationId: updateProject\n tags:\n - Projects\n summary: |\n Update fields in a project.\n description: |\n Updates fields in a project by its ID.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project UUID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any of the following project attributes can be updated.\n content:\n application/vnd.polaris.portfolios.projects-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/UpdatePortfolioSubItemPayload'\n - $ref: '#/components/schemas/UpdatePortfolioSubItemDastPayload'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project sub type\n value:\n name: SastProject\n description: This is a sast project\n DAST:\n description: An example for DAST project sub type\n value:\n name: DastProject\n description: This is a dast project\n entryPointUrl: http://dastPorfile.com\n entryPointPrivate: false\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.projects-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastImportResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualFormsResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSamlResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSeleniumResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualNoneResponse'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project sub type\n value:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n name: Sast Project\n applicationId: b6fedd54-6e06-40f2-b0ec-6f31cbe099dd\n projectType: PROJECT\n description: test sast project\n defaultBranch:\n id: 2006a516-94e4-49c4-94cc-8a6c2f0ea8ef\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n inTrash: false\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/projects/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n rel: self\n method: GET\n DAST-Import:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/8b35b89e-1994-4d2a-85e9-7826af0b1fec/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n DAST-Manual-None:\n description: An example for DAST project type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/8b35b89e-1994-4d2a-85e9-7826af0b1fec/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n DAST-Manual-Forms:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/8b35b89e-1994-4d2a-85e9-7826af0b1fec/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n DAST-Manual-Saml:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/8b35b89e-1994-4d2a-85e9-7826af0b1fec/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n DAST-Manual-Selenium:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/8b35b89e-1994-4d2a-85e9-7826af0b1fec/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n get:\n operationId: getProjectById\n tags:\n - Projects\n summary: |\n Find a project by id.\n description: |\n Gets a project by its id.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Project details.\n content:\n application/vnd.polaris.portfolios.projects-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/PortfolioSubItemSastScaResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastImportResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualFormsResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSamlResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualSeleniumResponse'\n - $ref: '#/components/schemas/PortfolioSubItemDastManualNoneResponse'\n examples:\n SAST/SCA:\n description: An example for SAST/SCA project type\n value:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n name: Sast Project\n applicationId: b6fedd54-6e06-40f2-b0ec-6f31cbe099dd\n projectType: PROJECT\n description: test sast project\n defaultBranch:\n id: 2006a516-94e4-49c4-94cc-8a6c2f0ea8ef\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n inTrash: false\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/projects/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n rel: self\n method: GET\n DAST-Import:\n description: An example for DAST project sub type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n DAST-Manual-None:\n description: An example for DAST project type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n DAST-Manual-Forms:\n description: An example for DAST project type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n DAST-Manual-Saml:\n description: An example for DAST project type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectType: DAST\n inTrash: false\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n DAST-Manual-Selenium:\n description: An example for DAST project type\n value:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n projectId: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/1967d38a-4983-4737-a9c5-64169d988b62/projects/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n delete:\n operationId: deleteProject\n tags:\n - Projects\n summary: |\n Delete a project.\n description: |\n Deletes a project by its ID.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Project has been deleted.\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Forbidden\n status: 403\n detail: The client does not have access to this item.\n '404':\n description: Not Found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Not Found.\n status: 404\n detail: The project does not exist.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /branches:\n get:\n operationId: getBranchesByFilter\n tags:\n - Branches\n summary: |\n Find portfolio branches using filter throughout organization\n description: |\n Retrieves all branches using filters for an organization\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: _filter\n in: query\n description: >-\n Filters the collection of branches for the specified filters. The filter follows [RSQL syntax](https://github.com/jirutka/rsql-parser). The filter will support id, name, description,\n source, defaultFlag, projectId, createdAt and updatedAt.\n example: _filter=projectId=in=('500a24c2-12e2-480c-8529-5c74a1ecf43a','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('473b1817-cf4f-4d0d-a256-8a95f6d33ca0')&_offset=0&_limit=2\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts branches on the specified attributes. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Accepted values for sorting are `id`, `name`, `description`, `source`, `defaultFlag`, `projectId`, `createdAt` and `updatedAt`.\n example: name|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.branches-1+json:\n schema:\n $ref: '#/components/schemas/BranchesGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /{portfolioId}/branches:\n get:\n operationId: getBranchesInTenant\n tags:\n - Branches\n summary: |\n Find portfolio branches using filter throughout organization\n description: |\n Retrieves all branches using filters for an organization\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: _filter\n in: query\n description: >-\n Filters the collection of branches for the specified filters. The filter follows [RSQL syntax](https://github.com/jirutka/rsql-parser). The filter will support id, name, description,\n source, defaultFlag, projectId, createdAt and updatedAt.\n example: _filter=projectId=in=('500a24c2-12e2-480c-8529-5c74a1ecf43a','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('473b1817-cf4f-4d0d-a256-8a95f6d33ca0')&_offset=0&_limit=2\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts branches on the specified attributes. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Accepted values for sorting are `id`, `name`, `description`, `source`, `defaultFlag`, `projectId`, `createdAt` and `updatedAt`.\n example: name|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.branches-1+json:\n schema:\n $ref: '#/components/schemas/BranchesGetResponse'\n example:\n _items:\n - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n projectId: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n name: string\n description: string\n source: string\n isDefault: false\n createdAt: string\n updatedAt: string\n autoDeleteSetting: false\n autoDeleteSettingsCustomized: false\n branchRetentionPeriodSetting: 30\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/branches?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','7d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: first\n method: GET\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/branches?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','7d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: next\n method: GET\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/branches?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','7d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: prev\n method: GET\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/branches?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','7d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: last\n method: GET\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/branches?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','7d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: self\n method: GET\n _collections:\n itemCount: 1\n currentPage: 1\n pageCount: 1\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /portfolio-sub-items/{id}/branches:\n post:\n operationId: createBranch\n tags:\n - Branches\n summary: |\n Create branch(es) for a portfolio subitem.\n description: |\n Creates branch(es) for a portfolio subitem by portfolio subitem ID.\n parameters:\n - name: id\n in: path\n description: Portfolio Subitem ID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Add branch(es) to a portfolio subitem. The property `source` is required and the possible values are `SCM`, `USER` and `CI`.\n content:\n application/vnd.pm.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchesPayload'\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '409':\n description: Conflict - Branch name already exists for the subitem.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:branch-name-conflict\n title: Branch Name Exists\n status: 409\n detail: Branch name must be unique across a project of an organization.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n get:\n operationId: getBranches\n tags:\n - Branches\n summary: |\n Find branches in a portfolio subitem.\n description: |\n Retrieves all branches in a portfolio subitem (through portfolio subitem ID) for the specified organization matching the filtering criteria.\n parameters:\n - name: id\n in: path\n description: Portfolio subitem ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: _filter\n in: query\n description: >-\n Filters the collection of branches for the specified portfolio subitem. The filter follows [RSQL syntax](https://github.com/jirutka/rsql-parser). Accepted values for filtering are `name`,\n `source` and `isDefault`.\n example: name=='demo';source=='SCM';isDefault==true\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts branches on the specified attributes. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Accepted values for sorting are `name` and `source`.\n example: name|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchGetAllResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /{portfolioId}/applications/{applicationId}/projects/{projectId}/branches:\n post:\n operationId: createBranchInProject\n tags:\n - Branches\n summary: |\n Create the branch for a project.\n description: |\n Creates the branch for a project by project ID.\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project ID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Add the branch to a project. The property `source` is required and the possible values are `SCM`, `USER` and `CI`.\n content:\n application/vnd.polaris.portfolios.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchesPayload'\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchResponse'\n example:\n id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n name: string\n description: string\n source: string\n isDefault: false\n autoDeleteSetting: false\n autoDeleteSettingsCustomized: false\n branchRetentionPeriodSetting: 30\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/projects/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/branches/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '409':\n description: Conflict - Branch name already exists for the subitem.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:branch-name-conflict\n title: Branch Name Exists\n status: 409\n detail: Branch name must be unique across a project of an organization.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n get:\n operationId: getBranchesInProject\n tags:\n - Branches\n summary: |\n Find branches in a project.\n description: |\n Retrieves all branches in a project for the specified organization matching the filtering criteria.\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: _filter\n in: query\n description: >-\n Filters the collection of branches for the specified portfolio subitem. The filter follows [RSQL syntax](https://github.com/jirutka/rsql-parser). Accepted values for filtering are `name`,\n `source` and `isDefault`.\n example: name=='demo';source=='SCM';isDefault==true\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts branches on the specified attributes. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Accepted values for sorting are `name` and `source`.\n example: name|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchGetAllResponse'\n example:\n id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n name: string\n description: string\n source: string\n isDefault: false\n autoDeleteSetting: false\n autoDeleteSettingsCustomized: false\n branchRetentionPeriodSetting: 30\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/projects/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/branches/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /branches/{id}:\n patch:\n operationId: updateBranch\n tags:\n - Branches\n summary: |\n Update fields in a branch.\n description: |\n Updates fields in a branch by branch ID.\n parameters:\n - name: id\n in: path\n description: Branch ID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any of the following branch attributes can be updated.\n content:\n application/vnd.pm.branches-1+json:\n schema:\n $ref: '#/components/schemas/UpdateBranchPayload'\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '409':\n description: Conflict - Branch name already exists for the subitem.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:branch-name-conflict\n title: Branch Name Exists\n status: 409\n detail: Branch name must be unique across a project of an organization.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n get:\n operationId: getBranchById\n tags:\n - Branches\n summary: |\n Find a branch by ID.\n description: |\n Gets a branch by branch ID.\n parameters:\n - name: id\n in: path\n description: Branch ID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Branch details.\n content:\n application/vnd.pm.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n delete:\n operationId: deleteBranch\n tags:\n - Branches\n summary: |\n Delete a branch.\n description: |\n Deletes a branch by branch ID.\n parameters:\n - name: id\n in: path\n description: Branch UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Branch has been deleted.\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Forbidden\n status: 403\n detail: The client does not have access to this item.\n '404':\n description: Not Found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Not Found.\n status: 404\n detail: The portfolio item does not exist.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /{portfolioId}/applications/{applicationId}/projects/{projectId}/branches/{id}:\n patch:\n operationId: updateBranch by id\n tags:\n - Branches\n summary: |\n Update fields in a branch.\n description: |\n Updates fields in a branch by branch ID.\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n description: Branch ID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any of the following branch attributes can be updated.\n content:\n application/vnd.polaris.portfolios.branches-1+json:\n schema:\n $ref: '#/components/schemas/UpdateBranchPayload'\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchResponse'\n example:\n id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n name: string\n description: string\n source: string\n isDefault: false\n autoDeleteSetting: false\n autoDeleteSettingsCustomized: false\n branchRetentionPeriodSetting: 30\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/projects/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/branches/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '409':\n description: Conflict - Branch name already exists for the subitem.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:branch-name-conflict\n title: Branch Name Exists\n status: 409\n detail: Branch name must be unique across a project of an organization.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n get:\n operationId: getBranch by id\n tags:\n - Branches\n summary: |\n Find a branch by ID.\n description: |\n Gets a branch by branch ID.\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n description: Branch ID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Branch details.\n content:\n application/vnd.polaris.portfolios.branches-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioSubItemBranchResponse'\n example:\n id: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n name: string\n description: string\n source: string\n isDefault: false\n autoDeleteSetting: false\n autoDeleteSettingsCustomized: false\n branchRetentionPeriodSetting: 30\n _links:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/applications/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/projects/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/branches/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n delete:\n operationId: deleteBranch by id\n tags:\n - Branches\n summary: |\n Delete a branch.\n description: |\n Deletes a branch by branch ID.\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: ProjectId ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n description: Branch UUID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '204':\n description: Branch has been deleted.\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Forbidden\n status: 403\n detail: The client does not have access to this item.\n '404':\n description: Not Found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Not Found.\n status: 404\n detail: The portfolio item does not exist.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /profiles/{id}:\n get:\n operationId: getProfile\n tags:\n - Profiles\n summary: |\n Find a profile by ID.\n description: |\n Gets a profile by profile ID.\n parameters:\n - name: id\n in: path\n description: Profile ID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Profile details.\n content:\n application/vnd.pm.profiles-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/GetProfileManualFormsResponse'\n - $ref: '#/components/schemas/GetProfileManualSamlResponse'\n - $ref: '#/components/schemas/GetProfileManualSeleniumResponse'\n - $ref: '#/components/schemas/GetProfileManualNoneResponse'\n - $ref: '#/components/schemas/GetProfileImportSettingResponse'\n examples:\n DAST-Import:\n description: An example for DAST import\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-None:\n description: An example for DAST manual none mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Forms:\n description: An example for DAST manual forms mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Saml:\n description: An example for DAST manual saml mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Selenium:\n description: An example for DAST manual selenium mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n put:\n operationId: updateProfile\n tags:\n - Profiles\n summary: |\n Update fields in a profile.\n description: |\n Updates fields in a profile by profile ID.\n parameters:\n - name: id\n in: path\n description: Specify the profile id.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any of the following profile attributes can be updated.\n content:\n application/vnd.pm.profiles-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/UpdateProfileImportSetting'\n - $ref: '#/components/schemas/UpdateProfileManualForms'\n - $ref: '#/components/schemas/UpdateProfileManualSaml'\n - $ref: '#/components/schemas/UpdateProfileManualSelenium'\n - $ref: '#/components/schemas/UpdateProfileManualNone'\n examples:\n DAST-Import:\n description: An example for DAST import\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-None:\n description: An example for DAST manual none mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Forms:\n description: An example for DAST manual forms mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Saml:\n description: An example for DAST manual saml mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Selenium:\n description: An example for DAST manual selenium mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.profiles-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/GetProfileImportSettingResponse'\n - $ref: '#/components/schemas/GetProfileManualFormsResponse'\n - $ref: '#/components/schemas/GetProfileManualSamlResponse'\n - $ref: '#/components/schemas/GetProfileManualSeleniumResponse'\n - $ref: '#/components/schemas/GetProfileManualNoneResponse'\n examples:\n DAST-Import:\n description: An example for DAST import\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast import profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f0\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-None:\n description: An example for DAST manual none mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Forms:\n description: An example for DAST manual forms mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Saml:\n description: An example for DAST manual saml mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Selenium:\n description: An example for DAST manual selenium mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /{portfolioId}/applications/{applicationId}/projects/{projectId}/profiles/{profileId}:\n get:\n operationId: getProfile by Id\n tags:\n - Profiles\n summary: |\n Find a profile by ID.\n description: |\n Gets a profile by profile ID.\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: profileId\n in: path\n description: Profile ID.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Profile details.\n content:\n application/vnd.polaris.portfolios.profiles-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/GetProfileManualFormsResponse'\n - $ref: '#/components/schemas/GetProfileManualSamlResponse'\n - $ref: '#/components/schemas/GetProfileManualSeleniumResponse'\n - $ref: '#/components/schemas/GetProfileManualNoneResponse'\n - $ref: '#/components/schemas/GetProfileImportSettingResponse'\n examples:\n DAST-Import:\n description: An example for DAST import\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-None:\n description: An example for DAST manual none mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Forms:\n description: An example for DAST manual forms mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Saml:\n description: An example for DAST manual saml mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Selenium:\n description: An example for DAST manual selenium mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n put:\n operationId: updateProfile by Id\n tags:\n - Profiles\n summary: |\n Update fields in a profile.\n description: |\n Updates fields in a profile by profile ID.\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: projectId\n in: path\n description: Project ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: profileId\n in: path\n description: Profile ID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Any of the following profile attributes can be updated.\n content:\n application/vnd.polaris.portfolios.profiles-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/UpdateProfileImportSetting'\n - $ref: '#/components/schemas/UpdateProfileManualForms'\n - $ref: '#/components/schemas/UpdateProfileManualSaml'\n - $ref: '#/components/schemas/UpdateProfileManualSelenium'\n - $ref: '#/components/schemas/UpdateProfileManualNone'\n examples:\n DAST-Import:\n description: An example for DAST import\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-None:\n description: An example for DAST manual none mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Forms:\n description: An example for DAST manual forms mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Saml:\n description: An example for DAST manual saml mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Selenium:\n description: An example for DAST manual selenium mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.synopsys.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.profiles-1+json:\n schema:\n anyOf:\n - $ref: '#/components/schemas/GetProfileImportSettingResponse'\n - $ref: '#/components/schemas/GetProfileManualFormsResponse'\n - $ref: '#/components/schemas/GetProfileManualSamlResponse'\n - $ref: '#/components/schemas/GetProfileManualSeleniumResponse'\n - $ref: '#/components/schemas/GetProfileManualNoneResponse'\n examples:\n DAST-Import:\n description: An example for DAST import\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast import profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f0\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-None:\n description: An example for DAST manual none mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Forms:\n description: An example for DAST manual forms mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Saml:\n description: An example for DAST manual saml mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n DAST-Manual-Selenium:\n description: An example for DAST manual selenium mode\n value:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/6d4b238e-48b7-43c9-955c-1a782badb214\n rel: self\n method: GET\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /portfolio-items/{portfolioItemId}/artifacts:\n post:\n operationId: createArtifact\n tags:\n - Artifacts\n summary: |\n Create artifact for a portfolio item.\n description: |\n Creates an artifact for a portfolio item by portfolio item ID. This can be used to create the DAST Projects.\n\n **Note:**\n * This API doesn't upload file-contents but returns a URL in `response.signedUrl` that can be used to upload the file-contents.\n\n * Use the **signedUrl** to perform a PUT operation and pass the file contents along.\n Example below :\n ```\n curl -v --upload-file scan-settings.json \\\n -H \"content-disposition:attachment;filename=scan-settings.json\" \\\n -H \"content-encoding:json\" -H \"content-type:application/json\" \\\n -H \"origin:https://polaris.blackduck.com\" \\\n -H \"x-goog-content-length-range:100,136840\" \\\n -H \"x-goog-hash:md5=Qubve08nhwspElM4Uf6q1Q==\" \\\n -H \"x-goog-meta-artifact-type:PROFILE_SETTING\" \\\n -H \"x-goog-resumable:start\"\\\n \"<response.signedUrl>\"\n ```\n * The value of **fileHash** should be a Base64-encoded \n * We use `gsutil` to calculate hash. For reference: `https://cloud.google.com/storage/docs/gsutil/commands/hash`\n * Use the value generated in md5 from the response.\n\n * Example to generate the fileHash using command: \n ``` \n ~/sources/sigug/WebGoat/.github [main] $ gsutil hash -m dependabot.yml\n Hashes [base64] for dependabot.yml:\n Hash (md5): snzADfKbKdkcxc0HDZnAnA==\n\n Operation completed over 1 objects/352.0 B.\n ```\n parameters:\n - name: portfolioItemId\n in: path\n description: PortfolioItem ID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n required: true\n description: >-\n Provide artifact details. Allowed artifactTypes are PROFILE_SETTING,APP_SPEC. The permissible file types for PROFILE_SETTING artifactType are `.json` and `.side`. The permissible file types\n for APP_SPEC artifactType are `.json`, `.har`, `.sdl`, `.yml`, and `.yaml`.\n content:\n application/vnd.pm.profile-artifacts-1+json:\n schema:\n $ref: '#/components/schemas/CreateProfileArtifact'\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.profile-artifacts-1+json:\n schema:\n $ref: '#/components/schemas/ProfileArtifact'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /portfolio-items/{portfolioItemId}/artifacts/{artifactId}:\n get:\n operationId: getArtifact\n tags:\n - Artifacts\n summary: |\n Fetch an artifact by ID.\n description: |\n Gets an artifact by artifact ID.\n parameters:\n - name: portfolioItemId\n in: path\n description: Specify the portfolioItem id.\n required: true\n schema:\n type: string\n format: uuid\n - name: artifactId\n in: path\n description: Specify an artifact id.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Artifact details (returns a json file data as response)\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n example: >-\n {\"pageReadyConfig\":{\"mode\":\"SPA\",\"pages\":null,\"regexes\":null},\"authSettings\":{\"loginType\":\"none\",\"settings\":{}},\"version\":\"0.1\",\"outputSummary\":true,\"outputPathCSV\":\"\",\"outputPathJSON\":\"\",\"outputPathHTML\":\"\",\"outputPathCrawlResultsJSON\":\"\",\"outputPathFilteredURLsJSON\":\"\",\"outputPathDedupHistoryJSON\":\"\",\"scanTimeout\":\"72h\",\"applyDebugHeader\":true,\"attackSettings\":{\"APIRL\":{\"requestLimit\":\"50\"},\"CMD\":{\"commandInjectionBlindAttackTimeout\":\"20s\"},\"XSS\":{\"forceVerify\":\"false\",\"timeoutXSSDialog\":\"1s\"}},\"excludedUrls\":[\"logout\",\"signout\",\"log-out\",\"sign-out\"],\"excludedAttackUrls\":null,\"excludedFileExtensions\":[\"a3c\",\"ace\",\"aif\",\"aifc\",\"aiff\",\"arj\",\"asf\",\"asx\",\"au\",\"avi\",\"axd\",\"bin\",\"bmp\",\"cab\",\"css\",\"djv\",\"djvu\",\"doc\",\"dwg\",\"eot\",\"eps\",\"es\",\"esl\",\"fif\",\"flv\",\"fvi\",\"gif\",\"gz\",\"hqx\",\"ice\",\"ico\",\"ief\",\"ifs\",\"iw4\",\"iw44\",\"jar\",\"jpe\",\"jpeg\",\"jpg\",\"js\",\"kar\",\"m4a\",\"m4p\",\"mdb\",\"mid\",\"midi\",\"mov\",\"movie\",\"mp\",\"mp2\",\"mp3\",\"mp4\",\"mpeg\",\"mpeg2\",\"mpg\",\"mpg2\",\"mpga\",\"msi\",\"pac\",\"pae\",\"pbm\",\"pdf\",\"pgm\",\"png\",\"pnm\",\"ppm\",\"ppt\",\"ps\",\"psd\",\"qt\",\"ra\",\"ram\",\"rar\",\"ras\",\"rgb\",\"rm\",\"rmf\",\"rpm\",\"smi\",\"snd\",\"svf\",\"svg\",\"tar\",\"tgz\",\"tif\",\"tiff\",\"ttf\",\"uff\",\"vis\",\"viv\",\"vivo\",\"vox\",\"wav\",\"wbmp\",\"wi\",\"wma\",\"wmv\",\"woff\",\"woff2\",\"xbm\",\"xls\",\"xpm\",\"xwd\",\"zip\"],\"excludedMimeTypes\":[\"image/bmp\",\"image/fif\",\"image/gif\",\"image/ief\",\"image/jpeg\",\"image/png\",\"image/tiff\",\"image/vasa\",\"image/vnd.rn-realpix\",\"image/x-cmu-raster\",\"image/x-freehand\",\"image/x-jps\",\"image/x-portable-anymap\",\"image/x-portable-bitmap\",\"image/x-portable-graymap\",\"image/x-portable-pixmap\",\"image/x-rgb\",\"image/x-xbitmap\",\"image/x-xpixmap\",\"image/x-xres\",\"image/x-xwindowdump\",\"video/animaflex\",\"video/x-ms-asf\",\"video/x-ms-asf-plugin\",\"video/avi\",\"video/msvideo\",\"video/x-msvideo\",\"video/avs-video\",\"video/dl\",\"video/x-dl\",\"video/x-dv\",\"video/fli\",\"video/x-fli\",\"video/x-atomic3d-feature\",\"video/gl\",\"video/x-gl\",\"audio/x-gsm\",\"video/x-isvideo\",\"audio/nspaudio\",\"audio/x-nspaudio\",\"audio/mpeg\",\"audio/x-mpequrl\",\"x-music/x-midi\",\"audio/midi\",\"audio/x-mid\",\"audio/x-midi\",\"music/crescendo\",\"audio/x-vnd.audioexplosion.mjuicemediafile\",\"video/x-motion-jpeg\",\"audio/mod\",\"audio/x-mod\",\"audio/x-mpeg\",\"video/mpeg\",\"video/x-mpeq2a\",\"audio/mpeg3\",\"audio/x-mpeg-3\",\"video/x-mpeg\",\"video/x-sgi-movie\",\"audio/make\",\"audio/vnd.qcelp\",\"video/quicktime\",\"video/x-qtc\",\"audio/x-pn-realaudio\",\"audio/x-pn-realaudio-plugin\",\"audio/x-realaudio\",\"audio/mid\",\"video/vnd.rn-realvideo\",\"audio/s3m\",\"video/x-scm\",\"audio/x-psid\",\"audio/basic\",\"audio/x-adpcm.tsi\",\"audio/tsp-audio\",\"audio/tsplayereb\",\"video/vivo\",\"video/vnd.vivo\",\"video/vnd.vivodeo/vdo\",\"audio/voc\",\"audio/x-voc\",\"video/vosaic\",\"audio/voxware\",\"audio/x-twinvq-plugin\",\"audio/x-twinvq\",\"audio/wav\",\"audio/x-wav\",\"video/x-amt-demorun\",\"audio/xm\",\"video/x-amt-showrun\"],\"excludedParameters\":[\"jsessionid\",\"__EVENTARGUMENT\",\"__EVENTTARGET\",\"__EVENTVALIDATION\",\"__VIEWSTATE\",\"X-WHS\"],\"excludedStatusCodes\":[401,404],\"excludedHosts\":[\"mxpnl\\\\.com\",\"log\\\\.optimizely\\\\.com\",\"olark\\\\.com\",\"doubleclick\\\\.net\",\"google\\\\-analytics\\\\.com\",\"clients\\\\d*.google.com\",\"adroll\\\\.com\",\"newrelic\\\\.com\",\"demandbase\\\\.com\",\"bizographics\\\\.com\",\"perfectaudience\\\\.com\",\"marketo\\\\.net\",\"heapanalytics\\\\.com\",\"bizible\\\\.com\",\"openx\\\\.net\",\"chartbeat\\\\.(net|com)\",\"company-target\\\\.com\",\"mktoresp\\\\.com\",\"zopim\\\\.com\",\"mouseflow\\\\.com\",\"exelator\\\\.com\",\"scorecardresearch\\\\.com\",\"qualtrics\\\\.com\",\"gigya\\\\.com\",\"fullstory\\\\.com\",\"impactradius\\\\-event\\\\.com\",\"rfihub\\\\.(net|com)\",\"googletagmanager\\\\.com\",\"tr\\\\.snapchat\\\\.com\",\"youtube*\\\\.com\",\"mpulse\\\\.net\",\"gstatic\\\\.com\",\"facebook\\\\.com\",\"facebook\\\\.net\",\"pinterest\\\\.com\",\"tiktok*\\\\.com\",\"fontawesome\\\\.com\",\"fbcdn\\\\.net\",\"twitter\\\\.com\",\"instagram\\\\.com\",\"squarespace\\\\.com\",\"linkedin\\\\.com\",\"stackadapt\\\\.com\",\"bing\\\\.com\",\"baidu\\\\.com\",\"pinimg\\\\.com\",\"ensighten\\\\.com\",\"richrelevance\\\\.com\",\"vimeo\\\\.com\",\"adsrvr\\\\.org\",\"pardot\\\\.com\",\"typekit\\\\.net\",\"cookielaw\\\\.org\",\"visualwebsiteoptimizer\\\\.com\",\"adobedtm\\\\.com\",\"dshield\\\\.org\",\"data\\\\.mothership\\\\.tools\",\"data-fr\\\\.mothership\\\\.tools\",\"lpsnmedia\\\\.net\",\"\\\\.wistia\\\\.com\",\"spotify\\\\.com\",\"scdn\\\\.co\",\"vimeocdn\\\\.com\",\"vidyard\\\\.com\",\"addthis\\\\.com\",\"pendo\\\\.io\",\"crazyegg\\\\.com\",\"akstat\\\\.io\",\"akamaihd\\\\.net\",\"rfihub\\\\.com\",\"sfdcstatic\\\\.com\",\"demdex\\\\.net\",\"snapchat\\\\.com\",\"evergage\\\\.com\",\"evgnet\\\\.com\",\"agkn\\\\.com\",\"mparticle\\\\.com\",\"braze\\\\.com\",\"kochava\\\\.com\",\"omtrdc\\\\.net\"],\"allowedHosts\":[],\"hosts\":null,\"customHeaders\":[{\"Name\":\"Cache-Control\",\"Values\":[\"no-cache\"]},{\"Name\":\"Accept-Language\",\"Values\":[\"en-US\",\"en\",\"q=0.5\"]}],\"customCookies\":null,\"onStateError\":\"ignore\",\"proxyServer\":\"\",\"proxyType\":\"auto\",\"requestOptions\":{\"retryCount\":1,\"timeout\":10000,\"followRedirects\":true,\"keepAlive\":true,\"userAgent\":\"Mozilla/5.0(Macintosh;IntelMacOSX10_15_7)AppleWebKit/537.36(KHTML,likeGecko)Chrome/113.0.0.0Safari/537.36\",\"detectThrottling\":false},\"useLocalAttackClasses\":false,\"activeCheckers\":[\"AM\",\"APIBA\",\"APIRL\",\"BAK\",\"CMD\",\"DIR\",\"FILE\",\"FUP\",\"ID\",\"LFI\",\"LOG4J\",\"NULLBYTE\",\"OR\",\"PHPI\",\"S4S\",\"SHELL\",\"SPOOF\",\"SQLI\",\"SSL\",\"SSRF\",\"STRUTS\",\"XSS\",\"XXE\"],\"passiveCheckers\":[\"CCN\",\"COOKIES\",\"CORS\",\"CSRF\",\"DEPHEADERS\",\"DIR\",\"FINGER\",\"FORMHTTP\",\"HTTP\",\"INSOBJ\",\"IP\",\"LEAK\",\"MISSHEADERS\",\"PASS\",\"SERVERERR\",\"SESSION\",\"SSN\",\"ST\",\"ST\"],\"disablePassiveCheckers\":false,\"failOnSeverity\":null,\"riskModel\":\"cvss\",\"logToFile\":false,\"logLevel\":\"info\",\"logFormat\":\"\",\"maxReportResponseBytes\":500000,\"evidenceImageQuality\":40,\"evidenceImageType\":\"jpeg\",\"evidenceStorageLocation\":\"/Users/bsedat/Synopsys/fastDAST/results\",\"maxRequestsPerSecond\":0,\"output\":{\"steps\":true,\"images\":{\"initialSteps\":false,\"attackStep\":true,\"login\":false},\"fullResponse\":false},\"fastProcessingOptions\":{\"fastJSONTraversal\":true},\"crawler\":{\"parsers\":[\"Form\",\"Link\",\"Redirect\",\"SPA\",\"Platform\",\"Sitemap\",\"Robots\",\"JavaScript\"],\"maxParserPagePermutations\":5,\"maxLinksPerPage\":100,\"maxLinkDepth\":15,\"maxLinksTotal\":-1,\"maxFormSubmissions\":0,\"formValues\":{\"typeValues\":{\"color\":\"#bebebe\",\"date\":\"01/01/2000\",\"email\":\"joeblogs@example.com\",\"month\":\"2023-01\",\"number\":\"1\",\"password\":\"Synopsys!1\",\"range\":\"1\",\"search\":\"synopsys\",\"tel\":\"678-333-3333\",\"time\":\"13:37\",\"url\":\"https://www.synopsys.com\",\"week\":\"2023-W01\"},\"nameValues\":{\"address\":\"1111HereSt.\",\"address1\":\"1111HereSt.\",\"amount\":\"10.10\",\"author\":\"FredFlintstone\",\"city\":\"Bedrock\",\"company\":\"Synopsys\",\"county\":\"Fermanagh\",\"date\":\"01/01/2000\",\"day\":\"10\",\"email\":\"joeblogs@example.com\",\"first\":\"Fred\",\"first_name\":\"Fred\",\"last\":\"Flintstone\",\"last_name\":\"Flintstone\",\"lname\":\"Flintstone\",\"login\":\"joeblogs@example.com\",\"logon\":\"joeblogs@example.com\",\"mail\":\"joeblogs@example.com\",\"month\":\"10\",\"name\":\"FredFlintstone\",\"nin\":\"AA123456A\",\"password\":\"Synopsys!1\",\"phone\":\"678-333-3333\",\"postcode\":\"BT28BG\",\"price\":\"10.10\",\"province\":\"ON\",\"sin\":\"999-999-999\",\"ssn\":\"222-21-2222\",\"state\":\"CA\",\"title\":\"President\",\"url\":\"https://www.synopsys.com\",\"user_email\":\"joeblogs@example.com\",\"website\":\"https://www.synopsys.com\",\"year\":\"2000\",\"zip\":\"90210\",\"zipcode\":\"90210\"},\"nameRegexValues\":{\"(?i)\\\\b(?:credit|debit|card(?:no)?)\":\"4111111111111111\",\"(?i)\\\\b(birthday|date[-_]?of[-_]?birth)\":\"01/01/2000\",\"(?i)\\\\b(ccv|cvv)\":\"123\",\"(?i)\\\\b(cell|tel|phone)\":\"678-333-3333\",\"(?i)\\\\b(company|employer|organization)\":\"Synopsys\",\"(?i)\\\\b(nin|national[-_]?insurance[-_]?number)\":\"AA123456A\",\"(?i)\\\\b(sin|social[-_]?insurance[-_]?number)\":\"999-999-999\",\"(?i)\\\\b(ssn|social[-_]?security[-_]?number)\":\"222-21-2222\",\"(?i)\\\\b(website|site|homepage)\":\"https://www.synopsys.com\",\"(?i)uuid\":\"515f60b6-c8da-11ed-afa1-0242ac120002\",\"[Ee]mail[-_]?(?:[Aa]ddr(?:ess)?)?(?:\\\\z|[A-Z_-])+\":\"joeblogs@example.com\",\"[Uu][Rr][LlIi](?:\\\\z|[A-Z_-])+\":\"https://www.synopsys.com\",\"[Zz]ip(?:[Cc]ode)?(?:\\\\z|[A-Z_-])+\":\"90210\"}},\"parserSettings\":{\"Form\":{\"ParseFormsMaxPermutations\":\"100\",\"ParsePOSTForms\":\"true\"},\"JavaScript\":{\"ForceHTTPClient\":\"false\",\"MaxJSFileSizeKB\":\"1000\"},\"Link\":{\"FindLinksInComments\":\"false\",\"FindLinksInSrcset\":\"true\",\"FindLinksInText\":\"false\"},\"Redirect\":{},\"SPA\":{\"DeduplicationLimit\":\"3\",\"ExcludeEventXPaths\":\"{\\\".*\\\":[\\\"//*[text()='logout']\\\",\\\"//*[text()='signout']\\\",\\\"//*[text()='logout']\\\",\\\"//*[text()='signout']\\\",\\\"//*[text()='Logout']\\\",\\\"//*[text()='Signout']\\\",\\\"//*[text()='LogOut']\\\",\\\"//*[text()='SignOut']\\\"]}\",\"ExcludedResourceTypes\":\"Image,Media,Font\",\"MaxDepth\":\"2\",\"MaxEvents\":\"50\",\"MaxEventsPerElement\":\"3\",\"MaxRuntime\":\"500000\",\"RemoveSkipsFromProgress\":\"false\"}},\"useFileNotFoundFingerprinter\":false,\"fileNotFoundStatusCodes\":[400,404,409,414],\"fileNotFoundSignatures\":[\"pagecannotbefound\",\"pagenolongerexists\",\"wasnotfoundonthisserver\",\"requestedpagenotfound\",\"404notfound\",\"404error\",\"404-filenotfound\"],\"fileNotFoundSimilarityPercent\":0.9,\"deduplication\":{\"deduplicatePages\":true,\"dedupeOnFragment\":true,\"dedupeOnForms\":true,\"hashSimilarityPercent\":0.9,\"requiredMatchCount\":2,\"pathBased\":true,\"globalSimilarPagesLimit\":20},\"browserRenderPagesBeforeParse\":true,\"queueType\":\"\",\"crawlTimeLimit\":\"70h\"},\"eventSettings\":{\"enabled\":[\"attack.new\",\"attack.exchange\",\"attack.exchange.rejected\",\"attack.exchange.deferred\",\"attack.exchange.executed\",\"dedup.page\",\"crawl.exchange\",\"crawl.start\",\"crawl.stop\",\"crawl.filter.pre\",\"runtime.memory\",\"browser.cpuseconds\",\"browser.memory\",\"browser.exchange.loaded\",\"scan.start\",\"scan.stop\",\"target.platform\",\"target.auth.login\",\"target.auth.logout\",\"crawl.filter.post\",\"crawl.parser\",\"vuln.new\",\"target.auth.reacquire\",\"attack.module.duration\",\"db.error\",\"http.ratelimit\",\"spa.event.new\",\"none\"],\"logEvents\":true},\"cleanupDB\":false,\"profileSettings\":{\"on\":false,\"samplesPerSecond\":0},\"browserSettings\":{\"excludedResourceTypes\":[\"Image\",\"Media\",\"Font\"],\"browserVisible\":false,\"forceCacheStaticResources\":true,\"timeouts\":{\"timeoutGetCookie\":\"500ms\",\"timeoutGetHTML\":\"4s\",\"timeoutGetLocation\":\"500ms\",\"timeoutIsVisible\":\"500ms\",\"timeoutLoadExchange\":\"10s\",\"timeoutResponseLoad\":\"10s\",\"timeoutRunEvent\":\"10s\",\"timeoutScreenshot\":\"20s\",\"timeoutSubmitForm\":\"10s\",\"timeoutSyncState\":\"4s\",\"timeoutWaitVisible\":\"2s\"},\"cacheSize\":200,\"prefillHiddenElements\":false,\"maxPoolSize\":2,\"maxIdleTimeSeconds\":120},\"maxPreLoginExchangeCount\":50,\"checkTooManyFailures\":true,\"checkLastRequestNum\":100,\"requestMaxFailuresPct\":0.6,\"requestMinSuccessPct\":0.2,\"createDebugPackage\":false,\"maxBodySizeMB\":16,\"useSmartSettings\":true}\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /{portfolioId}/applications/{applicationId}/artifacts:\n post:\n operationId: createArtifact for project\n tags:\n - Artifacts\n summary: |\n Create artifact for a portfolio item.\n description: |\n Creates an artifact for a portfolio item by portfolio item ID. This can be used to create the DAST Projects.\n\n **Note:**\n * This API doesn't upload file-contents but returns a URL in `response.signedUrl` that can be used to upload the file-contents.\n\n * Use the **signedUrl** to perform a PUT operation and pass the file contents along.\n Example below :\n ```\n curl -v --upload-file scan-settings.json \\\n -H \"content-disposition:attachment;filename=scan-settings.json\" \\\n -H \"content-encoding:json\" -H \"content-type:application/json\" \\\n -H \"origin:https://polaris.blackduck.com\" \\\n -H \"x-goog-content-length-range:100,136840\" \\\n -H \"x-goog-hash:md5=Qubve08nhwspElM4Uf6q1Q==\" \\\n -H \"x-goog-meta-artifact-type:PROFILE_SETTING\" \\\n -H \"x-goog-resumable:start\"\\\n \"<response.signedUrl>\"\n ```\n * The value of **fileHash** should be a Base64-encoded\n * We use `gsutil` to calculate hash. For reference: `https://cloud.google.com/storage/docs/gsutil/commands/hash`\n * Use the value generated in md5 from the response.\n\n * Example to generate the fileHash using command:\n ```\n ~/sources/sigug/WebGoat/.github [main] $ gsutil hash -m dependabot.yml\n Hashes [base64] for dependabot.yml:\n Hash (md5): snzADfKbKdkcxc0HDZnAnA==\n\n Operation completed over 1 objects/352.0 B.\n ```\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n required: true\n description: Provide an artifact details. Allowed artifactType is PROFILE_SETTING\n content:\n application/vnd.polaris.profile-artifacts-1+json:\n schema:\n $ref: '#/components/schemas/CreateProfileArtifact'\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.profile-artifacts-1+json:\n schema:\n $ref: '#/components/schemas/ProfileArtifact'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /{portfolioId}/applications/{applicationId}/artifacts/{artifactId}:\n get:\n operationId: getArtifact By Id\n tags:\n - Artifacts\n summary: |\n Fetch an artifact by ID.\n description: |\n Gets an artifact by artifact ID.\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n description: Application ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: artifactId\n in: path\n description: Artifact ID\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Artifact details (returns a json file data as response)\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n example: >-\n {\"pageReadyConfig\":{\"mode\":\"SPA\",\"pages\":null,\"regexes\":null},\"authSettings\":{\"loginType\":\"none\",\"settings\":{}},\"version\":\"0.1\",\"outputSummary\":true,\"outputPathCSV\":\"\",\"outputPathJSON\":\"\",\"outputPathHTML\":\"\",\"outputPathCrawlResultsJSON\":\"\",\"outputPathFilteredURLsJSON\":\"\",\"outputPathDedupHistoryJSON\":\"\",\"scanTimeout\":\"72h\",\"applyDebugHeader\":true,\"attackSettings\":{\"APIRL\":{\"requestLimit\":\"50\"},\"CMD\":{\"commandInjectionBlindAttackTimeout\":\"20s\"},\"XSS\":{\"forceVerify\":\"false\",\"timeoutXSSDialog\":\"1s\"}},\"excludedUrls\":[\"logout\",\"signout\",\"log-out\",\"sign-out\"],\"excludedAttackUrls\":null,\"excludedFileExtensions\":[\"a3c\",\"ace\",\"aif\",\"aifc\",\"aiff\",\"arj\",\"asf\",\"asx\",\"au\",\"avi\",\"axd\",\"bin\",\"bmp\",\"cab\",\"css\",\"djv\",\"djvu\",\"doc\",\"dwg\",\"eot\",\"eps\",\"es\",\"esl\",\"fif\",\"flv\",\"fvi\",\"gif\",\"gz\",\"hqx\",\"ice\",\"ico\",\"ief\",\"ifs\",\"iw4\",\"iw44\",\"jar\",\"jpe\",\"jpeg\",\"jpg\",\"js\",\"kar\",\"m4a\",\"m4p\",\"mdb\",\"mid\",\"midi\",\"mov\",\"movie\",\"mp\",\"mp2\",\"mp3\",\"mp4\",\"mpeg\",\"mpeg2\",\"mpg\",\"mpg2\",\"mpga\",\"msi\",\"pac\",\"pae\",\"pbm\",\"pdf\",\"pgm\",\"png\",\"pnm\",\"ppm\",\"ppt\",\"ps\",\"psd\",\"qt\",\"ra\",\"ram\",\"rar\",\"ras\",\"rgb\",\"rm\",\"rmf\",\"rpm\",\"smi\",\"snd\",\"svf\",\"svg\",\"tar\",\"tgz\",\"tif\",\"tiff\",\"ttf\",\"uff\",\"vis\",\"viv\",\"vivo\",\"vox\",\"wav\",\"wbmp\",\"wi\",\"wma\",\"wmv\",\"woff\",\"woff2\",\"xbm\",\"xls\",\"xpm\",\"xwd\",\"zip\"],\"excludedMimeTypes\":[\"image/bmp\",\"image/fif\",\"image/gif\",\"image/ief\",\"image/jpeg\",\"image/png\",\"image/tiff\",\"image/vasa\",\"image/vnd.rn-realpix\",\"image/x-cmu-raster\",\"image/x-freehand\",\"image/x-jps\",\"image/x-portable-anymap\",\"image/x-portable-bitmap\",\"image/x-portable-graymap\",\"image/x-portable-pixmap\",\"image/x-rgb\",\"image/x-xbitmap\",\"image/x-xpixmap\",\"image/x-xres\",\"image/x-xwindowdump\",\"video/animaflex\",\"video/x-ms-asf\",\"video/x-ms-asf-plugin\",\"video/avi\",\"video/msvideo\",\"video/x-msvideo\",\"video/avs-video\",\"video/dl\",\"video/x-dl\",\"video/x-dv\",\"video/fli\",\"video/x-fli\",\"video/x-atomic3d-feature\",\"video/gl\",\"video/x-gl\",\"audio/x-gsm\",\"video/x-isvideo\",\"audio/nspaudio\",\"audio/x-nspaudio\",\"audio/mpeg\",\"audio/x-mpequrl\",\"x-music/x-midi\",\"audio/midi\",\"audio/x-mid\",\"audio/x-midi\",\"music/crescendo\",\"audio/x-vnd.audioexplosion.mjuicemediafile\",\"video/x-motion-jpeg\",\"audio/mod\",\"audio/x-mod\",\"audio/x-mpeg\",\"video/mpeg\",\"video/x-mpeq2a\",\"audio/mpeg3\",\"audio/x-mpeg-3\",\"video/x-mpeg\",\"video/x-sgi-movie\",\"audio/make\",\"audio/vnd.qcelp\",\"video/quicktime\",\"video/x-qtc\",\"audio/x-pn-realaudio\",\"audio/x-pn-realaudio-plugin\",\"audio/x-realaudio\",\"audio/mid\",\"video/vnd.rn-realvideo\",\"audio/s3m\",\"video/x-scm\",\"audio/x-psid\",\"audio/basic\",\"audio/x-adpcm.tsi\",\"audio/tsp-audio\",\"audio/tsplayereb\",\"video/vivo\",\"video/vnd.vivo\",\"video/vnd.vivodeo/vdo\",\"audio/voc\",\"audio/x-voc\",\"video/vosaic\",\"audio/voxware\",\"audio/x-twinvq-plugin\",\"audio/x-twinvq\",\"audio/wav\",\"audio/x-wav\",\"video/x-amt-demorun\",\"audio/xm\",\"video/x-amt-showrun\"],\"excludedParameters\":[\"jsessionid\",\"__EVENTARGUMENT\",\"__EVENTTARGET\",\"__EVENTVALIDATION\",\"__VIEWSTATE\",\"X-WHS\"],\"excludedStatusCodes\":[401,404],\"excludedHosts\":[\"mxpnl\\\\.com\",\"log\\\\.optimizely\\\\.com\",\"olark\\\\.com\",\"doubleclick\\\\.net\",\"google\\\\-analytics\\\\.com\",\"clients\\\\d*.google.com\",\"adroll\\\\.com\",\"newrelic\\\\.com\",\"demandbase\\\\.com\",\"bizographics\\\\.com\",\"perfectaudience\\\\.com\",\"marketo\\\\.net\",\"heapanalytics\\\\.com\",\"bizible\\\\.com\",\"openx\\\\.net\",\"chartbeat\\\\.(net|com)\",\"company-target\\\\.com\",\"mktoresp\\\\.com\",\"zopim\\\\.com\",\"mouseflow\\\\.com\",\"exelator\\\\.com\",\"scorecardresearch\\\\.com\",\"qualtrics\\\\.com\",\"gigya\\\\.com\",\"fullstory\\\\.com\",\"impactradius\\\\-event\\\\.com\",\"rfihub\\\\.(net|com)\",\"googletagmanager\\\\.com\",\"tr\\\\.snapchat\\\\.com\",\"youtube*\\\\.com\",\"mpulse\\\\.net\",\"gstatic\\\\.com\",\"facebook\\\\.com\",\"facebook\\\\.net\",\"pinterest\\\\.com\",\"tiktok*\\\\.com\",\"fontawesome\\\\.com\",\"fbcdn\\\\.net\",\"twitter\\\\.com\",\"instagram\\\\.com\",\"squarespace\\\\.com\",\"linkedin\\\\.com\",\"stackadapt\\\\.com\",\"bing\\\\.com\",\"baidu\\\\.com\",\"pinimg\\\\.com\",\"ensighten\\\\.com\",\"richrelevance\\\\.com\",\"vimeo\\\\.com\",\"adsrvr\\\\.org\",\"pardot\\\\.com\",\"typekit\\\\.net\",\"cookielaw\\\\.org\",\"visualwebsiteoptimizer\\\\.com\",\"adobedtm\\\\.com\",\"dshield\\\\.org\",\"data\\\\.mothership\\\\.tools\",\"data-fr\\\\.mothership\\\\.tools\",\"lpsnmedia\\\\.net\",\"\\\\.wistia\\\\.com\",\"spotify\\\\.com\",\"scdn\\\\.co\",\"vimeocdn\\\\.com\",\"vidyard\\\\.com\",\"addthis\\\\.com\",\"pendo\\\\.io\",\"crazyegg\\\\.com\",\"akstat\\\\.io\",\"akamaihd\\\\.net\",\"rfihub\\\\.com\",\"sfdcstatic\\\\.com\",\"demdex\\\\.net\",\"snapchat\\\\.com\",\"evergage\\\\.com\",\"evgnet\\\\.com\",\"agkn\\\\.com\",\"mparticle\\\\.com\",\"braze\\\\.com\",\"kochava\\\\.com\",\"omtrdc\\\\.net\"],\"allowedHosts\":[],\"hosts\":null,\"customHeaders\":[{\"Name\":\"Cache-Control\",\"Values\":[\"no-cache\"]},{\"Name\":\"Accept-Language\",\"Values\":[\"en-US\",\"en\",\"q=0.5\"]}],\"customCookies\":null,\"onStateError\":\"ignore\",\"proxyServer\":\"\",\"proxyType\":\"auto\",\"requestOptions\":{\"retryCount\":1,\"timeout\":10000,\"followRedirects\":true,\"keepAlive\":true,\"userAgent\":\"Mozilla/5.0(Macintosh;IntelMacOSX10_15_7)AppleWebKit/537.36(KHTML,likeGecko)Chrome/113.0.0.0Safari/537.36\",\"detectThrottling\":false},\"useLocalAttackClasses\":false,\"activeCheckers\":[\"AM\",\"APIBA\",\"APIRL\",\"BAK\",\"CMD\",\"DIR\",\"FILE\",\"FUP\",\"ID\",\"LFI\",\"LOG4J\",\"NULLBYTE\",\"OR\",\"PHPI\",\"S4S\",\"SHELL\",\"SPOOF\",\"SQLI\",\"SSL\",\"SSRF\",\"STRUTS\",\"XSS\",\"XXE\"],\"passiveCheckers\":[\"CCN\",\"COOKIES\",\"CORS\",\"CSRF\",\"DEPHEADERS\",\"DIR\",\"FINGER\",\"FORMHTTP\",\"HTTP\",\"INSOBJ\",\"IP\",\"LEAK\",\"MISSHEADERS\",\"PASS\",\"SERVERERR\",\"SESSION\",\"SSN\",\"ST\",\"ST\"],\"disablePassiveCheckers\":false,\"failOnSeverity\":null,\"riskModel\":\"cvss\",\"logToFile\":false,\"logLevel\":\"info\",\"logFormat\":\"\",\"maxReportResponseBytes\":500000,\"evidenceImageQuality\":40,\"evidenceImageType\":\"jpeg\",\"evidenceStorageLocation\":\"/Users/bsedat/Synopsys/fastDAST/results\",\"maxRequestsPerSecond\":0,\"output\":{\"steps\":true,\"images\":{\"initialSteps\":false,\"attackStep\":true,\"login\":false},\"fullResponse\":false},\"fastProcessingOptions\":{\"fastJSONTraversal\":true},\"crawler\":{\"parsers\":[\"Form\",\"Link\",\"Redirect\",\"SPA\",\"Platform\",\"Sitemap\",\"Robots\",\"JavaScript\"],\"maxParserPagePermutations\":5,\"maxLinksPerPage\":100,\"maxLinkDepth\":15,\"maxLinksTotal\":-1,\"maxFormSubmissions\":0,\"formValues\":{\"typeValues\":{\"color\":\"#bebebe\",\"date\":\"01/01/2000\",\"email\":\"joeblogs@example.com\",\"month\":\"2023-01\",\"number\":\"1\",\"password\":\"Synopsys!1\",\"range\":\"1\",\"search\":\"synopsys\",\"tel\":\"678-333-3333\",\"time\":\"13:37\",\"url\":\"https://www.synopsys.com\",\"week\":\"2023-W01\"},\"nameValues\":{\"address\":\"1111HereSt.\",\"address1\":\"1111HereSt.\",\"amount\":\"10.10\",\"author\":\"FredFlintstone\",\"city\":\"Bedrock\",\"company\":\"Synopsys\",\"county\":\"Fermanagh\",\"date\":\"01/01/2000\",\"day\":\"10\",\"email\":\"joeblogs@example.com\",\"first\":\"Fred\",\"first_name\":\"Fred\",\"last\":\"Flintstone\",\"last_name\":\"Flintstone\",\"lname\":\"Flintstone\",\"login\":\"joeblogs@example.com\",\"logon\":\"joeblogs@example.com\",\"mail\":\"joeblogs@example.com\",\"month\":\"10\",\"name\":\"FredFlintstone\",\"nin\":\"AA123456A\",\"password\":\"Synopsys!1\",\"phone\":\"678-333-3333\",\"postcode\":\"BT28BG\",\"price\":\"10.10\",\"province\":\"ON\",\"sin\":\"999-999-999\",\"ssn\":\"222-21-2222\",\"state\":\"CA\",\"title\":\"President\",\"url\":\"https://www.synopsys.com\",\"user_email\":\"joeblogs@example.com\",\"website\":\"https://www.synopsys.com\",\"year\":\"2000\",\"zip\":\"90210\",\"zipcode\":\"90210\"},\"nameRegexValues\":{\"(?i)\\\\b(?:credit|debit|card(?:no)?)\":\"4111111111111111\",\"(?i)\\\\b(birthday|date[-_]?of[-_]?birth)\":\"01/01/2000\",\"(?i)\\\\b(ccv|cvv)\":\"123\",\"(?i)\\\\b(cell|tel|phone)\":\"678-333-3333\",\"(?i)\\\\b(company|employer|organization)\":\"Synopsys\",\"(?i)\\\\b(nin|national[-_]?insurance[-_]?number)\":\"AA123456A\",\"(?i)\\\\b(sin|social[-_]?insurance[-_]?number)\":\"999-999-999\",\"(?i)\\\\b(ssn|social[-_]?security[-_]?number)\":\"222-21-2222\",\"(?i)\\\\b(website|site|homepage)\":\"https://www.synopsys.com\",\"(?i)uuid\":\"515f60b6-c8da-11ed-afa1-0242ac120002\",\"[Ee]mail[-_]?(?:[Aa]ddr(?:ess)?)?(?:\\\\z|[A-Z_-])+\":\"joeblogs@example.com\",\"[Uu][Rr][LlIi](?:\\\\z|[A-Z_-])+\":\"https://www.synopsys.com\",\"[Zz]ip(?:[Cc]ode)?(?:\\\\z|[A-Z_-])+\":\"90210\"}},\"parserSettings\":{\"Form\":{\"ParseFormsMaxPermutations\":\"100\",\"ParsePOSTForms\":\"true\"},\"JavaScript\":{\"ForceHTTPClient\":\"false\",\"MaxJSFileSizeKB\":\"1000\"},\"Link\":{\"FindLinksInComments\":\"false\",\"FindLinksInSrcset\":\"true\",\"FindLinksInText\":\"false\"},\"Redirect\":{},\"SPA\":{\"DeduplicationLimit\":\"3\",\"ExcludeEventXPaths\":\"{\\\".*\\\":[\\\"//*[text()='logout']\\\",\\\"//*[text()='signout']\\\",\\\"//*[text()='logout']\\\",\\\"//*[text()='signout']\\\",\\\"//*[text()='Logout']\\\",\\\"//*[text()='Signout']\\\",\\\"//*[text()='LogOut']\\\",\\\"//*[text()='SignOut']\\\"]}\",\"ExcludedResourceTypes\":\"Image,Media,Font\",\"MaxDepth\":\"2\",\"MaxEvents\":\"50\",\"MaxEventsPerElement\":\"3\",\"MaxRuntime\":\"500000\",\"RemoveSkipsFromProgress\":\"false\"}},\"useFileNotFoundFingerprinter\":false,\"fileNotFoundStatusCodes\":[400,404,409,414],\"fileNotFoundSignatures\":[\"pagecannotbefound\",\"pagenolongerexists\",\"wasnotfoundonthisserver\",\"requestedpagenotfound\",\"404notfound\",\"404error\",\"404-filenotfound\"],\"fileNotFoundSimilarityPercent\":0.9,\"deduplication\":{\"deduplicatePages\":true,\"dedupeOnFragment\":true,\"dedupeOnForms\":true,\"hashSimilarityPercent\":0.9,\"requiredMatchCount\":2,\"pathBased\":true,\"globalSimilarPagesLimit\":20},\"browserRenderPagesBeforeParse\":true,\"queueType\":\"\",\"crawlTimeLimit\":\"70h\"},\"eventSettings\":{\"enabled\":[\"attack.new\",\"attack.exchange\",\"attack.exchange.rejected\",\"attack.exchange.deferred\",\"attack.exchange.executed\",\"dedup.page\",\"crawl.exchange\",\"crawl.start\",\"crawl.stop\",\"crawl.filter.pre\",\"runtime.memory\",\"browser.cpuseconds\",\"browser.memory\",\"browser.exchange.loaded\",\"scan.start\",\"scan.stop\",\"target.platform\",\"target.auth.login\",\"target.auth.logout\",\"crawl.filter.post\",\"crawl.parser\",\"vuln.new\",\"target.auth.reacquire\",\"attack.module.duration\",\"db.error\",\"http.ratelimit\",\"spa.event.new\",\"none\"],\"logEvents\":true},\"cleanupDB\":false,\"profileSettings\":{\"on\":false,\"samplesPerSecond\":0},\"browserSettings\":{\"excludedResourceTypes\":[\"Image\",\"Media\",\"Font\"],\"browserVisible\":false,\"forceCacheStaticResources\":true,\"timeouts\":{\"timeoutGetCookie\":\"500ms\",\"timeoutGetHTML\":\"4s\",\"timeoutGetLocation\":\"500ms\",\"timeoutIsVisible\":\"500ms\",\"timeoutLoadExchange\":\"10s\",\"timeoutResponseLoad\":\"10s\",\"timeoutRunEvent\":\"10s\",\"timeoutScreenshot\":\"20s\",\"timeoutSubmitForm\":\"10s\",\"timeoutSyncState\":\"4s\",\"timeoutWaitVisible\":\"2s\"},\"cacheSize\":200,\"prefillHiddenElements\":false,\"maxPoolSize\":2,\"maxIdleTimeSeconds\":120},\"maxPreLoginExchangeCount\":50,\"checkTooManyFailures\":true,\"checkLastRequestNum\":100,\"requestMaxFailuresPct\":0.6,\"requestMinSuccessPct\":0.2,\"createDebugPackage\":false,\"maxBodySizeMB\":16,\"useSmartSettings\":true}\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /portfolios/{portfolioId}/catalog:\n get:\n operationId: getPortfolioCatalog\n tags:\n - Portfolio catalog\n summary: |\n Retrieve the portfolio catalog information.\n description: |\n Gets the portfolio catalog information for the specified organization matching the filtering criteria.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: portfolioId\n in: path\n description: Portfolio UUID.\n required: true\n schema:\n type: string\n format: uuid\n - name: _filter\n in: query\n description: >-\n Filters the collection of portfolio items (applications) belonging to an organization. The filter follows the [RSQL syntax](https://github.com/jirutka/rsql-parser). Acceptable values for\n filtering are `id`, `name` and `description`.\n example: name=='demo'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts portfolio items (applications) by attribute. Default sorting method is `name` in `ascending` order. The format of the `_sort` parameter is\n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Acceptable values for sorting are `id`, `name`, `createdAt`, `updatedAt`, and `description`.\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 1000 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.portfolio-catalog-1+json:\n schema:\n $ref: '#/components/schemas/PortfolioCatalogGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /tags:\n get:\n operationId: getAllTags\n tags:\n - Tags\n summary: |\n Find tags.\n description: |\n Gets tags for the specified organization matching the filtering criteria.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n - Application Admin\n - Application Contributor\n - Application Observer\n parameters:\n - name: value\n in: query\n description: Tag value.\n example: tag\n schema:\n type: string\n - name: _filter\n in: query\n description: >-\n Filters the collection of tags belonging to an organization. The filter follows the [RSQL syntax](https://github.com/jirutka/rsql-parser). Acceptable values for filtering are `id` and\n `value`.\n example: value=='demo'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts the collection of tags belonging to an organization on the specified attributes. The default sorting method is `value` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Available values for sorting are `id` and `value`.\n example: value|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 10\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.tags-1+json:\n schema:\n $ref: '#/components/schemas/TagGetAllResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed queryParameter is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /applications/{id}/tags:\n post:\n operationId: createTagsForApplication\n tags:\n - Tags\n summary: |\n Create tag(s).\n description: |\n Creates a tag if not present, for the portfolio item by the portfolio item ID (tag is mapped to this).\n parameters:\n - name: id\n in: path\n description: Portfolio item UUID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Tags to add to the application.\n required: true\n content:\n application/vnd.pm.tags-1+json:\n schema:\n $ref: '#/components/schemas/TagsCreateResponse'\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.tags-1+json:\n schema:\n $ref: '#/components/schemas/TagsCreateResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '409':\n description: Conflict - tag name already exists for the application.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Conflict\n title: Conflict\n status: 409\n detail: Tag Value already exists.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n put:\n operationId: putTagsForApplication\n tags:\n - Tags\n summary: |\n Update portfolio item tags.\n description: |\n Deletes the existing tag mapping to a portfolio item and creates a new tag mapping by portfolio item ID.\n parameters:\n - name: id\n in: path\n description: Portfolio item UUID.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Tags to be put for the application.\n required: true\n content:\n application/vnd.pm.tags-1+json:\n schema:\n type: array\n items:\n type: string\n responses:\n '200':\n description: Tag details.\n content:\n application/vnd.synopsys.pm.tags-1+json:\n schema:\n $ref: '#/components/schemas/TagsCreateResponse'\n application/vnd.pm.tags-1+json:\n schema:\n $ref: '#/components/schemas/TagsCreateResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed request payload is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n get:\n operationId: getApplicationTags\n tags:\n - Tags\n summary: |\n Find tags for the portfolio item.\n description: |\n Gets tags matching the filtering criteria for the portfolio item specified by portfolio item ID.\n parameters:\n - name: id\n in: path\n description: Portfolio item ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: value\n in: query\n description: Tag Value.\n example: tag\n schema:\n type: string\n - name: _filter\n in: query\n description: >-\n Filters the collection of tags for the specified application. The filter follows the [RSQL syntax](https://github.com/jirutka/rsql-parser). Acceptable values for filtering are `id` and\n `value`.\n example: value=='demo'\n schema:\n type: string\n - name: _sort\n in: query\n description: >-\n Sorts tags for the specified portfolio item by attribute. The default sorting method is `value` in `ascending` order. The format of the `_sort` parameter is \n `{field_name}|{asc|desc},{field_name}|{asc|desc},...`. Acceptable values for sorting are `id` and `value`.\n example: value|asc\n schema:\n type: string\n - name: _offset\n in: query\n description: >\n Returns results, starting from the specified position within the response. For example, if the offset is set to 5, then the first 5 records are skipped and the 6th record is the first\n record returned. Default value is 0. If the offset is beyond the range of the collection, no results are returned.\n schema:\n type: integer\n format: int32\n example: 0\n - name: _limit\n in: query\n description: Restricts the number of results to the specified limit. The default is 100. If a limit greater than 100 is provided, the response will be \"HTTP 400 Bad Request.\"\n schema:\n type: integer\n format: int32\n example: 100\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.tags-1+json:\n schema:\n $ref: '#/components/schemas/TagGetResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed queryParameter is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /portfolio-items/{id}/entitlements:\n post:\n operationId: allocateEntitlements\n tags:\n - Entitlements\n summary: |\n Allocate entitlements to a portfolio item.\n description: |\n Allocates entitlements to a portfolio item by portfolio item ID which is of type APPLICATION.\n\n **Permissions:**\n - Application Admin\n parameters:\n - name: id\n in: path\n required: true\n description: Portfolio item Id\n schema:\n type: string\n format: uuid\n requestBody:\n description: List of entitlements to be allocated to the portfolio item of the type APPLICATION.\n content:\n application/vnd.pm.entitlements-2+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementPayload'\n required: true\n responses:\n '200':\n description: Success.\n content:\n application/vnd.synopsys.pm.entitlements-2+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementResponse'\n application/vnd.pm.entitlements-2+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, id is invalid.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '409':\n description: Conflict - Entitlements are already allocated.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Conflict\n title: Conflict\n status: 409\n detail: Entitlements are already allocated.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n get:\n operationId: getEntitlements\n tags:\n - Entitlements\n summary: |\n Find entitlements for the portfolio item.\n description: |\n Retrieves all the entitlements allocated to a portfolio item of the type APPLICATION by portfolio item ID.\n\n **Permissions:**\n - Application Admin\n parameters:\n - name: id\n in: path\n required: true\n description: Portfolio item ID.\n schema:\n type: string\n format: uuid\n - name: entitlementId\n in: query\n required: false\n description: Entitlement ID.\n schema:\n type: string\n format: uuid\n - name: assessmentType\n in: query\n required: false\n description: Assessment Type.\n schema:\n type: string\n enum:\n - SAST\n - SCA\n - name: _filter\n in: query\n required: false\n description: Filters the allocated entitlements under an organization's portfolio. The filter follows the [RSQL syntax](https://github.com/jirutka/rsql-parser).\n example: assessmentType=='SCA'\n schema:\n type: string\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.entitlements-2+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed Path Parameter is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n patch:\n operationId: updateEntitlements\n tags:\n - Entitlements\n summary: |\n Update subscription quantity allocated to a portfolio item.\n description: |\n Update subscription quantity allocated to a portfolio item ID which is of type APPLICATION\n\n **Permissions:**\n - Application Admin\n parameters:\n - name: Organization-Id\n in: header\n description: Organization ID.\n required: false\n schema:\n type: string\n format: uuid\n - name: id\n in: path\n required: true\n description: Portfolio item ID.\n schema:\n type: string\n format: uuid\n requestBody:\n description: List of entitlements allocated to the portfolio item of the type APPLICATION and subscription quantity to be increased.\n content:\n application/vnd.pm.entitlements-2+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementUpdatePayload'\n required: true\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.entitlements-2+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementUpdateResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, id is invalid.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /entitlements/{id}/portfolio-item-count:\n get:\n operationId: getPortfolioItemCount\n tags:\n - Entitlements\n summary: |\n Find Portfolio-item count for a given entitlement ID.\n description: |\n Gets the portfolio-item-count. That is, the number of portfolio items of the type APPLICATION mapped to the given entitlement ID for an organization.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n parameters:\n - name: id\n in: path\n required: true\n description: Entitlement ID.\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success.\n content:\n application/vnd.pm.entitlements-1+json:\n schema:\n $ref: '#/components/schemas/EntitlementApplicationCountResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Entitlement id is invalid.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n deprecated: true\n /{portfolioId}/applications/{applicationId}/entitlements:\n get:\n operationId: getApplicationEntitlements\n tags:\n - Application Entitlements\n summary: |\n Find entitlements for the application.\n description: |\n Retrieves all the entitlements allocated to an Application by application ID.\n\n **Permissions:**\n - Application Admin\n parameters:\n - name: portfolioId\n in: path\n required: true\n description: Portfolio ID.\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n required: true\n description: Application ID.\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.application-entitlements-1+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementsResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, as the passed Path Parameter is not recognised.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /{portfolioId}/applications/{applicationId}/entitlements/quantity:\n patch:\n operationId: update Application Entitlement Counts\n tags:\n - Application Entitlement Quantity\n summary: |\n Update subscription quantity allocated to an Application.\n description: |\n Update subscription quantity allocated to an Application\n\n **Permissions:**\n - Application Admin\n parameters:\n - name: portfolioId\n in: path\n description: portfolio ID.\n required: true\n schema:\n type: string\n format: uuid\n - name: applicationId\n in: path\n required: true\n description: Application ID.\n schema:\n type: string\n format: uuid\n requestBody:\n description: List of entitlements allocated to the portfolio item of the type APPLICATION and subscription quantity to be increased.\n content:\n application/vnd.polaris.portfolios.application-entitlements-quantity-1+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementUpdatePayload'\n required: true\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.application-entitlements-quantity-1+json:\n schema:\n $ref: '#/components/schemas/ApplicationEntitlementUpdateResponse'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Request cannot be processed, id is invalid.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\n /{portfolioId}/entitlements:\n get:\n operationId: getApplicationCountByEntitlementId\n tags:\n - Portfolio Entitlements\n summary: |\n Find Applications count for a given entitlement ID.\n description: |\n Gets the application count. That is, the number of applications mapped to the given entitlement ID for an organization.\n\n **Permissions:**\n - Org Admin\n - Organization Application Manager\n parameters:\n - name: portfolioId\n in: path\n required: true\n description: Portfolio ID.\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Success.\n content:\n application/vnd.polaris.portfolios.portfolio-entitlements-1+json:\n schema:\n $ref: '#/components/schemas/EntitlementApplicationCountResponseNew'\n '400':\n description: Bad request.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:bad-request\n title: Bad request\n status: 400\n detail: Entitlement id is invalid.\n '401':\n description: User is not authorized.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Unauthorized\n title: Unauthorized\n status: 401\n detail: Operation is not permitted.\n '403':\n description: Forbidden.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Forbidden\n title: Forbidden\n status: 403\n detail: Access denied, cannot access the requested resource.\n '404':\n description: Not found.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:Not-Found\n title: Not found\n status: 404\n detail: Requested resource is not found.\n '500':\n description: Internal server error.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/PolarisErrorResponse'\n example:\n type: urn:x-portfolio-service:internal-server-error\n title: Internal server error\n status: 500\n detail: Unexpected error occurred in processing the request.\ncomponents:\n securitySchemes:\n ApiKeyAuth:\n type: apiKey\n in: header\n name: Api-Token\n schemas:\n Portfolios:\n type: object\n properties:\n id:\n type: string\n format: uuid\n example:\n id: fe0c852a-0b9f-494e-9e57-c256eb8366d0\n PortfoliosGetResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/Portfolios'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolios?_offset=0&_limit=100\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/portfolios?_offset=0&_limit=100\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/portfolios?_offset=0&_limit=100\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/portfolios?_offset=0&_limit=100\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/portfolios?_offset=0&_limit=100\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n NewPortfoliosGetResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/Portfolios'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/api/portfolios?_offset=0&_limit=100\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios?_offset=0&_limit=100\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios?_offset=0&_limit=100\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios?_offset=0&_limit=100\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios?_offset=0&_limit=100\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioItemResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `portfolioItemId`.\n name:\n type: string\n description: Specify the Portfolio item `name`.\n itemType:\n type: string\n description: |\n Specify the Portfolio `itemType`.\n\n Example: APPLICATION\n description:\n type: string\n description: Optional to specify the description while creating portfolio item.\n portfolioId:\n type: string\n format: uuid\n description: Specify the `portfolioId` in which the portfolio item should exist.\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio item is in trash or not.\n createdAt:\n type: string\n description: Specify date and time of portfolio item creation.\n updatedAt:\n type: string\n description: Specify date and time of portfolio item update.\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete setting customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify branch retention period setting\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-items/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n PortfolioItemV2Response:\n type: object\n properties:\n id:\n type: string\n format: uuid\n name:\n type: string\n example: applicationABC\n itemType:\n type: string\n example: APPLICATION\n description:\n type: string\n example: creating an application\n portfolioId:\n type: string\n format: uuid\n inTrash:\n type: boolean\n default: false\n subscriptionTypeUsed:\n type: string\n example: PARALLEL\n entitlements:\n type: object\n properties:\n entitlementIds:\n type: array\n items:\n type: string\n format: uuid\n quantity:\n type: integer\n example: 1\n PortfolioItemGetResponse:\n type: object\n required:\n - _items\n - _links\n - _collections\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioItemDetails'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/portfolio-items?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/portfolio-items?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/portfolio-items?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/portfolio-items?_offset=100&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/portfolio-items?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioItemPayload:\n required:\n - name\n - organizationId\n - itemType\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio item name.\n itemType:\n type: string\n description: Specify `itemType` for portfolio item. Value can be `APPLICATION`.\n description:\n type: string\n description: Specify the description for the portfolio item.\n PortfolioItemV2Payload:\n required:\n - name\n - organizationId\n - itemType\n - subscriptionTypeUsed\n type: object\n properties:\n name:\n type: string\n example: applicationABC\n itemType:\n type: string\n example: APPLICATION\n description:\n type: string\n example: Creating an application\n inTrash:\n type: boolean\n example: false\n subscriptionTypeUsed:\n type: string\n example: PARALLEL\n entitlements:\n type: object\n properties:\n entitlementIds:\n type: array\n items:\n type: string\n format: uuid\n quantity:\n type: integer\n example: 1\n PortfolioItemDetails:\n type: object\n required:\n - id\n - name\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `portfolioItemId`.\n name:\n type: string\n description: Specify the Portfolio item `name`.\n itemType:\n type: string\n description: |\n Specify the Portfolio itemType.\n Example: APPLICATION\n subscriptionTypeUsed:\n type: string\n description: |\n Specify the Portfolio item subscription type used.\n Example: PARALLEL\n description:\n type: string\n description: Optional to specify the description while creating portfolio item.\n portfolioId:\n type: string\n format: uuid\n description: Specify the portfolioId in which the portfolio item should exist\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio item is in trash or not.\n createdAt:\n type: string\n description: Specify date and time of portfolio item creation.\n updatedAt:\n type: string\n description: Specify date and time of portfolio item creation.\n example:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n name: App\n itemType: APPLICATION\n subscriptionTypeUsed: PARALLEL\n description: app\n portfolioId: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n inTrash: false\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n ApplicationPayload:\n required:\n - name\n - organizationId\n - itemType\n - subscriptionTypeUsed\n type: object\n properties:\n name:\n type: string\n example: applicationABC\n description:\n type: string\n example: Creating an application\n inTrash:\n type: boolean\n example: false\n subscriptionTypeUsed:\n type: string\n example: PARALLEL\n entitlements:\n type: object\n properties:\n entitlementIds:\n type: array\n items:\n type: string\n format: uuid\n quantity:\n type: integer\n example: 1\n ApplicationsGetResponse:\n type: object\n required:\n - _items\n - _links\n - _collections\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/ApplicationDetails'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/api/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/applications?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/applications?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/applications?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/applications?_offset=100&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/applications?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n ApplicationDetails:\n type: object\n required:\n - id\n - name\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `portfolioItemId`.\n name:\n type: string\n description: Specify the Portfolio item `name`.\n subscriptionTypeUsed:\n type: string\n description: |\n Specify the Portfolio item subscription type used.\n Example: PARALLEL\n description:\n type: string\n description: Optional to specify the description while creating portfolio item.\n portfolioId:\n type: string\n format: uuid\n description: Specify the portfolioId in which the portfolio item should exist\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio item is in trash or not.\n createdAt:\n type: string\n description: Specify date and time of portfolio item creation.\n updatedAt:\n type: string\n description: Specify date and time of portfolio item creation.\n example:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n name: App\n subscriptionTypeUsed: PARALLEL\n description: app\n portfolioId: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n inTrash: false\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n ApplicationGetResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n name:\n type: string\n example: applicationABC\n description:\n type: string\n example: creating an application\n portfolioId:\n type: string\n format: uuid\n inTrash:\n type: boolean\n default: false\n subscriptionTypeUsed:\n type: string\n example: PARALLEL\n entitlements:\n type: object\n properties:\n entitlementIds:\n type: array\n items:\n type: string\n format: uuid\n quantity:\n type: integer\n example: 1\n OrganizationSettingsPayload:\n required:\n - labelCreationAllowedAtAppAndProj\n type: object\n properties:\n labelCreationAllowedAtAppAndProj:\n type: boolean\n example: true\n OrganizationSettingsResponse:\n required:\n - labelCreationAllowedAtAppAndProj\n type: object\n properties:\n labelCreationAllowedAtAppAndProj:\n type: boolean\n example: true\n CreateLabelPayload:\n required:\n - name\n type: object\n properties:\n name:\n type: string\n example: label1\n description:\n type: string\n example: this is label1\n DeleteBulkLabelPayload:\n required:\n - deleteAll\n - existingLabels\n type: object\n properties:\n deleteAll:\n type: boolean\n example: true\n existingLabels:\n type: array\n items:\n type: string\n format: uuid\n description: List of applicationIds\n MergeLabelPayload:\n required:\n - name\n - existingLabels\n type: object\n properties:\n name:\n type: string\n example: label1\n description:\n type: string\n example: label1 description (Optional)\n existingLabels:\n type: array\n items:\n type: string\n format: uuid\n description: List of labelIds\n LabelResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: id of the `label`.\n name:\n type: string\n description: name of the `label`\n description:\n type: string\n description: label description (Optional)\n createdAt:\n type: string\n description: Date and time of portfolio item creation.\n updatedAt:\n type: string\n description: Date and time of portfolio item creation.\n example:\n id: 1fbee12f-133e-45a7-8ed2-7ab87176af60\n name: label1\n description: label 1 description\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n LabelsResponse:\n type: object\n required:\n - _items\n - _links\n - _collections\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/LabelResponse'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/api/portfolios/labels?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/labels?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/labels?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/labels?_offset=100&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/labels?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n LabelResponseWithUsage:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: id of the `label`.\n name:\n type: string\n description: name of the `label`\n description:\n type: string\n description: label description (Optional)\n createdAt:\n type: string\n description: Date and time of portfolio item creation.\n updatedAt:\n type: string\n description: Date and time of portfolio item creation.\n applicationIds:\n type: array\n items:\n type: string\n format: uuid\n description: List of applicationIds\n projectIds:\n type: array\n items:\n type: string\n format: uuid\n description: List of applicationIds\n CreateApplicationLabelsPayload:\n required:\n - add\n - remove\n type: object\n properties:\n add:\n type: array\n items:\n type: string\n format: uuid\n description: List of labelIds to be added to the application\n remove:\n type: array\n items:\n type: string\n format: uuid\n description: List of labelIds to be removed from the application\n ApplicationLabelResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: id of the `label`.\n labelId:\n type: string\n format: uuid\n description: id of the `label`.\n name:\n type: string\n description: name of the `label`\n example:\n id: ee6d6783-bacf-434a-90af-8a441a19935d\n labelId: b9847942-1d56-46e7-a7c4-75b951c231ee\n name: label1\n ApplicationLabelsResponse:\n type: object\n required:\n - _items\n - _links\n - _collections\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/ApplicationLabelResponse'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/labels?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/labels?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/labels?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/labels?_offset=100&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/labels?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n CreateProjectLabelsPayload:\n required:\n - add\n - remove\n type: object\n properties:\n add:\n type: array\n items:\n type: string\n format: uuid\n description: List of labelIds to be added to the project\n remove:\n type: array\n items:\n type: string\n format: uuid\n description: List of labelIds to be removed from the project\n ProjectLabelResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: id of the `label`.\n labelId:\n type: string\n format: uuid\n description: id of the `ProjectLabel`.\n name:\n type: string\n description: name of the `label`\n example:\n id: 29c391ba-629b-4594-8209-1591015484ec\n labelId: 9b8ceda3-c9d2-4bd7-b710-5d75928c1a69\n name: label1\n ProjectLabelsResponse:\n type: object\n required:\n - _items\n - _links\n - _collections\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/ProjectLabelResponse'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/projects/{id}/labels?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/projects/{id}/labels?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/projects/{id}/labels?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/projects/{id}/labels?_offset=100&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/api/portfolios/{id}/applications/{id}/projects/{id}/labels?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioSubItemSastScaResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the portfolio `subitemId`.\n name:\n type: string\n description: Specify the portfolio subitemId `name`.\n subItemType:\n type: string\n description: Specify the portfolio `subitemType`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n defaultBranch:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the branch `id`.\n name:\n type: string\n description: Specify the branch `name`.\n description:\n type: string\n description: Optional to specify the branch description.\n source:\n type: string\n description: Specify the branch `source`.\n isDefault:\n type: boolean\n default: false\n description: Specify whether the branch is default or not.\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio subitem is in trash or not.\n portfolioItemId:\n type: string\n format: uuid\n description: Specify `portfolioItemId` in which the portfolio subitem is created.\n createdAt:\n type: string\n description: Specify date and time of portfolio subitem creation.\n updatedAt:\n type: string\n description: Specify date and time of portfolio subitem update.\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete setting customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify branch retention period setting\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n name: Sast Project\n portfolioItemId: b6fedd54-6e06-40f2-b0ec-6f31cbe099dd\n subItemType: PROJECT\n description: test sast project\n defaultBranch:\n id: 2006a516-94e4-49c4-94cc-8a6c2f0ea8ef\n name: dev-branch\n description: default branch for dev\n source: USER\n isDefault: true\n autoDeleteSetting: false\n branchRetentionPeriodSetting: 30\n autoDeleteSettingsCustomized: false\n inTrash: false\n createdAt: '2022-02-02 21:00:05'\n updatedAt: '2022-02-02 21:00:05'\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n rel: self\n method: GET\n PortfolioSubItemDastImportResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the portfolio subitem `id`.\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio subitem `subItemType`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio subitem is in trash or not.\n portfolioItemId:\n type: string\n format: uuid\n description: Specify `portfolioItemId` in which the portfolio subitem is created.\n createdAt:\n type: string\n description: Specify date and time of portfolio subitem created.\n updatedAt:\n type: string\n description: Specify date and time of portfolio subitem updated.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem.\n profile:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n importSettings:\n type: object\n description: Specify the profile `importSettings`.\n properties:\n settingArtifactId:\n type: string\n format: uuid\n description: Specify the profile `settingArtifactId`.\n isDefault:\n type: boolean\n default: false\n description: Specify whether the profile is default or not.\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-sub-items/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n proxy:\n type: object\n properties:\n projectId:\n type: string\n format: uuid\n description: Specify the proxy `projectId`\n applicationUrl:\n type: string\n description: Specify the proxy `applicationUrl`\n example:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n importSettings:\n settingArtifactId: 2a9c831a-aeba-4015-804e-702a8163bb9f\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: cf7ee65d-9f27-4690-974e-bd3f9ed4906d\n applicationUrl: http://example.com\n PortfolioSubItemDastManualFormsResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the portfolio subitem `id`.\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio subitem `subItemType`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio subitem is in trash or not.\n portfolioItemId:\n type: string\n format: uuid\n description: Specify `portfolioItemId` in which the portfolio subitem is created.\n createdAt:\n type: string\n description: Specify date and time of portfolio subitem created.\n updatedAt:\n type: string\n description: Specify date and time of portfolio subitem updated.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem.\n profile:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n manualSettings:\n type: object\n description: Specify the profile `manualSettings`.\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: FORMS\n simpleFormSetting:\n type: object\n description: Specify the `simpleFormSetting` details of authentication.\n properties:\n loginUrl:\n type: string\n description: Specify the `loginUrl` of simpleFormSetting.\n fields:\n type: object\n description: Specify the `fields` map with key value pairs like username, password etc.\n additionalProperties:\n type: string\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-sub-items/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n proxy:\n type: object\n properties:\n projectId:\n type: string\n format: uuid\n description: Specify the proxy `projectId`\n applicationUrl:\n type: string\n description: Specify the proxy `applicationUrl`\n example:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: cf7ee65d-9f27-4690-974e-bd3f9ed4906d\n applicationUrl: http://example.com\n PortfolioSubItemDastManualSamlResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the portfolio subitem `id`.\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio subitem `subItemType`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio subitem is in trash or not.\n portfolioItemId:\n type: string\n format: uuid\n description: Specify `portfolioItemId` in which the portfolio subitem is created.\n createdAt:\n type: string\n description: Specify date and time of portfolio subitem created.\n updatedAt:\n type: string\n description: Specify date and time of portfolio subitem updated.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem.\n profile:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SAML\n samlSetting:\n type: object\n properties:\n ssoLoginUrl:\n type: string\n fields:\n type: object\n description: Specify the `fields` map with key value pairs like username, password etc.\n additionalProperties:\n type: string\n httpHeaders:\n type: object\n description: Specify the `httpHeaders` map with key value pairs like Organization-id, Tenant-id etc.\n additionalProperties:\n type: string\n default:\n type: boolean\n default: false\n description: Specify whether the profile is default or not.\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-sub-items/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n proxy:\n type: object\n properties:\n projectId:\n type: string\n format: uuid\n description: Specify the proxy `projectId`\n applicationUrl:\n type: string\n description: Specify the proxy `applicationUrl`\n example:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SAML\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: cf7ee65d-9f27-4690-974e-bd3f9ed4906d\n applicationUrl: http://example.com\n PortfolioSubItemDastManualSeleniumResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the portfolio subitem `id`.\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio subitem `subItemType`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio subitem is in trash or not.\n portfolioItemId:\n type: string\n format: uuid\n description: Specify `portfolioItemId` in which the portfolio subitem is created.\n createdAt:\n type: string\n description: Specify date and time of portfolio subitem created.\n updatedAt:\n type: string\n description: Specify date and time of portfolio subitem updated.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem.\n profile:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SELENIUM\n seleniumSetting:\n type: object\n properties:\n sideFileArtifactId:\n type: string\n format: uuid\n default:\n type: boolean\n default: false\n description: Specify whether the profile is default or not.\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-sub-items/3fa85f64-5717-4562-b3fc-2c963f66afa6\n rel: self\n method: GET\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n proxy:\n type: object\n properties:\n projectId:\n type: string\n format: uuid\n description: Specify the proxy `projectId`\n applicationUrl:\n type: string\n description: Specify the proxy `applicationUrl`\n example:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dastprofile1test23\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: cf7ee65d-9f27-4690-974e-bd3f9ed4906d\n applicationUrl: http://example.com\n PortfolioSubItemDastManualNoneResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the portfolio subitem `id`.\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio subitem `subItemType`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n inTrash:\n type: boolean\n default: false\n description: Specify whether the portfolio subitem is in trash or not.\n portfolioItemId:\n type: string\n format: uuid\n description: Specify `portfolioItemId` in which the portfolio subitem is created.\n createdAt:\n type: string\n description: Specify date and time of portfolio subitem created.\n updatedAt:\n type: string\n description: Specify date and time of portfolio subitem updated.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem.\n profile:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: NONE\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n default:\n type: boolean\n default: false\n description: Specify whether the profile is default or not.\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n proxy:\n type: object\n properties:\n projectId:\n type: string\n format: uuid\n description: Specify the proxy `projectId`\n applicationUrl:\n type: string\n description: Specify the proxy `applicationUrl`\n example:\n id: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n name: testdastimport\n description: dast import project\n subItemType: DAST\n inTrash: false\n portfolioItemId: 1967d38a-4983-4737-a9c5-64169d988b62\n createdAt: '2024-03-19 08:14:43'\n updatedAt: '2024-03-19 08:14:43'\n entryPointUrl: https://exampldsae.com\n profile:\n id: 6d4b238e-48b7-43c9-955c-1a782badb214\n name: dast manual profile\n organizationId: f660b96c-78be-4d3c-bbd1-a6136533b247\n applicationId: 1967d38a-4983-4737-a9c5-64169d988b62\n projectId: 8b35b89e-1994-4d2a-85e9-7826af0b1fec\n performActiveAttack: false\n manualSettings:\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/portfolio-sub-items/8b35b89e-1994-4d2a-85e9-7826af0b1fec\n rel: self\n method: GET\n entryPointPrivate: false\n proxy:\n id: 47529b30-0f41-44fa-8098-207e59772bdf\n projectId: cf7ee65d-9f27-4690-974e-bd3f9ed4906d\n applicationUrl: http://example.com\n ProjectsGetResponse:\n type: object\n required:\n - _items\n - _links\n - _collections\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioCatalogProjectDetails'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/projects?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','7d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: first\n method: GET\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/projects?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: next\n method: GET\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/projects?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: prev\n method: GET\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/projects?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: last\n method: GET\n - href: >-\n https://polaris.blackduck.com/api/portfolios/02954084-d849-4270-870f-24c5fe79def1/projects?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioSubItemsGetResponse:\n type: object\n required:\n - _items\n - _links\n - _collections\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioCatalogProjectDetails'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','7d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: first\n method: GET\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: next\n method: GET\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: prev\n method: GET\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: last\n method: GET\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioSubItemSastScaGetResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioSubItemSastScaResponse'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioSubItemsDastImportGetResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioSubItemDastImportResponse'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/portfolio-sub-items?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioSubItemSastScaPayload:\n required:\n - name\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio `subitemType`.The possible values for subitemType are `PROJECT` and `DAST`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n defaultBranch:\n type: object\n properties:\n name:\n type: string\n description: Specify the branch `name`.\n description:\n type: string\n description: Specify the branch `description`.\n source:\n type: string\n description: Specify the branch `source`.\n isDefault:\n type: boolean\n default: false\n description: Specify true or false i.e., whether a branch should be created as default branch or not.\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete setting customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify branch retention period setting\n PortfolioSubItemDastImportSettingPayload:\n required:\n - name\n - entryPointUrl\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio `subitemType`.The possible values for subitemType are `PROJECT` and `DAST`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem.\n profile:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n importSettings:\n type: object\n description: Specify the profile `importSettings`.\n properties:\n settingArtifactId:\n type: string\n format: uuid\n description: Specify the profile `settingArtifactId`.\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n PortfolioSubItemDastManualSettingSimpleFormPayload:\n required:\n - name\n - entryPointUrl\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio `subitemType`.The possible values for subitemType are `PROJECT` and `DAST`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem.\n profile:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n description: Specify the profile `manualSettings`.\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: FORMS\n simpleFormSetting:\n type: object\n description: Specify the `simpleFormSetting` details of authentication.\n properties:\n loginUrl:\n type: string\n description: Specify the `loginUrl` of simpleFormSetting.\n fields:\n type: object\n description: Specify the `fields` map with key value pairs like username, password etc.\n additionalProperties:\n type: string\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n PortfolioSubItemDastManualSettingSamlPayload:\n required:\n - name\n - entryPointUrl\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio `subitemType`.The possible values for subitemType are `PROJECT` and `DAST`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem to update.\n profile:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SAML\n samlSetting:\n type: object\n properties:\n ssoLoginUrl:\n type: string\n fields:\n type: object\n description: Specify the `fields` map with key value pairs like username, password etc.\n additionalProperties:\n type: string\n httpHeaders:\n type: object\n description: Specify the `httpHeaders` map with key value pairs like Organization-id, Tenant-id etc.\n additionalProperties:\n type: string\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n PortfolioSubItemDastManualSettingSeleniumPayload:\n required:\n - name\n - entryPointUrl\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio `subitemType`.The possible values for subitemType are `PROJECT` and `DAST`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem to update.\n profile:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SELENIUM\n seleniumSetting:\n type: object\n properties:\n sideFileArtifactId:\n type: string\n format: uuid\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n PortfolioSubItemDastManualSettingNonePayload:\n required:\n - name\n - entryPointUrl\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n subItemType:\n type: string\n description: Specify the portfolio `subitemType`.The possible values for subitemType are `PROJECT` and `DAST`.\n description:\n type: string\n description: Optional to specify the portfolio subitem description.\n entryPointUrl:\n type: string\n description: Specify entryPointUrl of portfolio subitem to update.\n profile:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: NONE\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n UpdatePortfolioSubItemPayload:\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n description:\n type: string\n description: Specify the portfolio subitem `description`.\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete setting customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify branch retention period setting\n UpdatePortfolioSubItemDastPayload:\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio subitem `name`.\n description:\n type: string\n description: Specify the portfolio subitem `description`.\n entryPointUrl:\n type: string\n description: Specify the portfolio subitem `entryPointUrl`.\n entryPointPrivate:\n type: boolean\n default: false\n description: Specify the `entryPointPrivate` value as true or false.\n PortfolioSubItemBranchesPayload:\n required:\n - name\n type: object\n properties:\n name:\n type: string\n description: Specify the branch `name`.\n description:\n type: string\n description: Optional to specify the branch `description`.\n source:\n type: string\n description: Specify the portfolio `source`.The possible values for source are `SCM`, `USER` and `CI`.\n isDefault:\n default: false\n description: Specify whether the specified branch is the default branch or not.\n UpdateBranchPayload:\n type: object\n properties:\n name:\n type: string\n description: Specify the branch `name`.\n description:\n type: string\n description: Specify the branch `description`.\n source:\n type: string\n description: Specify the branch `source`.\n isDefault:\n type: boolean\n default: false\n description: Specify true or false i.e., whether a branch should be updated to default branch or not.\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete setting customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify branch retention period setting\n PortfolioSubItemBranchDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `branchId`.\n name:\n type: string\n description: Specify the branch `name`.\n description:\n type: string\n description: Optional to specify the branch description.\n source:\n type: string\n description: Specify the branch `source`.\n isDefault:\n type: boolean\n default: false\n description: Specify whether the branch is default branch or not.\n example:\n id: 948a3733-37e0-4e7f-9885-fb68c55768b7\n name: demo\n description: description\n source: USER\n isDefault: false\n autoDeleteSetting: false,\n branchRetentionPeriodSetting: 30,\n autoDeleteSettingsCustomized: false\n PortfolioSubItemBranchResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `branchId`.\n name:\n type: string\n description: Specify the branch `name`.\n description:\n type: string\n description: Optional to specify the branch description.\n source:\n type: string\n description: Specify the branch `source`.\n isDefault:\n type: boolean\n default: false\n description: Specify whether the branch is default branch or not.\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete setting customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify branch retention period setting\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/branches/948a3733-37e0-4e7f-9885-fb68c55768b7\n rel: self\n method: GET\n PortfolioSubItemBranchGetAllResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioSubItemBranchDetails'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-sub-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/branches?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/portfolio-sub-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/branches?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/portfolio-sub-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/branches?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/portfolio-sub-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/branches?_offset=0&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/portfolio-sub-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/branches?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n GetProfileManualNoneResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: NONE\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n id: 00c08285-d7e2-410a-9b64-26828f7c7ff7\n name: Dast ProfileA\n organizationId: 00867302-6cac-49b3-893a-6edb8bf20ec1\n applicationId: 94d1d57d-e3bf-438d-975b-2458d268eb4d\n projectId: a4b131a4-4a99-4270-ad29-838ba15efbbb\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: NONE\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/00c08285-d7e2-410a-9b64-26828f7c7ff7\n rel: self\n method: GET\n GetProfileImportSettingResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n importSettings:\n type: object\n description: Specify the profile `importSettings`.\n properties:\n settingArtifactId:\n type: string\n format: uuid\n description: Specify the profile `settingArtifactId`.\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n id: 00c08285-d7e2-410a-9b64-26828f7c7ff7\n name: Dast ProfileA\n organizationId: 00867302-6cac-49b3-893a-6edb8bf20ec1\n applicationId: 94d1d57d-e3bf-438d-975b-2458d268eb4d\n projectId: a4b131a4-4a99-4270-ad29-838ba15efbbb\n performActiveAttack: true\n importSettings:\n settingArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f0\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/00c08285-d7e2-410a-9b64-26828f7c7ff7\n rel: self\n method: GET\n GetProfileManualFormsResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SELENIUM\n simpleFormSetting:\n type: object\n description: Specify the `simpleFormSetting` details of authentication.\n properties:\n loginUrl:\n type: string\n description: Specify the `loginUrl` of simpleFormSetting.\n fields:\n type: object\n description: Specify the `fields` map with key value pairs like username, password etc.\n additionalProperties:\n type: string\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n id: 00c08285-d7e2-410a-9b64-26828f7c7ff7\n name: Dast ProfileA\n organizationId: 00867302-6cac-49b3-893a-6edb8bf20ec1\n applicationId: 94d1d57d-e3bf-438d-975b-2458d268eb4d\n projectId: a4b131a4-4a99-4270-ad29-838ba15efbbb\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n simpleFormSetting:\n loginUrl: http://login.com\n fields:\n userName: synopsys\n password: password\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/00c08285-d7e2-410a-9b64-26828f7c7ff7\n rel: self\n method: GET\n GetProfileManualSamlResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SELENIUM\n samlSetting:\n type: object\n properties:\n ssoLoginUrl:\n type: string\n fields:\n type: object\n description: Specify the `fields` map with key value pairs like username, password etc.\n additionalProperties:\n type: string\n httpHeaders:\n type: object\n description: Specify the `httpHeaders` map with key value pairs like Organization-id, Tenant-id etc.\n additionalProperties:\n type: string\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n id: 00c08285-d7e2-410a-9b64-26828f7c7ff7\n name: Dast ProfileA\n organizationId: 00867302-6cac-49b3-893a-6edb8bf20ec1\n applicationId: 94d1d57d-e3bf-438d-975b-2458d268eb4d\n projectId: a4b131a4-4a99-4270-ad29-838ba15efbbb\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/00c08285-d7e2-410a-9b64-26828f7c7ff7\n rel: self\n method: GET\n GetProfileManualSeleniumResponse:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the profile `id`.\n name:\n type: string\n description: Specify the profile `name`.\n organizationId:\n type: string\n format: uuid\n description: Specify the `organizationId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n default:\n type: boolean\n default: true\n description: Specify whether the profile is default or not.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SELENIUM\n seleniumSetting:\n type: object\n properties:\n sideFileArtifactId:\n type: string\n format: uuid\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n id: 00c08285-d7e2-410a-9b64-26828f7c7ff7\n name: Dast ProfileA\n organizationId: 00867302-6cac-49b3-893a-6edb8bf20ec1\n applicationId: 94d1d57d-e3bf-438d-975b-2458d268eb4d\n projectId: a4b131a4-4a99-4270-ad29-838ba15efbbb\n performActiveAttack: true\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: FORMS\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n _links:\n - href: https://polaris.blackduck.com/profiles/00c08285-d7e2-410a-9b64-26828f7c7ff7\n rel: self\n method: GET\n UpdateProfileManualSelenium:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n example: DastProfile B\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SELENIUM\n seleniumSetting:\n type: object\n properties:\n sideFileArtifactId:\n type: string\n format: uuid\n example:\n name: dastprofile1test23\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n UpdateProfileManualSaml:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n example: DastProfile B\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SELENIUM\n samlSetting:\n type: object\n properties:\n ssoLoginUrl:\n type: string\n fields:\n type: object\n description: Specify the `fields` map with key value pairs like username, password etc.\n additionalProperties:\n type: string\n httpHeaders:\n type: object\n description: Specify the `httpHeaders` map with key value pairs like Organization-id, Tenant-id etc.\n additionalProperties:\n type: string\n example:\n name: dastprofile1test23\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SELENIUM\n samlSetting:\n ssoLoginUrl: http://example.com\n fields:\n userName: synopsys\n password: password\n httpHeaders:\n Organization-id: 6b35b89e-1994-4d2a-85e9-7826af0b1fed\n default: true\n UpdateProfileManualForms:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n example: DastProfile B\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: SELENIUM\n simpleFormSetting:\n type: object\n description: Specify the `simpleFormSetting` details of authentication.\n properties:\n loginUrl:\n type: string\n description: Specify the `loginUrl` of simpleFormSetting.\n fields:\n type: object\n description: Specify the `fields` map with key value pairs like username, password etc.\n additionalProperties:\n type: string\n example:\n name: dastprofile1test23\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: SELENIUM\n seleniumSetting:\n sideFileArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f2\n default: true\n UpdateProfileManualNone:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n example: DastProfile B\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n manualSettings:\n type: object\n properties:\n allowedHosts:\n type: string\n description: Specify the `allowedHosts` for manualSettings.\n authentication:\n type: object\n properties:\n type:\n type: string\n description: Specify the `type` of authentication.\n example: V0\n mode:\n type: string\n description: Specify the `mode` of authentication.\n example: NONE\n example:\n name: dastprofile1test23\n performActiveAttack: false\n manualSettings:\n allowedHosts: http://dast-porfile.com, Springfield, http://127.0.0.1:22766\n authentication:\n type: v0\n mode: NONE\n default: true\n UpdateProfileImportSetting:\n type: object\n properties:\n name:\n type: string\n description: Specify the profile `name`.\n example: DastProfile B\n performActiveAttack:\n type: boolean\n default: false\n description: Specify the `performActiveAttack` value as true or false.\n importSettings:\n type: object\n description: Specify the profile `importSettings`.\n properties:\n settingArtifactId:\n type: string\n format: uuid\n description: Specify the profile `settingArtifactId`.\n example:\n name: dastprofile1test23\n performActiveAttack: false\n importSettings:\n settingArtifactId: 1caa4290-3a6f-458d-bb9d-d5566dffd4f0\n ProfileArtifact:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the file `id`.\n fileName:\n type: string\n description: Specify the file `name`.\n fileHash:\n type: string\n description: Specify the file `hash`.\n fileSize:\n type: string\n description: Specify the file `size`.\n artifactType:\n type: string\n description: Specify the file `type`.\n signedUrl:\n type: string\n description: Specify the file `signedUrl`.\n createdAt:\n type: string\n description: Specify date and time of file creation.\n example:\n id: 13471a54-3202-453c-b965-a635f07d0a2e\n fileName: scan-settings.json\n artifactType: PROFILE_SETTING\n signedUrl: https://***\n createdAt: '2024-03-15T11:11:57Z'\n _links:\n - href: https://polaris.blackduck.com/portfolio-items/0bae12aa-793b-46f0-b882-6cb6d3062a10/artifacts/13471a54-3202-453c-b965-a635f07d0a2e\n rel: self\n method: GET\n _type: artifact\n CreateProfileArtifact:\n type: object\n properties:\n fileName:\n type: string\n description: Specify the file `name`.\n fileHash:\n type: string\n description: Specify the file `hash`.\n fileSize:\n type: string\n description: Specify the file `size`.\n artifactType:\n type: string\n description: Specify the file `type`.\n example:\n fileSize: '10485760'\n fileName: scan-settings.json\n fileHash: BcCmzw204GJFlOcnyl6OhA==\n artifactType: PROFILE_SETTING\n ApplicationEntitlementPayload:\n type: object\n properties:\n entitlementIds:\n type: array\n items:\n type: string\n format: uuid\n description: Specify the entitlement IDs to be allocated to an application.\n ApplicationEntitlementResponse:\n type: object\n properties:\n entitlementIds:\n type: array\n items:\n type: string\n format: uuid\n description: Specify the entitlement IDs allocated to an application.\n quantity:\n type: integer\n format: int32\n default: 1\n description: Quantity of entitlements allocated.\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/entitlements\n rel: self\n method: GET\n ApplicationEntitlementsResponse:\n type: object\n properties:\n applicationId:\n type: string\n format: uuid\n description: Application Id.\n entitlements:\n type: array\n items:\n $ref: '#/components/schemas/ApplicationEntitlementResponseNew'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/entitlements\n rel: self\n method: GET\n ApplicationEntitlementUpdatePayload:\n type: object\n properties:\n entitlementIds:\n type: array\n items:\n type: string\n format: uuid\n description: Specify the entitlement IDs allocated to the application.\n quantity:\n type: integer\n description: Quantity of the subscription to allocate to the application.\n example: 1\n ApplicationEntitlementUpdateResponse:\n type: object\n properties:\n entitlementIds:\n type: array\n items:\n type: string\n format: uuid\n description: Specify the entitlement IDs allocated to an application.\n quantity:\n type: integer\n description: Quantity of subscription allocated to the application.\n example: 1\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolio-items/b6fedd54-6e06-40f2-b0ec-6f31cbe099dd/entitlements\n rel: self\n method: GET\n EntitlementApplicationCountResponse:\n type: object\n properties:\n entitlementId:\n type: string\n format: uuid\n description: Specify the entitlement ID of an application.\n portfolioItemCount:\n type: integer\n format: int32\n description: Specify the number of portfolio items mapped to an entitlement.\n EntitlementApplicationCountResponseNew:\n type: object\n properties:\n entitlementId:\n type: string\n format: uuid\n description: The entitlement ID of an application.\n applicationCount:\n type: integer\n format: int32\n description: The number of applications mapped to the entitlement.\n UpdateApplicationPayload:\n type: object\n properties:\n name:\n type: string\n description: Specify the portfolio item `name`.\n description:\n type: string\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete settings customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify the branch retention period.\n PortfolioCatalogGetResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioCatalogApplicationDetails'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/catalog?_offset=0&_limit=10\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/catalog?_offset=0&_limit=10\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/catalog?_offset=0&_limit=10\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/catalog?_offset=100&_limit=10\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/portfolios/d36521ae-21f3-412c-b3d2-bcbf8d26c9e0/catalog?_offset=0&_limit=10\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioCatalogApplicationDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `applicationId`.\n name:\n type: string\n description: Specify the application (Portfolio item) `name`.\n description:\n type: string\n description: Optional to specify the description while creating the application (portfolio item).\n createdAt:\n type: string\n description: Specify date and time of application (portfolio item) creation.\n updatedAt:\n type: string\n description: Specify date and time of application (portfolio item) latest update.\n projects:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioCatalogProjectDetails'\n example:\n id: ad6d36cc-5613-499d-91de-ce369daf8fd5\n name: App\n description: app\n createdAt: '2023-04-02 21:00:05'\n updatedAt: '2023-04-02 21:00:05'\n projects:\n - id: 694fb225-1c23-4060-adfc-26751fd5abae\n name: Proj\n applicationId: 1f8778b2-a2a7-48e4-9e0f-89ba8d0b9b3f\n description: proj\n createdAt: '2023-04-02 22:00:05'\n updatedAt: '2023-04-02 22:00:05'\n branches:\n - id: 1f8778b2-a2a7-48e4-9e0f-89ba8d0b9b3f\n applicationId: 1f8778b2-a2a7-48e4-9e0f-89ba8d0b9b3f\n projectId: 694fb225-1c23-4060-adfc-26751fd5abae\n name: polaris_main\n description: default main branch\n source: USER\n isDefault: true\n createdAt: '2023-04-02 23:00:05'\n updatedAt: '2023-04-02 23:00:05'\n BranchesGetResponse:\n type: object\n required:\n - _items\n - _links\n - _collections\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/PortfolioCatalogBranchDetails'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','7d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: first\n method: GET\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: next\n method: GET\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: prev\n method: GET\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: last\n method: GET\n - href: >-\n https://polaris.blackduck.com/portfolio-sub-items?_filter=applicationId=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6','d1f14074-e4e5-4d10-aaea-cb4e43be4741');id=in=('3fa85f64-5717-4562-b3fc-2c963f66afa6')&_offset=0&_limit=2\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n PortfolioCatalogProjectDetails:\n type: object\n required:\n - id\n - applicationId\n - name\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `projectId`.\n applicationId:\n type: string\n format: uuid\n description: Specify the `portfolioItemId`.\n name:\n type: string\n description: Specify the project (Portfolio sub-item) `name`.\n description:\n type: string\n description: Optional to specify the description while creating the project (portfolio sub-item).\n createdAt:\n type: string\n description: Specify date and time of project (portfolio sub-item) creation.\n updatedAt:\n type: string\n description: Specify date and time of project (portfolio sub-item) latest update.\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete setting customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify branch retention period setting\n branches:\n type: array\n description: Specify the branches associated with the project.\n items:\n $ref: '#/components/schemas/PortfolioCatalogBranchDetails'\n PortfolioCatalogBranchDetails:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `branchId`.\n projectId:\n type: string\n format: uuid\n description: Specify the `projectId`.\n name:\n type: string\n description: Specify the branch `name`.\n description:\n type: string\n description: Optional to specify the description while creating the branch.\n source:\n type: string\n description: Specify the branch `source`.\n isDefault:\n type: boolean\n default: false\n description: Specify whether the branch is default branch or not.\n createdAt:\n type: string\n description: Specify date and time of branch creation.\n updatedAt:\n type: string\n description: Specify date and time of branch latest update.\n autoDeleteSetting:\n type: boolean\n default: false\n description: Specify whether the auto delete setting is true or false.\n autoDeleteSettingsCustomized:\n type: boolean\n default: false\n description: Specify whether the auto delete setting customized is true or false.\n branchRetentionPeriodSetting:\n type: integer\n default: 30\n description: Specify branch retention period setting\n TagsCreateResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/Tagitems'\n _links:\n default: []\n _collections:\n $ref: '#/components/schemas/collection'\n TagGetResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/Tagitems'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/tags?_offset=0&_limit=100\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n TagGetAllResponse:\n type: object\n properties:\n _items:\n type: array\n items:\n $ref: '#/components/schemas/Tagitems'\n _links:\n type: array\n items:\n properties:\n href:\n type: string\n format: url\n rel:\n type: string\n default: self\n method:\n type: string\n default: GET\n example:\n - href: https://polaris.blackduck.com/tags?_offset=0&_limit=100\n rel: first\n method: GET\n - href: https://polaris.blackduck.com/tags?_offset=0&_limit=100\n rel: next\n method: GET\n - href: https://polaris.blackduck.com/tags?_offset=0&_limit=100\n rel: prev\n method: GET\n - href: https://polaris.blackduck.com/tags?_offset=0&_limit=100\n rel: last\n method: GET\n - href: https://polaris.blackduck.com/tags?_offset=0&_limit=100\n rel: self\n method: GET\n _collections:\n $ref: '#/components/schemas/collection'\n Tagitems:\n type: object\n properties:\n id:\n type: string\n format: uuid\n description: Specify the `tagId`.\n value:\n type: string\n description: Specify the `tag value`.\n inTrash:\n type: boolean\n default: false\n description: Specify whether the specified tag is in trash or not.\n example:\n id: d36521ae-21f3-412c-b3d2-bcbf8d26c9e0\n value: demo\n inTrash: false\n ApplicationEntitlementResponseNew:\n type: object\n properties:\n entitlementId:\n type: string\n format: uuid\n description: The entitlement ID used for the application.\n type:\n type: string\n description: The Assessment Type of an entitlement. e.g. SAST, DAST or SCA\n example: SAST\n executionMode:\n type: string\n description: the execution mode for the entitlement. e.g. PARALLEL or CONCURRENT\n example: PARALLEL\n quantityUsed:\n type: integer\n format: int32\n default: 1\n description: The quantity used under that application.\n PolarisErrorResponse:\n properties:\n type:\n type: string\n status:\n type: integer\n format: int64\n title:\n type: string\n details:\n type: string\n collection:\n type: object\n properties:\n itemCount:\n type: integer\n format: int32\n currentPage:\n type: integer\n default: 0\n pageCount:\n type: integer\n default: 25\n example:\n itemCount: 1\n currentPage: 1\n pageCount: 1\n"

{}