{"openapi":"3.0.0","info":{"title":"MSSP","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Endpoints in the Tenable.io MSSP Portal API allow you to view and manage your MSSP customer accounts. \n\nFor background information about the Tenable.io MSSP Portal, see the [Tenable.io MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm).","version":"1.0.0"},"security":[{"cloud":[]}],"tags":[{"name":"Accounts","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Account endpoints in the Tenable.io MSSP Portal API allow you to view and manage your MSSP customer accounts. \n\nFor background information about the Tenable.io MSSP Portal, see the [Tenable.io MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm)."},{"name":"Child Containers","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Child Containers endpoints in the Tenable.io MSSP Portal API allow you to view and manage your child accounts. \n\nFor background information about the Tenable.io MSSP Portal, see the [Tenable.io MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm)."},{"name":"Dashboards","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Dashboard endpoints in the Tenable.io MSSP Portal API allow you to retrieve details for various dashboard widgets. \n\nFor background information about the Tenable.io MSSP Portal, see the [Tenable.io MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm)."},{"name":"Domains","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Domains endpoints in the Tenable.io MSSP Portal API allow you to add domains, list domains, get domain details, update domains, and send activation codes to add domains. \n\nFor background information about the Tenable.io MSSP Portal, see the [Tenable.io MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm)."},{"name":"Filters","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Filters endpoints in the Tenable.io MSSP Portal API allow you to list the filtering capabilities for the other MSSP endpoints that support filtering. \n\nFor background information about the Tenable.io MSSP Portal, see the [Tenable.io MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm)."},{"name":"License","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. License endpoints in the Tenable.io MSSP Portal API allow you to retrieve license details for the account associated with the user's API credentials. \n\nFor background information about the Tenable.io MSSP Portal, see the [Tenable.io MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm)."},{"name":"Logos","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage the logos of their customer's Tenable.io instances. By default, the Tenable.io logo appears in the header of your customer's instances. The logo endpoints allow you to replace the Tenable.io logo with a logo appropriate to a customer's business context. Use these endpoints to add, assign, and delete logos. \n\nFor background information about logos in the Tenable.io MSSP Portal, see [Logos](https://docs.tenable.com/managed-security-service-provider/Content/Logos.htm) in Tenable.io MSSP Portal User Guide."},{"name":"Resource Links","description":"The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Resource Links endpoints in the Tenable.io MSSP Portal API allow you to add resource links, bulk add resource links, update resource links, and list resource links. \n\nFor background information about the Tenable.io MSSP Portal, see the [Tenable.io MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm)."}],"servers":[{"url":"https://cloud.tenable.com"}],"paths":{"/mssp/accounts/eval":{"post":{"tags":["Accounts"],"summary":"Create evaluation account","description":"Creates an evaluation account.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-accounts-eval","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","country"],"properties":{"email":{"type":"string","description":"The primary contact's email address. A valid email address must be in the format `name@domain`."},"country":{"type":"string","description":"The primary contact's country in ISO 3166-1 alpha-2 format. Valid country codes are `AU`, `BR`, `CA`, `EU`, `IN`, `JP`, `SG`, `UK`, and `US`."}}}}}},"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully created the evaluation account.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The UUID of the new evaluation account."}}},"examples":{"response":{"value":{"uuid":"ca4761ea-7a17-47dd-8b6d-1d913c6e26fb"}}}}}},"400":{"description":"Returned if your request specified invalid parameters or if your request was improperly formatted."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/accounts":{"get":{"tags":["Accounts"],"summary":"List child accounts","description":"Returns a list of child accounts in the Tenable.io MSSP Portal.\n\n A child account contains information about a customer instance of a Tenable.io product, including product license information and user-defined notes that can include valuable internal tracking or customer contact information.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-accounts-list","parameters":[{"description":"A filter condition in the format `field:operator:value`. For example, `f=container_name:match:tenable`. \n\n**Note:** To retrieve a list of filters to use with this endpoint, see the [GET /filters/mssp/accounts](ref:io-mssp-filters-account-list) endpoint. \n\nSee the list below for additional examples of possible filter combinations: \n* uuid:neq:afe4fa83-8430-4f7b-a4dd-c25bcfd21317 \n* licensed_assets:gte:222 \n* license_utilization:lt:100 \n* license_expiration_date:gt:90 \n* licensed_apps:eq:was,lumin \n* region:eq:US","required":false,"name":"f","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"If multiple `f` parameters are present, specifies whether Tenable.io MSSP applies `AND` or `OR` to conditions. Supported values are `and` and `or`. If you omit this parameter when using multiple `f` parameters, Tenable.io applies `AND` by default.","required":false,"name":"ft","in":"query","schema":{"type":"string"}},{"description":"Wildcard filter text. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the wildcard\\_fields' values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters. For example, if `w=wild&f=field1:match:one&f=field2:match:two&ft=or`, the record would match if the value of any supported wildcard\\_fields contained `wild`, AND either field1's value contained `one` or field2's value contained `two`.","required":false,"name":"w","in":"query","schema":{"type":"string"}},{"description":"A comma-delimited subset of wildcard\\_fields to search when applying the wildcard filter. For example, `field1,field2`. If `w` is provided, but `wf` is not, then all wildcard\\_fields' values are searched against the wildcard filter text. \n\n**Note:** To retrieve a list of fields that can be used as wild cards, see the [GET /filters/mssp/accounts](ref:io-mssp-filters-account-list) endpoint.","required":false,"name":"wf","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the Tenable.io MSSP Portal successfully retrieved the list of child accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChildAccountListResponse"},"examples":{"response":{"value":{"accounts":[{"uuid":"c3f75679-3e5f-4e14-a5c9-5f3d45e2c831","container_name":"container1","lms_customer_id":"123456","custom_name":"Child Account 1","sso_username":"child1","region":"us-west-2","site_id":"site1","licensed_assets":10,"licensed_assets_limit":50,"license_utilization":0.2,"license_expiration_date":1618051200000,"licensed_apps":["app1","app2","app3"],"notes":"Some notes about this child account","logo_uuid":"d2f75679-3e5f-4e14-a5c9-5f3d45e2c831","domains":["child1.com","child1.net"],"created":"2021-01-16T12:00:00Z","modified":"2021-01-16T12:00:00Z"},{"uuid":"d3f75679-3e5f-4e14-a5c9-5f3d45e2c831","container_name":"container2","lms_customer_id":"234567","custom_name":"Child Account 2","sso_username":"child2","region":"us-west-2","site_id":"site1","licensed_assets":20,"licensed_assets_limit":100,"license_utilization":0.2,"license_expiration_date":1618051200000,"licensed_apps":["app1","app2","app3"],"notes":"Some notes about this child account","logo_uuid":"e2f75679-3e5f-4e14-a5c9-5f3d45e2c831","domains":["child2.com","child2.net"],"created":"2021-01-16T12:00:00Z","modified":"2021-01-16T12:00:00Z"}]}}}}}},"400":{"description":"Returned if you specify invalid input parameters."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/accounts/{account_uuid}":{"get":{"tags":["Accounts"],"summary":"Get child account details","description":"Returns details for the specified child account.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-accounts-details","parameters":[{"name":"account_uuid","in":"path","description":"The UUID of the child account you want to retrieve details for.","required":true,"schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully retrieved the details for the specified child account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChildAccountResponse-Object"},"examples":{"response":{"value":{"uuid":"c3f75679-3e5f-4e14-a5c9-5f3d45e2c831","container_name":"container1","lms_customer_id":"123456","custom_name":"Child Account 1","sso_username":"child1","region":"us-west-2","site_id":"site1","licensed_assets":10,"licensed_assets_limit":50,"license_utilization":0.2,"license_expiration_date":1618051200000,"licensed_apps":["app1","app2","app3"],"notes":"Some notes about this child account","logo_uuid":"d2f75679-3e5f-4e14-a5c9-5f3d45e2c831","domains":["child1.com","child1.net"],"created":"2021-01-16T12:00:00Z","modified":"2021-01-16T12:00:00Z"}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified child account."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/accounts/{account_uuid}/domains":{"get":{"tags":["Accounts"],"summary":"List domains","description":"Returns a list of domains for the specified child account.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-accounts-domains-list","parameters":[{"name":"account_uuid","in":"path","description":"The UUID of the child account you want to retrieve domains for.","required":true,"schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully retrieved the list of domains for the specified child account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response-Accounts-Domains"},"examples":{"response":{"value":{"domains":[{"label":"child1.com","value":"child1.com"},{"label":"child1.net","value":"child1.net"},{"label":"child1.org","value":"child1.org"}]}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified child account."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/accounts/mssp-child-keys":{"post":{"tags":["Child Containers"],"summary":"Generate auth keys for child container","description":"Generates authorization keys for the specified child container. An `access_key` and a `secret_key` is included in the response.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-child-containers-generate-keys","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["child_container_uuid"],"properties":{"child_container_uuid":{"type":"string","description":"The UUID of the child container you want to generate authorization keys for."},"keys_validity_duration_seconds":{"type":"integer","description":"The number of seconds that the authorization keys should remain valid. The maximum value is `3600`. If this parameter is omitted, Tenable.io MSSP uses the default value of `1800` seconds.","example":60}}}}}},"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully generated authorization keys for the specified child container.","content":{"application/json":{"schema":{"type":"object","properties":{"parent_container_uuid":{"type":"string","format":"uuid","description":"The UUID of the parent container."},"child_container_uuid":{"type":"string","format":"uuid","description":"The UUID of the child container associated with the parent customer account."},"child_container_site":{"type":"string","description":"The cloud region in which the child container is located."},"keys_user_uuid":{"type":"string","format":"uuid","description":"The UUID of the read-only MSSP child keys user."},"access_key":{"type":"string","description":"The generated access key. It must be paired with the `secret_key`."},"secret_key":{"type":"string","description":"The generated secret key. It must be paired with the `access_key`."},"keys_expiration_epoch_seconds":{"type":"integer","description":"The date and time in Unix format when the authorization keys expire.","example":"1680627675"},"remote":{"type":"boolean","description":"Indicates whether or not the parent and child containers are in the same cloud region. If `true`, the parent and child containers are located in different cloud regions. If `false`, the parent and child containers are located in the same cloud region."},"_validity_info":{"type":"string","description":"The date and time in datetime format when the authorization keys expire.","example":"1680627675 60s PT1M 2023-04-04T17:01:15Z"}}},"examples":{"response":{"value":{"parent_container_uuid":"2e9436cf-e482-4548-adbc-6bc37a97a847","child_container_uuid":"ab5e06fd-0534-416e-95f2-f05be2c60897","child_container_site":"us-2b","keys_user_uuid":"180d3c62-0b93-45d0-995a-e20ff1d79386","access_key":"47382ce31d9e1e6aa45a2a1cb77fe0bc4c4e8036476b9883289661484a35e2bc","secret_key":"2c0442e31a0ab2249ce8c745d39280daeeb2e6a2eee840fae7a847372fcfc910","keys_expiration_epoch_seconds":1680627675,"remote":false,"_validity_info":"1680627675 60s PT1M 2023-04-04T17:01:15Z"}}}}}},"400":{"description":"Returned if your request specified invalid parameters or if your request was improperly formatted."},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified child container."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/accounts/childContainers/{user_uuid}":{"get":{"tags":["Child Containers"],"summary":"List child containers","description":"Returns a list of child containers associated with the specified user. You can retrieve a list of users with the [GET /users](ref:users-list) endpoint.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-child-containers-list","parameters":[{"name":"user_uuid","in":"path","description":"The UUID of the user you want to retrieve the list of child containers for.","required":true,"schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully retrieved the list of child containers for the specified user UUID.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Response-Child-Accounts"}},"examples":{"response":{"value":[{"parent_uuid":"a1b2c3d4","child_container_uuid":"e5f6g7h8"},{"parent_uuid":"i1j2k3l4","child_container_uuid":"m5n6o7p8"},{"parent_uuid":"q1r2s3t4","child_container_uuid":"u5v6w7x8"}]}}}}},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified child container."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/accounts/childContainers/{account_uuid}/history":{"get":{"tags":["Child Containers"],"summary":"Get child container history","description":"Returns the history for child containers associated with the specified parent account UUID.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-child-containers-history","parameters":[{"name":"account_uuid","in":"path","description":"The UUID of the account you want to retrieve the child container history for.","required":true,"schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully retrieved the child container history for the specified parent account UUID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response-Child-Accounts-History"},"examples":{"response":{"value":{"history":[{"uuid":"c3f75679-3e5f-4e14-a5c9-5f3d45e2c831","child_container_uuid":"container1","user_name":"John Smith","old_value":"Old value","updated_value":"New value","created":"2021-01-16T12:00:00Z"},{"uuid":"d3f75679-3e5f-4e14-a5c9-5f3d45e2c831","child_container_uuid":"container2","user_name":"Jane Doe","old_value":"Old value","updated_value":"New value","created":"2021-01-16T12:00:00Z"}]}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified customer account."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/dashboard":{"get":{"tags":["Dashboards"],"summary":"Get widget details","description":"Returns the data for the specified dashboard widget.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-dashboard-details","parameters":[{"name":"widget","required":true,"description":"The dashboard widget you want to retrieve data for. You can retrieve data for two dashboard widgets: ","in":"query","schema":{"type":"string","enum":["customer_licensing_data","scan_results"]}}],"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully retrieved the request dashboard widget data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response-Dashboards"},"examples":{"customer_licensing_data":{"value":{"customer_licensing_data":{"accounts":[{"uuid":"b21d8e1d-653d-468d-8ee8-7ee7f5a1c597","container_name":"example.com-772977010","licensed_assets":0,"licensed_assets_limit":10,"license_utilization":0,"licensed_apps":[],"domains":[]},{"uuid":"d3afd841-bdbb-407f-ad45-ebcc35e4afbc","container_name":"John Doe","licensed_assets":0,"licensed_assets_limit":1550,"license_utilization":0,"licensed_apps":[],"domains":[]},{"uuid":"19efcd2e-5908-475d-b03a-74b05dee508d","container_name":"Example, Inc.","licensed_assets":0,"licensed_assets_limit":66,"license_utilization":0,"licensed_apps":[],"domains":[]}]}}},"scan_results":{"value":{"scan_results":[{"child_container_uuid":"728774a4-d7a7-4d14-aff9-5f4a51665e6c","child_container_name":"example account","created_date":1670874338,"modified_date":1674850753,"scan_status_count":{"days_all":{"running_scans_count":"1","aborted_scans_count":"4","completed_scans_count":"39","canceled_scans_count":"0"},"days7":{"running_scans_count":"1","aborted_scans_count":"2","completed_scans_count":"4","canceled_scans_count":"0"},"days30":{"running_scans_count":"1","aborted_scans_count":"3","completed_scans_count":"26","canceled_scans_count":"0"},"days90":{"running_scans_count":"1","aborted_scans_count":"4","completed_scans_count":"39","canceled_scans_count":"0"},"days180":{"running_scans_count":"1","aborted_scans_count":"4","completed_scans_count":"39","canceled_scans_count":"0"},"days365":{"running_scans_count":"1","aborted_scans_count":"4","completed_scans_count":"39","canceled_scans_count":"0"}}}]}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified dashboard widget."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/domains":{"post":{"tags":["Domains"],"summary":"Add domain","description":"Adds a new domain to the specified container.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-domains-add","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request-Domains-Add"}}}},"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully added the domain to the specified container.","content":{"application/json":{"schema":{"type":"object","properties":{"container_uuid":{"type":"string","format":"uuid","description":"The UUID of the container where the domains were added."},"domains":{"type":"array","description":"An array of domains that exist for the container.","items":{"type":"string"}},"message":{"type":"string","description":"A short message about the operation."}}},"examples":{"response":{"value":{"container_uuid":"3ee227ef-59bb-453e-a6b9-3afe81ac888d","domains":["example.com","example.org"],"message":"Success"}}}}}},"400":{"description":"Returned if your request specified invalid parameters or if your request was improperly formatted."},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}},"get":{"tags":["Domains"],"summary":"List domains","description":"Returns a list of all child containers and their domains.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-domains-list","responses":{"200":{"description":"Returned if the Tenable.io MSSP Portal successfully retrieved the list of child containers and their domains.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response-Domains-List"},"examples":{"response":{"value":{"domain_list":[{"container_uuid":"9df7caa0-323a-463b-bc8c-a44116c649c0","domains":["example.com","example.org"],"message":"Success"},{"container_uuid":"db775a54-cbb8-4064-8bea-42118017c453","domains":["example2.com","example2.org"],"message":"Success"}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/domains/account/{account_uuid}":{"get":{"tags":["Domains"],"summary":"Get domain details","description":"Returns a list of domains and their details for the specified account UUID.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-domains-details-list","parameters":[{"name":"account_uuid","in":"path","description":"The UUID of the customer account you want to retrieve domains for.","required":true,"schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"responses":{"200":{"description":"Returned if the Tenable.io MSSP Portal successfully retrieved the list of domains and their details for the specified account UUID.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"container_uuid":{"type":"string","format":"uuid","description":"The UUID of the specified account."}}},{"$ref":"#/components/schemas/Response-Domains-Details-List"}]},"examples":{"response":{"value":{"container_uuid":"2baf5b11-0fd8-4bf6-ae1d-c426e9abb091","domains":[{"domain_name":"example.com","status":"ACTIVE","type":"PRIMARY","date_added":1663924506},{"domain_name":"widget.com","status":"ACTIVE","type":"PRIMARY","date_added":1663924506},{"host_name":"www","domain_name":"example2.com","status":"ACTIVATION_PENDING","type":"SECONDARY","date_added":1675037424,"user_name":"owner@example.com"},{"host_name":"test","domain_name":"example3.com","status":"ACTIVATION_PENDING","type":"SECONDARY","date_added":1675038101,"user_name":"owner@example.com"}]}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified customer account."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}},"put":{"tags":["Domains"],"summary":"Update domain","description":"Updates a domain associated with the specified account UUID.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-domains-update","parameters":[{"name":"account_uuid","in":"path","description":"The UUID of the customer account you want to update a domain for.","required":true,"schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain_name":{"description":"The domain name you want to update.","type":"string","example":"example.com"},"status":{"description":"The status you want to set for the domain.","type":"string","enum":["ACTIVE","DISABLED"]},"type":{"description":"The type you want to set for the domain.","type":"string","enum":["PRIMARY","SECONDARY"]}}}}}},"responses":{"200":{"description":"Returned if the Tenable.io MSSP Portal successfully updated the domain for the specified account UUID.","content":{"application/json":{"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified domain for the specified account UUID."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/domains/verifyDomain":{"post":{"tags":["Domains"],"summary":"Send activation code","description":"Sends a verification code to add a domain to a container.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-domains-verification","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request-Domains-Verify"}}}},"responses":{"200":{"description":"Returned if the Tenable.io MSSP Portal successfully sent the activation code.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating whether or not the Tenable.io MSSP Portal successfully sent the verification code."}}},"examples":{"response":{"value":{"message":"Activation Code has been sent to the user@example.com"}}}}}},"400":{"description":"Returned if your request specified invalid parameters or if your request was improperly formatted."},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/filters/mssp/accounts":{"get":{"tags":["Filters"],"summary":"List account filters","description":"Lists the filtering capabilities for account endpoints that support filtering.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-filters-account-list","responses":{"200":{"description":"Returned if the Tenable.io MSSP Portal successfully retrieved the list of account filters.","content":{"application/json":{"schema":{"type":"object","properties":{"wildcard_fields":{"$ref":"#/components/schemas/wildcard_fields"},"filters":{"$ref":"#/components/schemas/filters"}}},"examples":{"response":{"value":{"wildcard_fields":["container_name","custom_name","licensed_apps","region","notes"],"filters":[{"name":"container_name","readable_name":"Account Name","control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"operators":["eq","neq","match","nmatch"]},{"name":"uuid","readable_name":"Account UUID","control":{"readable_regex":"01234567-abcd-ef01-2345-6789abcdef01","type":"entry","regex":"[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}(,[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})*"},"operators":["eq","neq"]},{"name":"licensed_assets","readable_name":"Licenses Provisioned","control":{"readable_regex":"e.g. 1111111,2222222","type":"entry","regex":"0|(-?[1-9][0-9]*)"},"operators":["lte","gte","lt","gt","eq","neq"]},{"name":"license_utilization","readable_name":"License Utilization","control":{"readable_regex":"e.g. 1111111,2222222","type":"entry","regex":"0|(-?[1-9][0-9]*)"},"operators":["lte","gte","lt","gt","eq","neq"]},{"name":"license_expiration_date","readable_name":"License Expiring","control":{"readable_regex":"Enter no. of days, eg. 90","type":"entry","regex":"^[0-9]+$","maxlength":"6"},"operators":["lte","gte","lt","gt"]},{"name":"licensed_apps","readable_name":"Licensed Apps","control":{"type":"dropdown_multi","list":[{"name":"CONSEC","id":"consec"},{"name":"WAS","id":"was"},{"name":"LUMIN","id":"lumin"},{"name":"CNS","id":"cns"},{"name":"PCI","id":"pci"}]},"operators":["eq","neq"]},{"name":"region","readable_name":"Region","control":{"type":"dropdown_multi","list":[{"name":"QA-STAGING","id":"qa-staging"}]},"operators":["eq","neq"]}]}}}}}},"400":{"description":"Returned if you specify invalid input parameters."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/license":{"get":{"tags":["License"],"summary":"Get license details","description":"Returns license details for the account associated with the user's API credentials.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-license-details","responses":{"200":{"description":"Returned if the Tenable.io MSSP Portal successfully retrieved the license details.","content":{"application/json":{"schema":{"type":"object","properties":{"license_used":{"type":"string","description":"The number of licenses in use."},"license_purchased":{"type":"string","description":"The number of licenses purchased."}}},"examples":{"response":{"value":{"license_used":"195484","license_purchased":"0"}}}}}},"400":{"description":"Returned if you specify invalid input parameters."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/logos":{"post":{"tags":["Logos"],"summary":"Add logo","description":"Adds a logo to the Tenable.io MSSP Portal. After you add a logo to the Tenable.io MSSP Portal, use the [PUT /mssp/accounts/logos](ref:io-mssp-logos-assign) endpoint to assign the logo to a customer account.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-logos-create","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["logo","name"],"properties":{"logo":{"type":"string","description":"The logo to upload. The logo must be in PNG format and no larger than 246x52 pixels.","format":"binary"},"name":{"type":"string","description":"An identifiable, user-defined name for the logo."}}}}}},"responses":{"200":{"description":"Returned if Tenable.io MSSP Portal successfully added the logo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoUuidResponse"},"examples":{"response":{"value":{"uuid":"09fe899c-12c9-4d69-a13f-38851d47a482"}}}}}},"400":{"description":"Returned if your request specifies invalid query parameter values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-400"},"examples":{"response":{"value":{"error":"request should be multipart and include a single 'name' part"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}},"get":{"tags":["Logos"],"summary":"List logos","description":"Returns a list of logos you have uploaded to the Tenable.io MSSP Portal.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-logos-list","parameters":[],"responses":{"200":{"description":"A list of logos in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoListResponse"},"examples":{"response":{"value":{"logos":[{"uuid":"61a36add-d29b-4a52-bbce-c8215952ede5","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"AMZN","filename":"amzn-logo.png"},{"uuid":"ef646e13-137f-4931-88ed-17cb7aad8a1d","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"goog","filename":"goodlogo.png"},{"uuid":"853038f0-057a-4853-aa42-4dd85b22f735","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"Atos white","filename":"atos-logo-white.png"},{"uuid":"14e90536-8259-40da-91a0-0bbde4fc9e92","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"small","filename":"small-logo.png"},{"uuid":"46cf08ec-8d67-4232-848e-b229faa86e7a","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"FLOOOOOP","filename":"floop-logo.png"},{"uuid":"d4985710-7619-49d5-b31c-314b95d32457","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"TestLogo","filename":"mssp-logo.png"},{"uuid":"db111869-b47d-4c60-840e-bec83f00cb8e","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"brand new","filename":"mssp-logo.png"},{"uuid":"46519267-81d0-4fb6-89dc-39fe8280ee79","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"NASA","filename":"nasa-logo.png"},{"uuid":"5cc5d763-52a1-4943-a3b4-9bca84e9ae27","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"ZONE 88","filename":"mssp-logo.png"}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/logos/{logo_uuid}":{"get":{"tags":["Logos"],"summary":"Get logo details","description":"Returns details for the specified logo in the Tenable.io MSSP Portal.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-logos-details","parameters":[{"name":"logo_uuid","description":"The UUID of the logo for which you want to view details.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returns logo details for the requested logo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoObject"},"examples":{"response":{"value":{"uuid":"61a36add-d29b-4a52-bbce-c8215952ede5","container_uuid":"78093a9e-0992-4952-a984-328c44355804","name":"AMZN","filename":"amzn-logo.png"}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Portal cannot find the specified logo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-404"},"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}},"patch":{"tags":["Logos"],"summary":"Update logo","description":"Updates a logo in the Tenable.io MSSP Portal. This update overwrites the existing logo.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-logos-update","parameters":[{"name":"logo_uuid","description":"The UUID of the logo to update.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["logo","name"],"properties":{"logo":{"type":"string","description":"The logo to upload. The logo must be in PNG format and no larger than 246x52 pixels.","format":"binary"},"name":{"type":"string","description":"An identifiable, user-defined name for the logo."}}}}}},"responses":{"200":{"description":"Returned if Tenable.io MSSP Portal successfully updated the logo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoUuidResponse"},"examples":{"response":{"value":{"uuid":"6a902a71-22a3-4d53-a6cb-4b0d5e1058fd"}}}}}},"400":{"description":"Returned if your request specifies invalid query parameter values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-400"},"examples":{"response":{"value":{"error":"request should be multipart and include a single 'name' part"}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Portal cannot find the specified logo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-404"},"examples":{"response":{"value":{"error":"logo with uuid 8d20527a-c651-457e-9f9f-c26503045011 not found on container d6eacae7-7e1e-457e-9e4f-e86716db564e"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}},"delete":{"tags":["Logos"],"summary":"Delete logo","description":"Deletes the specified logo in the Tenable.io MSSP Portal.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-logos-delete","parameters":[{"name":"logo_uuid","description":"The UUID of the logo to delete.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returned if Tenable.io MSSP Portal successfully deletes the specified logo.","content":{"application/json":{"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Portal cannot find the specified logo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-404"},"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/accounts/logos":{"put":{"tags":["Logos"],"summary":"Assign logo","description":"Assigns a logo to one or more customer accounts in the Tenable.io MSSP Portal.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-logos-assign","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoAssignmentBulk"}}}},"responses":{"200":{"description":"Returned if Tenable.io MSSP Portal successfully assigns the specified logo to the specified account(s).","content":{"application/json":{"examples":{"response":{"value":{}}}}}},"400":{"description":"Returned if your request specifies an invalid `logo_uuid` or `account_uuids` query parameter value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-400"},"examples":{"response":{"value":{"error":"logo_uuid was not found"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/logos/{logo_uuid}/logo.png":{"get":{"tags":["Logos"],"summary":"Download logo (PNG)","description":"Returns a logo file in PNG format.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-logos-png-download","parameters":[{"name":"logo_uuid","description":"The UUID of the logo to download.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returned if the PNG file is downloaded successfully.","content":{"image/png":{"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/logos/{logo_uuid}/logo.base64":{"get":{"tags":["Logos"],"summary":"Download logo (Base64)","description":"Returns a logo file in Base64 format.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-logos-base64-download","parameters":[{"name":"logo_uuid","description":"The UUID of the logo to download.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returned if the file is downloaded successfully.","content":{"text/plain;charset=UTF-8":{"schema":{"type":"string","format":"byte"},"examples":{"response":{"value":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPYAAAA0CAIAAAA2UFIgAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAf1SURBVHhe7ZsxTBtLEECXX1tnlyekmOZw8WUQogREb0hBlSLN70hJmnQpf/cbKKH7xU+RKkWwe/9AiSJipTBubCTkElvX/z8zu3e3t7dnOw527GWerMS73O7Nzc7NzPlmV8Q/l4Jh3OU39T/DOAqbOOM4bOKM47CJM47DJs44Dps44zhs4ozjsIkzjsMmzjgOmzjjOE6b+Nr2f6/3T4vyy0F9TXVPT7Fy9/rgbrOgmpK8yelg+BN8zCEu8UM6mSXHe6Dq7WPVSsgxcRJR2cfzBhX3srKjWj/CoL3+ob7yob7bCoPqvr7etBixblfrqOp4bai5t6paMybv6qa/6sXDbuLHL3zR6zdE4XDNCffTvQFTO+iq1hMzbvLrbr8jxHox0eTFfV+IQqVEjTW/hv8VfpcWXyysC9EZDqmxtMxU4Tm0hqH6lsZq4qtHZdG4v/nUE0F5NbqV0bvU99C7q6iUG4gLpy9jH6B9V5FBO14PZ/jdCBqTnFG6QPpEXmdnc1/21F9QG4hPhDPsn25GkihnSULKHvgk3gv7z8tCeMFVLCfgRWLI4clVJPPoPntnzQ+EuBtoC/AYxka/o0xfeRM6OLzs0sH5qY4WlEkDurZRqoxaLBeec3XW/uzaGeTqZP5mY2IzcfQrYfuRnI3nv9LG18rizYf6+m2Igh4Gd1cYiFcuOyIViMOPvTAa6FU80ek9XMPxu36n1bQG7hGMOWNx+CclAytXIGrwHnsqf1cLdKJmu+SrWVIUTsrhLokhygFl6pUTrw9ngWk7Ijz7t32tjgzffq6/6Qkx7MDxsU8KSuEf+vCInc1tNU9yMC7wVbUgel9TLm3wcDmU7qPwqgx/7Zyppqh6BTHsfxyQKeRqWMUBdPzk9YVXqMK/xdVD0DZEgKxaEOPC7VdnueoJ1i5PJ5L5m42OxcQxS5FaRmeTylU6rfaF/FYqgGeq7dLtdRjAdz0QX992IMk52ViVdwv4JN05ZQP3CMacceC9l7f4rrJm7UTh229gBxZQdyAGutUoW5DQKcaSN5x6/POUR0Rwhb48qIYi/P4o7RLXsnHfjpoYP+X8ozWcLA0chimlfwQnxSF07Rm1SHIvfCSTrN3omednNsOwpb4lZEy8WHkXBSkpRFCtZJ9SJQ15O9IH79GEB0hyRNmvx3fLE2Gc8XhvqybIcYK7mho0FzRNMIhO6+bt1NJiAtoEfwxLGIXghwNTMwpyw/7RnhYwobmJLllPaXI1LOOA54E/kiklrH3sm55GLTNjRmZzfdtc+RxH4ATTxOV9c3apJMDQIz2EAWWTtRcyl7Ug1wwiVPb+Tm7NJCUtnG5YkwqNkWeMMlp1Ioo8E8xJoDwUlDMaj5BpwDggUaHo/7UBfsHzqA8TFXvy2gXXCxE8WkvZrIJP6X+SOcMYDVNYL/lHJbxD4EkrKFeOSlEEiIjVMoq8q4v67Ws3HbM0G+35JIVp4pgaajeQjA4WmQbtdfAQ5S2MOPjJpPzdNvgzWAmlju4N3C0yQkFu2rhqorMctP+CJ9oqPB3uV3qQB4/EdsaLbzAKHfAVKEUe1r2BPHLSOQnUo4xa9DHSDKn0bPqR5fq2XzmEGciDmplJlmFb/mryGJJRRs1eX8X0cRrGpfH8mhd+HyTfpbYtaskh7+pS/da1m475m40Qs9u7CQ/F+yeis2uLHYsEyfn4ldLlZZHZYZ5+CWZm4mvblNo27aF/oSBR1XdM0n7CSzE/yQzMhnfgM45j+12cYRyCTZxxHDZxxnHYxBnHYRNnHGdeJl7E+jL7e76nh+rUVBWhJNuz/FhVqlfhMcQv9uJG6f3TVOJj5aBo3GvvF7M9vw6XdhssBQ4mKliNFFd6ENke5vkwr1c/VCgsen1R9gNo9r6ufBniq1pZrYTVZ832ht6sHzzCEP+yFZ5U6dUjDonesdNheEwXneJ5SX/fu1p/vbWeej2W6tnZ3McCbqpxXb/14E+06YbKo3ESPBjkrJWjd2wkOcqshtC0lk5joDDkJBLhAdWfnQp7sheO86dElSodhoFHuYo8jN4O5s6skdZDqL/i1cQI7uiKsHfYedPzz/UhS8JcvXi6cN4ovbdW6OtV/FuQYtq2HaTY2QxkqbFqGz1r21TNA8Obl+XKsX3rwNh9GLbO9MAcOW27DexTZfZt5IgaiL6un4R8IRFTD7k7D2qlSAwvOPc6cABVuW2b5VMLzFxNfIqSfDUkKoensanKuIsvda1KmDbRpEqNUz1axgLWdnORt3VgdAl/fl1/PDArp50RUxm6Gr3LIbtdYOTmA0MPLa1E1phKE0M9zORtkVxYli0Xt2w70KCdXY1vWpFatkdjwq0D5O3UJw7Q1s6E0XKmGTMVMd0uh0lmdp4FMHGjJD/dlDsaqRwet8Nktx3oP1Acb4C7Sj9opnvIA6kdHsd720fUCeRuHbCW8I+r6wdMOSETAG8a/2oZX+MEUxkYohr6Ub2AdeZIDEMP1ThWqKlSmd6y84tN3CjJz1bod4R/ReXwcofvyG0HtPExzjEQs+f6tgmppAzf74btg7FbB6wl/GPr+vFEuXKmrnGCqSQ5uxzCs15B6gcy6dTDyciZDT1cPOGmh8VjgYtp6YFJTPzwTj8RCL3aO9vDPEOWLRfPZcyDJvNs4S0RjOM448UZxg6bOOM4bOKM47CJM47DJs44Dps44zhs4ozjsIkzjsMmzjgOmzjjOGzijOOwiTNOI8T/kBgTqu2ISYMAAAAASUVORK5CYII="}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/resourcelink/addBulk":{"post":{"tags":["Resource Links"],"summary":"Bulk add resource links","description":"Adds or updates resource links for multiple customer accounts.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-resource-links-bulk","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["container_uuid_list","resource_links"],"properties":{"parent_container_uuid":{"description":"The UUID of the parent container for the child containers you want to bulk add resource links for.","type":"string","format":"uuid","example":"d1dd4fb9-7648-4eb0-90a4-7cf5e742460c"},"container_uuid_list":{"description":"An array of child containers that you want to bulk add resource links for.","type":"array","items":{"description":"A child container UUID.","type":"string","example":"a11d8e1d-653d-468d-8ee8-7ee7f5a1c597"},"example":["a11d8e1d-653d-468d-8ee8-7ee7f5a1c597","e4afd841-bdbb-407f-ad45-ebcc35e4afbc"]},"resource_links":{"description":"An array of resource links to bulk add to the child containers.","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the resource.","type":"string","example":"Resource 4"},"url":{"description":"The URL of the resource.","type":"string","example":"https://example.com/resource1"}}}}}}}}},"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully bulk added the resource links for the specified customer accounts.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The status of the bulk add operation."}}},"examples":{"response":{"value":{"status":"SUCCESS"}}}}}},"400":{"description":"Returned if your request specified invalid parameters or if your request was improperly formatted."},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}},"/mssp/resourcelink/account/{account_uuid}":{"post":{"tags":["Resource Links"],"summary":"Add resource links","description":"Adds or updates resource links for the specified customer account.
Requires ADMINISTRATOR [64] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-resource-links-add","parameters":[{"name":"account_uuid","in":"path","description":"The UUID of the customer account you want to add resource links for.","required":true,"schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"An array of resource links to add to the specified account.","type":"array","items":{"description":"An array of resource links to add to the specified account.","type":"object","properties":{"name":{"description":"The name of the resource.","type":"string","example":"Resource 1"},"url":{"description":"The URL of the resource.","type":"string","example":"http://resource1.com"}}}}}}},"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully added the resource links for the specified customer account.","content":{"application/json":{"schema":{"type":"object","properties":{"container_uuid":{"type":"string","format":"uuid","description":"The UUID of the container where the resource links were added."},"message":{"type":"object","properties":{"code":{"type":"string","description":"The status code associated with the operation results."},"message":{"type":"string","description":"The status message associated with the operation results."}}}}},"examples":{"response":{"value":{"container_uuid":"4368d507-92e1-4069-addf-0e7795569762","message":{"code":"MSSP_1001","message":"Successfully modified resource links for given container UUID"}}}}}}},"400":{"description":"Returned if your request specified invalid parameters or if your request was improperly formatted."},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}},"get":{"tags":["Resource Links"],"summary":"List resource links","description":"Returns the resource links for the specified account.
Requires BASIC [16] user permissions. See [Permissions](doc:permissions).
","operationId":"io-mssp-resource-links-list","parameters":[{"name":"account_uuid","in":"path","description":"The UUID of the customer account you want to retrieve resource links for.","required":true,"schema":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}],"responses":{"200":{"description":"Returned if the Tenable.io MSSP Platform successfully retrieved the resource links for the specified customer account.","content":{"application/json":{"schema":{"type":"object","properties":{"container_uuid":{"type":"string","format":"uuid","description":"The UUID of the container associated with the resource links."},"resource_links":{"type":"array","description":"An array of resource link objects.","items":{"$ref":"#/components/schemas/Resource-Link-Object"}}}},"examples":{"response":{"value":{"container_uuid":"b11d8e1d-653d-468d-8ee8-7ee7f5a1c597","resource_links":[{"name":"Resource 1","url":"http://resource1.com"},{"name":"Resource 2","url":"http://resource2.com"},{"name":"Resource 3","url":"https://example.com/resource3"},{"name":"Resource 4","url":"https://example.com/resource4"}]}}}}}},"404":{"description":"Returned if the Tenable.io MSSP Platform could not find the specified customer account."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"\n\n\n 429 Too Many Requests\n\n\n\n
\n

429 Too Many Requests

\n
\n
\n
nginx
\n\n\n"}}}}},"500":{"description":"Returned if an internal error occurred in the Tenable.io MSSP Portal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse-500"},"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}}}}},"components":{"securitySchemes":{"cloud":{"type":"apiKey","in":"header","name":"X-ApiKeys","description":"Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY"}},"schemas":{"ChildAccountListResponse":{"type":"object","required":["accounts"],"properties":{"accounts":{"description":"An array of customer account objects.","type":"array","items":{"$ref":"#/components/schemas/ChildAccountResponse-Object"}}}},"Response-Child-Accounts-History":{"type":"object","required":["history"],"properties":{"history":{"description":"An array of child container history objects.","type":"array","items":{"$ref":"#/components/schemas/Response-Child-Accounts-History-Object"}}}},"Response-Accounts-Domains":{"type":"object","properties":{"domains":{"description":"An array of domain objects.","type":"array","items":{"$ref":"#/components/schemas/Response-Accounts-Domains-Object"}}}},"Response-Domains-Details-List":{"type":"object","properties":{"domains":{"description":"An array of domain objects.","type":"array","items":{"$ref":"#/components/schemas/Response-Domains-Details-List-Object"}}}},"Response-Domains-List":{"type":"object","properties":{"domains_list":{"description":"An array of customer account objects.","type":"array","items":{"$ref":"#/components/schemas/Response-Domains-List-Object"}}}},"Response-Dashboards":{"type":"object","properties":{"customer_licensing_data":{"description":"A customer accounts object.","properties":{"accounts":{"description":"An array of customer account objects.","type":"array","items":{"$ref":"#/components/schemas/Response-Dashboards-Accounts-Object"}}}}}},"Response-Dashboards-Accounts-Object":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"483f7000-734e-46d0-9fea-2a8ac2f8e9f6","description":"The UUID of the customer account in the Tenable.io MSSP Portal."},"container_name":{"type":"string","example":"Dallas Office","description":"The name of the customer account in the Tenable.io MSSP Portal."},"licensed_assets":{"type":"integer","format":"int64","description":"The number of assets currently counted against the customer's Tenable.io license."},"licensed_assets_limit":{"type":"integer","format":"int64","description":"The number of assets which the customer is licensed to scan."},"license_utilization":{"type":"number","multipleOf":0.1,"description":"The current license utilization."},"licensed_apps":{"type":"array","description":"List of licensed Tenable applications. The applications can include: ","items":{"type":"string"}},"domains":{"type":"array","description":"A list of the customer domains.","items":{"type":"string"}}}},"Resource-Link-Object":{"type":"object","properties":{"name":{"type":"string","description":"The name of the resource link."},"url":{"type":"string","description":"The URL of the resource link."}}},"ChildAccountResponse-Object":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","format":"uuid","example":"483f7000-734e-46d0-9fea-2a8ac2f8e9f6","description":"The UUID of the customer account in the Tenable.io MSSP Portal."},"container_name":{"type":"string","example":"Dallas Office","description":"The name of the customer account in the Tenable.io MSSP Portal."},"lms_customer_id":{"type":"string","description":"The lms_customer_id."},"custom_name":{"type":"string","description":"A custom name in addition to the container name to help you more easily identify the customer / container."},"sso_username":{"type":"string","description":"The sso_username."},"region":{"type":"string","example":"US East","description":"The Tenable.io AWS cloud region that contains the customer account. Customer account regions correspond to the regions used for [cloud sensors](https://docs.tenable.com/vulnerability-management/Content/Platform/Settings/Sensors/CloudSensors.htm). To avoid latency issues, Tenable recommends that scans in the customer instance use scanners in the same region as the customer account."},"licensed_assets":{"type":"integer","format":"int64","description":"The number of assets currently counted against the customer's Tenable.io license."},"licensed_assets_limit":{"type":"integer","format":"int64","description":"The number of assets which the customer is licensed to scan."},"license_utilization":{"type":"number","multipleOf":0.1,"description":"The current license utilization."},"licensed_apps":{"type":"array","description":"List of licensed Tenable applications. The applications can include: ","items":{"type":"string"}},"notes":{"type":"string","description":"User-defined text; for example, internal tracking or customer contact information."},"logo_uuid":{"type":"string","description":"The UUID of the logo assigned to the customer account in the Tenable.io MSSP Portal. This attribute is only present if a custom logo is assigned to the account."},"domains":{"type":"array","description":"A list of the customer domains.","items":{"type":"string"}},"created":{"type":"string","description":"An ISO timestamp indicating the date and time on which the container was created; for example, `2021-01-16T12:00:00Z`."},"modified":{"type":"string","description":"An ISO timestamp indicating the date and time on which the container was last modified; for example, `2021-01-16T12:00:00Z`."}}},"Response-Child-Accounts":{"type":"object","properties":{"parent_uuid":{"description":"The UUID of the parent account.","type":"string","format":"uuid"},"account_uuids":{"type":"array","description":"An array of child account UUIDs that you want to link with the parent account.","items":{"type":"string"}}}},"Response-Child-Accounts-History-Object":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"483f7000-734e-46d0-9fea-2a8ac2f8e9f6","description":"The UUID of the customer account in the Tenable.io MSSP Portal."},"child_container_uuid":{"type":"string","format":"uuid","example":"483f7000-734e-46d0-9fea-2a8ac2f8e9f6","description":"The UUID of the child container associated with the parent customer account."},"user_name":{"type":"string","description":"The user name associated with the change."},"old_value":{"type":"string","description":"The old value of the item that was changed."},"new_value":{"type":"string","description":"The new value of the item that was changed."},"created":{"type":"string","description":"An ISO timestamp indicating the date and time on which the change was made; for example, `2021-01-16T12:00:00Z`."}}},"Response-Accounts-Domains-Object":{"type":"object","properties":{"label":{"type":"string","description":"The domain label."},"value":{"type":"string","description":"The domain value."}}},"Response-Domains-Details-List-Object":{"type":"object","properties":{"domain_name":{"type":"string","example":"example.com","description":"The name of the domain."},"status":{"type":"string","description":"The status of the domain. For example, `ACTIVE`, ACTIVATION_PENDING`, or `DISABLED`."},"type":{"type":"string","description":"The type of domain. For example, `PRIMARY` or `SECONDARY`."},"date_added":{"type":"integer","description":"The Unix timestamp when the domain was added.","format":"int32"}}},"Response-Domains-List-Object":{"type":"object","properties":{"container_uuid":{"type":"string","format":"uuid","example":"483f7000-734e-46d0-9fea-2a8ac2f8e9f6","description":"The UUID of the child container in the Tenable.io MSSP Portal."},"domains":{"type":"array","description":"An array of domains associated with the container.","items":{"type":"string"}},"message":{"type":"string","description":"A short status message about the operation."}}},"filters":{"type":"array","description":"A list of filters available for the record type.","items":{"$ref":"#/components/schemas/filter"}},"filter":{"type":"object","properties":{"name":{"type":"string","description":"The field name to be used in request query strings when applying the filter."},"readable_name":{"type":"string","description":"The filter's display label."},"operators":{"description":"Strings which represent the comparison operations which can be used for the filter.","type":"array","items":{"type":"string"}},"control":{"type":"object","properties":{"readable_regex":{"type":"string","description":"Provides a human-readable \"hint\" which describes what the filter string should look like."},"type":{"type":"string","description":"The type of UI control which represents the filter."},"regex":{"type":"string","description":"A regex which can be used by a user interface to validate input."},"max_length":{"type":"integer","description":"The max length of the filter."}}},"group_name":{"type":"string","description":"Always set to `NULL`. Legacy attribute associated with deprecated functionality."}}},"wildcard_fields":{"description":"Array of strings which represent each field which supports \"wildcard\" search. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the supported fields' values matches against the filter string, then the record matches the wildcard filter. Note that for a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.","type":"array","items":{"type":"string"}},"ProvisioningForm-Update":{"type":"object","required":["account_name","po_number","provisioned_account_details","sso_username"],"properties":{"notes":{"type":"string","description":"User-defined text; for example, internal tracking or customer contact information."},"custom_name":{"type":"string","description":"A custom name in addition to the account name to help you more easily identify the customer / container."},"logo_uuid":{"type":"string","description":"The UUID of the logo you want to assign to the customer account in the Tenable.io MSSP Portal."}}},"Request-Domains-Add":{"type":"object","required":["container_uuid","domain_name","activation_code"],"properties":{"container_uuid":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","description":"The UUID of the container to add the new domain to."},"domain_name":{"type":"string","description":"The domain you want to add to the container."},"activation_code":{"type":"string","description":"The required activation code to add the domain to the specified container."}}},"Request-Domains-Verify":{"type":"object","required":["container_uuid","domain_name","host_name"],"properties":{"container_uuid":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","description":"The UUID of the container to add the new domain to."},"domain_name":{"type":"string","description":"The domain you want to add to the container."},"host_name":{"type":"string","description":"The host name associated with the domain name. Typically this is the first part of the email address of the user you want to send the verification to. For example, for user@example.com, `user` would be the host name."},"is_resend":{"type":"boolean","description":"Indicates whether or not to resend the verification code."}}},"LogoListResponse":{"type":"object","properties":{"logos":{"description":"An array of logo objects.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/LogoObject"}}}},"LogoObject":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the logo."},"container_uuid":{"type":"string","description":"The UUID of the container that contains the logo."},"name":{"type":"string","description":"The user-defined name of the logo."},"filename":{"type":"string","description":"The filename of the logo."}}},"LogoAssignmentBulk":{"type":"object","required":["logo_uuid","account_uuids"],"properties":{"logo_uuid":{"type":"string","description":"The UUID of a logo in the Tenable.io MSSP Portal."},"account_uuids":{"type":"array","description":"An array of customer account UUIDs in the Tenable.io MSSP Portal.","items":{"type":"string"}}}},"Info":{"type":"object","properties":{"mssp_logo":{"type":"string","description":"A logo in Base64 format."}}},"LogoUuidResponse":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","description":"The UUID of the logo."}}},"ErrorResponse-400":{"type":"object","properties":{"error":{"type":"string","description":"A brief message about the missing or invalid parameter value(s)."}}},"ErrorResponse-404":{"type":"object","properties":{"error":{"type":"string","description":"A brief message about the object that could not be found."}}},"ErrorResponse-409":{"type":"object","properties":{"error":{"type":"string","description":"A brief message about the conflict."}}},"ErrorResponse-500":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status code of the error."},"error":{"type":"string","description":"The standard HTTP error name."},"message":{"type":"string","description":"A brief message about the cause of the error."}}}}},"x-readme":{"proxy-enabled":false,"samples-languages":["python","curl","node","powershell","ruby","javascript","objectivec","java","php","csharp","go","swift","kotlin"],"explorer-enabled":true,"samples-enabled":true}}