From 8d31a48edfce0d47442ef05c7f1089ddca1417b0 Mon Sep 17 00:00:00 2001 From: Rajit Shah Date: Wed, 25 Mar 2026 15:49:44 -0500 Subject: [PATCH 1/5] feat(ngts): add NGTS/Venafi TLS Protect Cloud API reference to SCM MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds full NGTS API reference under SCM > NGTS Configuration, mirroring developer.venafi.com/tlsprotectcloud with all 30 API categories and 183 endpoints. Spec generated from devhub-manager merged OAS, transformed to meet PANW Spectral standards (0 errors). POC branch — pending proper workflow through pandev-tools and api-specs MR. EPIC: VC-50859 --- docusaurus.config.ts | 5 + .../scm/config/ngts/tlsprotect-cloud.json | 25404 ++++++++++++++++ products/scm/api/config/ngts/ngts-api.md | 55 + products/scm/sidebars.ts | 12 + src/pages/strata-cloud-manager/index.js | 7 + static/img/homepage-banner/2.svg | 3 + 6 files changed, 25486 insertions(+) create mode 100644 openapi-specs/scm/config/ngts/tlsprotect-cloud.json create mode 100644 products/scm/api/config/ngts/ngts-api.md create mode 100644 static/img/homepage-banner/2.svg diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 2f20012b8..f92596d0e 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -1031,6 +1031,11 @@ const config = { outputDir: "products/scm/api/tenancy", sidebarOptions: { groupPathsBy: "tag" }, }, + ngts: { + specPath: "openapi-specs/scm/config/ngts/tlsprotect-cloud.json", + outputDir: "products/scm/api/config/ngts", + sidebarOptions: { groupPathsBy: "tag" }, + }, ciedss: { specPath: "openapi-specs/scm/config/ciedss", outputDir: "products/scm/api/config/ciedss", diff --git a/openapi-specs/scm/config/ngts/tlsprotect-cloud.json b/openapi-specs/scm/config/ngts/tlsprotect-cloud.json new file mode 100644 index 000000000..ae392e9fe --- /dev/null +++ b/openapi-specs/scm/config/ngts/tlsprotect-cloud.json @@ -0,0 +1,25404 @@ +{ + "components": { + "parameters": { + "AuthTypesParam": { + "description": "The authentication types separated by commas.", + "explode": false, + "in": "query", + "name": "authTypes", + "schema": { + "items": { + "$ref": "#/components/schemas/AuthType" + }, + "minItems": 1, + "type": "array" + } + }, + "CMSConfigIdParam": { + "description": "The id of the Credential Manager Service configuration.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/CMSConfId" + } + }, + "CMSCredentialDetailsParam": { + "description": "The option of whether or not return full credential details. Only Admin users can use this parameter.", + "in": "query", + "name": "details", + "schema": { + "type": "boolean" + } + }, + "CMSTypesParam": { + "description": "The privileged access management types separated by commas.", + "explode": false, + "in": "query", + "name": "cmsTypes", + "schema": { + "items": { + "$ref": "#/components/schemas/CMSType" + }, + "minItems": 1, + "type": "array" + } + }, + "CredentialIdParam": { + "description": "The credential Id.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/CredentialId" + } + }, + "CredentialIdsParam": { + "description": "The credential Ids separated by commas.", + "explode": false, + "in": "query", + "name": "ids", + "schema": { + "items": { + "$ref": "#/components/schemas/CredentialId" + }, + "minItems": 1, + "type": "array" + } + }, + "TeamIdsParam": { + "description": "The team Ids separated by commas.", + "explode": false, + "in": "query", + "name": "teamIds", + "schema": { + "items": { + "$ref": "#/components/schemas/TeamId" + }, + "minItems": 1, + "type": "array" + } + } + }, + "requestBodies": { + "AddCredentialsBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCredentialsRequest" + } + } + }, + "description": "The body request to add credentials to existing Credential Manager Service configurations." + }, + "CreateCMSConfigurationsBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCMSConfigurationsRequest" + } + } + }, + "description": "The body request to create the given Credential Manager Service configuration using their details." + }, + "TestCMSConfigurationBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCMSConfigurationRequest" + } + } + }, + "description": "The body request to test the given Credential Manager Service configuration using their details." + }, + "TestCredentialBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCredentialRequest" + } + } + }, + "description": "The body request to test the given credential." + }, + "UpdateCMSConfigurationsBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCMSConfigurationRequest" + } + } + }, + "description": "The body request to update the given Credential Manager Service configuration using their details." + }, + "UpdateCredentialBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCredentialRequest" + } + } + }, + "description": "The body request to update the given credential." + } + }, + "responses": { + "200DeleteCredentials": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCredentialsResponse" + } + } + }, + "description": "The credentials deleted successfully." + }, + "200GetCMSConfiguration": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CMSConfigurationResponse" + } + } + }, + "description": "The Credential Manager Service configuration received." + }, + "200GetCMSConfigurations": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCMSConfigurationsResponse" + } + } + }, + "description": "The Credential Manager Service configurations received." + }, + "200GetCredential": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialResponse" + } + } + }, + "description": "The retrieved credential." + }, + "200GetCredentials": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCredentialsResponse" + } + } + }, + "description": "The retrieved credentials for a company." + }, + "200TestCMSConfiguration": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCMSConfigurationResponse" + } + } + }, + "description": "Ok. Contains the result of testing the Credential Manager Service configuration." + }, + "200TestCredential": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCredentialResponse" + } + } + }, + "description": "Connection test to credential successful." + }, + "200UpdateCMSConfiguration": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CMSConfigurationResponse" + } + } + }, + "description": "The Credential Manager Service configurations updated." + }, + "200UpdateCredential": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialResponse" + } + } + }, + "description": "The credentials updated successfully." + }, + "201AddCredentials": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCredentialsResponse" + } + } + }, + "description": "The credentials added successfully." + }, + "201CreateCMSConfigurations": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCMSConfigurationsResponse" + } + } + }, + "description": "The Credential Manager Service configurations created." + }, + "400BadRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Bad request." + }, + "401Unauthorized": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Unauthorized. Missing or invalid credentials." + }, + "403Forbidden": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Forbidden. The user does not have the permission to do this action." + }, + "404NotFound": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Not found. The resource was not found." + }, + "500InternalServerErrorContent": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Internal Server Error." + } + }, + "schemas": { + "ActivityLogCondition": { + "description": "A Condition for filtering", + "properties": { + "field": { + "description": "Represents a field for filtering", + "example": "activityType", + "type": "string" + }, + "operator": { + "$ref": "#/components/schemas/ActivityLogFilterOperator" + }, + "value": { + "description": "represents a field's value", + "example": "Authentication", + "type": "string" + }, + "values": { + "description": "represents a field's values", + "example": [ + "Authentication", + "Users" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ActivityLogEntriesResponse": { + "properties": { + "activityLogEntries": { + "description": "A collection of activity log entries", + "items": { + "$ref": "#/components/schemas/ActivityLogEntryInformation" + }, + "type": "array" + }, + "count": { + "description": "The number of activity log entries.", + "example": 2, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "ActivityLogEntryInformation": { + "properties": { + "activityDate": { + "description": "The date when a log entry was produced", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "activityName": { + "description": "An activity name", + "example": "Login Succeeded", + "type": "string" + }, + "activityType": { + "description": "An activity type", + "example": "Authentication", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "criticality": { + "description": "An activity criticality", + "example": 0, + "format": "int32", + "type": "integer" + }, + "id": { + "description": "UUID of a log entry", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "message": { + "description": "An activity log message", + "example": "user logged in", + "type": "string" + }, + "payload": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "ActivityLogFilter": { + "properties": { + "expression": { + "$ref": "#/components/schemas/BaseActivityLogFilter" + }, + "ordering": { + "$ref": "#/components/schemas/BaseActivityLogOrdering" + }, + "paging": { + "$ref": "#/components/schemas/Page1" + } + }, + "type": "object" + }, + "ActivityLogFilterOperand": { + "properties": { + "operand": { + "$ref": "#/components/schemas/ActivityLogCondition" + }, + "operator": { + "$ref": "#/components/schemas/UnaryOperator" + } + }, + "type": "object" + }, + "ActivityLogFilterOperands": { + "properties": { + "operands": { + "description": "A list of conditions that will be used for filtering", + "example": [ + { + "field": "activityType", + "operator": "EQ", + "value": "Authentication" + }, + { + "field": "activityName", + "operator": "EQ", + "value": "Login Succeeded" + } + ], + "items": { + "$ref": "#/components/schemas/BaseActivityLogFilter" + }, + "type": "array" + }, + "operator": { + "$ref": "#/components/schemas/NaryOperator" + } + }, + "type": "object" + }, + "ActivityLogFilterOperator": { + "description": "An operator for filtering", + "enum": [ + "EQ", + "LT", + "LTE", + "GT", + "GTE", + "IN" + ], + "example": "EQ", + "type": "string" + }, + "ActivityLogName": { + "properties": { + "key": { + "type": "string" + }, + "readableName": { + "type": "string" + } + }, + "type": "object" + }, + "ActivityLogOrder": { + "properties": { + "direction": { + "$ref": "#/components/schemas/Direction" + }, + "field": { + "description": "A field, that will be used for ordering", + "example": "activityDate", + "type": "string" + } + }, + "type": "object" + }, + "ActivityLogType": { + "properties": { + "key": { + "type": "string" + }, + "readableName": { + "type": "string" + }, + "values": { + "items": { + "$ref": "#/components/schemas/ActivityLogName" + }, + "type": "array" + } + }, + "type": "object" + }, + "AddCredentialRequest": { + "description": "The properties representing a credential to add.", + "properties": { + "authType": { + "$ref": "#/components/schemas/AuthType" + }, + "cmsConfigId": { + "$ref": "#/components/schemas/CMSConfId" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "credentialDetails": { + "$ref": "#/components/schemas/CreateCredentialDetails" + }, + "name": { + "$ref": "#/components/schemas/CredentialName" + }, + "teamsIds": { + "$ref": "#/components/schemas/TeamsIds" + } + }, + "required": [ + "name", + "cmsType", + "authType", + "credentialDetails" + ], + "type": "object" + }, + "AddCredentialsRequest": { + "description": "Array of credentials to add.", + "properties": { + "credentials": { + "items": { + "$ref": "#/components/schemas/AddCredentialRequest" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "credentials" + ], + "type": "object" + }, + "AddCredentialsResponse": { + "description": "The response for the add credentials action.", + "properties": { + "count": { + "type": "integer" + }, + "credentialsAdded": { + "items": { + "$ref": "#/components/schemas/CredentialResponse" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "credentialsAdded", + "count" + ], + "type": "object" + }, + "AdvancedSettingsInformation": { + "properties": { + "enableIssuanceAuditLog": { + "description": "Whether audit log entries must be generated for each issued certificate", + "example": false, + "type": "boolean" + }, + "includeRawCertDataInAuditLog": { + "description": "Whether the raw certificate data must be included in the audit log entry", + "example": false, + "type": "boolean" + }, + "requireFIPSCompliantBuild": { + "description": "Whether FIPS-compliant build is required", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "AnyValue1": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue10": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue2": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue3": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue4": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue5": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue6": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue7": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue8": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue9": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "ApiClientInformation": { + "description": "Represents the information of the client that is calling the API", + "example": { + "identifier": "192.168.1.63", + "type": "Venafi VCert CLI" + }, + "properties": { + "identifier": { + "description": "Client identifier", + "example": "199.121.8.74", + "type": "string" + }, + "type": { + "description": "Client type", + "example": "Venafi VCert CLI", + "type": "string" + } + }, + "type": "object" + }, + "ApiKeyInformation": { + "properties": { + "apiKeyStatus": { + "$ref": "#/components/schemas/ApiKeyStatus" + }, + "apiVersion": { + "$ref": "#/components/schemas/ApiVersion" + }, + "companyId": { + "description": "UUID of a company.", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date and time the API key was created.", + "format": "date-time", + "type": "string" + }, + "key": { + "description": "UUID of an API key.", + "format": "uuid", + "type": "string" + }, + "memberedTeams": { + "description": "Membered teams of the user associated with this API key.", + "items": { + "description": "Membered teams of the user associated with this API key.", + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "productRoles": { + "additionalProperties": { + "description": "Product roles of the user associated with this API key.", + "items": { + "$ref": "#/components/schemas/Role2" + }, + "type": "array", + "uniqueItems": true + }, + "description": "Product roles of the user associated with this API key.", + "type": "object" + }, + "systemRoles": { + "description": "System roles of the user associated with this API key.", + "items": { + "$ref": "#/components/schemas/SystemRole" + }, + "type": "array", + "uniqueItems": true + }, + "urlPrefix": { + "description": "Tenant URL Prefix.", + "type": "string" + }, + "userId": { + "description": "UUID of a user.", + "format": "uuid", + "type": "string" + }, + "username": { + "description": "Email address of the registered user.", + "type": "string" + }, + "validityEndDate": { + "description": "The date and time the API key will no longer be valid.", + "format": "date-time", + "type": "string" + }, + "validityStartDate": { + "description": "The date and time the API key became valid.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "ApiKeyStatus": { + "enum": [ + "PENDING_ACTIVATION", + "ACTIVE", + "INACTIVE", + "PENDING_ROTATION", + "ROTATED", + "EXPIRED" + ], + "type": "string" + }, + "ApiVersion": { + "description": "Indicates version of the API.", + "enum": [ + "ALL", + "V1" + ], + "type": "string" + }, + "AppId": { + "description": "The application ID from the CyberArk provider.", + "type": "string" + }, + "Application": { + "description": "Application ID to associate with the service account", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "ApplicationInformation": { + "properties": { + "certificateIssuingTemplateAliasIdMap": { + "additionalProperties": { + "format": "uuid", + "type": "string" + }, + "type": "object" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "description": { + "type": "string" + }, + "fullyQualifiedDomainNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "id": { + "format": "uuid", + "type": "string" + }, + "ipRanges": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "ownerIdsAndTypes": { + "items": { + "$ref": "#/components/schemas/OwnerIdAndType" + }, + "type": "array" + }, + "ownership": { + "$ref": "#/components/schemas/ApplicationOwnership" + }, + "owningServiceAccounts": { + "items": { + "$ref": "#/components/schemas/ServiceAccountInformation" + }, + "type": "array" + }, + "owningTeams": { + "items": { + "$ref": "#/components/schemas/TeamInformation1" + }, + "type": "array" + }, + "owningUsers": { + "items": { + "$ref": "#/components/schemas/UserInformation1" + }, + "type": "array" + }, + "ports": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ApplicationOwnership": { + "properties": { + "owningTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "owningUsers": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ApplicationRenewalConfiguration": { + "properties": { + "renewalActions": { + "description": "A set of options that can be used to specify the actions that should be taken when the auto-renewal process runs.", + "example": { + "provision": false, + "renew": true + }, + "properties": { + "provision": { + "description": "If true, the system with attempt to provision any certificates associated with this application after a successful auto-renewal.", + "type": "boolean" + }, + "renew": { + "description": "If true, the system will attempt to renew any certificates associated with this application that are expected to expire within the configured number of days.", + "type": "boolean" + } + }, + "required": [ + "renew", + "provision" + ], + "type": "object" + }, + "renewalWindow": { + "description": "A set of options to control the time window in which auto-renewal of certificates should be attempted.", + "example": { + "days": 16, + "inherit": false + }, + "properties": { + "days": { + "description": "Any certificates associated with this application that are expected to expire within the specified number of days will be acted on.", + "format": "int64", + "minimum": 1, + "type": "integer" + }, + "inherit": { + "description": "If true, \"days\" value configured for this application will be ignored and the value configured at the tenant level will be used.", + "type": "boolean" + } + }, + "required": [ + "inherit" + ], + "type": "object" + } + }, + "required": [ + "renewalActions", + "renewalWindow" + ], + "type": "object" + }, + "ApplicationRequest": { + "properties": { + "certificateIssuingTemplateAliasIdMap": { + "additionalProperties": { + "description": "Represents a mapping of certificate issuing template aliases to their UUIDs.", + "format": "uuid", + "type": "string" + }, + "description": "Represents a mapping of certificate issuing template aliases to their UUIDs.", + "example": { + "dev-cit": "20bcb9a1-0f9c-407e-9673-b048c3d6479d", + "qa-cit": "448de2a0-1159-40f0-b3ae-e4f712577e87" + }, + "type": "object" + }, + "description": { + "description": "A description for an applications", + "example": "this application will hold dev certificates", + "type": "string" + }, + "externalIpRanges": { + "description": "Represents a collection of external IP ranges.", + "example": [ + "127.254.0.0/16", + "192.2.3.0/32" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "fqdns": { + "description": "A collection of FQDNs", + "example": [ + "venafi.docs.com", + "api.venafi" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "fullyQualifiedDomainNames": { + "description": "Represents a collection of fully qualified domain names (FQDNs).", + "example": [ + "internal.venafi.docs", + "internal.api.venafi" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "internalFqdns": { + "description": "Represents a collection of fully qualified domain names (FQDNs) used for internal purposes.", + "example": [ + "internal.venafi.docs", + "internal.api.venafi" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "internalIpRanges": { + "description": "epresents a collection of internal IP ranges.", + "example": [ + "127.254.0.0/16", + "127.2.3.0/32" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "internalPorts": { + "description": "Represents a collection of external ports.", + "example": [ + "8080", + "9090" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "ipRanges": { + "description": "Represents a collection of CIDR (Classless Inter-Domain Routing) ranges.", + "example": [ + "127.254.0.0/16", + "192.2.3.0/32" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "An application name", + "example": "dev app", + "type": "string" + }, + "ownerIdsAndTypes": { + "description": "Represents a collection of ownership UUIDs and types.", + "example": [ + { + "ownerId": "f94c36a4-31b3-4aaf-a5c9-83fc7277db9f", + "ownerType": "USER" + }, + { + "ownerId": "2f796153-33e8-48d6-82e0-cc3b259f78ec", + "ownerType": "TEAM" + } + ], + "items": { + "$ref": "#/components/schemas/OwnerIdAndType" + }, + "type": "array" + }, + "ports": { + "description": "Represents a collection of network ports.", + "example": [ + "443", + "7776" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "startTargetedDiscovery": { + "description": "Specifies whether to start target discovery.", + "type": "boolean" + } + }, + "required": [ + "fullyQualifiedDomainNames", + "internalPorts", + "ipRanges", + "name", + "ownerIdsAndTypes", + "ports" + ], + "type": "object" + }, + "ApplicationResponse": { + "properties": { + "applications": { + "items": { + "$ref": "#/components/schemas/ApplicationInformation" + }, + "type": "array" + }, + "ownershipCount": { + "format": "int32", + "type": "integer" + }, + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ApplicationsAssignRequest": { + "properties": { + "action": { + "enum": [ + "REPLACE", + "ADD", + "DELETE", + "DELETE_ALL" + ], + "type": "string" + }, + "certificateIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "targetedApplicationIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "action", + "certificateIds", + "targetedApplicationIds" + ], + "type": "object" + }, + "ApplicationsAssignResponse": { + "properties": { + "certificates": { + "items": { + "$ref": "#/components/schemas/CertificateInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApprovalDecisionRequest": { + "properties": { + "reason": { + "description": "Reason for user's decision", + "example": "I reject this request because the certificate won't be needed anymore.", + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "ApprovalRequestInformation": { + "properties": { + "approvalRule": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + }, + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "type": "array", + "uniqueItems": true + }, + "approversOutcome": { + "description": "A collection of approver outcomes", + "items": { + "$ref": "#/components/schemas/ApproverOutcomeInformation" + }, + "type": "array", + "uniqueItems": true + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "companyId": { + "description": "UUID of a company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date a approval request was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "entityId": { + "description": "UUID of a certificate request", + "example": "5ece3180-b1e0-11ed-862d-ad36b18e787b", + "format": "uuid", + "type": "string" + }, + "finalApprover": { + "$ref": "#/components/schemas/ApproverPropertyOpenApi" + }, + "id": { + "description": "UUID of a approval request", + "example": "5ece3180-b1e0-11ed-862d-ad36b18e787d", + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "description": "The date a approval request was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "requestorId": { + "description": "UUID of a requestor", + "example": "8268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "requiredApprovalsCount": { + "description": "Count of a required approvals", + "example": 2, + "format": "int32", + "type": "integer" + }, + "status": { + "description": "Status of an approval request", + "enum": [ + "NOT_REQUIRED", + "PENDING_APPROVAL", + "PENDING_FINAL_APPROVAL", + "APPROVED", + "REJECTED", + "EXPIRED", + "AUTO_APPROVED" + ], + "example": "PENDING_APPROVAL", + "type": "string" + } + }, + "type": "object" + }, + "ApproverOutcomeInformation": { + "properties": { + "companyId": { + "description": "UUID of a company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date a approver outcome was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "UUID of an approver outcome", + "example": "5ece3180-b1e0-11ed-862d-ad36b18e787c", + "format": "uuid", + "type": "string" + }, + "reason": { + "description": "Reason of an outcome", + "example": "Not needed", + "type": "string" + }, + "status": { + "description": "Status of an approval request", + "enum": [ + "APPROVED", + "REJECTED" + ], + "example": "APPROVED", + "type": "string" + }, + "userId": { + "description": "UUID of a user", + "example": "8268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + } + }, + "type": "object" + }, + "ApproverProperty": { + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "enum": [ + "USER", + "TEAM" + ], + "type": "string" + } + }, + "type": "object" + }, + "ApproverPropertyOpenApi": { + "description": "Approver with id that can be only user type", + "properties": { + "id": { + "description": "UUID specific to the approver user/team", + "example": "8268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "Approver type", + "example": "USER", + "type": "string" + } + }, + "type": "object" + }, + "AuthType": { + "description": "The type of the authentication:\n * `password`\n * `username_password`\n", + "enum": [ + "password", + "username_password" + ], + "type": "string" + }, + "AwsCloudProviderInformation": { + "properties": { + "accountIds": { + "description": "Array of AWS account IDs each of which should be a 12-digit identifier", + "example": [ + "123456789012" + ], + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "regions": { + "description": "Array of AWS regions", + "example": [ + "us-west-1" + ], + "items": { + "enum": [ + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2", + "af-south-1", + "ap-east-1", + "ap-south-2", + "ap-southeast-3", + "ap-southeast-4", + "ap-south-1", + "ap-northeast-3", + "ap-northeast-2", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "ca-central-1", + "eu-central-1", + "eu-west-1", + "eu-west-2", + "eu-south-1", + "eu-west-3", + "eu-south-2", + "eu-north-1", + "eu-central-2", + "me-south-1", + "me-central-1", + "sa-east-1", + "us-gov-east-1", + "us-gov-west-1" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "accountIds", + "regions" + ], + "type": "object" + }, + "AzureCloudProviderInformation": { + "properties": { + "subscriptionIds": { + "description": "Array of Azure subscription IDs each of which should be UUID", + "example": [ + "8d10da13-8125-4ba9-a717-bf7490507b3d" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "subscriptionIds" + ], + "type": "object" + }, + "BaseActivityLogFilter": { + "description": "Root expression for filtering", + "oneOf": [ + { + "$ref": "#/components/schemas/ActivityLogFilterOperands" + }, + { + "$ref": "#/components/schemas/ActivityLogFilterOperand" + }, + { + "$ref": "#/components/schemas/ActivityLogCondition" + } + ], + "type": "object" + }, + "BaseActivityLogOrdering": { + "description": "Specify the ordering of a search result", + "properties": { + "orders": { + "items": { + "$ref": "#/components/schemas/ActivityLogOrder" + }, + "type": "array" + } + }, + "type": "object" + }, + "BaseFilter": { + "description": "Root expression for filtering", + "oneOf": [ + { + "$ref": "#/components/schemas/FilterOperands" + }, + { + "$ref": "#/components/schemas/FilterOperand" + }, + { + "$ref": "#/components/schemas/Condition" + } + ], + "type": "object" + }, + "BaseOrdering": { + "description": "Specify the ordering of a search result", + "properties": { + "orders": { + "items": { + "$ref": "#/components/schemas/Order" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkApprovalRequest": { + "properties": { + "ids": { + "description": "Set of UUIDs of the certificate requests", + "example": [ + "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" + ], + "items": { + "description": "Set of UUIDs of the certificate requests", + "format": "uuid", + "type": "string" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + }, + "reason": { + "description": "Reason for user's decision", + "example": "I reject this request because the certificate won't be needed anymore.", + "maxLength": 1024, + "type": "string" + }, + "wsClientId": { + "description": "The ws client id, that will be used when the execution finishes", + "example": "someid", + "type": "string" + } + }, + "required": [ + "ids" + ], + "type": "object" + }, + "BulkApprovalResponse": { + "properties": { + "operationId": { + "type": "string" + } + }, + "type": "object" + }, + "CMSAuthenticationType": { + "description": "The authentication type for the privileged access management:\n * `certificate` - For authentication with a Certificate bundle\n * `userPassword` - For authentication with user and password\n", + "enum": [ + "certificate", + "userPassword" + ], + "type": "string" + }, + "CMSConfId": { + "description": "The Credential Manager Service configuration ID.", + "example": "72e4c1f6-d85f-11ed-afa1-0242ac120002", + "format": "uuid", + "type": "string" + }, + "CMSConfigurationResponse": { + "description": "The information representing a Credential Manager Service configuration for response.", + "properties": { + "cmsDetails": { + "$ref": "#/components/schemas/ResponseCMSDetails" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "companyId": { + "$ref": "#/components/schemas/CompanyId" + }, + "createdBy": { + "$ref": "#/components/schemas/CreatedBy" + }, + "createdOn": { + "$ref": "#/components/schemas/CreatedOn" + }, + "id": { + "$ref": "#/components/schemas/CMSConfId" + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/LastModifiedBy" + }, + "lastModifiedOn": { + "$ref": "#/components/schemas/LastModifiedOn" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "vSatelliteIds": { + "$ref": "#/components/schemas/VSatelliteIds" + } + }, + "type": "object" + }, + "CMSType": { + "description": "The type of the privileged access management:\n * `cyberark` - For CyberArk privileged access management\n * `hashicorp` - For HashiCorp privileged access management\n", + "enum": [ + "cyberark", + "hashicorp" + ], + "type": "string" + }, + "CMSURL": { + "description": "The baseUrl of the privileged access management provider.", + "format": "uri", + "type": "string" + }, + "CSRAttributesInformation": { + "description": "Represents CSR attributes for certificate requests. Required when isVaaSGenerated is set to true and reuseCSR to false.", + "example": { + "commonName": "localhost", + "country": "MX", + "keyTypeParameters": { + "keyCurve": "P256", + "keyLength": 4096, + "keyType": "RSA" + }, + "locality": "Merida", + "organization": "venafi", + "organizationalUnits": [ + "devops" + ], + "state": "Yucatan", + "subjectAlternativeNamesByType": { + "dnsNames": [ + "localhost" + ] + } + }, + "properties": { + "commonName": { + "type": "string" + }, + "country": { + "type": "string" + }, + "keyTypeParameters": { + "$ref": "#/components/schemas/KeyTypeParameters1" + }, + "locality": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "organizationalUnits": { + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/SubjectAlternativeNamesByType" + } + }, + "type": "object" + }, + "Capability": { + "enum": [ + "DEFAULT", + "ISSUANCE", + "VALIDATION", + "ENTERPRISE", + "PROVISIONING", + "SINGLE_SIGN_ON", + "DISTRIBUTED_ISSUER", + "CLOUD_PROVIDERS", + "CREDENTIAL_MANAGER", + "KUBERNETES_DISCOVERY", + "KUBERNETES_ENTERPRISE_COMPONENTS", + "KUBERNETES_ENTERPRISE_COMPONENTS_CERT_MANAGER", + "KUBERNETES_ENTERPRISE_COMPONENTS_VEI", + "KUBERNETES_ENTERPRISE_COMPONENTS_APE", + "KUBERNETES_ENTERPRISE_COMPONENTS_OS", + "KUBERNETES_INTEGRATION_TLSPDC" + ], + "type": "string" + }, + "CapabilityInformation": { + "properties": { + "isTrial": { + "type": "boolean" + }, + "name": { + "$ref": "#/components/schemas/Capability" + }, + "productExpiryDate": { + "format": "date-time", + "type": "string" + }, + "productGraceExpiryDate": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "isTrial", + "name", + "productExpiryDate" + ], + "type": "object" + }, + "CertificateAuthorityProductInformation1": { + "properties": { + "certificateType": { + "enum": [ + "OTHER", + "DOMAIN_VALIDATED_SSL" + ], + "type": "string" + }, + "hashAlgorithm": { + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "type": "string" + }, + "productName": { + "type": "string" + }, + "productTypes": { + "items": { + "enum": [ + "SSL", + "CODESIGN" + ], + "type": "string" + }, + "type": "array" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "type": "object" + }, + "CertificateAuthorityProductInformation2": { + "description": "Product specific for external certificate authority", + "discriminator": { + "propertyName": "certificateAuthority" + }, + "properties": { + "certificateAuthority": { + "type": "string" + }, + "certificateType": { + "enum": [ + "OTHER", + "DOMAIN_VALIDATED_SSL" + ], + "type": "string" + }, + "hashAlgorithm": { + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "type": "string" + }, + "productName": { + "type": "string" + }, + "productTypes": { + "items": { + "enum": [ + "SSL", + "CODESIGN" + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "required": [ + "certificateAuthority" + ], + "type": "object" + }, + "CertificateCredentialData": { + "properties": { + "certificateBundle": { + "description": "The Base64 encoding certificate bundle encrypted content.", + "format": "byte", + "type": "string" + }, + "certificateId": { + "description": "The Id of the certificate selected from the Certificate Inventory", + "format": "uuid", + "type": "string" + }, + "certificatePassword": { + "description": "The password to decrypt the certificate bundle.", + "format": "password", + "type": "string" + }, + "fingerprint": { + "description": "The fingerprint of the certificate selected from the Certificate Inventory", + "type": "string" + } + }, + "type": "object" + }, + "CertificateDeletionRequest": { + "properties": { + "certificateIds": { + "description": "Unique certificate id(s) containing numbers, letters and dashes.", + "example": [ + "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", + "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "certificateIds" + ], + "type": "object" + }, + "CertificateExpirationInventoryMonitoringConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/InventoryMonitoringConfig" + }, + { + "properties": { + "applicationIds": { + "description": "Application IDs that the webhook applies to", + "items": { + "description": "Application IDs that the webhook applies to", + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "enabled": { + "description": "Enables or disables webhook messages.", + "type": "boolean" + }, + "includeUnassignedCertificates": { + "description": "Enables or disables notifications for unassigned certificates.", + "type": "boolean" + }, + "thresholds": { + "description": "Array of certificate expiration thresholds, in days, for when notifications will be sent. Limit is 3 values.", + "items": { + "description": "Array of certificate expiration thresholds, in days, for when notifications will be sent. Limit is 3 values.", + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "CertificateImportInfo": { + "description": "Base64 encoding certificate content.", + "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" + }, + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "47c9d920-da21-11ed-a63c-d508f08eeaa0", + "9303e940-df9d-11ed-8850-f18176fc5513" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificate": { + "description": "Certificate base64 encoded format (PEM without header/footer", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" + }, + "type": "array" + }, + "issuerCertificates": { + "description": "A collection of issuer certificates", + "example": [ + "Venafi issuer", + "QA Venafi issuer" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "certificate" + ], + "type": "object" + }, + "CertificateImportInformation": { + "description": "List of the certificates and private key pairs to import", + "properties": { + "certificate": { + "description": "Certificate to import", + "type": "string" + }, + "dekEncryptedPassword": { + "description": "Password to decrypt the certificate", + "type": "string" + }, + "dekEncryptedPrivateKey": { + "description": "Format of the private key", + "type": "string" + }, + "passwordEncryptedPrivateKey": { + "description": "Private key for certificate to import", + "type": "string" + }, + "pkcs12Keystore": { + "description": "pkcs12 keystore base64 encoded string", + "type": "string" + } + }, + "required": [ + "certificate", + "dekEncryptedPrivateKey", + "passwordEncryptedPrivateKey" + ], + "type": "object" + }, + "CertificateImportRequest1": { + "properties": { + "certificates": { + "description": "Base64 encoding certificate content.", + "items": { + "$ref": "#/components/schemas/CertificateImportInfo" + }, + "type": "array" + }, + "overrideBlocklist": { + "description": "What is this?? Need a description here.", + "type": "boolean" + } + }, + "required": [ + "certificates" + ], + "type": "object" + }, + "CertificateImportRequest2": { + "properties": { + "edgeInstanceId": { + "description": "Id for edge instance", + "format": "uuid", + "type": "string" + }, + "encryptionKeyId": { + "description": "Id for data encryption key", + "minLength": 1, + "type": "string" + }, + "importInformation": { + "description": "List of the certificates and private key pairs to import", + "items": { + "$ref": "#/components/schemas/CertificateImportInformation" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "edgeInstanceId", + "encryptionKeyId", + "importInformation" + ], + "type": "object" + }, + "CertificateImportResponse1": { + "properties": { + "certificateInformations": { + "description": "A collection of information about certificates that were newly imported.", + "items": { + "$ref": "#/components/schemas/ImportedCertificateInformation" + }, + "type": "array" + }, + "statistics": { + "additionalProperties": { + "description": "Certificate import statistics", + "format": "int32", + "type": "integer" + }, + "description": "Certificate import statistics", + "type": "object" + } + }, + "type": "object" + }, + "CertificateImportResponse2": { + "properties": { + "creationDate": { + "description": "Import creation date of certificates and private keys", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "Import id used to check the status of the bulk operation", + "type": "string" + } + }, + "type": "object" + }, + "CertificateImportStatusDetail": { + "description": "Status detail information for each certificate and private key imported related to the import id", + "properties": { + "certificateBytes": { + "description": "Bytes of the imported certificate", + "format": "byte", + "type": "string" + }, + "fingerprint": { + "description": "Unique identifier for the imported certificate", + "type": "string" + }, + "reason": { + "description": "Reason for the status result", + "type": "string" + }, + "status": { + "description": "Result status for the import", + "enum": [ + "IMPORTED", + "FAILED", + "SKIPPED", + "PROCESSING" + ], + "type": "string" + } + }, + "type": "object" + }, + "CertificateImportStatusDetailResponse": { + "properties": { + "id": { + "description": "Import id", + "format": "uuid", + "type": "string" + }, + "results": { + "description": "Status detail information for each certificate and private key imported related to the import id", + "items": { + "$ref": "#/components/schemas/CertificateImportStatusDetail" + }, + "type": "array" + }, + "status": { + "description": "Status of bulk import", + "enum": [ + "PROCESSING", + "COMPLETED", + "WAITING", + "FAILED" + ], + "type": "string" + } + }, + "type": "object" + }, + "CertificateInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "561baf7c-98b7-49af-ab9c-7b3a9fea3028", + "4adeba6f-0c94-4595-a5b6-babea458249f" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "archivedDate": { + "description": "The date a certificate was archived", + "example": "2022-05-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "authorityKeyIdentifierHash": { + "description": "An authority key identifier hash", + "example": "40572B10F85DDAF18BFF987372178532AB875BCA", + "type": "string" + }, + "certificateAuthorityAccountId": { + "description": "UUID of a certificate authority account", + "format": "uuid", + "type": "string" + }, + "certificateName": { + "description": "A certificate name", + "example": "venafi.com", + "type": "string" + }, + "certificateRequestId": { + "description": "UUID of a certificate request", + "example": "2e8964a0-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "certificateStatus": { + "description": "Certificate's status", + "enum": [ + "ACTIVE", + "RETIRED", + "DELETED" + ], + "example": "ACTIVE", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "dekHash": { + "description": "A certificate dek hash", + "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", + "type": "string" + }, + "encryptionType": { + "description": "A certificate encryption type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "EC", + "type": "string" + }, + "extendedKeyUsage": { + "description": "A collection of certificate extended key usages", + "example": [ + "1.3.6.1.5.5.7.3.2", + "1.3.6.1.5.5.7.3.1" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "fingerprint": { + "description": "A certificate fingerprint", + "example": "6D4C95512C117B004191F1A096ECAD13242FCD9F", + "type": "string" + }, + "id": { + "description": "UUID of a certificate", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "inhibitAnyPolicy": { + "description": "Inhibit any policy", + "example": 150, + "format": "int32", + "type": "integer" + }, + "inhibitPolicyMapping": { + "description": "Inhibit policy mapping", + "example": 200, + "format": "int32", + "type": "integer" + }, + "instances": { + "description": "A collection of certificate instances information", + "example": [ + { + "certificateId": "7ec12010-9051-11ed-8e50-b994b27d2ece", + "certificateInstanceId": "7ec1bc50-9051-11ed-8e50-b994b27d2ece", + "certificateSource": "USER_SCAN", + "deploymentStatus": "IN_USE", + "hostname": "venafi.com", + "instanceChainValidationStatus": [ + "OK" + ], + "ipAddress": "23.185.0.2", + "lastScanDate": "2023-01-09T19:12:05.314+00:00", + "lastValidatedAttempt": "2023-01-09T19:12:05.446+00:00", + "modificationDate": "2023-01-09T19:12:14.865+00:00", + "port": 443, + "serviceIds": [ + "1d61e9e0-9046-11ed-bf12-53a1b041cf25" + ], + "sslProtocols": [ + "TLSv1.3", + "TLSv1.2" + ], + "sslValidationErrorArguments": [], + "sslValidationStatus": "OK" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateInstanceInformation" + }, + "type": "array" + }, + "issuerAlternativeNameDns": { + "description": "A collection of certificate issuer alternative names DNs", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerAlternativeNameNonDns": { + "description": "A collection of certificate issuer alternative name none DNs", + "example": [ + "venafi issuer doman" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerC": { + "description": "A certificate issues Country", + "example": "US", + "type": "string" + }, + "issuerCN": { + "description": "A collection of certificate issuer Common names", + "example": [ + "HydrantID SSL CA G3" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerCertificateIds": { + "description": "A collection of issuer certificate IDs", + "example": [ + "2e8964a0-9046-11ed-8e50-b994b27d2ece", + "d5b418a0-297e-11eb-bc4c-8b24e5a66fb6" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "issuerDN": { + "description": "A certificate issue DN", + "example": "cn=HydrantID SSL CA G3,o=HydrantID (Avalanche Cloud Corporation),c=US", + "type": "string" + }, + "issuerL": { + "description": "A certificate issues Locality", + "example": "Salt Lake City", + "type": "string" + }, + "issuerOU": { + "description": "A collection of certificate issuer Organization units", + "example": [ + "Issuer CA" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerST": { + "description": "A certificate issuer State", + "example": "Utah", + "type": "string" + }, + "keyCurve": { + "description": "A certificate key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P256", + "type": "string" + }, + "keyStrength": { + "description": "A certificate key strength", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyUsage": { + "description": "A collection of certificate key usages", + "example": [ + "digitalSignature", + "keyEncipherment" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "lastNotification": { + "format": "int32", + "type": "integer" + }, + "managedCertificateId": { + "description": "UUID of a managed certificate", + "example": "2f0e7320-9046-11ed-8ab8-19e0a618d9cd", + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "description": "The last date a certificate was modified", + "example": "2022-03-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "ocspNoCheck": { + "description": "If a certificate no ocsp check", + "example": false, + "type": "boolean" + }, + "ownership": { + "$ref": "#/components/schemas/CertificateOwnership" + }, + "pathLength": { + "description": "A certificate path length", + "example": 3, + "format": "int32", + "type": "integer" + }, + "requireExplicitPolicy": { + "description": "Required explicit policy is required", + "example": 1, + "format": "int32", + "type": "integer" + }, + "selfSigned": { + "description": "If the certificate is self singed", + "example": true, + "type": "boolean" + }, + "serialNumber": { + "description": "A certificate serial number", + "example": "0C51A562B02A19A222FFB4730C47A8E2", + "type": "string" + }, + "signatureAlgorithm": { + "description": "A certificate signature algorithm", + "enum": [ + "MD2_WITH_RSA_ENCRYPTION", + "MD5_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION2", + "SHA256_WITH_RSA_ENCRYPTION", + "SHA384_WITH_RSA_ENCRYPTION", + "SHA512_WITH_RSA_ENCRYPTION", + "ID_DSA_WITH_SHA1", + "dsaWithSHA1", + "EC_DSA_WITH_SHA1", + "EC_DSA_WITH_SHA224", + "EC_DSA_WITH_SHA256", + "EC_DSA_WITH_SHA384", + "EC_DSA_WITH_SHA512", + "UNKNOWN", + "SHA1_WITH_RSAandMGF1", + "GOST_R3411_94_WITH_GOST_R3410_2001", + "GOST_R3411_94_WITH_GOST_R3410_94" + ], + "example": "SHA256_WITH_RSA_ENCRYPTION", + "type": "string" + }, + "signatureHashAlgorithm": { + "description": "A certificate signature hash algorithm", + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "example": "SHA256", + "type": "string" + }, + "statusModificationDate": { + "description": "The date a certificate's status was modified", + "example": "2022-04-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "statusModificationUserId": { + "description": "UUID of the user that modified the certificate installation", + "example": "3c9964a0-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "subjectAlternativeNameDns": { + "description": "A collection of certificate subject alternative names DNs", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectAlternativeNameNonDns": { + "description": "A collection of certificate subject alternative name none DNs", + "example": [ + "venafi domain" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData1" + }, + "subjectC": { + "description": "A certificate subject Country", + "example": "US", + "type": "string" + }, + "subjectCN": { + "description": "A collection of certificate subject CNs", + "example": [ + "venafi.com", + "cloud.venafi" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectDN": { + "description": "A certificate subject DN", + "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "subjectKeyIdentifierHash": { + "description": "A subject key identifier hash", + "example": "4E0CE93D3240561F468C33A85F08FCD3B04CC9DC", + "type": "string" + }, + "subjectL": { + "description": "A certificate subject Locality", + "example": "Salt Lake City", + "type": "string" + }, + "subjectO": { + "description": "A certificate subject Organization", + "example": "Venafi, Inc.", + "type": "string" + }, + "subjectOU": { + "description": "A collection of certificate subject Organization units", + "example": [ + "devops", + "test" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectST": { + "description": "A certificate subject State", + "example": "Utah", + "type": "string" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "owner:test.user", + "90-day" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "totalActiveInstanceCount": { + "description": "total active instances of a certificate", + "example": 50, + "format": "int32", + "type": "integer" + }, + "totalInstanceCount": { + "description": "total instances of a certificate", + "example": 100, + "format": "int32", + "type": "integer" + }, + "validityEnd": { + "description": "The date a certificate validity ends", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "validityStart": { + "description": "The date a certificate validity starts", + "example": "2022-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "versionType": { + "description": "A certificate version type", + "enum": [ + "OLD", + "CURRENT" + ], + "example": "CURRENT", + "type": "string" + } + }, + "type": "object" + }, + "CertificateInstanceInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "d3cce873-6957-4071-a65e-7676c0ae1123", + "322bcd99-286a-47ea-8dcd-8291ec5bff14" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificateId": { + "description": "UUID of a certificate", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "certificateInstanceId": { + "description": "UUID of a certificate instance", + "example": "f68daf30-4690-45bc-85b3-bb327024735e", + "format": "uuid", + "type": "string" + }, + "certificateSource": { + "description": "Certificate source", + "enum": [ + "UNKNOWN", + "USER_PROVIDED", + "USER_IMPORTED", + "USER_SCAN", + "TRUSTNET_SCAN", + "ON_PREM_CA_IMPORT", + "EXTERNAL_CA_IMPORT", + "FILE_IMPORT", + "EXTERNAL_SCAN", + "DOMAIN_SCAN", + "SMART_SCAN_INTERNAL", + "SMART_SCAN_EXTERNAL", + "SMART_VALIDATION_INTERNAL", + "SMART_VALIDATION_EXTERNAL", + "MACHINE_DISCOVERY", + "KUBERNETES_DISCOVERY", + "AWS_DISCOVERY", + "AZURE_DISCOVERY", + "GCP_DISCOVERY" + ], + "example": "USER_SCAN", + "type": "string" + }, + "deploymentStatus": { + "description": "The deployment status", + "enum": [ + "UNKNOWN", + "IN_USE", + "SUPERSEDED" + ], + "example": "IN_USE", + "type": "string" + }, + "hostname": { + "description": "A hostname", + "example": "venafi.com", + "type": "string" + }, + "instanceChainValidationStatus": { + "description": "A collection of the instance chain validation status", + "example": [ + "OK" + ], + "items": { + "enum": [ + "OK", + "CHAIN_BUILDING_FAILED", + "INCOMPLETE_CHAIN", + "CHAIN_EXPIRE_BEFORE_EE", + "DISTRUSTED", + "UNKNOWN_ERROR", + "SELF_SIGNED" + ], + "type": "string" + }, + "type": "array" + }, + "ipAddress": { + "description": "An ip address", + "example": "14.183.1.32", + "type": "string" + }, + "lastScanDate": { + "description": "The last scan date", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "lastValidatedAttempt": { + "description": "The last validation attempt date", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "modificationDate": { + "description": "The last modification date", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "port": { + "description": "A port number", + "example": 443, + "format": "int32", + "type": "integer" + }, + "serviceIds": { + "description": "A collection of service IDs", + "example": [ + "1d61e9e0-9046-11ed-bf12-53a1b041cf2" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "sslProtocols": { + "description": "A collection of ssl protocols", + "example": [ + "TLSv1.1", + "TLSv1.2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sslValidationErrorArguments": { + "description": "A collection of ssl validation error arguments", + "example": [ + "B69950CC5F51EDDF55F36AD2BC898767BC43CC2A", + "24E5796GA7298E78EDE47D6FAED0790E8F464G54" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sslValidationStatus": { + "description": "SSL validation status", + "enum": [ + "HOSTNAME_NOT_RESOLVABLE", + "NO_CERTIFICATE_PRESENTED", + "INVALID_CERTIFICATE_FOUND", + "UNEXPECTED_CERTIFICATE_FOUND", + "OLD_VERSION_CERTIFICATE_FOUND", + "TARGET_UNREACHABLE", + "UNKNOWN_ERROR", + "OK" + ], + "example": "OK", + "type": "string" + }, + "sslValidationStatusMessage": { + "description": "SSL validation status message", + "example": "Certificate installation is using older versions of certificate", + "type": "string" + } + }, + "type": "object" + }, + "CertificateInstanceValidationRequest": { + "properties": { + "instanceIds": { + "description": "Unique certificate instance id(s) containing numbers, letters and dashes.", + "example": [ + "7860eedb-c140-4354-b0ad-991cc7a7b4d1", + "0b0f6424-30bc-4ed8-ae83-cdeca3eaf60e" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "instanceIds" + ], + "type": "object" + }, + "CertificateIssuingTemplateInformation1": { + "properties": { + "certificateAuthority": { + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP", + "CONNECTOR" + ], + "type": "string" + }, + "certificateAuthorityAccountId": { + "format": "uuid", + "type": "string" + }, + "certificateAuthorityProductOptionId": { + "format": "uuid", + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "csrUploadAllowed": { + "type": "boolean" + }, + "everyoneIsConsumer": { + "type": "boolean" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "keyGeneratedByVenafiAllowed": { + "type": "boolean" + }, + "keyReuse": { + "type": "boolean" + }, + "keyTypes": { + "items": { + "$ref": "#/components/schemas/KeyTypeInformation1" + }, + "type": "array" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "priority": { + "format": "int32", + "type": "integer" + }, + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation1" + }, + "productEntitlement": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + }, + "productEntitlements": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string", + "writeOnly": true + }, + "reason": { + "type": "string" + }, + "recommendedSettings": { + "$ref": "#/components/schemas/RecommendedSettingsInformation1" + }, + "resourceConsumerTeamIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "resourceConsumerUserIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "sanDnsNameRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanIpAddressRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanRfc822NameRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanUniformResourceIdentifierRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "enum": [ + "AVAILABLE", + "UNAVAILABLE" + ], + "type": "string" + }, + "subjectCNRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectLRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectORegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectOURegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectSTRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "systemGenerated": { + "type": "boolean" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "type": "object" + }, + "CertificateIssuingTemplateInformation2": { + "properties": { + "certificateAuthority": { + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP", + "CONNECTOR" + ], + "type": "string" + }, + "certificateAuthorityAccountId": { + "format": "uuid", + "type": "string" + }, + "certificateAuthorityProductOptionId": { + "format": "uuid", + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "csrUploadAllowed": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "driverGeneratedCsr": { + "type": "boolean" + }, + "driverId": { + "format": "uuid", + "type": "string" + }, + "everyoneIsConsumer": { + "type": "boolean" + }, + "extendedKeyUsageValues": { + "items": { + "enum": [ + "SERVER", + "CLIENT" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "id": { + "format": "uuid", + "type": "string" + }, + "keyGeneratedByVenafiAllowed": { + "type": "boolean" + }, + "keyPairId": { + "format": "uuid", + "type": "string" + }, + "keyReuse": { + "type": "boolean" + }, + "keyTypes": { + "items": { + "$ref": "#/components/schemas/KeyTypeInformation2" + }, + "type": "array" + }, + "locationId": { + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "priority": { + "format": "int32", + "type": "integer" + }, + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" + }, + "reason": { + "type": "string" + }, + "recommendedSettings": { + "$ref": "#/components/schemas/RecommendedSettingsInformation2" + }, + "referencingApplicationIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "resourceConsumerTeamIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "resourceConsumerUserIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "sanDnsNameRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanIpAddressRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanRfc822NameRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanUniformResourceIdentifierRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "status": { + "enum": [ + "AVAILABLE", + "UNAVAILABLE" + ], + "type": "string" + }, + "subjectCNRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectLRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectORegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectOURegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectSTRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "systemGenerated": { + "type": "boolean" + }, + "trackingData": { + "$ref": "#/components/schemas/TrackingDataInformation" + } + }, + "type": "object" + }, + "CertificateIssuingTemplateRequest": { + "properties": { + "certificateAuthority": { + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP", + "CONNECTOR" + ], + "type": "string" + }, + "certificateAuthorityProductOptionId": { + "format": "uuid", + "type": "string" + }, + "csrUploadAllowed": { + "type": "boolean" + }, + "description": { + "maxLength": 1024, + "type": "string" + }, + "driverGeneratedCsr": { + "type": "boolean" + }, + "driverId": { + "format": "uuid", + "type": "string" + }, + "everyoneIsConsumer": { + "type": "boolean" + }, + "extendedKeyUsageValues": { + "items": { + "enum": [ + "SERVER", + "CLIENT" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "keyGeneratedByVenafiAllowed": { + "type": "boolean" + }, + "keyPairId": { + "format": "uuid", + "type": "string" + }, + "keyReuse": { + "type": "boolean" + }, + "keyTypes": { + "items": { + "$ref": "#/components/schemas/KeyTypeParameters2" + }, + "type": "array" + }, + "locationId": { + "format": "uuid", + "type": "string" + }, + "name": { + "maxLength": 64, + "type": "string" + }, + "priority": { + "format": "int32", + "type": "integer" + }, + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" + }, + "recommendedSettings": { + "$ref": "#/components/schemas/RecommendedSettingsRequest" + }, + "resourceConsumerTeamIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "resourceConsumerUserIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "sanIpAddressRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanRfc822NameRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sanUniformResourceIdentifierRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCNRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectLRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectORegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectOURegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectSTRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "trackingData": { + "$ref": "#/components/schemas/TrackingDataInformation" + } + }, + "required": [ + "certificateAuthority", + "certificateAuthorityProductOptionId", + "keyReuse", + "keyTypes", + "name", + "product" + ], + "type": "object" + }, + "CertificateIssuingTemplateResponse": { + "properties": { + "certificateIssuingTemplates": { + "items": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" + }, + "type": "array" + } + }, + "type": "object" + }, + "CertificateOwnership": { + "properties": { + "owningContainers": { + "items": { + "$ref": "#/components/schemas/ExtendedApplicationOwnership" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "CertificateRecoveryRequest": { + "properties": { + "applicationIds": { + "description": "Unique application id(s) containing numbers, letters and dashes.", + "example": [ + "47c9d920-da21-11ed-a63c-d508f08eeaa0", + "9303e940-df9d-11ed-8850-f18176fc5513" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificateIds": { + "description": "Unique certificate id(s) containing numbers, letters and dashes.", + "example": [ + "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", + "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "certificateIds" + ], + "type": "object" + }, + "CertificateRequestApprovalConditionsFilterRuleInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application ids the rule will be applicable to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificateAuthorityAccountIds": { + "description": "A collection of certificate authority account ids the rule will be applicable to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificateIssuingTemplateIds": { + "description": "A collection of certificate issuing template ids the rule will be applicable to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CertificateRequestApprovalExceptionsFilterRuleInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application ids the rule won't be applied to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "requestors": { + "description": "A collection of approvers, specified by type and id, for which the rule won't be applied", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "CertificateRequestApprovalRuleDeleteResponseOpenApi": { + "properties": { + "id": { + "description": "Approval rule `id`", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRequestApprovalRuleOpenApi": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "type": "array", + "uniqueItems": true + }, + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "format": "int32", + "type": "integer" + }, + "autoApproveOnRenew": { + "default": false, + "description": "Automatically approve when renew a certificate", + "type": "boolean" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" + }, + "creationDate": { + "description": "The date a approval rule was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "$ref": "#/components/schemas/ApproverPropertyOpenApi" + }, + "id": { + "description": "Approval rule `id`", + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "description": "The date a approval rule was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "type": "string" + }, + "priority": { + "description": "Priority of the rule", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of the approval rule", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRequestApprovalRulesRequest": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "example": 2, + "format": "int32", + "minimum": 1, + "type": "integer" + }, + "autoApproveOnRenew": { + "default": false, + "description": "Automatically approve when renew a certificate", + "type": "boolean" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" + }, + "continueProcessingOnException": { + "default": false, + "description": "Continue with next approval rules when match an approval rule exception condition", + "type": "boolean" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "description": "UUID of the final approver", + "example": "8268d820-a08d-11ed-bbc0-252385d6d390", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "example": "Approval rule for built in CA", + "maxLength": 64, + "type": "string" + }, + "type": { + "description": "The type of the approval rule", + "enum": [ + "ALL", + "AT_LEAST" + ], + "example": "AT_LEAST", + "type": "string" + } + }, + "required": [ + "approvers", + "conditions", + "name", + "type" + ], + "type": "object" + }, + "CertificateRequestApprovalRulesResponseOpenApi": { + "properties": { + "approvalRules": { + "items": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + }, + "type": "array" + } + }, + "type": "object" + }, + "CertificateRequestApprovalRulesUpdateRequest": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "example": 2, + "format": "int32", + "minimum": 1, + "type": "integer" + }, + "autoApproveOnRenew": { + "default": false, + "description": "Automatically approve when renew a certificate", + "type": "boolean" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" + }, + "continueProcessingOnException": { + "default": false, + "description": "Continue with next approval rules when match an approval rule exception condition", + "type": "boolean" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "description": "UUID of the final approver", + "example": "8268d820-a08d-11ed-bbc0-252385d6d390", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "example": "Approval rule for built in CA", + "maxLength": 64, + "type": "string" + }, + "priority": { + "description": "Rule priority. The order in which the rules will be executed. Starts from 1 (highest priority).", + "example": 5, + "minimum": 1, + "type": "number" + }, + "type": { + "description": "The type of the approval rule", + "enum": [ + "ALL", + "AT_LEAST" + ], + "example": "AT_LEAST", + "type": "string" + } + }, + "required": [ + "approvers", + "conditions", + "name", + "type" + ], + "type": "object" + }, + "CertificateRequestDocumentInformation": { + "properties": { + "applicationId": { + "description": "UUID of an application ID", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" + }, + "approvedIds": { + "description": "A collection of IDs of all users that have already approved", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "approverTeamIds": { + "description": "A collection of all team IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "approverUserIds": { + "description": "A collection of all user IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "caOrderId": { + "description": "A CA order ID", + "example": "63364861", + "type": "string" + }, + "certificateIds": { + "description": "A collection of certificate ids", + "example": [ + "1441c6f0-9136-11ed-bd65-ed926a033704", + "12257370-9132-11ed-bd65-ed926a033704" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificateIssuingTemplateId": { + "description": "UUID of certificate issuing template", + "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "UUID of the certificate request's owner", + "example": "88932c30-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date a certificate request was created", + "example": "2022-01-20T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "customAttributes": { + "$ref": "#/components/schemas/CustomAttributes1" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation4" + }, + "finalApproverId": { + "description": "UUID of the final approver if configured", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "UUID of a certificate request", + "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "keyCurve": { + "description": "Certificate request key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P521", + "type": "string" + }, + "keyLength": { + "description": "Certificate request key length", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyType": { + "description": "Certificate request key type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "RSA", + "type": "string" + }, + "modificationDate": { + "description": "The date a certificate request was modified", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The status of the certificate request", + "enum": [ + "NEW", + "PENDING", + "PENDING_APPROVAL", + "PENDING_FINAL_APPROVAL", + "REJECTED_APPROVAL", + "REQUESTED", + "ISSUED", + "REJECTED", + "CANCELLED", + "REVOKED", + "FAILED", + "DELETED" + ], + "example": "ISSUED", + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData1" + }, + "subjectCN": { + "description": "Certificate request subject CN", + "example": "venafi.com", + "type": "string" + }, + "subjectDN": { + "description": "Certificate request subject DN", + "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "test", + "category:security" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRequestDocumentResponse": { + "properties": { + "certificateRequests": { + "description": "A collection of certificate request information", + "example": [ + { + "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", + "caOrderId": "3a:5f:7e:9f:8c:e4:b6:f7:25:a7:81:0d:f0:ac:28:ec:fe:05:9b:30", + "certificateIds": [ + "a27dfc10-c357-11ed-946f-7db55f9ae03e", + "a275beb0-c357-11ed-946f-7db55f9ae03e", + "a24c16a0-c357-11ed-946f-7db55f9ae03e" + ], + "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", + "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", + "companyId": "98996d90-b797-11ed-a508-c13aa0641666", + "creationDate": "2023-03-15T17:34:26.466+00:00", + "id": "a1c0c690-c357-11ed-a00c-e3953fcf04eb", + "keyLength": 4096, + "keyType": "RSA", + "modificationDate": "2023-03-15T17:34:27.479+00:00", + "status": "ISSUED", + "subjectAlternativeNamesByType": { + "dNSName": [ + "localhost" + ] + }, + "subjectCN": "localhost", + "subjectDN": "cn=localhost,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", + "validityPeriod": "P10D" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateRequestDocumentInformation" + }, + "type": "array" + }, + "numFound": { + "description": "The number of certificate requests that were found", + "example": 10, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CertificateRequestInformation1": { + "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" + }, + "applicationId": { + "description": "UUID of an application ID", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" + }, + "approvedIds": { + "description": "A collection of IDs of all users that have already approved", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "approverTeamIds": { + "description": "A collection of all team IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "approverUserIds": { + "description": "A collection of all user IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "caOrderId": { + "description": "A CA order ID", + "example": "63364861", + "type": "string" + }, + "certificateIds": { + "description": "A collection of certificate IDs", + "example": [ + "1441c6f0-9136-11ed-bd65-ed926a033704", + "12257370-9132-11ed-bd65-ed926a033704" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificateIssuingTemplateId": { + "description": "UUID of a certificate issuing template", + "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "UUID of the certificate request's owner", + "example": "88932c30-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "certificateSigningRequest": { + "description": "A certificate signing request (CSR) in PEM format", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" + }, + "type": "array" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date a certificate request was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "customAttributesInformation": { + "$ref": "#/components/schemas/CustomAttributesInformation" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation4" + }, + "finalApproverId": { + "description": "UUID of the final approver if configured", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "UUID of a certificate request", + "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "keyCurve": { + "description": "Certificate request key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P521", + "type": "string" + }, + "keyLength": { + "description": "Certificate request key length", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyType": { + "description": "Certificate request key type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "RSA", + "type": "string" + }, + "modificationDate": { + "description": "The date a certificate request was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The status of a certificate request", + "enum": [ + "NEW", + "PENDING", + "PENDING_APPROVAL", + "PENDING_FINAL_APPROVAL", + "REJECTED_APPROVAL", + "REQUESTED", + "ISSUED", + "REJECTED", + "CANCELLED", + "REVOKED", + "FAILED", + "DELETED" + ], + "example": "ISSUED", + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData1" + }, + "subjectDN": { + "description": "Certificate request subject DN", + "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "test", + "category:security" + ], + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRequestInformation2": { + "properties": { + "caOrderId": { + "description": "A CA order ID", + "example": "63364861", + "type": "string" + }, + "certificateIds": { + "description": "A collection of certificate IDs", + "example": [ + "1441c6f0-9136-11ed-bd65-ed926a033704", + "12257370-9132-11ed-bd65-ed926a033704" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificateIssuingTemplateId": { + "description": "UUID of a certificate issuing template", + "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "certificateName": { + "description": "A certificate name", + "example": "venafi.com", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "UUID of the certificate request's owner", + "example": "88932c30-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "certificateSigningRequest": { + "description": "A certificate signing request (CSR) in PEM format", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date a certificate request was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "customAttributes": { + "$ref": "#/components/schemas/CustomAttributes2" + }, + "dekHash": { + "description": "A certificate dek hash", + "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", + "type": "string" + }, + "encryptedPrivateKey": { + "format": "byte", + "type": "string" + }, + "encryptionDetails": { + "$ref": "#/components/schemas/EncryptionDetails" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation9" + }, + "id": { + "description": "UUID of a certificate request", + "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "keyCurve": { + "description": "Certificate request key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P521", + "type": "string" + }, + "keyLength": { + "description": "Certificate request key length", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyType": { + "description": "Certificate request key type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "RSA", + "type": "string" + }, + "modificationDate": { + "description": "The date a certificate request was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" + }, + "productEntitlement": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + }, + "status": { + "description": "The status of a certificate request", + "enum": [ + "NEW", + "PENDING", + "PENDING_APPROVAL", + "PENDING_FINAL_APPROVAL", + "REJECTED_APPROVAL", + "REQUESTED", + "ISSUED", + "REJECTED", + "CANCELLED", + "REVOKED", + "FAILED", + "DELETED" + ], + "example": "ISSUED", + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData2" + }, + "subjectDN": { + "description": "Certificate request subject DN", + "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRequestRequest": { + "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" + }, + "applicationId": { + "description": "Application UUID", + "example": "b00701b0-886f-11ed-9f39-3d586ab80cf2", + "format": "uuid", + "type": "string" + }, + "certificateIssuingTemplateId": { + "description": "Certificate issuing template UUID", + "example": "a305d810-886f-11ed-9ccf-0dbf748eb1ae", + "format": "uuid", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "Certificate owner UUID", + "example": "a305d810-886f-11ed-9ccf-0dbf748eb1ae", + "format": "uuid", + "type": "string" + }, + "certificateSigningRequest": { + "description": "A certificate signing request(CSR) in PEM format. Required when reuseCSR and isVaaSGenerated are set to false.", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" + }, + "type": "array" + }, + "csrAttributes": { + "$ref": "#/components/schemas/CSRAttributesInformation" + }, + "customAttributes": { + "$ref": "#/components/schemas/CustomAttributesInformation" + }, + "existingCertificateId": { + "description": "Existing certificate UUID. Required when reuseCSR is set to true.", + "example": "b505d810-886f-11ed-9ccf-0dbf748eb1ae", + "format": "uuid", + "type": "string" + }, + "isVaaSGenerated": { + "description": "Specify whether VaaS should generate the request.", + "example": true, + "type": "boolean" + }, + "reuseCSR": { + "description": "Specifies whether an existing CSR is reused", + "example": true, + "type": "boolean" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "test", + "category:security" + ], + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" + } + }, + "required": [ + "applicationId", + "certificateIssuingTemplateId", + "isVaaSGenerated" + ], + "type": "object" + }, + "CertificateRequestResponse": { + "properties": { + "certificateRequests": { + "description": "A collection of certificate information", + "example": [ + { + "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", + "caOrderId": "3a:5f:7e:9f:8c:e4:b6:f7:25:a7:81:0d:f0:ac:28:ec:fe:05:9b:30", + "certificateIds": [ + "a27dfc10-c357-11ed-946f-7db55f9ae03e", + "a275beb0-c357-11ed-946f-7db55f9ae03e", + "a24c16a0-c357-11ed-946f-7db55f9ae03e" + ], + "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", + "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", + "companyId": "98996d90-b797-11ed-a508-c13aa0641666", + "creationDate": "2023-03-15T17:34:26.466+00:00", + "id": "a1c0c690-c357-11ed-a00c-e3953fcf04eb", + "keyLength": 4096, + "keyType": "RSA", + "modificationDate": "2023-03-15T17:34:27.479+00:00", + "status": "ISSUED", + "subjectAlternativeNamesByType": { + "dNSName": [ + "localhost" + ] + }, + "subjectCN": "localhost", + "subjectDN": "cn=localhost,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", + "validityPeriod": "P10D" + }, + { + "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", + "caOrderId": "6f:b7:27:c8:2c:bd:1a:b0:6f:43:fb:8a:6b:5b:a3:a6:c2:52:38:85", + "certificateIds": [ + "b767aef0-c357-11ed-946f-7db55f9ae03e", + "a275beb0-c357-11ed-946f-7db55f9ae03e", + "a24c16a0-c357-11ed-946f-7db55f9ae03e" + ], + "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", + "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", + "companyId": "98996d90-b797-11ed-a508-c13aa0641666", + "creationDate": "2023-03-15T17:35:02.384+00:00", + "id": "b7502f50-c357-11ed-a00c-e3953fcf04eb", + "keyLength": 4096, + "keyType": "RSA", + "modificationDate": "2023-03-15T17:35:02.544+00:00", + "status": "ISSUED", + "subjectAlternativeNamesByType": { + "dNSName": [ + "venafi.com" + ] + }, + "subjectCN": "venafi.com", + "subjectDN": "cn=venafi.com,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", + "validityPeriod": "P12D" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateRequestInformation1" + }, + "type": "array" + } + }, + "type": "object" + }, + "CertificateRequestResubmissionRequest": { + "properties": { + "certificateIssuingTemplateId": { + "description": "Certificate issuing template UUID", + "example": "a305d810-886f-11ed-9ccf-dbf748eb1ae0", + "format": "uuid", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "Certificate owner UUID", + "example": "a305d810-886f-11ed-4bbe-dbf748eb1ae0", + "format": "uuid", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" + }, + "type": "array" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" + } + }, + "type": "object" + }, + "CertificateResponse": { + "properties": { + "certificates": { + "description": "A collection of certificates", + "items": { + "$ref": "#/components/schemas/CertificateInformation" + }, + "type": "array" + }, + "count": { + "description": "The number of certificates.", + "example": 2, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CertificateRetirementRequest": { + "properties": { + "addToBlocklist": { + "description": "This parameter ensures the deleted certificate will not be discovered again.", + "example": true, + "type": "boolean" + }, + "certificateIds": { + "description": "Unique certificate id(s) containing numbers, letters and dashes.", + "example": [ + "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", + "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "certificateIds" + ], + "type": "object" + }, + "CertificateRevocationApprovalConditionsFilterRuleInformation": { + "properties": { + "certificateAuthorityAccountIds": { + "description": "A collection of certificate authority account ids the rule will be applicable to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "certificateAuthorityAccountIds" + ], + "type": "object" + }, + "CertificateRevocationApprovalExceptionsFilterRuleInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application ids the rule won't be applied to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "requestors": { + "description": "A collection of approvers, specified by type and id, for which the rule won't be applied", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "CertificateRevocationApprovalRuleDeleteResponseOpenApi": { + "properties": { + "id": { + "description": "Approval rule `id`", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRevocationApprovalRuleOpenApi": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "type": "array", + "uniqueItems": true + }, + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "format": "int32", + "type": "integer" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since revoke request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" + }, + "creationDate": { + "description": "The date a approval rule was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "$ref": "#/components/schemas/ApproverPropertyOpenApi" + }, + "id": { + "description": "Approval rule `id`", + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "description": "The date a approval rule was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "type": "string" + }, + "priority": { + "description": "Priority of the rule", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of the approval rule", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRevocationApprovalRulesRequest": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "example": 2, + "format": "int32", + "minimum": 1, + "type": "integer" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since revocation request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" + }, + "continueProcessingOnException": { + "default": false, + "description": "Continue with next approval rules when match an approval rule exception condition", + "type": "boolean" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "description": "UUID of the final approver", + "example": "8268d820-a08d-11ed-bbc0-252385d6d390", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "example": "Approval rule for built in CA", + "maxLength": 64, + "type": "string" + }, + "type": { + "description": "The type of the approval rule", + "enum": [ + "ALL", + "AT_LEAST" + ], + "example": "AT_LEAST", + "type": "string" + } + }, + "required": [ + "approvers", + "conditions", + "name", + "type" + ], + "type": "object" + }, + "CertificateRevocationApprovalRulesResponseOpenApi": { + "properties": { + "approvalRules": { + "items": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" + }, + "type": "array" + } + }, + "type": "object" + }, + "CertificateRevocationApprovalRulesUpdateRequest": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "example": 2, + "format": "int32", + "minimum": 1, + "type": "integer" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since revocation request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" + }, + "continueProcessingOnException": { + "default": false, + "description": "Continue with next approval rules when match an approval rule exception condition", + "type": "boolean" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "description": "UUID of the final approver", + "example": "8268d820-a08d-11ed-bbc0-252385d6d390", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "example": "Approval rule for built in CA", + "maxLength": 64, + "type": "string" + }, + "priority": { + "description": "Rule priority. The order in which the rules will be executed. Starts from 1 (highest priority).", + "example": 5, + "minimum": 1, + "type": "number" + }, + "type": { + "description": "The type of the approval rule", + "enum": [ + "ALL", + "AT_LEAST" + ], + "example": "AT_LEAST", + "type": "string" + } + }, + "required": [ + "approvers", + "conditions", + "name", + "type" + ], + "type": "object" + }, + "CertificateUsageMetadata": { + "properties": { + "appName": { + "type": "string" + }, + "automationMetadata": { + "type": "string" + }, + "nodeName": { + "type": "string" + } + }, + "type": "object" + }, + "CertificateValidationRequest": { + "properties": { + "certificateIds": { + "description": "Unique certificate id(s) containing numbers, letters and dashes.", + "example": [ + "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", + "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "certificateIds" + ], + "type": "object" + }, + "CertificateValidationResponse": { + "properties": { + "fingerprints": { + "description": "A collection of certificate's fingerprints", + "example": [ + "2C85B0AD64F55AA70BAC75F69711578DC505C3F9", + "051ECFBD202B0383A7745F479F978C8E9FA9ADE1" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CertificationRequestInformation": { + "properties": { + "hashAlgorithm": { + "description": "A certificate request signature hash algorithm", + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "example": "SHA256", + "type": "string" + }, + "keyCurve": { + "description": "Certificate request key length", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P256", + "type": "string" + }, + "keyLength": { + "description": "Certificate request key length", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyType": { + "description": "Certificate request key type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "RSA", + "type": "string" + }, + "publicKeyHash": { + "description": "A certificate request public hash key", + "example": "0048AA1D7E2F0017F9CA2E687D8776A1A340553D", + "type": "string" + }, + "signatureAlgorithm": { + "description": "A certificate request signature algorithm", + "enum": [ + "MD2_WITH_RSA_ENCRYPTION", + "MD5_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION2", + "SHA256_WITH_RSA_ENCRYPTION", + "SHA384_WITH_RSA_ENCRYPTION", + "SHA512_WITH_RSA_ENCRYPTION", + "ID_DSA_WITH_SHA1", + "dsaWithSHA1", + "EC_DSA_WITH_SHA1", + "EC_DSA_WITH_SHA224", + "EC_DSA_WITH_SHA256", + "EC_DSA_WITH_SHA384", + "EC_DSA_WITH_SHA512", + "UNKNOWN", + "SHA1_WITH_RSAandMGF1", + "GOST_R3411_94_WITH_GOST_R3410_2001", + "GOST_R3411_94_WITH_GOST_R3410_94" + ], + "example": "SHA256_WITH_RSA_ENCRYPTION", + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData1" + }, + "subjectDN": { + "description": "A certificate request subject DN", + "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", + "type": "string" + } + }, + "type": "object" + }, + "Channel": { + "enum": [ + "email" + ], + "type": "string" + }, + "ChartDetails": { + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "ClientAuthenticationInformation": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ + { + "$ref": "#/components/schemas/JwtStandardClaimsAuthenticationInformation" + }, + { + "$ref": "#/components/schemas/JwtJwksAuthenticationInformation" + }, + { + "$ref": "#/components/schemas/JwtOidcAuthenticationInformation" + } + ], + "properties": { + "type": { + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "ClientAuthenticationOpenApi": { + "discriminator": { + "mapping": { + "JWT_JWKS": "#/components/schemas/JwtJwksAuthenticationOpenApi", + "JWT_OIDC": "#/components/schemas/JwtOidcAuthenticationOpenApi", + "JWT_STANDARD_CLAIMS": "#/components/schemas/JwtStandardClaimsAuthenticationOpenApi" + }, + "propertyName": "type" + }, + "properties": { + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ClientAuthenticationRequestOpenApi": { + "properties": { + "clientAuthentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/JwtStandardClaimsAuthenticationOpenApi" + }, + { + "$ref": "#/components/schemas/JwtJwksAuthenticationOpenApi" + }, + { + "$ref": "#/components/schemas/JwtOidcAuthenticationOpenApi" + } + ], + "type": "object" + } + }, + "type": "object" + }, + "ClientAuthorizationInformation": { + "properties": { + "customClaimsAliases": { + "$ref": "#/components/schemas/CustomClaimsAliasesInformation" + } + }, + "type": "object" + }, + "CloudProvidersInformation": { + "properties": { + "aws": { + "$ref": "#/components/schemas/AwsCloudProviderInformation" + }, + "azure": { + "$ref": "#/components/schemas/AzureCloudProviderInformation" + }, + "google": { + "$ref": "#/components/schemas/GoogleCloudProviderInformation" + } + }, + "type": "object" + }, + "CompanyId": { + "description": "The company ID", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "CompanyInformation": { + "properties": { + "active": { + "type": "boolean" + }, + "companyType": { + "$ref": "#/components/schemas/CompanyType" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "domains": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "instanceId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "productEntitlements": { + "items": { + "$ref": "#/components/schemas/ProductEntitlementInformation" + }, + "type": "array" + }, + "tsgId": { + "type": "string" + }, + "urlPrefix": { + "type": "string" + } + }, + "required": [ + "id", + "productEntitlements" + ], + "type": "object" + }, + "CompanyType": { + "enum": [ + "INTERNAL", + "CA", + "TPP_CUSTOMER", + "REGULAR", + "OTHER" + ], + "type": "string" + }, + "Condition": { + "description": "A Condition for filtering", + "properties": { + "field": { + "description": "Represents a field for filtering", + "example": "certificateName", + "type": "string" + }, + "operator": { + "description": "An operator for filtering", + "enum": [ + "EQ", + "LT", + "LTE", + "GT", + "GTE", + "MATCH", + "FIND", + "IN" + ], + "example": "EQ", + "type": "string" + }, + "value": { + "description": "represents a field's value", + "example": "venafi.com", + "type": "string" + }, + "values": { + "description": "represents a field's values", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ConfigurationCreateRequest": { + "properties": { + "advancedSettings": { + "$ref": "#/components/schemas/AdvancedSettingsInformation" + }, + "clientAuthentication": { + "$ref": "#/components/schemas/ClientAuthenticationInformation" + }, + "clientAuthorization": { + "$ref": "#/components/schemas/ClientAuthorizationInformation" + }, + "cloudProviders": { + "$ref": "#/components/schemas/CloudProvidersInformation" + }, + "minTlsVersion": { + "description": "Minimum required TLS protocol version", + "enum": [ + "TLS12", + "TLS13" + ], + "type": "string" + }, + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "maxLength": 64, + "type": "string" + }, + "policyIds": { + "description": "Array of UUIDs of policies to associate with the new configuration", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "serviceAccountIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "subCaProviderId": { + "description": "UUID of Sub CA provider to associate with the new configuration", + "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "policyIds", + "subCaProviderId" + ], + "type": "object" + }, + "ConfigurationDeleteResponse": { + "properties": { + "id": { + "description": "UUID of the configuration", + "example": "7268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "type": "string" + } + }, + "type": "object" + }, + "ConfigurationInformation": { + "properties": { + "advancedSettings": { + "$ref": "#/components/schemas/AdvancedSettingsInformation" + }, + "clientAuthentication": { + "$ref": "#/components/schemas/ClientAuthenticationInformation" + }, + "clientAuthorization": { + "$ref": "#/components/schemas/ClientAuthorizationInformation" + }, + "cloudProviders": { + "$ref": "#/components/schemas/CloudProvidersInformation" + }, + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "controllerAllowedPolicyIds": { + "description": "Array of UUIDs of policies that the kubernetes controller is permitted to use", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "creationDate": { + "description": "When the configuration was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "id": { + "description": "UUID of the configuration", + "example": "7268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "longLivedCertCount": { + "description": "Number of long lived certificates", + "example": 2, + "format": "int64", + "type": "integer" + }, + "minTlsVersion": { + "description": "Minimum required TLS protocol version", + "enum": [ + "TLS12", + "TLS13" + ], + "type": "string" + }, + "modificationDate": { + "description": "When the configuration was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" + }, + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "type": "string" + }, + "policyIds": { + "description": "Array of UUIDs of policies to associate with the configuration", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "serviceAccountIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "shortLivedCertCount": { + "description": "Number of short lived certificates", + "example": 20, + "format": "int64", + "type": "integer" + }, + "ultraShortLivedCertCount": { + "description": "Number of ultra short lived certificates", + "example": 200, + "format": "int64", + "type": "integer" + }, + "unixSocketAllowedPolicyIds": { + "description": "Array of UUIDs of policies that are permitted to be used when using the unix socket", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ConfigurationResponse": { + "properties": { + "configurations": { + "items": { + "$ref": "#/components/schemas/ExtendedConfigurationInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ConfigurationUpdateRequest": { + "properties": { + "advancedSettings": { + "$ref": "#/components/schemas/AdvancedSettingsInformation" + }, + "clientAuthentication": { + "$ref": "#/components/schemas/ClientAuthenticationRequestOpenApi" + }, + "clientAuthorization": { + "$ref": "#/components/schemas/ClientAuthorizationInformation" + }, + "cloudProviders": { + "$ref": "#/components/schemas/CloudProvidersInformation" + }, + "minTlsVersion": { + "description": "Minimum required TLS protocol version", + "enum": [ + "TLS12", + "TLS13" + ], + "type": "string" + }, + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "maxLength": 64, + "type": "string" + }, + "policyIds": { + "description": "Array of UUIDs of policies to associate with the configuration", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "serviceAccountIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "subCaProviderId": { + "description": "UUID of Sub CA provider to associate with the configuration", + "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "format": "uuid", + "type": "string" + } + }, + "type": "object" + }, + "ConnectorsCreationRequest": { + "properties": { + "name": { + "type": "string" + }, + "properties": { + "$ref": "#/components/schemas/WebhookProperties" + } + }, + "required": [ + "name", + "properties" + ], + "type": "object" + }, + "ConnectorsInformation": { + "properties": { + "id": { + "description": "Unique identifier of the connector.", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Human-readable name of the connector.", + "type": "string" + }, + "properties": { + "$ref": "#/components/schemas/WebhookProperties" + }, + "status": { + "description": "Current status of the connector (for example, enabled or disabled).", + "type": "string" + } + }, + "required": [ + "id", + "name", + "status", + "properties" + ], + "type": "object" + }, + "ConnectorsResponse": { + "properties": { + "connectors": { + "items": { + "$ref": "#/components/schemas/ConnectorsInformation" + }, + "type": "array" + } + }, + "required": [ + "connectors" + ], + "type": "object" + }, + "ConnectorsUpdateRequest": { + "properties": { + "properties": { + "$ref": "#/components/schemas/WebhookProperties" + } + }, + "required": [ + "properties" + ], + "type": "object" + }, + "CreateCMSConfigurationRequest": { + "description": "The information representing a Credential Manager Service configuration for creation purpose.", + "properties": { + "cmsDetails": { + "$ref": "#/components/schemas/CreateCMSDetails" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "vSatelliteIds": { + "$ref": "#/components/schemas/VSatelliteIds" + } + }, + "required": [ + "cmsType", + "vSatelliteIds", + "cmsDetails" + ], + "type": "object" + }, + "CreateCMSConfigurationsRequest": { + "description": "The array of Credential Manager Service configurations to create.", + "properties": { + "cmsConfigurations": { + "items": { + "$ref": "#/components/schemas/CreateCMSConfigurationRequest" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "cmsConfigurations" + ], + "type": "object" + }, + "CreateCMSConfigurationsResponse": { + "description": "The array of Credential Manager Service configurations created.", + "properties": { + "cmsConfigurationsCreated": { + "items": { + "$ref": "#/components/schemas/CMSConfigurationResponse" + }, + "minItems": 1, + "type": "array" + }, + "count": { + "type": "integer" + } + }, + "required": [ + "cmsConfigurationsCreated", + "count" + ], + "type": "object" + }, + "CreateCMSDetails": { + "oneOf": [ + { + "$ref": "#/components/schemas/CreateCyberArkDetails" + }, + { + "$ref": "#/components/schemas/CreateHashiCorpDetails" + } + ] + }, + "CreateCredentialDetails": { + "oneOf": [ + { + "$ref": "#/components/schemas/CreateCyberArkCredDetails" + }, + { + "$ref": "#/components/schemas/CreateHashiCorpCredDetails" + } + ] + }, + "CreateCyberArkCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkDetailsRequiredProp" + } + ] + }, + "CreateCyberArkDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkConfigurationRequiredProp" + } + ] + }, + "CreateHashiCorpCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpDetailsRequiredProp" + } + ] + }, + "CreateHashiCorpDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpConfigurationRequiredProp" + } + ] + }, + "CreateServiceAccountRequestBody": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccountBaseObject" + }, + { + "required": [ + "name", + "scopes" + ], + "type": "object" + } + ], + "example": { + "applications": [ + "dc96438b-7a80-464b-a09b-9e5ec746c3e3", + "5bce5ff4-a69b-4e78-9b7e-6d4029995000" + ], + "authenticationType": "rsaKey", + "credentialLifetime": 30, + "name": "Firefly SA", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "publicKey": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEAzRCyRWzXlyhFp3RcUrum1Q6j7YR8jyL0L1fWnh7zgt4=\\n-----END PUBLIC KEY-----", + "scopes": [ + "distributed-issuance" + ] + } + }, + "CreateServiceAccountResponseBody": { + "example": { + "id": "933507dd-0286-11ef-bc25-8a00a468403f", + "privateKey": "-----BEGIN PRIVATE KEY-----\n\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\n-----END PRIVATE KEY-----\n", + "publicKey": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEAzRCyRWzXlyhFp3RcUrum1Q6j7YR8jyL0L1fWnh7zgt4=\\n-----END PUBLIC KEY-----" + }, + "properties": { + "id": { + "description": "The ID for this service account", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "ociAccountName": { + "description": "The OCI account name generated for a robot in case of the registry scope", + "type": "string" + }, + "ociRegistryToken": { + "description": "The OCI registry token generated for a robot in case of the registry scope", + "type": "string" + }, + "privateKey": { + "description": "The generated private key for the service account when not providing a public key on the create payload", + "type": "string" + }, + "publicKey": { + "description": "The generated public key for the service account when not providing a public key on the create payload", + "type": "string" + } + }, + "type": "object" + }, + "CreateTeamRequest": { + "properties": { + "members": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "name": { + "maxLength": 100, + "type": "string" + }, + "owners": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "role": { + "$ref": "#/components/schemas/TeamRole" + }, + "userMatchingRules": { + "items": { + "$ref": "#/components/schemas/UserMatchingRule" + }, + "type": "array" + } + }, + "required": [ + "name", + "owners", + "role" + ], + "type": "object" + }, + "CreatedBy": { + "description": "The ID of the user whom created the credential.", + "type": "string" + }, + "CreatedOn": { + "description": "The date in ISO 8601 full-date format when the credential was created.", + "format": "date", + "type": "string" + }, + "CredentialId": { + "description": "The ID of the Credential in our System.", + "example": "94e86140-d85f-11ed-afa1-0242ac120002", + "format": "uuid", + "type": "string" + }, + "CredentialName": { + "description": "The name of the Credential in our System.", + "type": "string" + }, + "CredentialResponse": { + "description": "The properties representing a Credential for response purposes.", + "properties": { + "authType": { + "$ref": "#/components/schemas/AuthType" + }, + "cmsConfigId": { + "$ref": "#/components/schemas/CMSConfId" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "createdBy": { + "$ref": "#/components/schemas/CreatedBy" + }, + "createdOn": { + "$ref": "#/components/schemas/CreatedOn" + }, + "credentialDetails": { + "$ref": "#/components/schemas/ResponseCredentialDetails" + }, + "id": { + "$ref": "#/components/schemas/CredentialId" + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/LastModifiedBy" + }, + "lastModifiedOn": { + "$ref": "#/components/schemas/LastModifiedOn" + }, + "name": { + "$ref": "#/components/schemas/CredentialName" + }, + "references": { + "$ref": "#/components/schemas/References" + }, + "teamsIds": { + "$ref": "#/components/schemas/TeamsIds" + } + }, + "required": [ + "id", + "name", + "cmsConfigId", + "authType", + "cmsType" + ], + "type": "object" + }, + "CustomAttributes1": { + "description": "Certificate request custom attributes", + "example": { + "dnsNames": [ + "www.venafi.com", + "venafi.com" + ] + }, + "properties": { + "dnsNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "overwriteSans": { + "type": "boolean" + } + }, + "type": "object" + }, + "CustomAttributes2": { + "description": "A certificate request custom attributes", + "example": { + "dnsNames": [ + "www.venafi.com", + "venafi.com" + ] + }, + "properties": { + "dnsNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "overwriteSans": { + "type": "boolean" + } + }, + "type": "object" + }, + "CustomAttributesInformation": { + "description": "Represents custom attributes for certificate requests", + "properties": { + "dnsNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "overwriteSans": { + "description": "Defines if the csr sans should be overwritten by the custom attributes dns sans", + "type": "boolean" + } + }, + "required": [ + "dnsNames" + ], + "type": "object" + }, + "CustomClaimsAliasesInformation": { + "properties": { + "allowAllPolicies": { + "maxLength": 128, + "type": "string" + }, + "allowedPolicies": { + "maxLength": 128, + "type": "string" + }, + "configuration": { + "maxLength": 128, + "type": "string" + } + }, + "type": "object" + }, + "CyberArkConfiguration": { + "allOf": [ + { + "properties": { + "appID": { + "$ref": "#/components/schemas/AppId" + }, + "baseUrl": { + "$ref": "#/components/schemas/CMSURL" + } + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/CertificateCredentialData" + } + ], + "description": "The configuration for the CyberArk app. It's required to set the value for the `cmsType` property to `cyberark`." + }, + "CyberArkConfigurationRequiredProp": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkConfiguration" + } + ], + "description": "The configuration for the CyberArk app. It's required to set the value for the `cmsType` property to `cyberark`.", + "required": [ + "appID", + "baseUrl" + ] + }, + "CyberArkDetails": { + "description": "The CyberArk Credential information.", + "properties": { + "folder": { + "description": "The folder property into the CyberArk Safe.", + "type": "string" + }, + "objectName": { + "description": "The account's name which represents the credential in the CyberArk instance.", + "type": "string" + }, + "safe": { + "description": "The CyberArk Safe property.", + "type": "string" + } + }, + "type": "object" + }, + "CyberArkDetailsRequiredProp": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkDetails" + } + ], + "required": [ + "objectName", + "safe" + ] + }, + "DailyPatternInformation": { + "allOf": [ + { + "$ref": "#/components/schemas/SchedulerPatternInformation2" + }, + { + "properties": { + "duration": { + "description": "Duration in ISO-8601 format", + "enum": [ + "PT8H", + "PT12H", + "PT24H" + ], + "example": "PT24H", + "type": "string" + }, + "startTime": { + "description": "Start time in HH:mm:ss format", + "pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", + "type": "string" + } + }, + "type": "object" + } + ], + "required": [ + "duration", + "startTime" + ], + "type": "object" + }, + "DeleteCredentialsResponse": { + "description": "The response for the delete credentials action.", + "properties": { + "count": { + "type": "integer" + }, + "idsCredentialsDeleted": { + "items": { + "$ref": "#/components/schemas/CredentialId" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "idsCredentialsDeleted", + "count" + ], + "type": "object" + }, + "Deployment": { + "properties": { + "executionTarget": { + "default": "vsat", + "description": "HELP", + "type": "string" + }, + "image": { + "description": "URL for where the plugin image resides.", + "type": "string" + } + }, + "required": [ + "image", + "executionTarget" + ], + "title": "Deployment", + "type": "object", + "x-examples": { + "Example 1": { + "deployment": { + "executionTarget": "vsat", + "image": "public.ecr.aws/docker/library/nginx:mainline-alpine3.18-slim" + } + } + } + }, + "Details": { + "properties": { + "credentialsExpiringOn": { + "description": "The exact date on which the credentials will expire", + "format": "date-time", + "type": "string" + }, + "enabled": { + "description": "Indicates if the given service account must be enabled or disabled where disable means that the credentials cannot be used for", + "type": "boolean" + }, + "id": { + "description": "The ID for this service account", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "lastUsedOn": { + "description": "The last time the account credentials were used to authenticate a machine", + "format": "date-time", + "type": "string" + }, + "updatedBy": { + "description": "The UUID of the latest user that modified the account", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "updatedOn": { + "description": "The last time the account details were updated", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "Direction": { + "description": "An ordering direction", + "enum": [ + "ASC", + "DESC" + ], + "example": "DESC", + "type": "string" + }, + "EdgeInstanceConnectionDetails": { + "properties": { + "activeMessageCount": { + "format": "int32", + "type": "integer" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "expiredMessageCount": { + "format": "int32", + "type": "integer" + }, + "failedMessageCount": { + "format": "int32", + "type": "integer" + }, + "lastConnectedDate": { + "format": "date-time", + "type": "string" + }, + "lastDisconnectedDate": { + "format": "date-time", + "type": "string" + }, + "timestamp": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "EdgeInstanceHealthDetails": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "hsmStatus": { + "$ref": "#/components/schemas/HSMEdgeStatus" + }, + "installedCharts": { + "items": { + "$ref": "#/components/schemas/NamespaceChartDetails" + }, + "type": "array" + }, + "nodeStatus": { + "items": { + "$ref": "#/components/schemas/NodeStatusDetails" + }, + "type": "array" + }, + "systemstatus": { + "items": { + "$ref": "#/components/schemas/NamespaceStatusDetails" + }, + "type": "array" + }, + "timestamp": { + "format": "date-time", + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "EdgeInstanceInformation": { + "properties": { + "address": { + "type": "string" + }, + "canRestore": { + "type": "boolean" + }, + "clientId": { + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "deploymentDate": { + "format": "date-time", + "type": "string" + }, + "edgeStatus": { + "$ref": "#/components/schemas/EdgeStatus" + }, + "edgeType": { + "$ref": "#/components/schemas/EdgeType" + }, + "encryptionKeyDeploymentDate": { + "format": "date-time", + "type": "string" + }, + "encryptionKeyId": { + "type": "string" + }, + "environmentId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "integrationServicesCount": { + "format": "int64", + "type": "integer" + }, + "kubernetesVersion": { + "type": "string" + }, + "lastSeenOnDate": { + "format": "date-time", + "type": "string" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "pairingCodeId": { + "format": "uuid", + "type": "string" + }, + "primaryInstanceId": { + "format": "uuid", + "type": "string" + }, + "productEntitlements": { + "items": { + "$ref": "#/components/schemas/ProductEntitlement2" + }, + "type": "array" + }, + "reconciliationFailed": { + "type": "boolean" + }, + "satelliteVersion": { + "type": "string" + }, + "serviceAccountId": { + "format": "uuid", + "type": "string" + }, + "statusDetails": { + "$ref": "#/components/schemas/EdgeInstanceStatusDetailsInformation" + }, + "upgradeOrderPriority": { + "format": "int32", + "type": "integer" + }, + "upgradeStatus": { + "$ref": "#/components/schemas/UpgradeStatus" + }, + "version": { + "format": "int32", + "type": "integer" + }, + "workerStatusDetails": { + "items": { + "$ref": "#/components/schemas/EdgeWorkerStatusDetailsInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "EdgeInstanceRequest": { + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "upgradeOrderPriority": { + "format": "int32", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "EdgeInstanceResponse": { + "properties": { + "edgeInstances": { + "items": { + "$ref": "#/components/schemas/EdgeInstanceInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "EdgeInstanceStatusDetailsInformation": { + "properties": { + "connectionDetails": { + "items": { + "$ref": "#/components/schemas/EdgeInstanceConnectionDetails" + }, + "type": "array" + }, + "healthDetails": { + "items": { + "$ref": "#/components/schemas/EdgeInstanceHealthDetails" + }, + "type": "array" + } + }, + "type": "object" + }, + "EdgeStatus": { + "enum": [ + "ACTIVE", + "LOST_CONNECTION", + "REGISTERED", + "PAIRED", + "LOST_CONNECTION_DURING_INSTALL", + "INSTALLED", + "INSTALL_FAILED", + "UNHEALTHY", + "ERROR", + "INSTALLING" + ], + "type": "string" + }, + "EdgeType": { + "enum": [ + "ALL", + "HUB", + "SATELLITE" + ], + "type": "string" + }, + "EdgeWorkerDeleteResponse": { + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "pairingCode": { + "type": "string" + } + }, + "type": "object" + }, + "EdgeWorkerHealthDetails": { + "properties": { + "age": { + "format": "int64", + "type": "integer" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "cpuUsage": { + "format": "int32", + "type": "integer" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "edgeWorkerId": { + "format": "uuid", + "type": "string" + }, + "host": { + "type": "string" + }, + "memoryUsage": { + "format": "int64", + "type": "integer" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "services": { + "items": { + "$ref": "#/components/schemas/WorkerServiceStatusDetails" + }, + "type": "array" + }, + "status": { + "type": "string" + }, + "timestamp": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "EdgeWorkerInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "environmentId": { + "format": "uuid", + "type": "string" + }, + "hiddenPairingCode": { + "type": "string" + }, + "host": { + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "lastSeenOnDate": { + "format": "date-time", + "type": "string" + }, + "pairingCode": { + "type": "string" + }, + "pairingPublicKey": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "status": { + "$ref": "#/components/schemas/WorkerStatus" + } + }, + "type": "object" + }, + "EdgeWorkerRequest": { + "properties": { + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "host": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EdgeWorkerStatusDetailsInformation": { + "properties": { + "edgeWorkerId": { + "format": "uuid", + "type": "string" + }, + "healthDetails": { + "items": { + "$ref": "#/components/schemas/EdgeWorkerHealthDetails" + }, + "type": "array" + } + }, + "type": "object" + }, + "EdgeWorkersResponse": { + "properties": { + "edgeWorkers": { + "items": { + "$ref": "#/components/schemas/EdgeWorkerInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "EncryptionDetails": { + "properties": { + "encryptionType": { + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/AnyValue9" + } + }, + "type": "object" + }, + "EncryptionKeyInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "id": { + "type": "string" + }, + "key": { + "type": "string" + }, + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithm" + }, + "lastBackupDate": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "EncryptionKeysResponse": { + "properties": { + "encryptionKeys": { + "items": { + "$ref": "#/components/schemas/EncryptionKeyInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "EntityTag": { + "properties": { + "value": { + "type": "string" + }, + "weak": { + "type": "boolean" + } + }, + "type": "object" + }, + "Error": { + "description": "Hold the error details.", + "properties": { + "args": { + "description": "List of arguments used to generate the error message.", + "items": { + "type": "object" + }, + "type": "array" + }, + "code": { + "description": "The error code.", + "type": "integer" + }, + "message": { + "description": "The error message.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ], + "type": "object" + }, + "ErrorInformation1": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue1" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation10": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue10" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation2": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue2" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation3": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue3" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation4": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue4" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation5": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue5" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation6": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue6" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation7": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue7" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation8": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue8" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation9": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue9" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorResponse1": { + "properties": { + "errors": { + "description": "Short, human readable, description of the error.", + "items": { + "$ref": "#/components/schemas/ErrorInformation1" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse10": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation9" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse11": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation10" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse2": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation2" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse3": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation3" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse4": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation4" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse5": { + "description": "Holds the response body returned for errors.", + "properties": { + "errors": { + "description": "List of encountered errors.", + "items": { + "$ref": "#/components/schemas/Error" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse6": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation5" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse7": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation6" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse8": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation7" + }, + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse9": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation8" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExportedActivityLogEntryInformation": { + "properties": { + "activityDate": { + "description": "The date when a log entry was produced", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "activityName": { + "description": "An activity name", + "example": "Login Succeeded", + "type": "string" + }, + "activityType": { + "description": "An activity type", + "example": "Authentication", + "type": "string" + }, + "criticality": { + "description": "An activity criticality", + "example": 0, + "format": "int32", + "type": "integer" + }, + "id": { + "description": "UUID of a log entry", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "message": { + "description": "An activity log message", + "example": "user logged in", + "type": "string" + }, + "payload": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "Expression": { + "type": "object" + }, + "ExtendedApplicationOwnership": { + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "owningTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "owningUsers": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ExtendedCertificateInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "561baf7c-98b7-49af-ab9c-7b3a9fea3028", + "4adeba6f-0c94-4595-a5b6-babea458249f" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "archivedDate": { + "description": "The date a certificate was archived", + "example": "2022-05-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "authorityKeyIdentifierHash": { + "description": "An authority key identifier hash", + "example": "40572B10F85DDAF18BFF987372178532AB875BCA", + "type": "string" + }, + "certificateAuthorityAccountId": { + "description": "UUID of a certificate authority account", + "format": "uuid", + "type": "string" + }, + "certificateName": { + "description": "A certificate name", + "example": "venafi.com", + "type": "string" + }, + "certificateRequestId": { + "description": "UUID of a certificate request", + "example": "2e8964a0-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "certificateStatus": { + "description": "Certificate's status", + "enum": [ + "ACTIVE", + "RETIRED", + "DELETED" + ], + "example": "ACTIVE", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "dekHash": { + "description": "A certificate dek hash", + "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", + "type": "string" + }, + "encryptionType": { + "description": "A certificate encryption type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "EC", + "type": "string" + }, + "extendedKeyUsage": { + "description": "A collection of certificate extended key usages", + "example": [ + "1.3.6.1.5.5.7.3.2", + "1.3.6.1.5.5.7.3.1" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "fingerprint": { + "description": "A certificate fingerprint", + "example": "6D4C95512C117B004191F1A096ECAD13242FCD9F", + "type": "string" + }, + "id": { + "description": "UUID of a certificate", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "inhibitAnyPolicy": { + "description": "Inhibit any policy", + "example": 150, + "format": "int32", + "type": "integer" + }, + "inhibitPolicyMapping": { + "description": "Inhibit policy mapping", + "example": 200, + "format": "int32", + "type": "integer" + }, + "instances": { + "description": "A collection of certificate instances information", + "example": [ + { + "certificateId": "7ec12010-9051-11ed-8e50-b994b27d2ece", + "certificateInstanceId": "7ec1bc50-9051-11ed-8e50-b994b27d2ece", + "certificateSource": "USER_SCAN", + "deploymentStatus": "IN_USE", + "hostname": "venafi.com", + "instanceChainValidationStatus": [ + "OK" + ], + "ipAddress": "23.185.0.2", + "lastScanDate": "2023-01-09T19:12:05.314+00:00", + "lastValidatedAttempt": "2023-01-09T19:12:05.446+00:00", + "modificationDate": "2023-01-09T19:12:14.865+00:00", + "port": 443, + "serviceIds": [ + "1d61e9e0-9046-11ed-bf12-53a1b041cf25" + ], + "sslProtocols": [ + "TLSv1.3", + "TLSv1.2" + ], + "sslValidationErrorArguments": [], + "sslValidationStatus": "OK" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateInstanceInformation" + }, + "type": "array" + }, + "issuerAlternativeNameDns": { + "description": "A collection of certificate issuer alternative names DNs", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerAlternativeNameNonDns": { + "description": "A collection of certificate issuer alternative name none DNs", + "example": [ + "venafi issuer doman" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerC": { + "description": "A certificate issues Country", + "example": "US", + "type": "string" + }, + "issuerCN": { + "description": "A collection of certificate issuer Common names", + "example": [ + "HydrantID SSL CA G3" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerCertificateIds": { + "description": "A collection of issuer certificate IDs", + "example": [ + "2e8964a0-9046-11ed-8e50-b994b27d2ece", + "d5b418a0-297e-11eb-bc4c-8b24e5a66fb6" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "issuerCertificates": { + "description": "A collection of certificate information", + "items": { + "$ref": "#/components/schemas/CertificateInformation" + }, + "type": "array" + }, + "issuerDN": { + "description": "A certificate issue DN", + "example": "cn=HydrantID SSL CA G3,o=HydrantID (Avalanche Cloud Corporation),c=US", + "type": "string" + }, + "issuerL": { + "description": "A certificate issues Locality", + "example": "Salt Lake City", + "type": "string" + }, + "issuerOU": { + "description": "A collection of certificate issuer Organization units", + "example": [ + "Issuer CA" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerST": { + "description": "A certificate issuer State", + "example": "Utah", + "type": "string" + }, + "keyCurve": { + "description": "A certificate key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P256", + "type": "string" + }, + "keyStrength": { + "description": "A certificate key strength", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyUsage": { + "description": "A collection of certificate key usages", + "example": [ + "digitalSignature", + "keyEncipherment" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "lastNotification": { + "format": "int32", + "type": "integer" + }, + "managedCertificateId": { + "description": "UUID of a managed certificate", + "example": "2f0e7320-9046-11ed-8ab8-19e0a618d9cd", + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "description": "The last date a certificate was modified", + "example": "2022-03-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "ocspNoCheck": { + "description": "If a certificate no ocsp check", + "example": false, + "type": "boolean" + }, + "ownership": { + "$ref": "#/components/schemas/CertificateOwnership" + }, + "pathLength": { + "description": "A certificate path length", + "example": 3, + "format": "int32", + "type": "integer" + }, + "requireExplicitPolicy": { + "description": "Required explicit policy is required", + "example": 1, + "format": "int32", + "type": "integer" + }, + "selfSigned": { + "description": "If the certificate is self singed", + "example": true, + "type": "boolean" + }, + "serialNumber": { + "description": "A certificate serial number", + "example": "0C51A562B02A19A222FFB4730C47A8E2", + "type": "string" + }, + "signatureAlgorithm": { + "description": "A certificate signature algorithm", + "enum": [ + "MD2_WITH_RSA_ENCRYPTION", + "MD5_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION2", + "SHA256_WITH_RSA_ENCRYPTION", + "SHA384_WITH_RSA_ENCRYPTION", + "SHA512_WITH_RSA_ENCRYPTION", + "ID_DSA_WITH_SHA1", + "dsaWithSHA1", + "EC_DSA_WITH_SHA1", + "EC_DSA_WITH_SHA224", + "EC_DSA_WITH_SHA256", + "EC_DSA_WITH_SHA384", + "EC_DSA_WITH_SHA512", + "UNKNOWN", + "SHA1_WITH_RSAandMGF1", + "GOST_R3411_94_WITH_GOST_R3410_2001", + "GOST_R3411_94_WITH_GOST_R3410_94" + ], + "example": "SHA256_WITH_RSA_ENCRYPTION", + "type": "string" + }, + "signatureHashAlgorithm": { + "description": "A certificate signature hash algorithm", + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "example": "SHA256", + "type": "string" + }, + "statusModificationDate": { + "description": "The date a certificate's status was modified", + "example": "2022-04-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "statusModificationUserId": { + "description": "UUID of the user that modified the certificate installation", + "example": "3c9964a0-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "subjectAlternativeNameDns": { + "description": "A collection of certificate subject alternative names DNs", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectAlternativeNameNonDns": { + "description": "A collection of certificate subject alternative name none DNs", + "example": [ + "venafi domain" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData1" + }, + "subjectC": { + "description": "A certificate subject Country", + "example": "US", + "type": "string" + }, + "subjectCN": { + "description": "A collection of certificate subject CNs", + "example": [ + "venafi.com", + "cloud.venafi" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectDN": { + "description": "A certificate subject DN", + "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "subjectKeyIdentifierHash": { + "description": "A subject key identifier hash", + "example": "4E0CE93D3240561F468C33A85F08FCD3B04CC9DC", + "type": "string" + }, + "subjectL": { + "description": "A certificate subject Locality", + "example": "Salt Lake City", + "type": "string" + }, + "subjectO": { + "description": "A certificate subject Organization", + "example": "Venafi, Inc.", + "type": "string" + }, + "subjectOU": { + "description": "A collection of certificate subject Organization units", + "example": [ + "devops", + "test" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectST": { + "description": "A certificate subject State", + "example": "Utah", + "type": "string" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "owner:test.user", + "90-day" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "totalActiveInstanceCount": { + "description": "total active instances of a certificate", + "example": 50, + "format": "int32", + "type": "integer" + }, + "totalInstanceCount": { + "description": "total instances of a certificate", + "example": 100, + "format": "int32", + "type": "integer" + }, + "validityEnd": { + "description": "The date a certificate validity ends", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "validityStart": { + "description": "The date a certificate validity starts", + "example": "2022-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "versionType": { + "description": "A certificate version type", + "enum": [ + "OLD", + "CURRENT" + ], + "example": "CURRENT", + "type": "string" + } + }, + "type": "object" + }, + "ExtendedCertificateInstanceInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "d3cce873-6957-4071-a65e-7676c0ae1123", + "322bcd99-286a-47ea-8dcd-8291ec5bff14" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificate": { + "$ref": "#/components/schemas/CertificateInformation" + }, + "certificateId": { + "description": "UUID of a certificate", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "certificateInstanceId": { + "description": "UUID of a certificate instance", + "example": "f68daf30-4690-45bc-85b3-bb327024735e", + "format": "uuid", + "type": "string" + }, + "certificateSource": { + "description": "Certificate source", + "enum": [ + "UNKNOWN", + "USER_PROVIDED", + "USER_IMPORTED", + "USER_SCAN", + "TRUSTNET_SCAN", + "ON_PREM_CA_IMPORT", + "EXTERNAL_CA_IMPORT", + "FILE_IMPORT", + "EXTERNAL_SCAN", + "DOMAIN_SCAN", + "SMART_SCAN_INTERNAL", + "SMART_SCAN_EXTERNAL", + "SMART_VALIDATION_INTERNAL", + "SMART_VALIDATION_EXTERNAL", + "MACHINE_DISCOVERY", + "KUBERNETES_DISCOVERY", + "AWS_DISCOVERY", + "AZURE_DISCOVERY", + "GCP_DISCOVERY" + ], + "example": "USER_SCAN", + "type": "string" + }, + "deploymentStatus": { + "description": "The deployment status", + "enum": [ + "UNKNOWN", + "IN_USE", + "SUPERSEDED" + ], + "example": "IN_USE", + "type": "string" + }, + "hostname": { + "description": "A hostname", + "example": "venafi.com", + "type": "string" + }, + "instanceChainValidationStatus": { + "description": "A collection of the instance chain validation status", + "example": [ + "OK" + ], + "items": { + "enum": [ + "OK", + "CHAIN_BUILDING_FAILED", + "INCOMPLETE_CHAIN", + "CHAIN_EXPIRE_BEFORE_EE", + "DISTRUSTED", + "UNKNOWN_ERROR", + "SELF_SIGNED" + ], + "type": "string" + }, + "type": "array" + }, + "ipAddress": { + "description": "An ip address", + "example": "14.183.1.32", + "type": "string" + }, + "lastScanDate": { + "description": "The last scan date", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "lastValidatedAttempt": { + "description": "The last validation attempt date", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "modificationDate": { + "description": "The last modification date", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "port": { + "description": "A port number", + "example": 443, + "format": "int32", + "type": "integer" + }, + "serviceIds": { + "description": "A collection of service IDs", + "example": [ + "1d61e9e0-9046-11ed-bf12-53a1b041cf2" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "sslProtocols": { + "description": "A collection of ssl protocols", + "example": [ + "TLSv1.1", + "TLSv1.2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sslValidationErrorArguments": { + "description": "A collection of ssl validation error arguments", + "example": [ + "B69950CC5F51EDDF55F36AD2BC898767BC43CC2A", + "24E5796GA7298E78EDE47D6FAED0790E8F464G54" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sslValidationStatus": { + "description": "SSL validation status", + "enum": [ + "HOSTNAME_NOT_RESOLVABLE", + "NO_CERTIFICATE_PRESENTED", + "INVALID_CERTIFICATE_FOUND", + "UNEXPECTED_CERTIFICATE_FOUND", + "OLD_VERSION_CERTIFICATE_FOUND", + "TARGET_UNREACHABLE", + "UNKNOWN_ERROR", + "OK" + ], + "example": "OK", + "type": "string" + }, + "sslValidationStatusMessage": { + "description": "SSL validation status message", + "example": "Certificate installation is using older versions of certificate", + "type": "string" + } + }, + "type": "object" + }, + "ExtendedCertificateInstanceResponse": { + "properties": { + "count": { + "format": "int32", + "type": "integer" + }, + "instances": { + "items": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExtendedConfigurationInformation": { + "properties": { + "advancedSettings": { + "$ref": "#/components/schemas/AdvancedSettingsInformation" + }, + "clientAuthentication": { + "$ref": "#/components/schemas/ClientAuthenticationInformation" + }, + "clientAuthorization": { + "$ref": "#/components/schemas/ClientAuthorizationInformation" + }, + "cloudProviders": { + "$ref": "#/components/schemas/CloudProvidersInformation" + }, + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "controllerAllowedPolicyIds": { + "description": "Array of UUIDs of policies that the kubernetes controller is permitted to use", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "creationDate": { + "description": "When the configuration was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "id": { + "description": "UUID of the configuration", + "example": "7268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "longLivedCertCount": { + "description": "Number of long lived certificates", + "example": 2, + "format": "int64", + "type": "integer" + }, + "minTlsVersion": { + "description": "Minimum required TLS protocol version", + "enum": [ + "TLS12", + "TLS13" + ], + "type": "string" + }, + "modificationDate": { + "description": "When the configuration was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" + }, + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "type": "string" + }, + "policies": { + "items": { + "$ref": "#/components/schemas/PolicyInformation" + }, + "type": "array" + }, + "policyDefinitions": { + "items": { + "$ref": "#/components/schemas/PolicyInformation" + }, + "type": "array" + }, + "policyIds": { + "description": "Array of UUIDs of policies to associate with the configuration", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "serviceAccountIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "shortLivedCertCount": { + "description": "Number of short lived certificates", + "example": 20, + "format": "int64", + "type": "integer" + }, + "subCaProvider": { + "$ref": "#/components/schemas/SubCaProviderInformation" + }, + "ultraShortLivedCertCount": { + "description": "Number of ultra short lived certificates", + "example": 200, + "format": "int64", + "type": "integer" + }, + "unixSocketAllowedPolicyIds": { + "description": "Array of UUIDs of policies that are permitted to be used when using the unix socket", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExtendedPolicyInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "configurations": { + "items": { + "$ref": "#/components/schemas/ConfigurationInformation" + }, + "type": "array" + }, + "creationDate": { + "description": "When the policy was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "extendedKeyUsages": { + "description": "Extended key usages", + "example": [ + "CLIENT_AUTH", + "SERVER_AUTH" + ], + "items": { + "enum": [ + "ANY", + "SERVER_AUTH", + "CLIENT_AUTH", + "CODE_SIGNING", + "EMAIL_PROTECTION", + "IPSEC_ENDSYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "TIME_STAMPING", + "OCSP_SIGNING", + "DVCS", + "SBGP_CERT_AA_SERVER_AUTH", + "SCVP_RESPONDER", + "EAP_OVER_PPP", + "EAP_OVER_LAN", + "SCVP_SERVER", + "SCVP_CLIENT", + "IPSEC_IKE", + "CAPWAP_AC", + "CAPWAP_WTP", + "IPSEC_IKE_INTERMEDIATE", + "SMARTCARD_LOGON" + ], + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "UUID of the policy", + "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", + "format": "uuid", + "type": "string" + }, + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithmInformation" + }, + "keyUsages": { + "description": "Key usages", + "example": [ + "keyEncipherment", + "digitalSignature" + ], + "items": { + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], + "type": "string" + }, + "type": "array" + }, + "modificationDate": { + "description": "When the policy was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" + }, + "name": { + "description": "Name of the policy", + "example": "Some policy", + "type": "string" + }, + "sans": { + "$ref": "#/components/schemas/SansInformation" + }, + "subject": { + "$ref": "#/components/schemas/SubjectAttributesInformation" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "type": "object" + }, + "Facet": { + "properties": { + "domain": { + "additionalProperties": { + "$ref": "#/components/schemas/AnyValue4" + }, + "type": "object" + }, + "facets": { + "items": { + "$ref": "#/components/schemas/Facet" + }, + "type": "array" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "Filter1": { + "format": "json", + "type": "string" + }, + "Filter2": { + "properties": { + "expression": { + "$ref": "#/components/schemas/BaseFilter" + }, + "ordering": { + "$ref": "#/components/schemas/BaseOrdering" + }, + "paging": { + "$ref": "#/components/schemas/Page2" + } + }, + "type": "object" + }, + "FilterOperand": { + "properties": { + "operand": { + "$ref": "#/components/schemas/Condition" + }, + "operator": { + "description": "An operator for filtering", + "enum": [ + "NOT" + ], + "example": "NOT", + "type": "string" + } + }, + "type": "object" + }, + "FilterOperands": { + "properties": { + "operands": { + "description": "A list of conditions that will be used for filtering", + "example": [ + { + "field": "certificateStatus", + "operator": "EQ", + "value": "ACTIVE" + }, + { + "field": "certificateName", + "operator": "EQ", + "value": "venafi.com" + } + ], + "items": { + "$ref": "#/components/schemas/BaseFilter" + }, + "type": "array" + }, + "operator": { + "description": "An operator for filtering", + "enum": [ + "AND", + "OR" + ], + "example": "OR", + "type": "string" + } + }, + "type": "object" + }, + "GeneralNamesData1": { + "description": "A certificate subject alternative name by type", + "example": { + "dNSName": [ + "www.venafi.com", + "venafi.com" + ] + }, + "properties": { + "dNSName": { + "items": { + "type": "string" + }, + "type": "array" + }, + "directoryName": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ediPartyName": { + "items": { + "type": "string" + }, + "type": "array" + }, + "iPAddress": { + "items": { + "type": "string" + }, + "type": "array" + }, + "otherName": { + "items": { + "type": "string" + }, + "type": "array" + }, + "registeredID": { + "items": { + "type": "string" + }, + "type": "array" + }, + "rfc822Name": { + "items": { + "type": "string" + }, + "type": "array" + }, + "uniformResourceIdentifier": { + "items": { + "type": "string" + }, + "type": "array" + }, + "x400Address": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GeneralNamesData2": { + "description": "A certificate request subject alternative name (SAN) type", + "example": { + "dNSName": [ + "www.venafi.com", + "venafi.com" + ] + }, + "properties": { + "dNSName": { + "items": { + "type": "string" + }, + "type": "array" + }, + "directoryName": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ediPartyName": { + "items": { + "type": "string" + }, + "type": "array" + }, + "iPAddress": { + "items": { + "type": "string" + }, + "type": "array" + }, + "otherName": { + "items": { + "type": "string" + }, + "type": "array" + }, + "registeredID": { + "items": { + "type": "string" + }, + "type": "array" + }, + "rfc822Name": { + "items": { + "type": "string" + }, + "type": "array" + }, + "uniformResourceIdentifier": { + "items": { + "type": "string" + }, + "type": "array" + }, + "x400Address": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetCMSConfigurationsResponse": { + "description": "The array of Credential Manager Service configurations received.", + "properties": { + "cmsConfigurations": { + "items": { + "$ref": "#/components/schemas/CMSConfigurationResponse" + }, + "minItems": 1, + "type": "array" + }, + "count": { + "type": "integer" + } + }, + "required": [ + "cmsConfigurations", + "count" + ], + "type": "object" + }, + "GetCredentialsResponse": { + "description": "Array of credentials received.", + "properties": { + "count": { + "type": "integer" + }, + "credentials": { + "items": { + "$ref": "#/components/schemas/CredentialResponse" + }, + "type": "array" + } + }, + "required": [ + "credentials", + "count" + ], + "type": "object" + }, + "GetServiceAccountScopesResponseBody": { + "example": [ + { + "authenticationType": "rsaKey", + "id": "distributed-issuance", + "readableName": "Distributed Issuance" + } + ], + "items": { + "$ref": "#/components/schemas/ScopeDetails" + }, + "type": "array" + }, + "GetServiceAccountsByClientIDResponseBody": { + "$ref": "#/components/schemas/ServiceAccountDetails" + }, + "GetServiceAccountsResponseBody": { + "example": [ + { + "authenticationType": "rsaKey", + "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", + "credentialLifetime": 365, + "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", + "enabled": true, + "id": "933507dd-0286-11ef-bc25-8a00a468403f", + "name": "Service Account I", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "scopes": [ + "distributed-issuance" + ], + "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", + "updatedOn": "2024-01-01T00:00:00.000000Z" + }, + { + "authenticationType": "rsaKey", + "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", + "credentialLifetime": 365, + "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", + "enabled": true, + "id": "933507dd-0286-11ef-bc25-8a00a468403a", + "name": "Service Account II", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "scopes": [ + "distributed-issuance" + ], + "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", + "updatedOn": "2024-01-01T00:00:00.000000Z" + } + ], + "items": { + "$ref": "#/components/schemas/ServiceAccountDetailsNoKey" + }, + "type": "array" + }, + "GoogleCloudProviderInformation": { + "properties": { + "projectIdentifiers": { + "description": "Array of Google project identifiers each of which should be a string with int64 number or 6 to 30 lowercase letters, digits, or hyphens, should start with a letter and not contain trailing hyphens", + "example": [ + "415104041262", + "tokyo-rain-123" + ], + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "regions": { + "description": "Array of Google regions", + "example": [ + "us-west1" + ], + "items": { + "enum": [ + "asia-east1", + "asia-east2", + "asia-northeast1", + "asia-northeast2", + "asia-northeast3", + "asia-south1", + "asia-south2", + "asia-southeast1", + "asia-southeast2", + "australia-southeast1", + "australia-southeast2", + "europe-central2", + "europe-north1", + "europe-southwest1", + "europe-west1", + "europe-west12", + "europe-west2", + "europe-west3", + "europe-west4", + "europe-west6", + "europe-west8", + "europe-west9", + "me-central1", + "me-west1", + "northamerica-northeast1", + "northamerica-northeast2", + "southamerica-east1", + "southamerica-west1", + "us-central1", + "us-east1", + "us-east4", + "us-east5", + "us-south1", + "us-west1", + "us-west2", + "us-west3", + "us-west4" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "projectIdentifiers", + "regions" + ], + "type": "object" + }, + "HSMEdgeStatus": { + "enum": [ + "HSM_ERROR", + "HSM_NOT_CONFIGURED", + "HSM_LOST_CONNECTION", + "HSM_HEALTHY" + ], + "type": "string" + }, + "HashiCorpConfiguration": { + "allOf": [ + { + "properties": { + "authType": { + "$ref": "#/components/schemas/CMSAuthenticationType" + }, + "url": { + "$ref": "#/components/schemas/CMSURL" + } + }, + "required": [ + "authType" + ], + "type": "object" + }, + { + "oneOf": [ + { + "$ref": "#/components/schemas/CertificateCredentialData" + }, + { + "$ref": "#/components/schemas/UserPasswordAuthenticationData" + } + ] + } + ], + "description": "The configuration for the HashiCorp app. It's required to set the value for the `cmsType` property to `hashicorp`." + }, + "HashiCorpConfigurationRequiredProp": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpConfiguration" + } + ], + "description": "The configuration for the HashiCorp app. It's required to set the value for the `cmsType` property to `hashicorp`.", + "required": [ + "url" + ] + }, + "HashiCorpDetails": { + "description": "The HashiCorp Credential information.", + "properties": { + "secretKeyName": { + "description": "The HashiCorp secret key name property.", + "type": "string" + }, + "secretPath": { + "description": "The HashiCorp secret path property.", + "type": "string" + } + }, + "type": "object" + }, + "HashiCorpDetailsRequiredProp": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpDetails" + } + ], + "required": [ + "secretPath", + "secretKeyName" + ] + }, + "ImportedCertificateInformation": { + "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" + }, + "base64Certificate": { + "description": "Certificate base64 encoded format (PEM without header/footer", + "type": "string" + }, + "certificateSource": { + "description": "A certificate source", + "enum": [ + "UNKNOWN", + "USER_PROVIDED", + "USER_IMPORTED", + "USER_SCAN", + "TRUSTNET_SCAN", + "ON_PREM_CA_IMPORT", + "EXTERNAL_CA_IMPORT", + "FILE_IMPORT", + "EXTERNAL_SCAN", + "DOMAIN_SCAN", + "SMART_SCAN_INTERNAL", + "SMART_SCAN_EXTERNAL", + "SMART_VALIDATION_INTERNAL", + "SMART_VALIDATION_EXTERNAL", + "MACHINE_DISCOVERY", + "KUBERNETES_DISCOVERY", + "AWS_DISCOVERY", + "AZURE_DISCOVERY", + "GCP_DISCOVERY" + ], + "example": "USER_PROVIDED", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" + }, + "type": "array" + }, + "companyId": { + "description": "UUID of a company", + "example": "2d558b30-da16-11ed-8e4f-8339a1bc8d58", + "format": "uuid", + "type": "string" + }, + "fingerprint": { + "description": "A certificate fingerprint", + "example": "2C85B0AD64F55AA70BAC75F69711578DC505C3F9", + "type": "string" + }, + "id": { + "description": "UUID of a Certificate", + "example": "16cb6940-e2de-11ed-a644-4fab0ea00b60", + "format": "uuid", + "type": "string" + }, + "issuerCertificateIds": { + "description": "A collection of issuer certificates", + "example": [ + "Venafi issuer", + "QA Venafi issuer" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "managedCertificateId": { + "description": "UUID of a managed certificate", + "example": "17488880-e2de-11ed-aed6-79d407efea73", + "format": "uuid", + "type": "string" + } + }, + "type": "object" + }, + "IntegrationServiceCreationRequest": { + "properties": { + "edgeInstancesIds": { + "description": "A unique id of the vSatellite containing numbers, letters and dashes.", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "environmentId": { + "description": "Unique environment id containing numbers, letters and dashes.", + "example": "2e8cfc70-74ce-11ed-9051-cfa579eae364", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "The name of the service.", + "example": "Internet discovery", + "minLength": 1, + "type": "string" + }, + "scheduleEnabled": { + "description": "Determines if the discovery services are on a schedule.", + "example": true, + "type": "boolean" + }, + "schedulePattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation1" + }, + "serviceType": { + "description": "The type of the service being executed", + "enum": [ + "BASIC_DISCOVERY", + "ENHANCED_DISCOVERY", + "EXTERNAL_SCAN", + "INTERNET_DISCOVERY", + "SMART_DISCOVERY_EXTERNAL", + "KEY_GENERATION", + "MSCA", + "ACME" + ], + "example": "ENHANCED_DISCOVERY", + "type": "string" + }, + "targets": { + "$ref": "#/components/schemas/TargetsInformation" + }, + "workTypes": { + "description": "The work type of the service being executed.", + "items": { + "enum": [ + "DISCOVER", + "MANAGE" + ], + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "environmentId", + "name", + "serviceType", + "workTypes" + ], + "type": "object" + }, + "IntegrationServiceDetailsResponse": { + "properties": { + "integrationsServices": { + "description": "A object containing details of the service (e.g, name, status work type, schedule).", + "items": { + "$ref": "#/components/schemas/IntegrationServiceInformation" + }, + "type": "array" + }, + "totalCount": { + "description": "This represents the total number of services that have been created.", + "example": 10, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "IntegrationServiceInformation": { + "properties": { + "companyId": { + "description": "Unique company id containing in UUID format.", + "example": "2b391680-74ce-11ed-bf7a-a3d5ccdf275c", + "format": "uuid", + "type": "string" + }, + "edgeInstancesIds": { + "description": "A unique id of the vSatellite containing in UUID format.", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "encryptionKeyId": { + "description": "Encryption key UUID", + "example": "41bb5280-7193-11ed-a059-a7f274bd0b5b", + "format": "uuid", + "type": "string" + }, + "environmentId": { + "description": "Unique environment id containing in UUID format.", + "example": "2e8cfc70-74ce-11ed-9051-cfa579eae364", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "A unique id containing in UUID format.", + "example": "2e8d71a0-74ce-11ed-9051-cfa579eae364", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "The name of the service.", + "example": "Internet discovery", + "type": "string" + }, + "schedulePattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation1" + }, + "schedulerEnabled": { + "description": "Determines if the discovery services are on a schedule.", + "example": true, + "type": "boolean" + }, + "serviceType": { + "description": "The type of the service being executed.", + "enum": [ + "BASIC_DISCOVERY", + "ENHANCED_DISCOVERY", + "EXTERNAL_SCAN", + "INTERNET_DISCOVERY", + "SMART_DISCOVERY_EXTERNAL", + "KEY_GENERATION", + "MSCA", + "ACME" + ], + "example": "ENHANCED_DISCOVERY", + "type": "string" + }, + "status": { + "description": "The current status of the service.", + "enum": [ + "ACTIVE", + "DISABLED", + "RUNNING", + "WARNING", + "DRAFT", + "ERROR" + ], + "example": "DISABLED", + "type": "string" + }, + "statusMessage": { + "description": "The corresponding status message of the service.", + "example": "Integration service is disable", + "type": "string" + }, + "systemGenerated": { + "description": "If an integration service was generated automatically", + "example": true, + "type": "boolean" + }, + "targets": { + "$ref": "#/components/schemas/TargetsInformation" + }, + "workTypes": { + "description": "The work type of the service being executed.", + "items": { + "enum": [ + "DISCOVER", + "MANAGE" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "IntegrationServiceUpdateRequest": { + "properties": { + "edgeInstancesIds": { + "description": "A unique id of the vSatellite containing in UUID format.", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "The name of the service.", + "example": "Internet discovery", + "type": "string" + }, + "scheduleEnabled": { + "description": "Determines if the discovery services are on a schedule.", + "example": true, + "type": "boolean" + }, + "schedulePattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation1" + }, + "targets": { + "$ref": "#/components/schemas/TargetsInformation" + }, + "workTypes": { + "description": "The work type of the service being executed.", + "items": { + "enum": [ + "DISCOVER", + "MANAGE" + ], + "type": "string" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "IntermediateCertificateInformation": { + "properties": { + "certificate": { + "description": "Intermediate certificate bytes in PEM format", + "format": "PEM", + "type": "string" + }, + "commonName": { + "description": "Common name of the Intermediate certificate", + "example": "example.com", + "type": "string" + }, + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "configuration": { + "$ref": "#/components/schemas/ConfigurationInformation" + }, + "creationDate": { + "description": "When the intermediate certificate was created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation2" + }, + "fingerprint": { + "description": "Intermediate certificate fingerprint", + "type": "string" + }, + "id": { + "description": "UUID of the intermediate certificate", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "issuerCertificates": { + "description": "Intermediate certificate chain bytes in PEM format", + "items": { + "description": "Intermediate certificate chain bytes in PEM format", + "type": "string" + }, + "type": "array" + }, + "longLivedCertCount": { + "description": "Number of long lived certificates", + "example": 1, + "format": "int64", + "type": "integer" + }, + "modificationDate": { + "description": "When the intermediate certificate was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" + }, + "shortLivedCertCount": { + "description": "Number of short lived certificates", + "example": 10, + "format": "int64", + "type": "integer" + }, + "status": { + "description": "Status of the Intermediate certificate request", + "example": "ISSUED", + "type": "string" + }, + "ultraShortLivedCertCount": { + "description": "Number of ultra short lived certificates", + "example": 100, + "format": "int64", + "type": "integer" + }, + "validityEnd": { + "description": "Intermediate certificate validity end date", + "type": "string" + }, + "validityStart": { + "description": "Intermediate certificate validity start date", + "type": "string" + }, + "workflowId": { + "description": "Intermediate certificate workflow id", + "type": "string" + } + }, + "type": "object" + }, + "IntermediateCertificateResponse": { + "properties": { + "intermediateCertificates": { + "items": { + "$ref": "#/components/schemas/IntermediateCertificateInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "InventoryMonitoringConfig": { + "discriminator": { + "mapping": { + "CERTIFICATE_EXPIRATION": "#/components/schemas/CertificateExpirationInventoryMonitoringConfig" + }, + "propertyName": "inventoryMonitoringConfigurationType" + }, + "properties": { + "inventoryMonitoringConfigurationType": { + "type": "string" + } + }, + "type": "object" + }, + "InventoryMonitoringConfigRequest": { + "properties": { + "inventoryMonitoringConfiguration": { + "oneOf": [ + { + "$ref": "#/components/schemas/CertificateExpirationInventoryMonitoringConfig" + } + ], + "type": "object" + } + }, + "type": "object" + }, + "InventoryMonitoringConfiguration": { + "discriminator": { + "propertyName": "inventoryMonitoringConfigurationType" + }, + "properties": { + "inventoryMonitoringConfigurationType": { + "type": "string" + } + }, + "required": [ + "inventoryMonitoringConfigurationType" + ], + "type": "object" + }, + "InventoryMonitoringConfigurationResponse": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "2b391680-74ce-11ed-bf7a-a3d5ccdf275c", + "format": "uuid", + "type": "string" + }, + "configuration": { + "$ref": "#/components/schemas/InventoryMonitoringConfiguration" + }, + "id": { + "description": "UUID of the configuration", + "example": "2e8d71a0-74ce-11ed-9051-cfa579eae364", + "format": "uuid", + "type": "string" + } + }, + "type": "object" + }, + "InventoryMonitoringSchedulerInformation": { + "properties": { + "name": { + "description": "Name of the configuration", + "type": "string" + }, + "status": { + "description": "Status of the configuration", + "enum": [ + "PENDING", + "RUNNING", + "DONE", + "FAILED" + ], + "type": "string" + } + }, + "type": "object" + }, + "InvitationInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "productRoles": { + "additionalProperties": { + "items": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "userId": { + "format": "uuid", + "type": "string" + } + }, + "type": "object" + }, + "InvitationRequest": { + "properties": { + "role": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + } + }, + "required": [ + "role" + ], + "type": "object" + }, + "InvitationResponse": { + "properties": { + "invitations": { + "items": { + "$ref": "#/components/schemas/InvitationInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "IssuingTemplateDomainsSyncInformation": { + "properties": { + "error": { + "$ref": "#/components/schemas/ErrorInformation9" + }, + "issuingTemplateId": { + "format": "uuid", + "type": "string" + }, + "status": { + "enum": [ + "COMPLETED", + "FAILED" + ], + "type": "string" + } + }, + "type": "object" + }, + "IssuingTemplateDomainsSyncResponse": { + "properties": { + "issuingTemplatesInformationList": { + "items": { + "$ref": "#/components/schemas/IssuingTemplateDomainsSyncInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "IssuingTemplatesDomainsSyncRequest": { + "properties": { + "action": { + "enum": [ + "REPLACE" + ], + "type": "string" + }, + "certificateAuthorityAccountId": { + "format": "uuid", + "type": "string" + }, + "issuingTemplatesIds": { + "description": "Set of UUIDs of the issuing templates", + "example": [ + "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" + ], + "items": { + "description": "Set of UUIDs of the issuing templates", + "format": "uuid", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "action", + "certificateAuthorityAccountId", + "issuingTemplatesIds" + ], + "type": "object" + }, + "JwtClient": { + "properties": { + "allowedPolicyIds": { + "description": "Array of UUIDs of policies that the client is permitted to use", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "issuer": { + "description": "Issuer of the JWT", + "example": "https://kubernetes.default.svc", + "type": "string" + }, + "jwksUri": { + "description": "URL used to pull the trusted singing keys used for validation", + "example": "https://www.example.com:6443/jwks", + "type": "string" + }, + "name": { + "description": "Name of the client", + "example": "Some client", + "type": "string" + }, + "subjects": { + "description": "Array of subjects of the JWT", + "example": [ + "system:serviceaccount:venafi:application-team-1" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "JwtClientInformation": { + "properties": { + "allowedPolicyIds": { + "description": "Array of UUIDs of policies that the client is permitted to use", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "issuer": { + "description": "Issuer of the JWT", + "example": "https://kubernetes.default.svc", + "maxLength": 2048, + "type": "string" + }, + "jwksUri": { + "description": "URL used to pull the trusted singing keys used for validation", + "example": "https://www.example.com:6443/jwks", + "maxLength": 2048, + "type": "string" + }, + "name": { + "description": "Name of the client", + "example": "Some client", + "maxLength": 64, + "type": "string" + }, + "subjects": { + "description": "Array of subjects of the JWT", + "example": [ + "system:serviceaccount:venafi:application-team-1" + ], + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "allowedPolicyIds", + "issuer", + "name", + "subjects" + ], + "type": "object" + }, + "JwtJwksAuthenticationInformation": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationInformation" + }, + { + "properties": { + "urls": { + "description": "Array of JWT JWKS urls", + "example": [ + "https://jwks.example.com" + ], + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + } + ], + "required": [ + "urls" + ], + "type": "object" + }, + "JwtJwksAuthenticationOpenApi": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationOpenApi" + }, + { + "properties": { + "urls": { + "description": "Array of JWT JWKS urls", + "example": [ + "https://jwks.example.com" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "JwtOidcAuthenticationInformation": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationInformation" + }, + { + "properties": { + "audience": { + "description": "OpenId audience", + "example": "Client1", + "maxLength": 256, + "type": "string" + }, + "baseUrl": { + "description": "JWT OpenId base URL", + "example": "https://openid.example.com", + "maxLength": 2048, + "type": "string" + } + }, + "type": "object" + } + ], + "required": [ + "audience", + "baseUrl" + ], + "type": "object" + }, + "JwtOidcAuthenticationOpenApi": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationOpenApi" + }, + { + "properties": { + "audience": { + "description": "OpenId audience", + "example": "Alpha testers", + "type": "string" + }, + "baseUrl": { + "description": "JWT OpenId base URL", + "example": "https://oidc.example.com/", + "type": "string" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "JwtStandardClaimsAuthenticationInformation": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationInformation" + }, + { + "properties": { + "audience": { + "description": "Recipients that the JWT is intended for", + "example": "Client1", + "maxLength": 256, + "type": "string" + }, + "clients": { + "description": "List with clients, identified by processing JWTs that include standard/registered claims", + "items": { + "$ref": "#/components/schemas/JwtClientInformation" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + } + ], + "required": [ + "audience", + "clients" + ], + "type": "object" + }, + "JwtStandardClaimsAuthenticationOpenApi": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationOpenApi" + }, + { + "properties": { + "audience": { + "description": "Recipients that the JWT is intended for", + "example": "Client1", + "type": "string" + }, + "clients": { + "description": "List with clients, identified by processing JWTs that include standard/registered claims", + "items": { + "$ref": "#/components/schemas/JwtClient" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "KeyAlgorithm": { + "enum": [ + "RSA", + "ED25519", + "VSAT_HPKE" + ], + "type": "string" + }, + "KeyAlgorithmInformation": { + "description": "Key algorithm", + "properties": { + "allowedValues": { + "description": "Key algorithm allowed values", + "items": { + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "defaultValue": { + "description": "Key algorithm default value", + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "example": "RSA_4096", + "type": "string" + } + }, + "required": [ + "allowedValues", + "defaultValue" + ], + "type": "object" + }, + "KeyTypeInformation1": { + "discriminator": { + "propertyName": "keyType" + }, + "properties": { + "keyType": { + "type": "string" + } + }, + "type": "object" + }, + "KeyTypeInformation2": { + "discriminator": { + "propertyName": "keyType" + }, + "properties": { + "keyType": { + "type": "string" + } + }, + "type": "object" + }, + "KeyTypeParameters1": { + "properties": { + "keyCurve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" + }, + "keyLength": { + "format": "int32", + "type": "integer" + }, + "keyType": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" + } + }, + "required": [ + "keyCurve", + "keyLength", + "keyType" + ], + "type": "object" + }, + "KeyTypeParameters2": { + "properties": { + "keyCurves": { + "items": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" + }, + "type": "array" + }, + "keyLengths": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "keyType": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" + } + }, + "required": [ + "keyType" + ], + "type": "object" + }, + "LastModifiedBy": { + "description": "The ID of the user whom modified the credential.", + "type": "string" + }, + "LastModifiedOn": { + "description": "The date in ISO 8601 full-date format when the credential was modified.", + "format": "date", + "type": "string" + }, + "Link": { + "properties": { + "params": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "rel": { + "type": "string" + }, + "rels": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uri": { + "format": "uri", + "type": "string" + }, + "uriBuilder": { + "$ref": "#/components/schemas/UriBuilder" + } + }, + "type": "object" + }, + "LocalLoginRequest": { + "properties": { + "localLoginDisabled": { + "type": "boolean" + } + }, + "type": "object" + }, + "LocalizationResource": { + "description": "Translation map for the UI being rendered. This map is used with the manifest schema. The keys represent the values provided for the \"x-localizationKey\" property in the domain entity definition, and each key's value is used to represent field labels, enum values, or error messages.", + "nullable": true, + "properties": { + "en": { + "type": "object" + } + }, + "title": "LocalizationResources", + "type": "object", + "x-examples": { + "Example 1": { + "en": { + "address": { + "label": "Server Hostname" + }, + "binding": { + "label": "Server Store Details" + }, + "certificateName": { + "description": "How the certificate should appear on the server.", + "label": "Certificate Name" + }, + "chainName": { + "label": "Chain Bundle Name" + }, + "discovery": { + "expiredCertificatesLabel": "Exclude expired certificates", + "inactiveProfilesLabel": "Exclude certificates that are not in use by either a virtual server or a monitor.", + "partitionDescription": "A comma separated list of partition names.", + "partitionLabel": "Partition(s)" + }, + "discoveryType": { + "all": "Both Monitors and Virtual Servers", + "label": "Resource Types to Discover", + "monitor": "Monitors", + "virtualServer": "Virtual Servers" + }, + "keystore": { + "label": "Certificate Information" + }, + "parentProfile": { + "description": "No value is interpreted as \"clientssl\" or \"serverssl\" depending on the Profile Type selected.", + "label": "Parent Profile" + }, + "partition": { + "description": "No value is interpreted as the \"Common\" partition.", + "label": "Partition" + }, + "password": { + "hidePassword": "Hide Password", + "label": "Password", + "showPassword": "Show Password" + }, + "port": { + "description": "No value is interpreted as 443.", + "label": "Port" + }, + "serverName": { + "description": "An alternative DNS name used for Server Name Indication.", + "label": "SNI" + }, + "sslProfile": { + "label": "SSL Profile" + }, + "sslProfileType": { + "client": "Client SSL Profile", + "label": "Profile Type", + "server": "Server SSL Profile" + }, + "username": { + "label": "Username" + } + } + } + } + }, + "MachineBatchProvisioningResultInformation": { + "properties": { + "endDate": { + "format": "date-time", + "type": "string" + }, + "errorMessage": { + "type": "string" + }, + "machineIdentitiesCount": { + "format": "int64", + "type": "integer" + }, + "machineIdentitiesFailedCount": { + "format": "int64", + "type": "integer" + }, + "machineIdentitiesSucceedCount": { + "format": "int64", + "type": "integer" + }, + "startDate": { + "format": "date-time", + "type": "string" + }, + "type": { + "enum": [ + "MANUAL", + "SCHEDULED" + ], + "type": "string" + } + }, + "type": "object" + }, + "MachineCreationRequest": { + "properties": { + "connectionDetails": { + "$ref": "#/components/schemas/AnyValue10" + }, + "dekId": { + "minLength": 1, + "type": "string" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "machineTypeId": { + "deprecated": true, + "format": "uuid", + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + }, + "owningTeamId": { + "format": "uuid", + "type": "string" + }, + "pluginId": { + "format": "uuid", + "type": "string" + }, + "status": { + "enum": [ + "DRAFT", + "VERIFIED", + "UNVERIFIED", + "DELETING" + ], + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "connectionDetails", + "dekId", + "edgeInstanceId", + "name", + "pluginId" + ], + "type": "object" + }, + "MachineDiscoveryResultInformation": { + "properties": { + "certificatesCountCurrent": { + "format": "int64", + "type": "integer" + }, + "certificatesCountTotal": { + "format": "int64", + "type": "integer" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "discoveryStatus": { + "enum": [ + "NEVER INITIATED", + "INITIATED", + "RUNNING", + "COMPLETED", + "ABORTED", + "ABORTING", + "FAILED" + ], + "type": "string" + }, + "endDate": { + "format": "date-time", + "type": "string" + }, + "errorCount": { + "format": "int32", + "type": "integer" + }, + "machineIdentitiesCount": { + "format": "int64", + "type": "integer" + }, + "machineIdentitiesDeletedCount": { + "format": "int64", + "type": "integer" + }, + "machineIdentitiesMissingCount": { + "format": "int64", + "type": "integer" + }, + "startDate": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "MachineDocumentInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "integrationId": { + "format": "uuid", + "type": "string" + }, + "machineIdentitiesCount": { + "format": "int32", + "type": "integer" + }, + "machineName": { + "type": "string" + }, + "machineType": { + "deprecated": true, + "type": "string" + }, + "machineTypeId": { + "deprecated": true, + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "ownership": { + "$ref": "#/components/schemas/MachineOwnership" + }, + "owningTeam": { + "format": "uuid", + "type": "string" + }, + "pluginId": { + "format": "uuid", + "type": "string" + }, + "pluginName": { + "type": "string" + }, + "status": { + "enum": [ + "DRAFT", + "VERIFIED", + "UNVERIFIED", + "DELETING" + ], + "type": "string" + } + }, + "type": "object" + }, + "MachineDocumentResponse": { + "properties": { + "machines": { + "items": { + "$ref": "#/components/schemas/MachineDocumentInformation" + }, + "type": "array" + }, + "totalCount": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "MachineIdentityCreationRequest": { + "properties": { + "binding": { + "$ref": "#/components/schemas/AnyValue10" + }, + "certificateId": { + "format": "uuid", + "type": "string" + }, + "keystore": { + "$ref": "#/components/schemas/AnyValue10" + }, + "machineId": { + "format": "uuid", + "type": "string" + } + }, + "required": [ + "certificateId", + "machineId" + ], + "type": "object" + }, + "MachineIdentityDocumentInformation": { + "properties": { + "applicationIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "binding": { + "$ref": "#/components/schemas/AnyValue10" + }, + "certificateFingerprint": { + "type": "string" + }, + "certificateId": { + "format": "uuid", + "type": "string" + }, + "certificateName": { + "type": "string" + }, + "certificateValidityEnd": { + "format": "date-time", + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "keystore": { + "$ref": "#/components/schemas/AnyValue10" + }, + "lastSeenOn": { + "format": "date-time", + "type": "string" + }, + "machineId": { + "format": "uuid", + "type": "string" + }, + "machineName": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/AnyValue10" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "NEW", + "PENDING", + "INSTALLED", + "DISCOVERED", + "VALIDATED", + "MISSING", + "FAILED" + ], + "type": "string" + } + }, + "type": "object" + }, + "MachineIdentityDocumentResponse": { + "properties": { + "machineIdentities": { + "items": { + "$ref": "#/components/schemas/MachineIdentityDocumentInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "MachineIdentityInformation": { + "properties": { + "binding": { + "$ref": "#/components/schemas/AnyValue10" + }, + "certificateId": { + "format": "uuid", + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "keystore": { + "$ref": "#/components/schemas/AnyValue10" + }, + "lastSeenOn": { + "format": "date-time", + "type": "string" + }, + "machineId": { + "format": "uuid", + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/AnyValue10" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "NEW", + "PENDING", + "INSTALLED", + "DISCOVERED", + "VALIDATED", + "MISSING", + "FAILED" + ], + "type": "string" + } + }, + "type": "object" + }, + "MachineIdentityResponse": { + "properties": { + "machineIdentities": { + "items": { + "$ref": "#/components/schemas/MachineIdentityInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "MachineIdentitySearchRequest": { + "properties": { + "expression": { + "$ref": "#/components/schemas/Expression" + }, + "ordering": { + "$ref": "#/components/schemas/Ordering" + }, + "paging": { + "$ref": "#/components/schemas/Paging" + } + }, + "type": "object" + }, + "MachineIdentityUpdateRequest": { + "properties": { + "binding": { + "$ref": "#/components/schemas/AnyValue10" + }, + "certificateId": { + "format": "uuid", + "type": "string" + }, + "keystore": { + "$ref": "#/components/schemas/AnyValue10" + } + }, + "type": "object" + }, + "MachineIdentityWorkflowInformation": { + "properties": { + "workflowId": { + "type": "string" + }, + "workflowName": { + "type": "string" + } + }, + "type": "object" + }, + "MachineIdentityWorkflowRequest": { + "properties": { + "workflowInput": { + "$ref": "#/components/schemas/ProvisionCertificateWorkflowInputInformation" + }, + "workflowName": { + "type": "string" + } + }, + "required": [ + "workflowName" + ], + "type": "object" + }, + "MachineInformation": { + "properties": { + "batchProvisioningResult": { + "$ref": "#/components/schemas/MachineBatchProvisioningResultInformation" + }, + "batchProvisioningSchedulerEnabled": { + "type": "boolean" + }, + "batchProvisioningSchedulerPattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation3" + }, + "batchProvisioningStatus": { + "enum": [ + "NEVER_INITIATED", + "INITIATED", + "RUNNING", + "COMPLETED", + "ABORTED", + "ABORTING", + "FAILED" + ], + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "discoveryJson": { + "$ref": "#/components/schemas/AnyValue10" + }, + "discoverySchedulerEnabled": { + "type": "boolean" + }, + "discoverySchedulerPattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation3" + }, + "discoveryStatus": { + "enum": [ + "NEVER INITIATED", + "INITIATED", + "RUNNING", + "COMPLETED", + "ABORTED", + "ABORTING", + "FAILED" + ], + "type": "string" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "integrationId": { + "format": "uuid", + "type": "string" + }, + "machineType": { + "deprecated": true, + "type": "string" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "owningTeamId": { + "format": "uuid", + "type": "string" + }, + "pluginId": { + "format": "uuid", + "type": "string" + }, + "status": { + "enum": [ + "DRAFT", + "VERIFIED", + "UNVERIFIED", + "DELETING" + ], + "type": "string" + } + }, + "type": "object" + }, + "MachineOwnership": { + "properties": { + "owningTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "MachineUpdateRequest": { + "properties": { + "batchProvisioningSchedulerEnabled": { + "type": "boolean" + }, + "batchProvisioningSchedulerPattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation3" + }, + "connectionDetails": { + "$ref": "#/components/schemas/AnyValue10" + }, + "discoveryJson": { + "$ref": "#/components/schemas/AnyValue10" + }, + "discoverySchedulerEnabled": { + "type": "boolean" + }, + "discoverySchedulerPattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation3" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "name": { + "type": "string" + }, + "owningTeamId": { + "format": "uuid", + "type": "string" + }, + "status": { + "enum": [ + "DRAFT", + "VERIFIED", + "UNVERIFIED", + "DELETING" + ], + "type": "string" + } + }, + "type": "object" + }, + "MachineWorkflowRequest": { + "properties": { + "workflowInput": { + "$ref": "#/components/schemas/AnyValue10" + }, + "workflowName": { + "type": "string" + } + }, + "type": "object" + }, + "MachinesResponse": { + "properties": { + "machines": { + "items": { + "$ref": "#/components/schemas/MachineInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "MachinesSearchRequest": { + "properties": { + "expression": { + "$ref": "#/components/schemas/Expression" + }, + "ordering": { + "$ref": "#/components/schemas/Ordering" + }, + "paging": { + "$ref": "#/components/schemas/Paging" + } + }, + "type": "object" + }, + "Manifest": { + "properties": { + "deployment": { + "$ref": "#/components/schemas/Deployment" + }, + "description": { + "description": "Description text for the plugin.", + "type": "string" + }, + "domainSchema": { + "type": "object" + }, + "hooks": { + "properties": { + "mapping": { + "type": "object" + }, + "requestConverters": { + "items": {}, + "nullable": true, + "type": "array" + } + }, + "required": [ + "mapping" + ], + "type": "object" + }, + "localizationResources": { + "$ref": "#/components/schemas/LocalizationResource" + }, + "name": { + "description": "Name of the plugin.", + "type": "string" + }, + "pluginType": { + "$ref": "#/components/schemas/PluginType" + }, + "workTypes": { + "description": "Defines the type of workflows supported for the plugin.", + "items": { + "$ref": "#/components/schemas/WorkType" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "name", + "workTypes", + "deployment", + "domainSchema", + "hooks" + ], + "title": "Manifest", + "type": "object", + "x-examples": { + "Example 1": { + "deployment": { + "executionTarget": "vsat", + "image": "public.ecr.aws/docker/library/nginx:mainline-alpine3.18-slim" + }, + "description": "Description text.", + "domainSchema": { + "binding": { + "properties": { + "parentProfile": { + "description": "parentProfile.description", + "type": "string", + "x-labelLocalizationKey": "parentProfile.label", + "x-rank": 1 + }, + "serverName": { + "description": "serverName.description", + "format": "hostname", + "type": "string", + "x-labelLocalizationKey": "serverName.label", + "x-rank": 3, + "x-rule": { + "condition": { + "type": "#/properties/sslProfileType" + }, + "effect": "SHOW" + } + }, + "sslProfile": { + "type": "string", + "x-labelLocalizationKey": "sslProfile.label", + "x-rank": 2 + }, + "sslProfileType": { + "oneOf": [ + { + "const": "client", + "x-labelLocalizationKey": "sslProfileType.client" + }, + { + "const": "server", + "x-labelLocalizationKey": "sslProfileType.server" + } + ], + "x-labelLocalizationKey": "sslProfileType.label", + "x-rank": 0 + } + }, + "required": [ + "sslProfile", + "sslProfileType" + ], + "type": "object", + "x-labelLocalizationKey": "binding.label", + "x-primaryKey": [ + "#/sslProfileType", + "#/sslProfile" + ] + }, + "certificateBundle": { + "properties": { + "certificate": { + "contentEncoding": "base64", + "type": "string" + }, + "certificateChain": { + "contentEncoding": "base64", + "type": "string" + }, + "privateKey": { + "contentEncoding": "base64", + "type": "string", + "x-encrypted-base64": true + } + }, + "required": [ + "certificate", + "privateKey", + "certificateChain" + ], + "type": "object" + }, + "connection": { + "properties": { + "hostnameOrAddress": { + "type": "string", + "x-labelLocalizationKey": "address.label", + "x-rank": 0 + }, + "password": { + "type": "string", + "x-controlOptions": { + "hidePasswordLabel": "password.hidePassword", + "password": true, + "showPasswordLabel": "password.showPassword" + }, + "x-encrypted": true, + "x-labelLocalizationKey": "password.label", + "x-rank": 3 + }, + "port": { + "description": "port.description", + "maximum": 65535, + "minimum": 1, + "type": "integer", + "x-labelLocalizationKey": "port.label", + "x-rank": 1 + }, + "username": { + "type": "string", + "x-encrypted": true, + "x-labelLocalizationKey": "username.label", + "x-rank": 2 + } + }, + "required": [ + "hostnameOrAddress", + "username", + "password" + ], + "type": "object" + }, + "discovery": { + "properties": { + "discoveryType": { + "oneOf": [ + { + "const": "all", + "x-labelLocalizationKey": "discoveryType.all" + }, + { + "const": "monitor", + "x-labelLocalizationKey": "discoveryType.monitor" + }, + { + "const": "virtualServer", + "x-labelLocalizationKey": "discoveryType.virtualServer" + } + ], + "x-labelLocalizationKey": "discoveryType.label", + "x-rank": 0 + }, + "excludeExpiredCertificates": { + "type": "boolean", + "x-labelLocalizationKey": "discovery.expiredCertificatesLabel", + "x-rank": 2 + }, + "excludeInactiveProfiles": { + "type": "boolean", + "x-labelLocalizationKey": "discovery.inactiveProfilesLabel", + "x-rank": 3 + }, + "partition": { + "default": "Common", + "description": "discovery.partitionDescription", + "maxLength": 64, + "type": "string", + "x-labelLocalizationKey": "discovery.partitionLabel", + "x-rank": 1 + } + }, + "type": "object" + }, + "discoveryControl": { + "properties": { + "maxResults": { + "type": "int" + } + }, + "required": [ + "maxResults" + ], + "type": "object" + }, + "discoveryPage": { + "properties": { + "discoveryType": { + "type": "string" + }, + "paginator": { + "type": "string" + } + }, + "type": "object" + }, + "keystore": { + "properties": { + "certificateName": { + "description": "certificateName.description", + "type": "string", + "x-labelLocalizationKey": "certificateName.label", + "x-rank": 0 + }, + "chainName": { + "type": "string", + "x-labelLocalizationKey": "chainName.label", + "x-rank": 1 + }, + "partition": { + "description": "partition.description", + "maxLength": 64, + "type": "string", + "x-labelLocalizationKey": "partition.label", + "x-rank": 2, + "x-targetConfigurationRef": "/partitions" + } + }, + "required": [ + "certificateName", + "chainName" + ], + "type": "object", + "x-labelLocalizationKey": "keystore.label", + "x-primaryKey": [ + "#/certificateName", + "#/partition" + ] + } + }, + "hooks": { + "mapping": { + "configureInstallationEndpoint": "/v1/configureinstallationendpoint", + "discoverCertificates": "/v1/discovercertificates", + "installCertificateBundle": "/v1/installcertificatebundle", + "testConnection": "/v1/testconnection" + }, + "requestConverters": [ + "arguments-decrypter" + ] + }, + "localizationResources": { + "en": { + "address": { + "label": "Server Hostname" + }, + "binding": { + "label": "Server Store Details" + }, + "certificateName": { + "description": "How the certificate should appear on the server.", + "label": "Certificate Name" + }, + "chainName": { + "label": "Chain Bundle Name" + }, + "discovery": { + "expiredCertificatesLabel": "Exclude expired certificates.", + "inactiveProfilesLabel": "Exclude certificates that are not in use by either a virtual server or a monitor.", + "partitionDescription": "A comma separated list of partition names.", + "partitionLabel": "Partition(s)" + }, + "discoveryType": { + "all": "Both Monitors and Virtual Servers", + "label": "Resource Types to Discover", + "monitor": "Monitors", + "virtualServer": "Virtual Servers" + }, + "keystore": { + "label": "Certificate Information" + }, + "parentProfile": { + "description": "No value is interpreted as \"clientssl\" or \"serverssl\" depending on the Profile Type selected.", + "label": "Parent Profile" + }, + "partition": { + "description": "No value is interpreted as the \"Common\" partition.", + "label": "Partition" + }, + "password": { + "hidePassword": "Hide Password", + "label": "Password", + "showPassword": "Show Password" + }, + "port": { + "description": "No value is interpreted as 443.", + "label": "Port" + }, + "serverName": { + "description": "An alternative DNS name used for Server Name Indication.", + "label": "SNI" + }, + "sslProfile": { + "label": "SSL Profile" + }, + "sslProfileType": { + "client": "Client SSL Profile", + "label": "Profile Type", + "server": "Server SSL Profile" + }, + "username": { + "label": "Username" + } + } + }, + "name": "Sample Manifest" + } + } + }, + "MediaType": { + "properties": { + "parameters": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "subtype": { + "type": "string" + }, + "type": { + "type": "string" + }, + "wildcardSubtype": { + "type": "boolean" + }, + "wildcardType": { + "type": "boolean" + } + }, + "type": "object" + }, + "MetadataInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "productEntitlement": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + } + }, + "type": "object" + }, + "Name": { + "description": "The Name of CMS configuration", + "type": "string" + }, + "NamespaceChartDetails": { + "properties": { + "charts": { + "items": { + "$ref": "#/components/schemas/ChartDetails" + }, + "type": "array" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "NamespaceStatusDetails": { + "properties": { + "name": { + "type": "string" + }, + "pods": { + "items": { + "$ref": "#/components/schemas/PodStatusDetails" + }, + "type": "array" + }, + "timestamp": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "NaryOperator": { + "description": "An operator for filtering", + "enum": [ + "AND", + "OR" + ], + "example": "OR", + "type": "string" + }, + "NewCookie": { + "properties": { + "comment": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "expiry": { + "format": "date-time", + "type": "string" + }, + "httpOnly": { + "type": "boolean" + }, + "maxAge": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sameSite": { + "enum": [ + "NONE", + "LAX", + "STRICT" + ], + "type": "string" + }, + "secure": { + "type": "boolean" + }, + "value": { + "type": "string" + }, + "version": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "NodeCondition": { + "properties": { + "Status": { + "type": "string", + "writeOnly": true + }, + "Type": { + "type": "string", + "writeOnly": true + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "NodeInfo": { + "properties": { + "kubelet_version": { + "type": "string" + } + }, + "type": "object" + }, + "NodeStatusDetails": { + "properties": { + "conditions": { + "items": { + "$ref": "#/components/schemas/NodeCondition" + }, + "type": "array" + }, + "info": { + "$ref": "#/components/schemas/NodeInfo" + } + }, + "type": "object" + }, + "Operator": { + "enum": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "ENDS_WITH" + ], + "type": "string" + }, + "Order": { + "properties": { + "direction": { + "description": "An ordering direction", + "enum": [ + "ASC", + "DESC" + ], + "example": "DESC", + "type": "string" + }, + "field": { + "description": "A field, that will be used for ordering", + "example": "modificationDate", + "type": "string" + } + }, + "type": "object" + }, + "OrderObject": { + "properties": { + "direction": { + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + }, + "field": { + "type": "string" + } + }, + "type": "object" + }, + "Ordering": { + "properties": { + "orders": { + "items": { + "$ref": "#/components/schemas/OrderObject" + }, + "type": "array" + } + }, + "type": "object" + }, + "OwnerIdAndType": { + "properties": { + "ownerId": { + "format": "uuid", + "type": "string" + }, + "ownerType": { + "enum": [ + "USER", + "TEAM", + "SERVICE_ACCOUNT" + ], + "type": "string" + } + }, + "required": [ + "ownerId", + "ownerType" + ], + "type": "object" + }, + "Page1": { + "description": "Specify pagination on the search request", + "properties": { + "pageNumber": { + "description": "page number", + "example": 0, + "format": "int32", + "type": "integer" + }, + "pageSize": { + "description": "page size", + "example": 10, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Page2": { + "description": "Specify pagination on the search request", + "properties": { + "pageNumber": { + "description": "page number", + "example": 0, + "format": "int32", + "type": "integer" + }, + "pageSize": { + "description": "page size", + "example": 10, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Paging": { + "properties": { + "pageNumber": { + "format": "int32", + "type": "integer" + }, + "pageSize": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PairingCodeInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "environmentId": { + "format": "uuid", + "type": "string" + }, + "expirationDate": { + "format": "date-time", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "pairingCode": { + "type": "string" + }, + "productEntitlements": { + "items": { + "$ref": "#/components/schemas/ProductEntitlement2" + }, + "type": "array" + }, + "reuseCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PairingCodeRequest": { + "properties": { + "environmentId": { + "format": "uuid", + "type": "string" + }, + "primaryInstanceId": { + "format": "uuid", + "type": "string" + }, + "reuseCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PatchServiceAccountByClientIDRequestBody": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccountPatchBaseObject" + }, + { + "properties": { + "enabled": { + "description": "Indicates if the given service account must be enabled or disabled where disable means that the credentials cannot be used for authentication", + "type": "boolean" + } + }, + "type": "object" + } + ], + "example": { + "credentialLifetime": 365, + "enabled": true, + "name": "New name", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAor3JRni8bObnKbmWzRubiNyKMoCXLVrswqiMm2h8zl8=\n-----END PUBLIC KEY-----\n", + "scopes": [ + "distributed-issuance" + ] + } + }, + "Persona": { + "enum": [ + "Application Owners", + "All PKI Admins", + "All Admins" + ], + "type": "string" + }, + "Plugin": { + "properties": { + "creationTime": { + "description": "Represents the date when the plugin was created.", + "format": "date-time", + "type": "string" + }, + "disabled": { + "description": "Indicates whether the tenant has disabled the plugin from its list of plugins.", + "type": "boolean" + }, + "id": { + "description": "Represents the plugin ID.", + "type": "string" + }, + "lastModifiedOn": { + "description": "Date the plugin was last modified.", + "format": "date-time", + "type": "string" + }, + "maintainer": { + "description": "Refers to the organization, individual, email, location, or website responsible for maintaining the plugin.", + "nullable": true, + "type": "string" + }, + "manifest": { + "$ref": "#/components/schemas/Manifest" + }, + "name": { + "description": "Represents the name of the plugin. This must be unique.", + "type": "string" + }, + "pluginType": { + "$ref": "#/components/schemas/PluginType" + }, + "revision": { + "description": "Represents the number of times the plugins has been updated.", + "type": "integer" + }, + "workTypes": { + "description": "Represents the type of workflow the plugin supports.", + "items": { + "$ref": "#/components/schemas/WorkType" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "id", + "name", + "revision", + "pluginType", + "workTypes", + "manifest", + "lastModifiedOn", + "creationTime" + ], + "title": "Plugin", + "type": "object" + }, + "PluginResponse": { + "properties": { + "plugins": { + "items": { + "$ref": "#/components/schemas/Plugin" + }, + "type": "array" + } + }, + "required": [ + "plugins" + ], + "title": "PluginResponse", + "type": "object" + }, + "PluginType": { + "description": "Used for differentiation between different types of plugins.", + "enum": [ + "MACHINE", + "CA", + "TPP", + "CREDENTIAL_MANAGER" + ], + "title": "PluginType", + "type": "string" + }, + "PodStatusDetails": { + "properties": { + "age": { + "format": "int64", + "type": "integer" + }, + "cpuUsage": { + "format": "int32", + "type": "integer" + }, + "image": { + "type": "string" + }, + "memoryUsage": { + "format": "int64", + "type": "integer" + }, + "name": { + "type": "string" + }, + "restartCount": { + "format": "int32", + "type": "integer" + }, + "status": { + "type": "string" + } + }, + "type": "object" + }, + "PolicyCreateRequest": { + "properties": { + "extendedKeyUsages": { + "description": "Extended key usages", + "example": [ + "CLIENT_AUTH", + "SERVER_AUTH" + ], + "items": { + "enum": [ + "ANY", + "SERVER_AUTH", + "CLIENT_AUTH", + "CODE_SIGNING", + "EMAIL_PROTECTION", + "IPSEC_ENDSYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "TIME_STAMPING", + "OCSP_SIGNING", + "DVCS", + "SBGP_CERT_AA_SERVER_AUTH", + "SCVP_RESPONDER", + "EAP_OVER_PPP", + "EAP_OVER_LAN", + "SCVP_SERVER", + "SCVP_CLIENT", + "IPSEC_IKE", + "CAPWAP_AC", + "CAPWAP_WTP", + "IPSEC_IKE_INTERMEDIATE", + "SMARTCARD_LOGON" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithmInformation" + }, + "keyUsages": { + "description": "Key usages", + "example": [ + "keyEncipherment", + "digitalSignature" + ], + "items": { + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "name": { + "description": "Name of the policy", + "example": "Some policy", + "maxLength": 64, + "type": "string" + }, + "sans": { + "$ref": "#/components/schemas/SansInformation" + }, + "subject": { + "$ref": "#/components/schemas/SubjectAttributesInformation" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "required": [ + "extendedKeyUsages", + "keyAlgorithm", + "keyUsages", + "name", + "sans", + "subject", + "validityPeriod" + ], + "type": "object" + }, + "PolicyDeleteResponse": { + "properties": { + "id": { + "description": "UUID of the policy", + "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the policy", + "example": "Some policy", + "type": "string" + } + }, + "type": "object" + }, + "PolicyInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "When the policy was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "extendedKeyUsages": { + "description": "Extended key usages", + "example": [ + "CLIENT_AUTH", + "SERVER_AUTH" + ], + "items": { + "enum": [ + "ANY", + "SERVER_AUTH", + "CLIENT_AUTH", + "CODE_SIGNING", + "EMAIL_PROTECTION", + "IPSEC_ENDSYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "TIME_STAMPING", + "OCSP_SIGNING", + "DVCS", + "SBGP_CERT_AA_SERVER_AUTH", + "SCVP_RESPONDER", + "EAP_OVER_PPP", + "EAP_OVER_LAN", + "SCVP_SERVER", + "SCVP_CLIENT", + "IPSEC_IKE", + "CAPWAP_AC", + "CAPWAP_WTP", + "IPSEC_IKE_INTERMEDIATE", + "SMARTCARD_LOGON" + ], + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "UUID of the policy", + "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", + "format": "uuid", + "type": "string" + }, + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithmInformation" + }, + "keyUsages": { + "description": "Key usages", + "example": [ + "keyEncipherment", + "digitalSignature" + ], + "items": { + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], + "type": "string" + }, + "type": "array" + }, + "modificationDate": { + "description": "When the policy was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" + }, + "name": { + "description": "Name of the policy", + "example": "Some policy", + "type": "string" + }, + "sans": { + "$ref": "#/components/schemas/SansInformation" + }, + "subject": { + "$ref": "#/components/schemas/SubjectAttributesInformation" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "type": "object" + }, + "PolicyResponse": { + "properties": { + "policies": { + "items": { + "$ref": "#/components/schemas/ExtendedPolicyInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "PolicyUpdateRequest": { + "properties": { + "extendedKeyUsages": { + "description": "Extended key usages", + "example": [ + "CLIENT_AUTH", + "SERVER_AUTH" + ], + "items": { + "enum": [ + "ANY", + "SERVER_AUTH", + "CLIENT_AUTH", + "CODE_SIGNING", + "EMAIL_PROTECTION", + "IPSEC_ENDSYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "TIME_STAMPING", + "OCSP_SIGNING", + "DVCS", + "SBGP_CERT_AA_SERVER_AUTH", + "SCVP_RESPONDER", + "EAP_OVER_PPP", + "EAP_OVER_LAN", + "SCVP_SERVER", + "SCVP_CLIENT", + "IPSEC_IKE", + "CAPWAP_AC", + "CAPWAP_WTP", + "IPSEC_IKE_INTERMEDIATE", + "SMARTCARD_LOGON" + ], + "type": "string" + }, + "type": "array" + }, + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithmInformation" + }, + "keyUsages": { + "description": "Key usages", + "example": [ + "keyEncipherment", + "digitalSignature" + ], + "items": { + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name of the policy", + "example": "Some policy", + "maxLength": 64, + "type": "string" + }, + "sans": { + "$ref": "#/components/schemas/SansInformation" + }, + "subject": { + "$ref": "#/components/schemas/SubjectAttributesInformation" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "type": "object" + }, + "ProductEntitlement1": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + }, + "ProductEntitlement2": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + }, + "ProductEntitlementInformation": { + "properties": { + "capabilities": { + "items": { + "$ref": "#/components/schemas/CapabilityInformation" + }, + "type": "array" + }, + "label": { + "$ref": "#/components/schemas/ProductEntitlement1" + }, + "visibilityConstraintsInformation": { + "$ref": "#/components/schemas/VisibilityConstraintsInformation" + } + }, + "required": [ + "capabilities", + "label", + "visibilityConstraintsInformation" + ], + "type": "object" + }, + "PropertyInformation": { + "properties": { + "allowedValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "defaultValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "maxOccurrences": { + "format": "int32", + "type": "integer" + }, + "minOccurrences": { + "format": "int32", + "type": "integer" + }, + "type": { + "enum": [ + "IGNORED", + "FORBIDDEN", + "OPTIONAL", + "REQUIRED", + "LOCKED" + ], + "type": "string" + } + }, + "type": "object" + }, + "ProviderConfigInformation": { + "properties": { + "api_key": { + "type": "string" + }, + "endpoint": { + "type": "string" + } + }, + "type": "object" + }, + "ProviderInformation": { + "properties": { + "config": { + "$ref": "#/components/schemas/ProviderConfigInformation" + }, + "inputs": { + "items": { + "$ref": "#/components/schemas/ProviderInputInformation" + }, + "type": "array" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ProviderInputInformation": { + "properties": { + "hosts": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ports": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subnet": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ProvisionCertificateWorkflowInputInformation": { + "properties": { + "wsClientId": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "wsClientId" + ], + "type": "object" + }, + "PublicPluginCreationRequest": { + "properties": { + "maintainer": { + "description": "Refers to the organization, individual, email, location, or website responsible for maintaining the plugin.", + "nullable": true, + "type": "string" + }, + "manifest": { + "$ref": "#/components/schemas/Manifest" + }, + "pluginType": { + "$ref": "#/components/schemas/PluginType" + } + }, + "required": [ + "manifest", + "pluginType" + ], + "title": "PublicPluginCreationRequest", + "type": "object", + "x-stoplight": { + "id": "sto5fs3n5bxmf" + } + }, + "PublicPluginUpdateRequest": { + "properties": { + "image": { + "nullable": true, + "type": "string" + }, + "maintainer": { + "nullable": true, + "type": "string" + }, + "manifest": { + "$ref": "#/components/schemas/Manifest" + } + }, + "title": "PublicPluginUpdateRequest", + "type": "object", + "x-stoplight": { + "id": "8ypau6to0udah" + } + }, + "PutServiceAccountByClientIDCredentialsRequestBody": { + "example": { + "extendCredentialLifetime": true + }, + "properties": { + "extendCredentialLifetime": { + "description": "Extend the credential lifetime", + "type": "boolean" + } + }, + "required": [ + "extendCredentialLifetime" + ], + "type": "object" + }, + "PutServiceAccountByClientIDCredentialsResponseBody": { + "properties": { + "credentialExpiresIn": { + "description": "Expiration in hours for service account credentials", + "format": "float", + "type": "number", + "x-go-type": "float64" + } + }, + "type": "object" + }, + "PutServiceAccountByClientIDOCITokenResponseBody": { + "properties": { + "ociRegistryToken": { + "description": "The OCI registry token generated for a robot in case of the registry scope", + "type": "string" + } + }, + "type": "object" + }, + "Recipient": { + "properties": { + "id": { + "description": "The ID of a user or team who should be included as a recipient.", + "format": "UUID", + "type": "string" + }, + "type": { + "description": "The type of the recipient.", + "enum": [ + "User", + "Team" + ], + "type": "string" + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "RecommendedSettingsInformation1": { + "properties": { + "key": { + "$ref": "#/components/schemas/RecommendedSettingsKeyTypeInformation1" + }, + "sanRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCNRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCValue": { + "type": "string" + }, + "subjectLValue": { + "type": "string" + }, + "subjectOUValue": { + "type": "string" + }, + "subjectOValue": { + "type": "string" + }, + "subjectSTValue": { + "type": "string" + } + }, + "type": "object" + }, + "RecommendedSettingsInformation2": { + "properties": { + "key": { + "$ref": "#/components/schemas/RecommendedSettingsKeyTypeInformation2" + }, + "keyGeneratedBy": { + "type": "string" + }, + "sanRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCNRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCValue": { + "type": "string" + }, + "subjectLValue": { + "type": "string" + }, + "subjectOUValue": { + "type": "string" + }, + "subjectOValue": { + "type": "string" + }, + "subjectSTValue": { + "type": "string" + } + }, + "type": "object" + }, + "RecommendedSettingsKeyTypeInformation1": { + "properties": { + "curve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "type": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" + } + }, + "type": "object" + }, + "RecommendedSettingsKeyTypeInformation2": { + "properties": { + "curve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "type": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" + } + }, + "type": "object" + }, + "RecommendedSettingsKeyTypeParameter": { + "properties": { + "curve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "type": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" + } + }, + "type": "object" + }, + "RecommendedSettingsRequest": { + "properties": { + "key": { + "$ref": "#/components/schemas/RecommendedSettingsKeyTypeParameter" + }, + "keyGeneratedBy": { + "type": "string" + }, + "sanRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCNRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectCValue": { + "pattern": "^(([A-Z]{2})|(\\.\\*))$", + "type": "string" + }, + "subjectLValue": { + "pattern": "[^\\*]*", + "type": "string" + }, + "subjectOUValue": { + "pattern": "[^\\*]*", + "type": "string" + }, + "subjectOValue": { + "pattern": "[^\\*]*", + "type": "string" + }, + "subjectSTValue": { + "pattern": "[^\\*]*", + "type": "string" + } + }, + "type": "object" + }, + "RecoveryCodeInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "dataPlaneDomain": { + "type": "string" + }, + "expirationDate": { + "format": "date-time", + "type": "string" + }, + "hiddenRecoveryCode": { + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "productEntitlements": { + "items": { + "$ref": "#/components/schemas/ProductEntitlement2" + }, + "type": "array" + }, + "recoveryCode": { + "type": "string" + }, + "tsgId": { + "type": "string" + } + }, + "type": "object" + }, + "RecoveryCodeRequest": { + "properties": { + "edgeInstanceId": { + "format": "uuid", + "type": "string" + } + }, + "required": [ + "edgeInstanceId" + ], + "type": "object" + }, + "Reference": { + "description": "The machine referenced.", + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ReferenceType" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "ReferenceType": { + "description": "The type of the reference:\n * `machine`\n", + "enum": [ + "machine" + ], + "type": "string" + }, + "References": { + "description": "The machines referenced.", + "items": { + "$ref": "#/components/schemas/Reference" + }, + "type": "array", + "uniqueItems": true + }, + "Response": { + "properties": { + "allowedMethods": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "closed": { + "type": "boolean" + }, + "cookies": { + "additionalProperties": { + "$ref": "#/components/schemas/NewCookie" + }, + "type": "object" + }, + "date": { + "format": "date-time", + "type": "string" + }, + "entity": { + "$ref": "#/components/schemas/AnyValue4" + }, + "entityTag": { + "$ref": "#/components/schemas/EntityTag" + }, + "headers": { + "additionalProperties": { + "items": { + "$ref": "#/components/schemas/AnyValue4" + }, + "type": "array" + }, + "properties": { + "empty": { + "type": "boolean" + } + }, + "type": "object" + }, + "language": { + "properties": { + "country": { + "type": "string" + }, + "displayCountry": { + "type": "string" + }, + "displayLanguage": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "displayScript": { + "type": "string" + }, + "displayVariant": { + "type": "string" + }, + "extensionKeys": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "iso3Country": { + "type": "string" + }, + "iso3Language": { + "type": "string" + }, + "language": { + "type": "string" + }, + "script": { + "type": "string" + }, + "unicodeLocaleAttributes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "unicodeLocaleKeys": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "variant": { + "type": "string" + } + }, + "type": "object" + }, + "lastModified": { + "format": "date-time", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "links": { + "items": { + "$ref": "#/components/schemas/Link" + }, + "type": "array", + "uniqueItems": true + }, + "location": { + "format": "uri", + "type": "string" + }, + "mediaType": { + "$ref": "#/components/schemas/MediaType" + }, + "metadata": { + "additionalProperties": { + "items": { + "$ref": "#/components/schemas/AnyValue4" + }, + "type": "array" + }, + "properties": { + "empty": { + "type": "boolean" + } + }, + "type": "object" + }, + "status": { + "format": "int32", + "type": "integer" + }, + "statusInfo": { + "$ref": "#/components/schemas/StatusType" + }, + "stringHeaders": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "properties": { + "empty": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "ResponseCMSDetails": { + "description": "An string containing the JSON content representing the details of the specific privileged access management.", + "oneOf": [ + { + "$ref": "#/components/schemas/ResponseCyberArkDetails" + }, + { + "$ref": "#/components/schemas/ResponseHashiCorpDetails" + } + ] + }, + "ResponseCredentialDetails": { + "oneOf": [ + { + "$ref": "#/components/schemas/ResponseCyberArkCredDetails" + }, + { + "$ref": "#/components/schemas/ResponseHashiCorpCredDetails" + } + ] + }, + "ResponseCyberArkCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkDetailsRequiredProp" + } + ] + }, + "ResponseCyberArkDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkConfiguration" + } + ] + }, + "ResponseHashiCorpCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpDetailsRequiredProp" + } + ] + }, + "ResponseHashiCorpDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpConfiguration" + } + ] + }, + "Role1": { + "enum": [ + "SYSTEM_ADMIN", + "OUTAGE_DETECTION_PLATFORM_ADMIN", + "OUTAGE_DETECTION_PKI_ADMIN", + "OUTAGE_DETECTION_RESOURCE_OWNER", + "OUTAGE_DETECTION_GUEST" + ], + "type": "string" + }, + "Role2": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "RolesRequest": { + "properties": { + "roles": { + "additionalProperties": { + "$ref": "#/components/schemas/Role2" + }, + "type": "object" + }, + "systemAdmin": { + "type": "boolean" + } + }, + "type": "object" + }, + "SSOStatus": { + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "SansInformation": { + "description": "Subject alternative names", + "properties": { + "dnsNames": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "ipAddresses": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "rfc822Names": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "uniformResourceIdentifiers": { + "$ref": "#/components/schemas/PropertyInformation" + } + }, + "type": "object" + }, + "ScanafiConfigResponseV1": { + "properties": { + "id": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/MetadataInformation" + }, + "provider": { + "$ref": "#/components/schemas/ProviderInformation" + } + }, + "type": "object" + }, + "SchedulerPatternInformation1": { + "description": "Determines schedule pattern (e.g., days of the week, recurrence time).", + "discriminator": { + "propertyName": "recurrenceType" + }, + "properties": { + "recurrenceType": { + "type": "string" + } + }, + "required": [ + "recurrenceType" + ], + "type": "object" + }, + "SchedulerPatternInformation2": { + "discriminator": { + "mapping": { + "DAY": "#/components/schemas/DailyPatternInformation", + "WEEK": "#/components/schemas/WeeklyPatternInformation" + }, + "propertyName": "recurrenceType" + }, + "properties": { + "recurrenceType": { + "type": "string" + } + }, + "required": [ + "recurrenceType" + ], + "type": "object" + }, + "SchedulerPatternInformation3": { + "discriminator": { + "propertyName": "recurrenceType" + }, + "properties": { + "recurrenceType": { + "type": "string" + } + }, + "required": [ + "recurrenceType" + ], + "type": "object" + }, + "Scope": { + "description": "The service account authorization scopes", + "example": "distributed-issuance", + "type": "string" + }, + "ScopeDetails": { + "description": "The service account authorization scopes detailed", + "example": { + "authenticationType": "rsaKey", + "id": "distributed-issuance", + "readableName": "Distributed Issuance" + }, + "properties": { + "authenticationType": { + "description": "Type of authentication used in the scope", + "type": "string" + }, + "id": { + "description": "ID for the given scope", + "type": "string" + }, + "readableName": { + "description": "User friendly name for the scope", + "type": "string" + } + }, + "required": [ + "id", + "readableName" + ], + "type": "object" + }, + "ServiceAccountBaseObject": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccountBaseObjectNoKey" + }, + { + "properties": { + "publicKey": { + "description": "The client generated public key", + "maxLength": 2000, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "ServiceAccountBaseObjectNoKey": { + "properties": { + "applications": { + "description": "The list of applications for which the account is authorized", + "example": [ + "dc96438b-7a80-464b-a09b-9e5ec746c3e3", + "5bce5ff4-a69b-4e78-9b7e-6d4029995000" + ], + "items": { + "$ref": "#/components/schemas/Application" + }, + "type": "array", + "uniqueItems": true + }, + "audience": { + "description": "The intended audience or recipients of the entity", + "example": "Audience", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "authenticationType": { + "description": "Type of authentication used in the scope. Currently supporting two types rsaKey and ociToken", + "example": "rsaKey", + "type": "string" + }, + "companyId": { + "description": "The UUID of the company/tenant", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "credentialLifetime": { + "description": "The number of days for which the credentials will be valid before expiring and requiring renewal", + "example": 365, + "maximum": 365, + "minimum": 1, + "type": "integer" + }, + "issuerURL": { + "description": "The URL of the entity issuer, providing the source or origin", + "example": "https://accounts.google.com/", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "jwksURI": { + "description": "The URI pointing to the JSON Web Key Set (JWKS) for the entity, facilitating secure authentication", + "example": "https://www.googleapis.com/oauth2/v3/certs", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "User friendly name for the given account", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "owner": { + "description": "The UUID of the owning team", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "scopes": { + "description": "The list of scopes for which the account is authorized", + "example": [ + "distributed-issuance" + ], + "items": { + "$ref": "#/components/schemas/Scope" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "subject": { + "description": "The subject of the entity, representing the main topic or title.", + "example": "Subject", + "maxLength": 250, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ServiceAccountBasePatchObjectNoKey": { + "properties": { + "applications": { + "description": "The list of applications for which the account is authorized", + "example": [ + "dc96438b-7a80-464b-a09b-9e5ec746c3e3", + "5bce5ff4-a69b-4e78-9b7e-6d4029995000" + ], + "items": { + "$ref": "#/components/schemas/Application" + }, + "type": "array", + "uniqueItems": true + }, + "audience": { + "description": "The intended audience or recipients of the entity", + "example": "Audience", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "credentialLifetime": { + "description": "The number of days for which the credentials will be valid before expiring and requiring renewal", + "maximum": 365, + "minimum": 1, + "type": "integer" + }, + "issuerURL": { + "description": "The URL of the entity issuer, providing the source or origin", + "example": "https://accounts.google.com/", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "jwksURI": { + "description": "The URI pointing to the JSON Web Key Set (JWKS) for the entity, facilitating secure authentication", + "example": "https://www.googleapis.com/oauth2/v3/certs", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "User friendly name for the given account", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "owner": { + "description": "The UUID of the owning team", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "scopes": { + "description": "The list of scopes for which the account is authorized", + "items": { + "$ref": "#/components/schemas/Scope" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "subject": { + "description": "The subject of the entity, representing the main topic or title.", + "example": "Subject", + "maxLength": 250, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ServiceAccountDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccountBaseObject" + }, + { + "$ref": "#/components/schemas/Details" + } + ] + }, + "ServiceAccountDetailsNoKey": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccountBaseObjectNoKey" + }, + { + "$ref": "#/components/schemas/Details" + } + ], + "example": { + "authenticationType": "rsaKey", + "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", + "credentialLifetime": 365, + "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", + "enabled": true, + "id": "933507dd-0286-11ef-bc25-8a00a468403f", + "name": "Service Account I", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "scopes": [ + "distributed-issuance" + ], + "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", + "updatedOn": "2024-01-01T00:00:00.000000Z" + } + }, + "ServiceAccountInformation": { + "properties": { + "applications": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "applicationsAdded": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "applicationsRemoved": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "authType": { + "type": "string" + }, + "authenticationType": { + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "name": { + "type": "string" + }, + "owner": { + "format": "uuid", + "type": "string" + }, + "ownership": { + "additionalProperties": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "serviceAccount": { + "type": "boolean" + }, + "tenantId": { + "format": "uuid", + "type": "string" + }, + "userAccount": { + "type": "boolean" + } + }, + "type": "object" + }, + "ServiceAccountPatchBaseObject": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccountBasePatchObjectNoKey" + }, + { + "properties": { + "publicKey": { + "description": "The client generated public key", + "maxLength": 2000, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "StatusResponse": { + "description": "Details about the current in-progress certificate auto-renewal process, and the most recently completed process.", + "properties": { + "current": { + "$ref": "#/components/schemas/StatusResponseItem" + }, + "previous": { + "$ref": "#/components/schemas/StatusResponseItem" + } + }, + "required": [ + "current" + ], + "type": "object" + }, + "StatusResponseItem": { + "description": "Details about the upcoming certificate auto-renewal run.", + "example": { + "applications": 13, + "certificates": { + "eligible": 47, + "renewal": { + "failed": 1, + "successful": 9, + "triggered": 3 + } + }, + "state": "running", + "timestamp": "2023-08-25T20:59:36.688019837Z" + }, + "properties": { + "applications": { + "description": "The number of applications that have auto-renewal enabled.", + "example": 13, + "format": "int64", + "type": "integer" + }, + "certificates": { + "description": "A set of statistics related to the certificates that were included in the auto-renewal process.", + "example": { + "eligible": 47, + "renewal": { + "failed": 1, + "successful": 9, + "triggered": 3 + } + }, + "properties": { + "eligible": { + "description": "The number of certificates that belong to an application that has auto-renewal enabled.", + "format": "int64", + "type": "integer" + }, + "renewal": { + "properties": { + "failed": { + "description": "The number of certificates for which renewal failed", + "format": "int64", + "type": "integer" + }, + "successful": { + "description": "The number of certificates for which renewal completed successfully", + "format": "int64", + "type": "integer" + }, + "triggered": { + "description": "The number of certificates for which the renewal has been started", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "triggered", + "successful", + "failed" + ], + "type": "object" + } + }, + "required": [ + "eligible", + "renewal" + ], + "type": "object" + }, + "state": { + "description": "A string representing the status of a specific run of the auto-renewal process.", + "enum": [ + "pending", + "triggered", + "running", + "complete", + "awaiting results", + "no enabled apps", + "no automated keypair service active", + "failure" + ], + "example": "running", + "type": "string" + }, + "timestamp": { + "description": "The date and time when certificate auto-renewal is estimated to begin.", + "example": "2023-08-25T20:59:36.688019837Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "timestamp", + "state", + "applications", + "certificates" + ], + "type": "object" + }, + "StatusType": { + "properties": { + "family": { + "enum": [ + "INFORMATIONAL", + "SUCCESSFUL", + "REDIRECTION", + "CLIENT_ERROR", + "SERVER_ERROR", + "OTHER" + ], + "type": "string" + }, + "reasonPhrase": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SubCaProviderCreateRequest": { + "properties": { + "caAccountId": { + "description": "UUID of the CA account used by this Sub CA provider", + "example": "4ece3180-b1e0-11ed-862d-ad36b18e787a", + "format": "uuid", + "type": "string" + }, + "caProductOptionId": { + "description": "UUID of the CA product option used by this Sub CA provider", + "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", + "format": "uuid", + "type": "string" + }, + "caType": { + "description": "Type of CA this Sub CA provider works with", + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP" + ], + "example": "BUILTIN", + "type": "string" + }, + "commonName": { + "description": "Common name", + "example": "example.com", + "maxLength": 64, + "type": "string" + }, + "country": { + "description": "Country", + "example": "US", + "maxLength": 64, + "type": "string" + }, + "keyAlgorithm": { + "description": "Key algorithm type", + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "example": "EC_P256", + "type": "string" + }, + "locality": { + "description": "Locality", + "example": "San Antonio", + "maxLength": 64, + "type": "string" + }, + "name": { + "description": "Name of the Sub CA provider", + "example": "Some Sub CA provider", + "maxLength": 64, + "type": "string" + }, + "organization": { + "description": "Organization", + "example": "Some organization", + "maxLength": 64, + "type": "string" + }, + "organizationalUnit": { + "description": "Organizational unit", + "example": "Some organizational unit", + "maxLength": 64, + "type": "string" + }, + "pkcs11": { + "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" + }, + "stateOrProvince": { + "description": "State or province", + "example": "Texas", + "maxLength": 64, + "type": "string" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "required": [ + "caAccountId", + "caProductOptionId", + "caType", + "commonName", + "keyAlgorithm", + "name", + "validityPeriod" + ], + "type": "object" + }, + "SubCaProviderDeleteResponse": { + "properties": { + "id": { + "description": "UUID of the Sub CA provider", + "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the Sub CA provider", + "example": "Some Sub CA", + "type": "string" + } + }, + "type": "object" + }, + "SubCaProviderInformation": { + "properties": { + "caAccountId": { + "description": "UUID of the CA account used by this Sub CA provider", + "example": "4ece3180-b1e0-11ed-862d-ad36b18e787a", + "format": "uuid", + "type": "string" + }, + "caProductOptionId": { + "description": "UUID of the CA product option used by this Sub CA provider", + "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", + "format": "uuid", + "type": "string" + }, + "caType": { + "description": "Type of CA this Sub CA provider works with", + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP" + ], + "example": "BUILTIN", + "type": "string" + }, + "commonName": { + "description": "Common name", + "example": "example.com", + "type": "string" + }, + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "country": { + "description": "Country", + "example": "US", + "type": "string" + }, + "creationDate": { + "description": "When the Sub CA provider was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "id": { + "description": "UUID of the Sub CA provider", + "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "format": "uuid", + "type": "string" + }, + "keyAlgorithm": { + "description": "Key algorithm type", + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "example": "EC_P256", + "type": "string" + }, + "locality": { + "description": "Locality", + "example": "San Antonio", + "type": "string" + }, + "modificationDate": { + "description": "When the Sub CA provider was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" + }, + "name": { + "description": "Name of the Sub CA provider", + "example": "Some Sub CA provider", + "type": "string" + }, + "organization": { + "description": "Organization", + "example": "Some organization", + "type": "string" + }, + "organizationalUnit": { + "description": "Organizational unit", + "example": "Some organizational unit", + "type": "string" + }, + "pkcs11": { + "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" + }, + "stateOrProvince": { + "description": "State or province", + "example": "Texas", + "type": "string" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "type": "object" + }, + "SubCaProviderPkcs11ConfigurationInformation": { + "properties": { + "allowedClientLibraries": { + "description": "A collection of strings each of which represents SHA256 hash of an allowed HSM client library", + "example": [ + "c34d199f2e30bb679cd9b8533b99975465aefe8b023be1b37972f1ab43ab7b2d" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "partitionLabel": { + "description": "HSM Partition Label", + "example": "workload-identity-manager-hsm-partition", + "type": "string" + }, + "partitionSerialNumber": { + "description": "HSM Partition Serial Number", + "example": "1444210958933", + "pattern": "^[A-Fa-fx0-9]{0,18}$", + "type": "string" + }, + "pin": { + "description": "HSM PIN", + "example": "1234", + "type": "string", + "writeOnly": true + }, + "signingEnabled": { + "description": "Indicates whether HSM signing is enabled or not", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "SubCaProviderResponse": { + "properties": { + "subCaProviders": { + "items": { + "$ref": "#/components/schemas/SubCaProviderInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubCaProviderUpdateRequest": { + "properties": { + "caProductOptionId": { + "description": "UUID of the CA product option used by this Sub CA provider", + "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", + "format": "uuid", + "type": "string" + }, + "commonName": { + "description": "Common name", + "example": "example.com", + "maxLength": 64, + "type": "string" + }, + "country": { + "description": "Country", + "example": "US", + "maxLength": 64, + "type": "string" + }, + "keyAlgorithm": { + "description": "Key algorithm type", + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "example": "EC_P256", + "type": "string" + }, + "locality": { + "description": "Locality", + "example": "San Antonio", + "maxLength": 64, + "type": "string" + }, + "name": { + "description": "Name of the Sub CA provider", + "example": "Some Sub CA", + "maxLength": 64, + "type": "string" + }, + "organization": { + "description": "Organization", + "example": "Some organization", + "maxLength": 64, + "type": "string" + }, + "organizationalUnit": { + "description": "Organizational unit", + "example": "Some organizational unit", + "maxLength": 64, + "type": "string" + }, + "pkcs11": { + "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" + }, + "stateOrProvince": { + "description": "State or province", + "example": "Texas", + "maxLength": 64, + "type": "string" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "type": "object" + }, + "SubjectAlternativeNamesByType": { + "properties": { + "dnsNames": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ipAddresses": { + "items": { + "type": "string" + }, + "type": "array" + }, + "rfc822Names": { + "items": { + "type": "string" + }, + "type": "array" + }, + "uniformResourceIdentifiers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubjectAttributesInformation": { + "description": "Subject attributes", + "properties": { + "commonName": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "country": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "locality": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "organization": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "organizationalUnit": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "stateOrProvince": { + "$ref": "#/components/schemas/PropertyInformation" + } + }, + "type": "object" + }, + "SystemRole": { + "enum": [ + "SYSTEM_ADMIN", + "CONDOR_METRICS" + ], + "type": "string" + }, + "TagAssignmentErrorInformation": { + "description": "Error information for tags not assigned", + "example": { + "errorInformation": { + "message": "not assigned", + "statusCode": 1111 + } + }, + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue8" + }, + "type": "array" + }, + "message": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TagInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "UUID of the tag", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "isReserved": { + "description": "Used by Venafi to reserve system tags", + "example": false, + "type": "boolean" + }, + "key": { + "description": "Same as tag name, though all lowercase", + "example": "application", + "type": "string" + }, + "name": { + "description": "Name of the tag", + "example": "Application", + "type": "string" + } + }, + "type": "object" + }, + "TagRequest": { + "description": "Array of tag and tag-value objects", + "properties": { + "name": { + "description": "Name of the tag", + "example": "Application", + "minLength": 1, + "type": "string" + }, + "values": { + "description": "Array of values associated with the tag", + "example": [ + "TLS Protect", + "Jetstack" + ], + "items": { + "description": "Array of values associated with the tag", + "example": "[\"TLS Protect\",\"Jetstack\"]", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "TagResponse": { + "properties": { + "count": { + "description": "Number of tags returned", + "example": 7, + "format": "int32", + "type": "integer" + }, + "tags": { + "items": { + "$ref": "#/components/schemas/TagInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "TagValueInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "The ID of the value", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "tagId": { + "description": "The ID of the tag the value applies to", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "value": { + "description": "Name of the value", + "example": "TLS Protect", + "type": "string" + } + }, + "type": "object" + }, + "TagValuesRequest": { + "properties": { + "values": { + "description": "Array of value names to associate with the tag", + "items": { + "description": "Array of value names to associate with the tag", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "values" + ], + "type": "object" + }, + "TagValuesResponse": { + "properties": { + "count": { + "description": "Number of values returned", + "example": 7, + "format": "int32", + "type": "integer" + }, + "values": { + "items": { + "$ref": "#/components/schemas/TagValueInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "TagsAndValuesInformation": { + "properties": { + "tag": { + "$ref": "#/components/schemas/TagInformation" + }, + "values": { + "items": { + "$ref": "#/components/schemas/TagValueInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "TagsAndValuesResponse": { + "properties": { + "tagsAndValues": { + "items": { + "$ref": "#/components/schemas/TagsAndValuesInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "TagsAssignRequest": { + "properties": { + "action": { + "description": "Action to perform", + "enum": [ + "REPLACE", + "ADD", + "DELETE", + "DELETE_ALL" + ], + "example": "REPLACE", + "type": "string" + }, + "entityIds": { + "description": "Array of UUIDs of the objects", + "example": [ + "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" + ], + "items": { + "description": "Array of UUIDs of the objects", + "format": "uuid", + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "entityType": { + "description": "Object type that the tag applies to", + "enum": [ + "CERTIFICATE", + "CERTIFICATE_INSTANCE", + "APPLICATION" + ], + "example": "CERTIFICATE", + "type": "string" + }, + "targetedTags": { + "description": "Array of tags to apply", + "example": [ + "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" + ], + "items": { + "description": "Array of tags to apply", + "example": "[\"265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "entityIds" + ], + "type": "object" + }, + "TagsAssignResponse": { + "properties": { + "tagsAssignInformation": { + "items": { + "$ref": "#/components/schemas/TagsAssignResponseInformation" + }, + "type": "array" + } + }, + "type": "object" + }, + "TagsAssignResponseInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date when the assignment is created", + "example": "2023-01-30T16:28:53.166Z", + "format": "date-time", + "type": "string" + }, + "entityId": { + "description": "UUID of the object", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "entityType": { + "description": "Object type that the tag applies to", + "example": "CERTIFICATE", + "type": "string" + }, + "errorInformation": { + "$ref": "#/components/schemas/TagAssignmentErrorInformation" + }, + "modificationDate": { + "description": "The date when the assignment is last modified", + "example": "2023-01-30T16:28:53.166Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "Status of the assigned entity", + "example": "ASSIGNED", + "type": "string" + }, + "tags": { + "description": "The tags that are assigned", + "example": [ + "Application:TLS" + ], + "items": { + "description": "The tags that are assigned", + "example": "[\"Application:TLS\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "TagsAssignmentAggregatesRequest": { + "properties": { + "entityType": { + "description": "Object type that the tag applies to. If null, get all object types", + "enum": [ + "CERTIFICATE", + "CERTIFICATE_INSTANCE", + "APPLICATION" + ], + "example": "CERTIFICATE", + "type": "string" + }, + "tags": { + "description": "Array of tags", + "example": [ + "TAG", + "Tag:Value" + ], + "items": { + "description": "Array of tags", + "example": "[\"TAG\",\"Tag:Value\"]", + "type": "string" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "tags" + ], + "type": "object" + }, + "TagsAssignmentAggregatesResponse": { + "properties": { + "aggregates": { + "additionalProperties": { + "description": "Represents a mapping of tag name to list of aggregates information", + "example": { + "TagNew": [ + { + "count": 2, + "entityType": "CERTIFICATE" + }, + { + "count": 5, + "entityType": "APPLICATION" + } + ], + "tag:value": [ + { + "count": 6, + "entityType": "CERTIFICATE" + }, + { + "count": 1, + "entityType": "APPLICATION" + } + ] + }, + "items": { + "$ref": "#/components/schemas/TagsAssignmentAggregatesResponseInformation" + }, + "type": "array" + }, + "description": "Represents a mapping of tag name to list of aggregates information", + "example": { + "TagNew": [ + { + "count": 2, + "entityType": "CERTIFICATE" + }, + { + "count": 5, + "entityType": "APPLICATION" + } + ], + "tag:value": [ + { + "count": 6, + "entityType": "CERTIFICATE" + }, + { + "count": 1, + "entityType": "APPLICATION" + } + ] + }, + "type": "object" + } + }, + "type": "object" + }, + "TagsAssignmentAggregatesResponseInformation": { + "description": "Represents a mapping of tag name to list of aggregates information", + "example": { + "TagNew": [ + { + "count": 2, + "entityType": "CERTIFICATE" + }, + { + "count": 5, + "entityType": "APPLICATION" + } + ], + "tag:value": [ + { + "count": 6, + "entityType": "CERTIFICATE" + }, + { + "count": 1, + "entityType": "APPLICATION" + } + ] + }, + "properties": { + "count": { + "description": "Number of entities per type", + "example": 2, + "format": "int32", + "type": "integer" + }, + "entityType": { + "description": "Object type that the tag applies to", + "example": "CERTIFICATE", + "type": "string" + } + }, + "type": "object" + }, + "TagsBulkRequest": { + "properties": { + "tags": { + "description": "Array of tag and tag-value objects", + "items": { + "$ref": "#/components/schemas/TagRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "Target": { + "properties": { + "connection": { + "description": "JSON object that configures the webhook connection for this target.\nSupported fields:\n- `url` (string, required): HTTPS endpoint URL for the webhook.\n- `headers` (object, optional): Key/value pairs of HTTP headers. Only the `Authorization` header is honored by the webhook service; all other headers are ignored.\n- `secret` (string, optional): Shared secret used to generate an HMAC signature sent in the `VaaS-Signature` header.\nWebhook deliveries always use `Content-Type: application/json`. Custom `Content-Type` values are not supported.\nExample:\n ```json\n{\n\"url\": \"https://example.com/webhook\",\n\"headers\": {\n\"Authorization\": \"Splunk 12345678-ABCD\"\n},\n\"secret\": \"my-shared-secret\"\n }\n", + "format": "json", + "type": "string" + }, + "type": { + "description": "The delivery mechanism for this connector. For webhook-based notifications, use:\n- `generic` for a standard HTTPS webhook endpoint\n- `slack` for a Slack webhook target\n- `teams` for a Microsoft Teams webhook target\n", + "enum": [ + "generic", + "slack", + "teams" + ], + "type": "string" + } + }, + "required": [ + "connection", + "type" + ], + "type": "object" + }, + "TargetsInformation": { + "description": "This object contains service type and ports.", + "discriminator": { + "propertyName": "serviceType" + }, + "properties": { + "serviceType": { + "type": "string" + } + }, + "required": [ + "serviceType" + ], + "type": "object" + }, + "TeamId": { + "description": "The ID of a team.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "TeamInformation1": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "members": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "name": { + "type": "string" + }, + "owners": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ownership": { + "additionalProperties": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "productRoles": { + "additionalProperties": { + "items": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "systemRoles": { + "items": { + "enum": [ + "SYSTEM_ADMIN", + "CONDOR_METRICS" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "TeamInformation2": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "members": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "owners": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "productRoles": { + "additionalProperties": { + "items": { + "$ref": "#/components/schemas/Role2" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "role": { + "$ref": "#/components/schemas/TeamRole" + }, + "systemRoles": { + "items": { + "$ref": "#/components/schemas/SystemRole" + }, + "type": "array", + "uniqueItems": true + }, + "userMatchingRules": { + "items": { + "$ref": "#/components/schemas/UserMatchingRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "TeamMembersRequest": { + "properties": { + "members": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "members" + ], + "type": "object" + }, + "TeamOwnersRequest": { + "properties": { + "owners": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "owners" + ], + "type": "object" + }, + "TeamRole": { + "enum": [ + "SYSTEM_ADMIN", + "PKI_ADMIN", + "RESOURCE_OWNER", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "TeamsIds": { + "description": "The ID's of teams.", + "items": { + "$ref": "#/components/schemas/TeamId" + }, + "type": "array", + "uniqueItems": true + }, + "TeamsResponse": { + "properties": { + "teams": { + "items": { + "$ref": "#/components/schemas/TeamInformation2" + }, + "type": "array" + } + }, + "type": "object" + }, + "TenantExpirationNotificationConfiguration": { + "properties": { + "additionalRecipients": { + "description": "A list of users and/or teams who should be added as recipients.", + "example": [ + { + "id": "22153ae0-4352-11ee-b95c-3531a284802b", + "type": "User" + }, + { + "id": "22153ae0-4352-11ee-b95c-12345abcd123", + "type": "Team" + } + ], + "items": { + "$ref": "#/components/schemas/Recipient" + }, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "A list of channels that should be used to deliver the notification.", + "example": [ + "email" + ], + "items": { + "$ref": "#/components/schemas/Channel" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "enabled": { + "description": "If true, then the system will send notification for certificates which are nearing expiration.", + "example": true, + "type": "boolean" + }, + "fallbackToPKIAdmin": { + "description": "If true, then all users with the PKI admin role will be added as recipients if the persona list does not include any recipients for a specific certificate.", + "example": true, + "type": "boolean" + }, + "includeCertificateDetails": { + "description": "If true, then the notification may include potentially sensitive details about the certificate that is nearing expiration.", + "example": true, + "type": "boolean" + }, + "personas": { + "description": "A list of personas who should be recipients of the notification. If \"Application Owners\" is included then the owners of the Application object to which the certificate is assigned will be added as recipients. If \"All PKI Admins\" or \"All Admins\" are present then all users in the system with that role will be added as recipients.", + "example": [ + "Application Owners", + "All PKI Admins" + ], + "items": { + "$ref": "#/components/schemas/Persona" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "TenantExpirationReportsConfiguration": { + "properties": { + "additionalRecipients": { + "description": "A list of users and/or teams who should be added as recipients.", + "example": [ + { + "id": "22153ae0-4352-11ee-b95c-3531a284802b", + "type": "User" + }, + { + "id": "22153ae0-4352-11ee-b95c-12345abcd123", + "type": "Team" + } + ], + "items": { + "$ref": "#/components/schemas/Recipient" + }, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "A list of channels that should be used to deliver the notification.", + "example": [ + "email" + ], + "items": { + "$ref": "#/components/schemas/Channel" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "enabled": { + "description": "If true, then the system will send reports providing details of certificates which are nearing expiration.", + "example": true, + "type": "boolean" + }, + "expiringWithinDays": { + "description": "Any certificates which will expire within the number of days specified here will be included in the report.", + "example": 30, + "type": "integer" + }, + "ignoreAfterDays": { + "description": "Any certificates which have expired for more than the specified days will be excluded in the report.", + "example": 30, + "type": "integer" + }, + "roles": { + "description": "All users with the specified VaaS roles will be added as a report recipient.", + "example": [ + "SYSTEM_ADMIN" + ], + "items": { + "$ref": "#/components/schemas/Role1" + }, + "type": "array", + "uniqueItems": true + }, + "schedule": { + "description": "A cron string representing the desired schedule for delivering reports. Note that currently reports may not be sent more than once per day. The `hour` and `minute` fields of the cron schedule will be ignored.", + "example": "0 0 * * Mon", + "type": "string" + } + }, + "type": "object" + }, + "TenantRenewalConfiguration": { + "properties": { + "id": { + "description": "The object ID", + "example": "12a05220-4352-11ee-ac28-c1379e5decf9", + "format": "UUID", + "type": "string" + }, + "renewalWindow": { + "description": "A set of options to control the time window in which auto-renewal of certificates should be attempted.", + "example": { + "days": 30 + }, + "properties": { + "days": { + "description": "Any certificates associated with this object that are expected to expire within the specified number of days will be acted on.", + "format": "int64", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "days" + ], + "type": "object" + } + }, + "required": [ + "id", + "renewalWindow" + ], + "type": "object" + }, + "TestCMSConfigurationRequest": { + "description": "The information representing a Credential Manager Service configuration for test purposes.", + "properties": { + "cmsDetails": { + "$ref": "#/components/schemas/TestCMSDetails" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "id": { + "$ref": "#/components/schemas/CMSConfId" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "vSatelliteIds": { + "$ref": "#/components/schemas/VSatelliteIds" + }, + "wsClientId": { + "description": "An ID where you can subscribe to receive the response of the workflow.", + "type": "string" + } + }, + "required": [ + "wsClientId" + ], + "type": "object" + }, + "TestCMSConfigurationResponse": { + "description": "The result of testing the Credential Manager Service configuration.", + "properties": { + "workflowId": { + "format": "uuid", + "type": "string" + }, + "workflowName": { + "type": "string" + } + }, + "required": [ + "workflowId", + "workflowName" + ], + "type": "object" + }, + "TestCMSDetails": { + "oneOf": [ + { + "$ref": "#/components/schemas/TestCyberArkDetails" + }, + { + "$ref": "#/components/schemas/TestHashiCorpDetails" + } + ] + }, + "TestCredentialDetails": { + "oneOf": [ + { + "$ref": "#/components/schemas/TestCyberArkCredDetails" + }, + { + "$ref": "#/components/schemas/TestHashiCorpCredDetails" + } + ] + }, + "TestCredentialRequest": { + "description": "The properties representing a credential to test.", + "properties": { + "authType": { + "$ref": "#/components/schemas/AuthType" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "credentialDetails": { + "$ref": "#/components/schemas/TestCredentialDetails" + }, + "id": { + "$ref": "#/components/schemas/CredentialId" + }, + "wsClientId": { + "description": "An ID where you can subscribe to receive the response of the workflow.", + "type": "string" + } + }, + "required": [ + "wsClientId" + ], + "type": "object" + }, + "TestCredentialResponse": { + "description": "The result of testing access to the credential.", + "properties": { + "workflowId": { + "format": "uuid", + "type": "string" + }, + "workflowName": { + "type": "string" + } + }, + "required": [ + "workflowId", + "workflowName" + ], + "type": "object" + }, + "TestCyberArkCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkDetails" + } + ] + }, + "TestCyberArkDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkConfigurationRequiredProp" + } + ] + }, + "TestHashiCorpCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpDetails" + } + ] + }, + "TestHashiCorpDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpConfigurationRequiredProp" + } + ] + }, + "TrackingDataInformation": { + "discriminator": { + "propertyName": "certificateAuthority" + }, + "properties": { + "certificateAuthority": { + "type": "string" + } + }, + "required": [ + "certificateAuthority" + ], + "type": "object" + }, + "UnaryOperator": { + "description": "An operator for filtering", + "enum": [ + "NOT" + ], + "example": "NOT", + "type": "string" + }, + "UpdateCMSConfigurationRequest": { + "description": "The information representing a Credential Manager Service configuration for update.", + "properties": { + "cmsDetails": { + "$ref": "#/components/schemas/UpdateCMSDetails" + }, + "id": { + "$ref": "#/components/schemas/CMSConfId" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "vSatelliteIds": { + "$ref": "#/components/schemas/VSatelliteIds" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "UpdateCMSDetails": { + "oneOf": [ + { + "$ref": "#/components/schemas/UpdateCyberArkDetails" + }, + { + "$ref": "#/components/schemas/UpdateHashiCorpDetails" + } + ] + }, + "UpdateCredentialDetails": { + "oneOf": [ + { + "$ref": "#/components/schemas/UpdateCyberArkCredDetails" + }, + { + "$ref": "#/components/schemas/UpdateHashiCorpCredDetails" + } + ] + }, + "UpdateCredentialRequest": { + "description": "The properties representing a credential to update.", + "properties": { + "cmsConfigId": { + "$ref": "#/components/schemas/CMSConfId" + }, + "credentialDetails": { + "$ref": "#/components/schemas/UpdateCredentialDetails" + }, + "id": { + "$ref": "#/components/schemas/CredentialId" + }, + "name": { + "$ref": "#/components/schemas/CredentialName" + }, + "teamsIds": { + "$ref": "#/components/schemas/TeamsIds" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "UpdateCyberArkCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkDetails" + } + ] + }, + "UpdateCyberArkDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkConfiguration" + } + ] + }, + "UpdateHashiCorpCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpDetails" + } + ] + }, + "UpdateHashiCorpDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpConfiguration" + } + ] + }, + "UpdateTeamRequest": { + "properties": { + "name": { + "maxLength": 100, + "type": "string" + }, + "role": { + "$ref": "#/components/schemas/TeamRole" + }, + "userMatchingRules": { + "items": { + "$ref": "#/components/schemas/UserMatchingRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "UpdatesConfigRequest": { + "properties": { + "updateConfigSchedulerPattern": { + "oneOf": [ + { + "$ref": "#/components/schemas/DailyPatternInformation" + }, + { + "$ref": "#/components/schemas/WeeklyPatternInformation" + } + ], + "type": "object" + } + }, + "required": [ + "updateConfigSchedulerPattern" + ], + "type": "object" + }, + "UpdatesConfigResponse": { + "properties": { + "updateConfigSchedulerPattern": { + "oneOf": [ + { + "$ref": "#/components/schemas/DailyPatternInformation" + }, + { + "$ref": "#/components/schemas/WeeklyPatternInformation" + } + ], + "type": "object" + } + }, + "type": "object" + }, + "UpgradeStatus": { + "enum": [ + "LATEST", + "UPGRADE_PENDING", + "UPGRADING", + "FAILED" + ], + "type": "string" + }, + "UriBuilder": { + "type": "object" + }, + "UserAccountResponse": { + "properties": { + "apiKey": { + "$ref": "#/components/schemas/ApiKeyInformation" + }, + "company": { + "$ref": "#/components/schemas/CompanyInformation" + }, + "user": { + "$ref": "#/components/schemas/UserInformation2" + } + }, + "type": "object" + }, + "UserAccountType": { + "enum": [ + "WEB_UI", + "API" + ], + "type": "string" + }, + "UserAccountTypeRequest": { + "properties": { + "accountType": { + "$ref": "#/components/schemas/UserAccountType" + } + }, + "required": [ + "accountType" + ], + "type": "object" + }, + "UserForceLocalPasswordExpirationRequest": { + "properties": { + "forceLocalPasswordExpiration": { + "type": "boolean" + } + }, + "required": [ + "forceLocalPasswordExpiration" + ], + "type": "object" + }, + "UserInformation1": { + "properties": { + "admin": { + "type": "boolean" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "firstname": { + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "lastname": { + "type": "string" + }, + "memberedTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ownedTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "productRoles": { + "additionalProperties": { + "items": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "resourceOwner": { + "type": "boolean" + }, + "serviceAccount": { + "type": "boolean" + }, + "systemRoles": { + "items": { + "enum": [ + "SYSTEM_ADMIN", + "CONDOR_METRICS" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "teamsIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "userAccountType": { + "type": "string" + }, + "userStatus": { + "type": "string" + }, + "userType": { + "type": "string" + }, + "username": { + "type": "string" + } + }, + "type": "object" + }, + "UserInformation2": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "emailAddress": { + "type": "string" + }, + "firstLoginDate": { + "format": "date-time", + "type": "string" + }, + "firstname": { + "type": "string" + }, + "forceLocalPasswordExpiration": { + "type": "boolean" + }, + "hasPassword": { + "type": "boolean" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "lastname": { + "type": "string" + }, + "localLoginDisabled": { + "type": "boolean" + }, + "memberedTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ownedTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "productRoles": { + "additionalProperties": { + "items": { + "$ref": "#/components/schemas/Role2" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "signupAttributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ssoStatus": { + "$ref": "#/components/schemas/SSOStatus" + }, + "systemRoles": { + "items": { + "$ref": "#/components/schemas/SystemRole" + }, + "type": "array", + "uniqueItems": true + }, + "userAccountType": { + "$ref": "#/components/schemas/UserAccountType" + }, + "userStatus": { + "$ref": "#/components/schemas/UserStatus" + }, + "userType": { + "$ref": "#/components/schemas/UserType" + }, + "username": { + "type": "string" + } + }, + "type": "object" + }, + "UserMatchingRule": { + "properties": { + "claimName": { + "minLength": 1, + "type": "string" + }, + "operator": { + "$ref": "#/components/schemas/Operator" + }, + "value": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "claimName", + "operator", + "value" + ], + "type": "object" + }, + "UserPasswordAuthenticationData": { + "properties": { + "password": { + "description": "The user's password of the underlying credentials provider.", + "format": "password", + "type": "string" + }, + "userName": { + "description": "The user's name of the underlying credentials provider.", + "type": "string" + } + }, + "type": "object" + }, + "UserResponse": { + "properties": { + "users": { + "items": { + "$ref": "#/components/schemas/UserInformation2" + }, + "type": "array" + } + }, + "type": "object" + }, + "UserStatus": { + "enum": [ + "PENDING_ACTIVATION", + "ACTIVE", + "INACTIVE" + ], + "type": "string" + }, + "UserType": { + "enum": [ + "EXTERNAL", + "INTERNAL" + ], + "type": "string" + }, + "VSatelliteId": { + "description": "The VSatellite ID", + "format": "uuid", + "type": "string" + }, + "VSatelliteIds": { + "description": "An array of the VSatellite Ids which are connected to the CMS provider.", + "items": { + "$ref": "#/components/schemas/VSatelliteId" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "VisibilityConstraintsInformation": { + "properties": { + "fullAccessDurationDays": { + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "limitedAccessNotificationDays": { + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "limitedVisibilityCertCount": { + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "limitedVisibilityCertInstallPerCertCount": { + "format": "int32", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "WebhookProperties": { + "description": "Connector properties for webhook-based notifications.\nWebhook notifications are delivered as HTTP POST requests with a JSON body structured as:\n```json\n{\n \"events\": [\n {\n \"eventName\": \"string\",\n \"eventType\": \"string\",\n \"message\": \"string\",\n \"criticality\": 0,\n \"createdAt\": \"2025-01-15T12:45:00Z\"\n }\n ]\n}\n```\nOnly one event is included per request. The webhook service sets `Content-Type: application/json`, `VaaS-Timestamp`, and, when a `secret` is configured in the connection, `VaaS-Signature`.\n", + "properties": { + "filter": { + "$ref": "#/components/schemas/Filter1" + }, + "target": { + "$ref": "#/components/schemas/Target" + } + }, + "required": [ + "filter", + "target" + ], + "type": "object" + }, + "WeeklyPatternInformation": { + "allOf": [ + { + "$ref": "#/components/schemas/SchedulerPatternInformation2" + }, + { + "properties": { + "daysOfWeek": { + "description": "Days of the week", + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "items": { + "description": "Days of the week", + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "duration": { + "description": "Duration in ISO-8601 format", + "enum": [ + "PT8H", + "PT12H", + "PT24H" + ], + "example": "PT24H", + "type": "string" + }, + "startTime": { + "description": "Start time in HH:mm:ss format", + "pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", + "type": "string" + } + }, + "type": "object" + } + ], + "required": [ + "daysOfWeek", + "duration", + "startTime" + ], + "type": "object" + }, + "WorkType": { + "description": "Defines the type of supported workflow for the plugin.", + "enum": [ + "DISCOVERY", + "CREDENTIAL", + "PROVISIONING", + "ISSUANCE", + "CERTIFICATE_IMPORT" + ], + "title": "WorkType", + "type": "string" + }, + "WorkerServiceStatusDetails": { + "properties": { + "name": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "type": "object" + }, + "WorkerStatus": { + "enum": [ + "DRAFT", + "PAIRED", + "ACTIVE", + "FAILED", + "INACTIVE" + ], + "type": "string" + } + }, + "securitySchemes": { + "tppl-api-key": { + "in": "header", + "name": "tppl-api-key", + "type": "apiKey" + } + } + }, + "info": { + "title": "TLS Protect Cloud API for Strata Cloud Manager", + "description": "Use the TLS Protect Cloud APIs to manage certificates, certificate requests, applications, machine identities, users, teams, event logs, and more.\nThis Open API spec was created for the Strata Cloud Manager platform. \u00a9 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.", + "version": "1.0.0", + "license": { + "name": "MIT", + "url": "https://opensource.org/license/mit" + } + }, + "openapi": "3.0.1", + "paths": { + "/outagedetection/v1/certificates": { + "get": { + "description": "This endpoint allows you to retrieve all your certificates according to a specified criteria. This API provides a quick way to gather certificate details in order to install the certificates where they are needed.\n\nUse the `subject` query parameter to limit the search based on the certificate subject common name.", + "operationId": "certificates_getAll", + "parameters": [ + { + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "excludeSupersededInstances", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Ability to enter regular expression to match specific criteria.", + "in": "query", + "name": "subject", + "schema": { + "type": "string" + } + }, + { + "description": "Indicates the maximum integer number of certificates returned.", + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "maximum": 10000, + "minimum": 1, + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + } + }, + "description": "Certificate(s) response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all certificate data", + "tags": [ + "Certificates" + ] + }, + "post": { + "description": "This endpoint allows you to import CA-issued certificates, and optionally include their intermediate and root certificates.", + "operationId": "certificateimports_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportRequest1" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportResponse1" + } + } + }, + "description": "Certificate imported." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Import certificates", + "tags": [ + "Certificate Import" + ] + } + }, + "/outagedetection/v1/certificates/{id}": { + "get": { + "description": "This endpoint retrieves certificate data using the **id** parameter to match a specified value.", + "operationId": "certificates_getById", + "parameters": [ + { + "description": "Displays list of **owningUsers**.", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "excludeSupersededInstances", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "A unique certificate id containing numbers, letters and dashes.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInformation" + } + } + }, + "description": "Certificate details matching specified **id**." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Certificate was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve certificate data via id", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/{id}/contents": { + "get": { + "description": "This endpoint downloads a certificate or a certificate chain in a specified format and chain order. This can be useful for troubleshoot purposes for a certificate or certificate chain. This endpoint does not download private key material.", + "operationId": "certificates_getContentsById", + "parameters": [ + { + "description": "Specify an 'accept' header parameter's value", + "in": "header", + "name": "Accept", + "schema": { + "enum": [ + "text/plain", + "application/octet-stream" + ], + "type": "string" + } + }, + { + "description": "A unique certificate id containing numbers, letters and dashes.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Indicates the export format. Default is `PEM`.", + "in": "query", + "name": "format", + "schema": { + "enum": [ + "PEM", + "DER" + ], + "type": "string" + } + }, + { + "description": "Determines order of certificate chain. Default is End Entity Only (`EE_ONLY`).", + "in": "query", + "name": "chainOrder", + "schema": { + "enum": [ + "EE_ONLY", + "EE_FIRST", + "ROOT_FIRST" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + }, + "application/octet-stream": { + "schema": { + "type": "string" + } + }, + "text/plain": { + "schema": { + "type": "string" + } + } + }, + "description": "Certificate details matching specified **id**." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Certificate was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Download certificate or certificate chain via", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/validation": { + "post": { + "description": "This endpoint allows you to submit one or more certificates for validation using the **certificateIds** parameter. After the validation completes, you can view the validation results in the web UI. See the [validation documentation](https://docs.venafi.cloud/CSH_validation_overview) for more information.", + "operationId": "certificates_validation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateValidationRequest" + } + } + } + }, + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateValidationResponse" + } + } + }, + "description": "Certificates submitted for validation response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Submit certificates for validation", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/retirement": { + "post": { + "description": "This endpoint retires one or more certificates using the **certificateIds** parameter to match a specified value.", + "operationId": "certificateretirement_retireCertificates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRetirementRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + } + }, + "description": "Certificate retirement response" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retire certificates", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/recovery": { + "post": { + "description": "This endpoint recovers previously retired certificates and assigns them to a specified application.", + "operationId": "certificateretirement_recoverCertificates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRecoveryRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + } + }, + "description": "Certificate recovery response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Recover retired certificates", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/deletion": { + "post": { + "description": "This endpoint deletes retired certificates using the **certificateIds** parameter to match a specific value.", + "operationId": "certificateretirement_deleteCertificates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateDeletionRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Response of \"No Content\" is a successful deletion of the certificate." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete retired certificates", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificatesearch": { + "post": { + "description": "This endpoint retrieves certificate data according to specified search criteria based on commonly used field search parameters. Some examples are `signatureHashAlgorithm`, `validityEnd`, and `issuerCN`. For more information, see [common search parameters](https://docs.venafi.cloud/api/about-api-search-fields/).\n", + "operationId": "certificates_search_getByExpression", + "parameters": [ + { + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "excludeSupersededInstances", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter2" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + } + }, + "description": "Certificate response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve certificate data matching search criteria", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificateinstances": { + "get": { + "description": "Use this endpoint allows you to retrieve certificate instances according to specified criteria. Total certificate instances are the sum of the number of certificate installations, plus the total number of certificates that have no installations. Trusted CA certificates are not counted. For more information, see [certificate instances](https://docs.venafi.cloud/CSH_view_instances).\n\nUse query parameters to limit your search based on certificate criteria.", + "operationId": "certificateinstances_getAll", + "parameters": [ + { + "in": "query", + "name": "source", + "schema": { + "enum": [ + "UNKNOWN", + "USER_PROVIDED", + "USER_IMPORTED", + "USER_SCAN", + "TRUSTNET_SCAN", + "ON_PREM_CA_IMPORT", + "EXTERNAL_CA_IMPORT", + "FILE_IMPORT", + "EXTERNAL_SCAN", + "DOMAIN_SCAN", + "SMART_SCAN_INTERNAL", + "SMART_SCAN_EXTERNAL", + "SMART_VALIDATION_INTERNAL", + "SMART_VALIDATION_EXTERNAL", + "MACHINE_DISCOVERY", + "KUBERNETES_DISCOVERY", + "AWS_DISCOVERY", + "AZURE_DISCOVERY", + "GCP_DISCOVERY" + ], + "type": "string" + } + }, + { + "in": "query", + "name": "ipAddress", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "hostname", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" + } + } + }, + "description": "Certificate response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Certificate Instances", + "tags": [ + "Certificate Installations" + ] + } + }, + "/outagedetection/v1/certificateinstances/{id}": { + "get": { + "description": "This endpoint retrieves a certificate instance using the **id** parameter to match a specified value.\n", + "operationId": "certificateinstances_getById", + "parameters": [ + { + "description": "A unique id containing numbers, letters and dashes. This parameter is listed as **certificateInstanceId** in the request and response.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceInformation" + } + } + }, + "description": "Certificate instances response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Certificate installation not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve certificate instance via id", + "tags": [ + "Certificate Installations" + ] + } + }, + "/outagedetection/v1/certificateinstances/validation": { + "post": { + "description": "This endpoint allows you to submit one or more certificate instances for validation using the **instanceIds** parameter. Why is certificate validation important? Because security, compliance, and technological innovations introduce new criteria for the validation of certificates and the servers that host them, Certificate Manager - SaaS uses validation techniques to ensure that your certificates remain valid and are being used properly.", + "operationId": "certificateinstances_validation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateInstanceValidationRequest" + } + } + }, + "required": true + }, + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Response" + } + } + }, + "description": "Response of \"Accepted\" is a successful submission of the certificate(s)." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Submit certificates for validation", + "tags": [ + "Certificate Installations" + ] + } + }, + "/outagedetection/v1/certificateinstancesearch": { + "post": { + "description": "Use this endpoint to retrieve certificate instance data according to specified search criteria based on commonly used field search parameters. Some examples are `signatureHashAlgorithm`, `validityEnd`, and `issuerCN`. For more information, see [common search parameters](https://docs.venafi.cloud/api/about-api-search-fields/#common-search-parameters)", + "operationId": "certificateinstances_search_getByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter2" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" + } + } + }, + "description": "Certificate Instances Response" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve certificate instance data matching search", + "tags": [ + "Certificate Installations" + ] + } + }, + "/v1/integrationservices": { + "get": { + "description": "This endpoint retrieves a list of all integration services, including certificate discovery services.", + "operationId": "integrationsservices_getAll", + "parameters": [ + { + "description": "This shows the total number of services.", + "in": "query", + "name": "totalCount", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "A unique id of a vSatellite in UUID format. Passing this id returns the services running on a given vSatellite.", + "in": "query", + "name": "edgeInstanceId", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceDetailsResponse" + } + } + }, + "description": "Integration Services matching the specified id." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all integration services", + "tags": [ + "Certificate Discovery" + ] + }, + "post": { + "description": "This endpoint creates a new integration service. Use this API to add services such as basic, enhanced, or internet discovery.", + "operationId": "integrationsservices_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceCreationRequest" + } + } + }, + "description": "Details of the service to be created", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceInformation" + } + } + }, + "description": "Integration service created." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create an integration service", + "tags": [ + "Certificate Discovery" + ] + } + }, + "/v1/integrationservices/{id}": { + "get": { + "description": "This endpoint retrieves an integration service using the id parameter to match a specified value. Use `/v1/integrationservices` to get the ids for integration services.", + "operationId": "integrationsservices_getById", + "parameters": [ + { + "description": "A unique integration service id in UUID format.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a service", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceInformation" + } + } + }, + "description": "Integration Services matching the specified id." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Integration service not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve an integration service via id", + "tags": [ + "Certificate Discovery" + ] + }, + "delete": { + "description": "This endpoint deletes an integration service using the id parameter to match a specified value.", + "operationId": "integrationsservices_delete", + "parameters": [ + { + "description": "A unique integration service id containing numbers, letters and dashes.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a service", + "format": "uuid", + "type": "string" + } + }, + { + "description": "Option to chose to retire the certificates discovered by this service. Default is **false**.", + "in": "query", + "name": "retireCertificates", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "204": { + "description": "Integration Service Deleted" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Integration service not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete an integration service", + "tags": [ + "Certificate Discovery" + ] + }, + "patch": { + "description": "This endpoint is used to update specific fields in an integration service. Only the fields that are specified in the request will be updated. Leaving the **edgeInstancesIds** parameter value empty will dissociate the vSatellites from the integration service.", + "operationId": "integrationsservices_update", + "parameters": [ + { + "description": "A unique integration service id containing in UUID format.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Integration Service ID", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceUpdateRequest" + } + } + }, + "description": "Details of the service to be updated", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceInformation" + } + } + }, + "description": "Updated integration service(s) matching the specified id." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Integration service not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update integration service properties", + "tags": [ + "Certificate Discovery" + ] + } + }, + "/v1/certificates/imports": { + "post": { + "description": "Import a list of certificates and their associated private key pairs", + "operationId": "certificates_import", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportRequest2" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportResponse2" + } + } + }, + "description": "Certificates and private keys imported" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Import a list of certificates and", + "tags": [ + "Private Key Import" + ] + } + }, + "/v1/certificates/imports/{id}": { + "get": { + "description": "Retrieve import details", + "operationId": "certificatesImport_getByImportId", + "parameters": [ + { + "description": "Import id associated with the result of importing a list of certificates and private keys", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportStatusDetailResponse" + } + } + }, + "description": "Import details matching the specified import id" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Import details not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve import details", + "tags": [ + "Private Key Import" + ] + } + }, + "/outagedetection/v1/certificaterequests": { + "get": { + "description": "Retrieves the details of all certificate requests.", + "operationId": "certificaterequests_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestResponse" + } + } + }, + "description": "The response body contains the details of the certificate requests" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all certificate", + "tags": [ + "Certificate Request" + ] + }, + "post": { + "description": "Creates a certificate request for the specified `applicationId` and using the specified `certificateIssuingTemplateId`. Indicate a renewal by specifying `existingCertificateId`. Set `isVaaSGenerated` to true, specify `csrAttributes` to request a certificate using *Automated Secure Keypair*. The `validityPeriod` value must be in the ISO8601 format for time duration. Examples of ISO8601 format time duration include _P1Y_ for one year, _P10D_ for ten days, and _PT12H_ for twelve hours.", + "operationId": "certificaterequests_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestResponse" + } + } + }, + "description": "A certificate request has been created, and its details can be found in the response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "The request is either incomplete or malformed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "The request is either incomplete or malformed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a certificate request", + "tags": [ + "Certificate Request" + ] + } + }, + "/outagedetection/v1/certificaterequests/{id}": { + "get": { + "description": "Retrieves the details of the certificate request with the specified `id`.", + "operationId": "certificaterequests_getById", + "parameters": [ + { + "description": "UUID of a Certificate Request", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Certificate Request", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestInformation1" + } + } + }, + "description": "A certificate request has been found, and its details are in the response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "The request is either incomplete or malformed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "The certificate request was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "The request is either incomplete or malformed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a certificate request details", + "tags": [ + "Certificate Request" + ] + } + }, + "/outagedetection/v1/certificaterequests/{id}/resubmission": { + "post": { + "description": "Resubmits the certificate request that has the specified `id`.", + "operationId": "certificaterequests_resubmitById", + "parameters": [ + { + "description": "UUID of a Certificate Request", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Certificate Request", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestResubmissionRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestResponse" + } + } + }, + "description": "Certificate Request was resubmitted; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Certificate Request not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Resubmit a certificate request", + "tags": [ + "Certificate Request" + ] + } + }, + "/outagedetection/v1/certificaterequests/validation": { + "post": { + "description": "This operation validates a proposed certificate request without actually submitting it.Checks for compliance with the specified issuing template and verifies all other references are valid (e.g., `existingCertificateId` is the UUID of an inventory certificate).", + "operationId": "certificaterequests_validation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificationRequestInformation" + } + } + }, + "description": "Certificate Request was validated." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Validate a certificate request", + "tags": [ + "Certificate Request" + ] + } + }, + "/outagedetection/v1/certificaterequestssearch": { + "post": { + "description": "Retrieves the details of certificate requests that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", + "operationId": "getCertificateRequestsByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter2" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestDocumentResponse" + } + } + }, + "description": "The response body contains the details of the certificate requests." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "The request is either incomplete or malformed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "The request is either incomplete or malformed." + } + }, + "summary": "Get the details of certificate requests", + "tags": [ + "Certificate Request" + ] + } + }, + "/v1/certificateissuingtemplates": { + "get": { + "description": "Retrieves the details of issuing templates ordered by `priority` and `certificateAuthority`.", + "operationId": "certificateissuingtemplate_getAll", + "parameters": [ + { + "description": "UUID of a Certificate Authority Account.", + "in": "query", + "name": "certificateAuthorityAccountId", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateResponse" + } + } + }, + "description": "Details of Issuing Templates in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of issuing templates", + "tags": [ + "Certificate Policy" + ] + }, + "post": { + "description": "Creates an issuing template.", + "operationId": "certificateissuingtemplate_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateResponse" + } + } + }, + "description": "Issuing Template was created; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Issuing Template not found." + }, + "409": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Issuing Template already exists." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add an issuing template", + "tags": [ + "Certificate Policy" + ] + } + }, + "/v1/certificateissuingtemplates/{id}": { + "get": { + "description": "Retrieve the details of the issuing template that has the specified `id`.", + "operationId": "certificateissuingtemplate_getById", + "parameters": [ + { + "description": "UUID of an Issuing Template.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Issuing Template.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" + } + } + }, + "description": "Issuing Template was found; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Issuing Template not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get an issuing template details", + "tags": [ + "Certificate Policy" + ] + }, + "put": { + "description": "Updates all the details of the issuing template that has the specified `id`.", + "operationId": "certificateissuingtemplate_update", + "parameters": [ + { + "description": "UUID of an Issuing Template.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Issuing Template.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" + } + } + }, + "description": "Issuing Template was updated; details in response body." + }, + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" + } + } + }, + "description": "Issuing Template exists." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Issuing Template not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Overwrite an issuing template details", + "tags": [ + "Certificate Policy" + ] + }, + "delete": { + "description": "Deletes the issuing template that has the specified `id`.", + "operationId": "certificateissuingtemplate_delete", + "parameters": [ + { + "description": "UUID of an Issuing Template.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Issuing Template.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Issuing Template was deleted" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Issuing Template not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove an issuing template", + "tags": [ + "Certificate Policy" + ] + } + }, + "/v1/certificateissuingtemplates/domainssynchronization": { + "post": { + "description": "Loads domain list from CA and updates the issuing templates with it", + "operationId": "domainssynchronization", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IssuingTemplatesDomainsSyncRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IssuingTemplateDomainsSyncResponse" + } + } + }, + "description": "List with the information about the status of the sync of every issuing template" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Synchronize issuing templates domains with CA", + "tags": [ + "Certificate Policy" + ] + } + }, + "/outagedetection/v1/applications": { + "get": { + "description": "Returns the details of applications matching the below provided criteria.", + "operationId": "applications_getAll", + "parameters": [ + { + "description": "Indicates whether or not the response should include the `owningUsers` and `owningTeams` details.", + "in": "query", + "name": "ownerDetails", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Indicates whether or not the response should exclude applications that are not editable by the current user.", + "in": "query", + "name": "ownershipCheck", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Indicates whether or not the response should exclude applications with no issuing templates assigned to them.", + "in": "query", + "name": "issuingTemplateAssigned", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "This parameter is deprecated for Application endpoints.", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationResponse" + } + } + }, + "description": "Details of applications in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of applications", + "tags": [ + "Application" + ] + }, + "post": { + "description": "Creates an application.", + "operationId": "applications_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationResponse" + } + } + }, + "description": "Application was created; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "409": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Application already exists." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add an application", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/{id}": { + "get": { + "description": "Retrieves the details of the application that has the specified `id`.", + "operationId": "applications_getById", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", + "type": "string" + } + }, + { + "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`).", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationInformation" + } + } + }, + "description": "Application Information" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Application not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get an application details", + "tags": [ + "Application" + ] + }, + "put": { + "description": "Updates (replaces) all details of the application that has the specified `id`.", + "operationId": "applications_update", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationInformation" + } + } + }, + "description": " Application was updated; details in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Application not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update an application details", + "tags": [ + "Application" + ] + }, + "delete": { + "description": "Deletes the application that has the specified `id`.", + "operationId": "applications_delete", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Application was deleted." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Application not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove an application", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/{id}/invitations": { + "post": { + "description": "Activates a URL that invites new users to become owners of the application with the specified `id`. The invitation link remains valid for 10 minutes.", + "operationId": "applications_invitations_create", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationResponse" + } + } + }, + "description": "If successful, this operation returns a User Invitation link in the response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Creates an invitation link for an", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/{id}/scanaficonfiguration": { + "get": { + "description": "Retrieves the *Basic Discovery* (Scanafi) configuration for the application that has the specified `id`.", + "operationId": "applications_getScanafiConfigById", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScanafiConfigResponseV1" + } + } + }, + "description": "Basic Discovery configuration in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Application not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the Basic Discovery configuration for", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/{name}/certificateissuingtemplates/{alias}": { + "get": { + "description": "Retrieves the details of the certificate issuing template identified by the specified `alias` assigned to the application that has the specified `name`.", + "operationId": "certificateissuingtemplates_getByAlias", + "parameters": [ + { + "description": "Name of an Application.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Alias of an Issuing Template for the specified Application.", + "in": "path", + "name": "alias", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" + } + } + }, + "description": "Issuing Template was found; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Issuing Template not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of an issuing", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/certificates": { + "patch": { + "description": "Update one or more application assignments for one or more certificates. Valid actions are ADD, REPLACE and DELETE.", + "operationId": "applications_assignToCertificates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationsAssignRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationsAssignResponse" + } + } + }, + "description": "Certificate application assignments were updated; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Manage application assignments for a set", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/name/{name}": { + "get": { + "description": "Retrieves the details of the application that has the specified `name`.", + "operationId": "applications_getByName", + "parameters": [ + { + "description": "Name of an Application.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`).", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationInformation" + } + } + }, + "description": "Application was found; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Application not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get an application details by its", + "tags": [ + "Application" + ] + } + }, + "/v1/credentialmanagerconfigurations": { + "get": { + "description": "Retrieves a set of stored Credential Manager Service configurations.", + "operationId": "get-public-cms-conf", + "parameters": [ + { + "$ref": "#/components/parameters/CMSTypesParam" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200GetCMSConfigurations" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "404": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves a set of Credential Manager", + "tags": [ + "Credential Management" + ] + }, + "post": { + "description": "Adds a set of new Credential Manager Service configurations. Only one Credential Manager Service configuration per `cmsType` per company can exist.", + "operationId": "post-public-cms-conf", + "requestBody": { + "$ref": "#/components/requestBodies/CreateCMSConfigurationsBodyRequest" + }, + "responses": { + "201": { + "$ref": "#/components/responses/201CreateCMSConfigurations" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "404": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a set of Credential Manager", + "tags": [ + "Credential Management" + ] + }, + "put": { + "description": "Updates the information of an existing Credential Manager Service configuration.", + "operationId": "put-public-cms-conf", + "requestBody": { + "$ref": "#/components/requestBodies/UpdateCMSConfigurationsBodyRequest" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200UpdateCMSConfiguration" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "404": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a Credential Manager Service configuration", + "tags": [ + "Credential Management" + ] + } + }, + "/v1/credentialmanagerconfigurations/{id}": { + "get": { + "description": "Retrieves a Credential Manager Service configuration by the specified `id`.", + "operationId": "get-public-cms-conf-id", + "responses": { + "200": { + "$ref": "#/components/responses/200GetCMSConfiguration" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "404": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves a Credential Manager Service configurati", + "tags": [ + "Credential Management" + ], + "parameters": [ + { + "$ref": "#/components/parameters/CMSConfigIdParam" + } + ] + }, + "delete": { + "description": "Deletes a Credential Manager Service configuration by the specified `id`.", + "operationId": "delete-public-cms-conf-id", + "responses": { + "204": { + "description": "The returned HTTP code if the Credential Manager Service configuration was deleted successfully." + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "404": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a Credential Manager Service configuration", + "tags": [ + "Credential Management" + ], + "parameters": [ + { + "$ref": "#/components/parameters/CMSConfigIdParam" + } + ] + } + }, + "/v1/credentialmanagerconfigurations/test": { + "post": { + "description": "Tests the connection to a configured privileged access management through selected VSatellites.", + "operationId": "post-public-cms-conf-test", + "requestBody": { + "$ref": "#/components/requestBodies/TestCMSConfigurationBodyRequest" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200TestCMSConfiguration" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "404": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Test the connection to a privileged", + "tags": [ + "Credential Management" + ] + } + }, + "/v1/credentialmanagerconfigurations/{id}/test": { + "post": { + "description": "Tests the connection to a configured privileged access management through selected VSatellites using a specified `id`.", + "operationId": "post-public-cms-conf-test-id", + "responses": { + "200": { + "$ref": "#/components/responses/200TestCMSConfiguration" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "404": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Test the connection to an external", + "tags": [ + "Credential Management" + ], + "parameters": [ + { + "$ref": "#/components/parameters/CMSConfigIdParam" + } + ] + } + }, + "/v1/credentials": { + "get": { + "description": "Retrieves a list of shared credentials for a company.", + "operationId": "get-public-cms-credential", + "parameters": [ + { + "$ref": "#/components/parameters/CMSCredentialDetailsParam" + }, + { + "$ref": "#/components/parameters/CMSTypesParam" + }, + { + "$ref": "#/components/parameters/CredentialIdsParam" + }, + { + "$ref": "#/components/parameters/TeamIdsParam" + }, + { + "$ref": "#/components/parameters/AuthTypesParam" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200GetCredentials" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "422": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves credentials for a company", + "tags": [ + "Credential Management" + ] + }, + "post": { + "description": "Adds a set of new shared credentials. The `name` for each credential must be unique.", + "operationId": "post-public-cms-credential", + "requestBody": { + "$ref": "#/components/requestBodies/AddCredentialsBodyRequest" + }, + "responses": { + "201": { + "$ref": "#/components/responses/201AddCredentials" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "422": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a set of new shared", + "tags": [ + "Credential Management" + ] + }, + "put": { + "description": "Updates the information of an existing shared credential.", + "operationId": "put-public-cms-credential", + "requestBody": { + "$ref": "#/components/requestBodies/UpdateCredentialBodyRequest" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200UpdateCredential" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "422": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a shared credential", + "tags": [ + "Credential Management" + ] + }, + "delete": { + "description": "Deletes existing shared credentials specified in the query parameter list of `ids`.", + "operationId": "delete-public-cms-credential", + "parameters": [ + { + "$ref": "#/components/parameters/CredentialIdsParam" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200DeleteCredentials" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "422": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete shared credentials", + "tags": [ + "Credential Management" + ] + } + }, + "/v1/credentials/{id}": { + "get": { + "description": "Retrieves the credential matching with provided `id`.", + "operationId": "get-public-cms-credential-id", + "parameters": [ + { + "$ref": "#/components/parameters/CMSCredentialDetailsParam" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200GetCredential" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "422": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves shared credential by ID", + "tags": [ + "Credential Management" + ] + }, + "delete": { + "description": "Deletes the shared credential by the specified `id`.", + "operationId": "delete-public-cms-credential-id", + "responses": { + "204": { + "description": "The returned http code if the credential was deleted successfully." + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "422": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete shared credential by ID", + "tags": [ + "Credential Management" + ], + "parameters": [ + { + "$ref": "#/components/parameters/CredentialIdParam" + } + ] + } + }, + "/v1/credentials/test": { + "post": { + "description": "Tests the access to a shared credential using a specified `id` or by providing credential values. If both an `id` and parameters are provided, parameters override existing credential values.", + "operationId": "post-public-cms-credential-test-id", + "requestBody": { + "$ref": "#/components/requestBodies/TestCredentialBodyRequest" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200TestCredential" + }, + "400": { + "$ref": "#/components/responses/400BadRequest" + }, + "401": { + "$ref": "#/components/responses/401Unauthorized" + }, + "403": { + "$ref": "#/components/responses/403Forbidden" + }, + "404": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Test the access to shared credential", + "tags": [ + "Credential Management" + ] + } + }, + "/v1/machineidentities": { + "get": { + "description": "Retrieves the details of all machine identities..", + "operationId": "machineidentities_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityResponse" + } + } + }, + "description": "All Machine Identities for the company." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all machine", + "tags": [ + "Machine Identities" + ] + }, + "post": { + "description": "Creates a machine identity for a machine.", + "operationId": "machineidentities_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityCreationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityInformation" + } + } + }, + "description": "Machine Identity was created; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a machine identity to a", + "tags": [ + "Machine Identities" + ] + } + }, + "/v1/machineidentities/{id}": { + "get": { + "description": "Retrieves the machine identity that has the specified `id`.", + "operationId": "machineidentities_getById", + "parameters": [ + { + "description": "UUID of a Machine Identity.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine Identity.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityInformation" + } + } + }, + "description": "Machine Identity matching specified id" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Machine Identity not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a machine identity details", + "tags": [ + "Machine Identities" + ] + }, + "delete": { + "description": "Deletes the machine identity that has the specified `id`.", + "operationId": "machineidentities_delete", + "parameters": [ + { + "description": "UUID of a Machine Identity.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine Identity.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Machine Identity was deleted." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Machine Identity not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove a machine identity", + "tags": [ + "Machine Identities" + ] + }, + "patch": { + "description": "CUpdates specific details of the machine identity that has the specified `id`.", + "operationId": "machineidentities_update", + "parameters": [ + { + "description": "UUID of a Machine Identity.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine Identity.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityInformation" + } + } + }, + "description": "Machine Identity was updated; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Machine Identity not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a machine identity details", + "tags": [ + "Machine Identities" + ] + } + }, + "/v1/machineidentities/{id}/workflows": { + "post": { + "description": "Used to initiate a workflow like 'testConnection' for the machine that has the specified `id`.", + "operationId": "machineidentities_initiateWorkflow", + "parameters": [ + { + "description": "UUID of a Machine Identity.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine Identity.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityWorkflowRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityWorkflowInformation" + } + } + }, + "description": "Workflow was initiated; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Machine identity not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Initiate a machine workflow", + "tags": [ + "Machine Identities" + ] + } + }, + "/v1/machineidentitysearch": { + "post": { + "description": "Retrieves the details of machine identities that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", + "operationId": "getMachineIdentitiesByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentitySearchRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityDocumentResponse" + } + } + }, + "description": "Details of Machine Identities in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "summary": "Get the details of machine identities", + "tags": [ + "Machine Identities" + ] + } + }, + "/v1/machinetypes": { + "get": { + "deprecated": true, + "description": "Deprecated. This functionality is no longer supported. Use the Plugins API set instead.", + "operationId": "machineTypes_getAll", + "responses": { + "default": { + "content": { + "application/json": {} + }, + "description": "default response" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Deprecated. This functionality is no longer", + "tags": [ + "Machine Types" + ] + } + }, + "/v1/machines": { + "get": { + "description": "Retrieves the details of all machines.", + "operationId": "machines_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachinesResponse" + } + } + }, + "description": "Details of Machines in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all machines", + "tags": [ + "Machines" + ] + }, + "post": { + "description": "Creates a machine corresponding to the specified `pluginId`.", + "operationId": "machines_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineCreationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } + }, + "description": "Machine was created; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a machine", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}": { + "get": { + "description": "Retrieves the details of the machine that matches the specified `id`.", + "operationId": "machines_getById", + "parameters": [ + { + "description": "UUID of a Machine", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } + }, + "description": "Machine was found; details in the response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Machine not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a machine details", + "tags": [ + "Machines" + ] + }, + "delete": { + "description": "Deletes a machine that has the specified `id`.", + "operationId": "machines_delete", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Machine deleted." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Request conditions failed." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Certificate installation not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a machine", + "tags": [ + "Machines" + ] + }, + "patch": { + "description": "Updates specific details of the machine that matches the specified `id`.", + "operationId": "machines_update", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } + }, + "description": "Machine was updated; details in the response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Machine not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a machine details", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}/workflows": { + "post": { + "description": "Triggers the beginning of the workflow.", + "operationId": "machines_initiateWorkflow", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineWorkflowRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } + }, + "description": "Workflow initiated successfully." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Initiate the workflow", + "tags": [ + "Machines" + ] + } + }, + "/v1/machinesearch": { + "post": { + "description": "Retrieves the details of machines that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", + "operationId": "getMachinesByExpression", + "parameters": [ + { + "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`)", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachinesSearchRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineDocumentResponse" + } + } + }, + "description": "Details of Machines in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "summary": "Get the details of machines matching", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}/batchprovisionings/abort": { + "post": { + "description": "Triggers the abort operation on the current batch provisioning process for the machine with the specified `id`.", + "operationId": "abort-v1-batchprovisionings-forMachineId", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Batch provisioning abort success." + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Operation forbidden." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Active batch provisioning not found." + }, + "405": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Abort batch provisioning not allowed." + }, + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Abort active batch provisioning for a", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}/discovery": { + "get": { + "description": "Retrieves the details of the machine's discovery.", + "operationId": "machineDiscoveryResults_getByMachineId", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineDiscoveryResultInformation" + } + } + }, + "description": "Discovery result for machine was found; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "The discovery result for the machine was not found. It is possible that discovery was never initiated. Run discovery and try again." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the discovery results for a", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}/discovery/abort": { + "post": { + "description": "Aborts an active discovery.", + "operationId": "machineDiscoveryResults_abortdiscovery", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } + }, + "description": "Abort discovery success." + }, + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Operation forbidden." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Active discovery not found." + }, + "405": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Abort discovery not allowed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Abort machine discovery", + "tags": [ + "Machines" + ] + } + }, + "/v1/users": { + "get": { + "description": "Retrieve list of users matching the criteria. Note that this operation might result in a larger-than-expected dataset.operation can potentially be expensive as resulting dataset may be large", + "operationId": "get-v1-users", + "parameters": [ + { + "description": "Current user status.", + "in": "query", + "name": "userStatus", + "schema": { + "items": { + "$ref": "#/components/schemas/UserStatus" + }, + "type": "array" + } + }, + { + "description": "Username string; Accepts regex", + "in": "query", + "name": "username", + "schema": { + "type": "string" + } + }, + { + "description": "Optional disabled user filter flag; true will return disabled users; false will return non-disabled users; default will return all users", + "in": "query", + "name": "disabled", + "schema": { + "type": "boolean" + } + }, + { + "description": "Optional soft-deleted user filter flag; true will return soft-deleted users; false will return non-soft-deleted users; default will return all users", + "in": "query", + "name": "deleted", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserResponse" + } + } + }, + "description": "All users" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve users matching specified criteria", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}": { + "get": { + "description": "Retrieve user with 'id' attribute matching specified value.", + "operationId": "get-v1-users-byId", + "parameters": [ + { + "description": "UUID of a user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation2" + } + } + }, + "description": "User matching specified userId" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Request conditions failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "User not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Request conditions failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve user details by user ID", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}/accounttype": { + "put": { + "description": "Update account type for user with 'id' attribute matching specified value.", + "operationId": "put-v1-users-byId-accounttype", + "parameters": [ + { + "description": "UUID of a user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccountTypeRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation2" + } + } + }, + "description": "User account type was updated. Updated user details in response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "User was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update user account type", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}/locallogin": { + "put": { + "description": "Enable/disable local login for specified user.", + "operationId": "put-v1-users-byId-locallogin", + "parameters": [ + { + "description": "UUID of a user.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalLoginRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation2" + } + } + }, + "description": "Local login property for the user was updated. Updated user details in response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "User not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Enable disable local login for user", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}/roles": { + "put": { + "description": "Update a user's currently assigned user role to limit or expand permissions. Learn more about [user roles](https://docs.venafi.cloud/CSH_user_roles_defined)", + "operationId": "put-v1-users-byId-roles", + "parameters": [ + { + "description": "UUID of a user.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RolesRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation2" + } + } + }, + "description": "User roles were updated. The newly assigned user role is given in the response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "User not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update user roles", + "tags": [ + "Users" + ] + } + }, + "/v1/users/username/{username}": { + "get": { + "description": "Lets you use the 'username' attribute to get the details of the associated user; specified value should be an email address.", + "operationId": "get-v1-users-username-byUsername", + "parameters": [ + { + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserResponse" + } + } + }, + "description": "Details of the user matching specified username." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "User not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve user details by username", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}/passwordexpiration": { + "put": { + "description": "Update if a user's password should be forced into an expired state for user with 'id' attribute matching specified value.", + "operationId": "put-v1-users-byId-passwordexpiration", + "parameters": [ + { + "description": "UUID of a user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserForceLocalPasswordExpirationRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation2" + } + } + }, + "description": "User forceLocalPasswordExpiration value was updated. Updated user details in response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "User was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update if a user must change", + "tags": [ + "Users" + ] + } + }, + "/v1/useraccounts": { + "get": { + "description": "Retrieve user account information for API key specified in header: User details, User's API key details and Associated company details.", + "operationId": "useraccounts_getByAuth", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccountResponse" + } + } + }, + "description": "Authenticated user's account information: user details, user's API key details, and associated company details." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "User account was not found for the specified API Key." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve an authenticated user account details", + "tags": [ + "User Accounts" + ] + } + }, + "/v1/teams": { + "get": { + "description": "Retrieve teams for the current company", + "operationId": "teams_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamsResponse" + } + } + }, + "description": "List of teams." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve teams for the current company", + "tags": [ + "Teams" + ] + }, + "post": { + "description": "Creates a team for the company with which the authenticated user is associated.", + "operationId": "teams_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTeamRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation2" + } + } + }, + "description": "Team created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a team", + "tags": [ + "Teams" + ] + } + }, + "/v1/teams/{id}": { + "get": { + "description": "Retrieve the details of a team that has the specified `id`.", + "operationId": "teams_getById", + "parameters": [ + { + "description": " UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": " UUID of a team.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation2" + } + } + }, + "description": "Team's details." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a team details", + "tags": [ + "Teams" + ] + }, + "delete": { + "description": "Deletes the team with specified `id`.", + "operationId": "teams_delete", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Team was deleted." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "delete a team", + "tags": [ + "Teams" + ] + }, + "patch": { + "description": "Updates the details of a team that matches the specified team `id`.", + "operationId": "teams_update", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTeamRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation2" + } + } + }, + "description": "Successfully updated team properties." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update team details", + "tags": [ + "Teams" + ] + } + }, + "/v1/teams/{id}/members": { + "post": { + "description": "Adds members to the team with specified team's`id`.", + "operationId": "teams_members_add", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamMembersRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation2" + } + } + }, + "description": "Successfully added team members. Updated team details in the response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add team members", + "tags": [ + "Teams" + ] + }, + "delete": { + "description": "Removes team members with the specified team's `id`.", + "operationId": "teams_members_delete", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamMembersRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation2" + } + } + }, + "description": "Members were removed. Updated team details in response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove team members", + "tags": [ + "Teams" + ] + } + }, + "/v1/teams/{id}/owners": { + "post": { + "description": "Adds owners to the team with the specified team's `id`.", + "operationId": "teams_members_owners_add", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamOwnersRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation2" + } + } + }, + "description": "Successfully added Team owners." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add team owners", + "tags": [ + "Teams" + ] + }, + "delete": { + "description": "Removes owners from the team with the specified team's `id`.", + "operationId": "teams_members_owners_remove", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamOwnersRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation2" + } + } + }, + "description": "Owners were removed. Updated team details in response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove team owners", + "tags": [ + "Teams" + ] + } + }, + "/v1/activitylogsearch": { + "post": { + "description": "Request specific event log data that matches your filter criteria and include a total count of entries in the response.", + "operationId": "activitylogs_getByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityLogFilter" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityLogEntriesResponse" + } + } + }, + "description": "Total count and list of matching log entries." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve count and activity log entries", + "tags": [ + "Event Logs" + ] + } + }, + "/v1/activitylogsearch/export": { + "post": { + "description": "Request specific event log data that matches your filter criteria. You can even specify the format in the header as either JSON or CSV.", + "operationId": "activitylogs_getAllByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityLogFilter" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ExportedActivityLogEntryInformation" + }, + "type": "array" + } + }, + "text/csv": { + "schema": { + "type": "string" + } + } + }, + "description": "List of matching log entries." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Export filtered event log data to", + "tags": [ + "Event Logs" + ] + } + }, + "/v1/activitytypes": { + "get": { + "description": "Retrieve types of activities used for event logging, such as failed login attempts or events that are critical. Learn more about [event logging](https://docs.venafi.cloud/vaas/logging/c-about-activity-logging/).", + "operationId": "activitylogtypes_get", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ActivityLogType" + }, + "type": "array" + } + } + }, + "description": "Types of activities in event logging; details in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve types of activities used for", + "tags": [ + "Event Logs" + ] + } + }, + "/v1/edgeinstances/{id}/update": { + "post": { + "description": "Triggering an update for a satellite instance (manual)", + "operationId": "create-edgeinstances-update", + "parameters": [ + { + "description": "Satellite Instance ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Satellite Instance ID", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Satellite Start Manual Update" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Satellite Instance Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Trigger manual update of Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeencryptionkeys": { + "get": { + "description": "Retrieve the list of satellite encryption keys based on query parameters", + "operationId": "edgeencryptionkeys_getAll", + "parameters": [ + { + "in": "query", + "name": "edgeInstanceId", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EncryptionKeysResponse" + } + } + }, + "description": "List of SatelliteEncryption keys" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Satellite Encryption Keys", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeencryptionkeys/{id}": { + "get": { + "description": "Retrieve satellite encryption key with 'id' attribute matching specified value; specified value should be string not numeric", + "operationId": "edgeencryptionkeys_getById", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EncryptionKeyInformation" + } + } + }, + "description": "Encryption key information" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Encryption key not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve SatelliteEncryption Key By Id", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeinstances": { + "get": { + "description": "Retrieve list of all satellite instances for company", + "operationId": "edgeinstances_getAll", + "parameters": [ + { + "in": "query", + "name": "environmentId", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeInstanceResponse" + } + } + }, + "description": "Satelliteinstances matching specified id" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Satellite Instances", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeinstances/{id}": { + "get": { + "description": "Retrieve satellite instance with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "edgeinstances_getById", + "parameters": [ + { + "description": "Satellite Instance ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Satellite Instance ID", + "format": "uuid", + "type": "string" + } + }, + { + "in": "query", + "name": "statusDetails", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeInstanceInformation" + } + } + }, + "description": "Satellite instance matching specified id" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Satellite instance not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Satellite Instance By Id", + "tags": [ + "VSatellite" + ] + }, + "put": { + "description": "Update satellite instance with specified new value", + "operationId": "edgeinstances_update", + "parameters": [ + { + "description": "Satellite Instance ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Satellite Instance ID", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeInstanceRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeInstanceInformation" + } + } + }, + "description": "Satellite Instance Updated" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Satellite Instance Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/pairingcodes/satellite": { + "post": { + "description": "Generate new pairing code for satellite instance registration", + "operationId": "pairingcodes_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PairingCodeRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PairingCodeInformation" + } + } + }, + "description": "Pairing Code Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create Pairing Code for Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/recoverycodes/satellite": { + "post": { + "description": "Generate new recovery code for satellite instance restoration", + "operationId": "recoverycodes_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecoveryCodeRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecoveryCodeInformation" + } + } + }, + "description": "Recovery Code Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create Recovery Code for Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeworkers": { + "get": { + "description": "Retrieve list of all satellite workers for company", + "operationId": "edgeworkers_getAll", + "parameters": [ + { + "in": "query", + "name": "edgeInstanceId", + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkersResponse" + } + } + }, + "description": "List of Satellite workers" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Satellite Workers", + "tags": [ + "VSatellite" + ] + }, + "post": { + "description": "Create satellite worker and generate the pairing information", + "operationId": "edgeworkers_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerInformation" + } + } + }, + "description": "Satellite worker information" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request conditions failed" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request conditions failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create Satellite Worker", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeworkers/{id}/pair": { + "post": { + "operationId": "edgeworkers_pair", + "parameters": [ + { + "description": "EdgeWorker ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "EdgeWorker ID", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerInformation" + } + } + }, + "description": "Satellite worker paired with Satellitehub" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request conditions failed" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request conditions failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Pair Satellite Worker with Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeworkers/{id}": { + "delete": { + "description": "Delete satellite worker", + "operationId": "edgeworker_delete", + "parameters": [ + { + "description": "EdgeWorker ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "EdgeWorker ID", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerDeleteResponse" + } + } + }, + "description": "Satellite worker deleted" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Satellite worker not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete Satellite Worker", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/updatesconfig": { + "get": { + "description": "Retrieve updates configuration for tenant", + "operationId": "updatesconfig_get", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatesConfigResponse" + } + } + }, + "description": "Tenant updates configuration" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Updates configuration", + "tags": [ + "VSatellite" + ] + }, + "patch": { + "description": "Create or update updates configuration. The default update window is set to daily, with a start time at 12:00 AM and duration of 24 hours. This schedule allows updates to be performed on demand as soon as they become available.\n **Example Default Request Body:**\n\n ```json\n {\n \"updateConfigSchedulerPattern\": {\n \"recurrenceType\": \"DAY\",\n \"startTime\": \"00:00:00\",\n \"duration\": \"PT24H\"\n }\n }\n ```\n", + "operationId": "updatesconfig_patch", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatesConfigRequest" + } + } + }, + "description": "Modify updates configuration using patch behavior. All top level properties are optional", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatesConfigResponse" + } + } + }, + "description": "Updates configuration created/updated" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create or Update Configuration", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/connectors/{id}": { + "put": { + "description": "Can be used to update specific fields. Only fields specified in the request will be updated.\nWhen the connector\u2019s target is a webhook (`generic`, `slack`, or `teams`), updating the connector triggers the same outbound connectivity check as creation. The service performs a live POST request Certificate Manager - SaaS to the configured `connection.url`. If the endpoint is unreachable (for example, due to DNS failure, TLS handshake issues, or network/firewall restrictions), the update request fails with a descriptive error.\n", + "operationId": "connectors_update", + "parameters": [ + { + "description": "Connector ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Connector ID", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsInformation" + } + } + }, + "description": "Connector Updated" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Connector Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update Connector properties", + "tags": [ + "Webhooks" + ] + }, + "delete": { + "description": "Delete a Connector.\nDeleting a connector removes its configuration for delivering events to the target endpoint, but it does not modify any customer firewall allowlisting or network settings. If your webhook endpoint requires allowlisting Venafi Cloud NAT IP addresses, that configuration must be managed separately.\n", + "operationId": "connectors_delete", + "parameters": [ + { + "description": "Connector ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Connector ID", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Connector Deleted" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Connector Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a Connector", + "tags": [ + "Webhooks" + ] + } + }, + "/v1/connectors": { + "get": { + "description": "Retrieve a list of all Connectors for a company", + "operationId": "connectors_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsResponse" + } + } + }, + "description": "Success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all Connectors for a company", + "tags": [ + "Webhooks" + ] + }, + "post": { + "description": "Create a Connector for your company. When the connector\u2019s target is a webhook (`generic`, `slack`, or `teams`), the service performs a live outbound POST request from Certificate Manager - SaaS to the specified `connection.url` during creation. This validates DNS resolution, TLS handshake, and network reachability. If the URL is unreachable (for example, blocked by firewall rules or incorrect DNS), the connector creation request fails with a timeout or connection error. This behavior is expected and prevents creating connectors that cannot receive webhook notifications.", + "operationId": "connectors_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsCreationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsInformation" + } + } + }, + "description": "Connector Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a Connector", + "tags": [ + "Webhooks" + ] + } + }, + "/outagedetection/v1/inventorymonitoringconfig/{type}": { + "get": { + "description": "Retrieves the details of the inventory monitoring configuration by configuration type", + "operationId": "inventorymonitoringconfiguration_getByType", + "parameters": [ + { + "description": "Configuration type", + "in": "path", + "name": "type", + "required": true, + "schema": { + "description": "Configuration type", + "enum": [ + "CERTIFICATE_EXPIRATION" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InventoryMonitoringConfigurationResponse" + } + } + }, + "description": "Details of inventory monitoring configuration in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Inventory monitoring configuration not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of the current", + "tags": [ + "Certificate Inventory Monitoring" + ] + }, + "put": { + "description": "Updates existing inventory monitoring configuration", + "operationId": "inventorymonitoringconfiguration_update", + "parameters": [ + { + "description": "Configuration type", + "in": "path", + "name": "type", + "required": true, + "schema": { + "description": "Type of the configuration", + "enum": [ + "CERTIFICATE_EXPIRATION" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InventoryMonitoringConfigRequest" + } + } + }, + "description": "Updates properties of the inventory monitoring configuration.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InventoryMonitoringConfigurationResponse" + } + } + }, + "description": "Inventory monitoring configuration was updated." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Updates existing inventory monitoring configuratio", + "tags": [ + "Certificate Inventory Monitoring" + ] + } + }, + "/outagedetection/v1/inventorymonitoringconfig/{type}/scheduler": { + "put": { + "description": "Update inventory monitoring scheduler by type", + "operationId": "inventorymonitoringconfigurationscheduler_update", + "parameters": [ + { + "description": "Configuration type", + "in": "path", + "name": "type", + "required": true, + "schema": { + "description": "Configuration type", + "enum": [ + "CERTIFICATE_EXPIRATION" + ], + "type": "string" + } + }, + { + "description": "Start the scheduler now", + "in": "query", + "name": "runNow", + "schema": { + "default": true, + "description": "Start the scheduler now", + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InventoryMonitoringSchedulerInformation" + } + } + }, + "description": "Inventory monitoring scheduler was updated." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update inventory monitoring scheduler by type", + "tags": [ + "Certificate Inventory Monitoring" + ] + } + }, + "/v1/expirationnotifications/tenantconfiguration": { + "get": { + "description": "Retrieve the certificate expiration notification configuration for the current tenant", + "operationId": "get-v1-tenant-expiration-notification-configuration", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" + } + } + }, + "description": "Success" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve the certificate expiration notification c", + "tags": [ + "Certificate Inventory Monitoring" + ] + }, + "put": { + "description": "Update the certificate expiration notification configuration for the current tenant", + "operationId": "put-v1-tenant-expiration-notification-configuration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" + } + } + }, + "description": "The options to apply", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" + } + } + }, + "description": "Success. The tenant configuration was successfully updated." + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update the certificate expiration notification con", + "tags": [ + "Certificate Inventory Monitoring" + ] + } + }, + "/v1/autorenewal/tenantconfiguration": { + "get": { + "description": "Retrieve the certificate expiration monitoring configuration for the current tenant", + "operationId": "get-v1-tenant-renewal-configuration", + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "id": "12a05220-4352-11ee-ac28-c1379e5decf9", + "renewalWindow": { + "days": 30 + } + }, + "schema": { + "$ref": "#/components/schemas/TenantRenewalConfiguration" + } + } + }, + "description": "Success" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve the monitoring configuration", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + }, + "put": { + "description": "Update the certificate expiration monitoring configuration for the current tenant", + "operationId": "put-v1-tenant-renewal-configuration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantRenewalConfiguration" + } + } + }, + "description": "The options to apply", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantRenewalConfiguration" + } + } + }, + "description": "Success. The tenant configuration was successfully updated." + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update the monitoring configuration", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + } + }, + "/v1/autorenewal/trigger": { + "post": { + "description": "The certificate renewal check is normally scheduled to run daily. This operation attempts to start the process for the current tenant now.", + "operationId": "post-v1-run-autorenewal", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatusResponse" + } + } + }, + "description": "Success. The auto-renewal check process was triggered." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Attempt to initiate the certificate renewal", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + } + }, + "/v1/autorenewal/status": { + "get": { + "description": "Get details about the status of the certificate auto-renewal monitoring process.", + "operationId": "get-v1-status", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatusResponse" + } + } + }, + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the current certificate auto-renewal monitorin", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + } + }, + "/v1/autorenewal/{application_id}/configuration": { + "get": { + "description": "Retrieve the certificate expiration monitoring configuration for the specified application", + "operationId": "get-v1-application-renewal-configuration", + "parameters": [ + { + "description": "The ID of the application that you would like to retrieve configuration for", + "example": "22153ae0-4352-11ee-b95c-3531a284802b", + "in": "path", + "name": "application_id", + "required": true, + "schema": { + "format": "UUID", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRenewalConfiguration" + } + } + }, + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve the monitoring configuration", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + }, + "put": { + "description": "Update the certificate expiration monitoring configuration for the specified application", + "operationId": "put-v1-application-renewal-configuration", + "parameters": [ + { + "description": "The ID of the application you want to update", + "example": "22153ae0-4352-11ee-b95c-3531a284802b", + "in": "path", + "name": "application_id", + "required": true, + "schema": { + "format": "UUID", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRenewalConfiguration" + } + } + }, + "description": "The options to apply", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRenewalConfiguration" + } + } + }, + "description": "Success. The application configuration was successfully updated." + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update the monitoring configuration", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + } + }, + "/v1/expirationreports/tenantconfiguration": { + "get": { + "description": "Retrieve the certificate expiration reports configuration for the current tenant", + "operationId": "get-v1-tenant-expiration-reports-configuration", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" + } + } + }, + "description": "Success" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve the certificate expiration reports config", + "tags": [ + "Certificate Expiration Reports" + ] + }, + "put": { + "description": "Update the certificate expiration reports configuration for the current tenant", + "operationId": "put-v1-tenant-expiration-reports-configuration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" + } + } + }, + "description": "The options to apply", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" + } + } + }, + "description": "Success. The tenant configuration was successfully updated." + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update the certificate expiration reports configur", + "tags": [ + "Certificate Expiration Reports" + ] + } + }, + "/v1/expirationreports/trigger": { + "post": { + "description": "The certificate reports job is normally scheduled per the tenant configuration. This operation attempts to start the process for the current tenant now.", + "operationId": "post-v1-run-reports", + "responses": { + "204": { + "description": "Success. The reports check process was triggered." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Attempt to initiate the certificate reports", + "tags": [ + "Certificate Expiration Reports" + ] + } + }, + "/v1/tags": { + "get": { + "description": "Retrieve details of all available tags", + "operationId": "tags_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagResponse" + } + } + }, + "description": "Details of tags in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all tags", + "tags": [ + "Tags" + ] + }, + "post": { + "description": "Create tag with optional values", + "operationId": "tags_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagRequest" + } + } + }, + "description": "Properties of the new tag.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagInformation" + } + } + }, + "description": "Tag is created. Details in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a tag", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/{name}": { + "get": { + "description": "Retrieve a tag with 'name' attribute matching a specified value", + "operationId": "tags_getByName", + "parameters": [ + { + "description": "Name of the tag.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag.", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagInformation" + } + } + }, + "description": "Details of tag in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Tag not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve tag by name", + "tags": [ + "Tags" + ] + }, + "delete": { + "description": "Delete a tag with 'name' attribute matching a specified value", + "operationId": "tags_deleteByName", + "parameters": [ + { + "description": "Name of the tag.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag.", + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Tag is deleted" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Tag not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete tag by name", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/{name}/values": { + "get": { + "description": "Retrieve tag values for a tag with 'name' attribute matching specified value", + "operationId": "tags_get_values", + "parameters": [ + { + "description": "Name of the tag.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag.", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagValuesResponse" + } + } + }, + "description": "Tag values in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Tag not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve values for a tag", + "tags": [ + "Tags" + ] + }, + "post": { + "description": "Create tag values for a tag with 'name' attribute matching specified value", + "operationId": "tag_values_create", + "parameters": [ + { + "description": "Name of the tag.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag.", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagValuesRequest" + } + } + }, + "description": "The values of the tag.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagValuesResponse" + } + } + }, + "description": "Tag values created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create tag values", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/{name}/values/{value}": { + "delete": { + "description": "Delete a value associated with a tag", + "operationId": "tags_deleteValueByName", + "parameters": [ + { + "description": "Name of the tag", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag", + "type": "string" + } + }, + { + "description": "Name of the value to delete", + "in": "path", + "name": "value", + "required": true, + "schema": { + "description": "Name of the value to delete", + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Tag value deleted" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Tag not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a tag value", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/values": { + "get": { + "description": "Retrieve tag values for all tags", + "operationId": "tags_getAllValues", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagValuesResponse" + } + } + }, + "description": "Tag values in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve values for all tags", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/creation": { + "post": { + "description": "Create tags in bulk with optional values", + "operationId": "tags_bulk_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsBulkRequest" + } + } + }, + "description": "Properties of the new tags.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAndValuesResponse" + } + } + }, + "description": "Tags are created. Details in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create tags in bulk", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/deletion": { + "post": { + "description": "Delete tags in bulk by specified keys and values", + "operationId": "tags_bulk_delete", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsBulkRequest" + } + } + }, + "description": "Properties of the tags to delete.", + "required": true + }, + "responses": { + "202": { + "description": "Tags are deleted" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Tags not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete tags in bulk", + "tags": [ + "Tags" + ] + } + }, + "/v1/tagsassignment": { + "patch": { + "description": "Replace, add, or delete one or more tags or tag values to/from one or more entities", + "operationId": "tags_assignToEntities", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAssignRequest" + } + } + }, + "description": "Properties of the assignments.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAssignResponse" + } + } + }, + "description": "Tag assign response" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Replace, add, or delete tags or", + "tags": [ + "Tags" + ] + } + }, + "/v1/tagsassignment/aggregates": { + "post": { + "description": "Bulk operation to retrieve number of entities per tag", + "operationId": "tags_assignmentAggregates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAssignmentAggregatesRequest" + } + } + }, + "description": "Entity Type and list of tags and/or tag:value pairs.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAssignmentAggregatesResponse" + } + } + }, + "description": "Entity type and total count per tag in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Bulk operation to retrieve number of", + "tags": [ + "Tags" + ] + } + }, + "/v1/distributedissuers/configurations": { + "post": { + "description": "Adds a new Issuer Configuration, which links the following together - Sub CA Provider, Policies used to determine which certificates can be issued, and the IdP (Identity Provider) the Issuer should trust when receiving signed JWTs from its clients.", + "operationId": "configurations_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurationCreateRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedConfigurationInformation" + } + } + }, + "description": "Issuer configuration successfully created; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a new Issuer configuration", + "tags": [ + "Workload Identity Manager Configurations" + ] + }, + "get": { + "description": "Retrieves a list of all Issuer Configurations. Configurations link together Sub CA Providers, Workload Issuance Policies and Identity Provider information. Together these allow an instance of an Issuer to obtain a Sub CA certificate and use it to issue certificates.", + "operationId": "configurations_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurationResponse" + } + } + }, + "description": "All Issuer configurations." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all Issuer", + "tags": [ + "Workload Identity Manager Configurations" + ] + } + }, + "/v1/distributedissuers/configurations/{id}": { + "get": { + "description": "Retrieves the details of the existing Issuer configuration for the specified `id`.", + "operationId": "configurations_getById", + "parameters": [ + { + "description": "Issuer configuration UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedConfigurationInformation" + } + } + }, + "description": "Specified Issuer configuration found; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Specified Issuer configuration was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get configurations details for a specific", + "tags": [ + "Workload Identity Manager Configurations" + ] + }, + "patch": { + "description": "Updates (replaces) fields on an Issuer configuration that has the specified `id`. Only fields specified in the request will be updated. Fields not specified in the request are not modified.", + "operationId": "configurations_update", + "parameters": [ + { + "description": "Issuer configuration UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurationUpdateRequest" + } + } + }, + "description": "Issuer configuration's details to update.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedConfigurationInformation" + } + } + }, + "description": "Specified Issuer configuration updated; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Specified Issuer configuration was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update an Issuer configuration details", + "tags": [ + "Workload Identity Manager Configurations" + ] + }, + "delete": { + "description": "Deletes the Issuer configuration for the specified `id`. Before deleting a configuration, be sure no Issuer instances use that configuration, or they will no longer function.", + "operationId": "configurations_delete", + "parameters": [ + { + "description": "Issuer configuration UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurationDeleteResponse" + } + } + }, + "description": "Specified Issuer configuration was deleted." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Issuer configuration was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove an Issuer configuration", + "tags": [ + "Workload Identity Manager Configurations" + ] + } + }, + "/v1/distributedissuers/subcaproviders": { + "post": { + "description": "Creates a sub ca provider", + "operationId": "subcaproviders_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderCreateRequest" + } + } + }, + "description": "Details of the new sub CA provider.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderInformation" + } + } + }, + "description": "Sub CA Provider was created; details in response body;" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a new Sub CA provider", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + }, + "get": { + "description": "Returns a list of all the subordinate CA providers along with their details.", + "operationId": "subcaprovider_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderResponse" + } + } + }, + "description": "All Sub CA providers with details." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all Sub", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + } + }, + "/v1/distributedissuers/subcaproviders/{id}": { + "get": { + "description": "Retrieves the details of the subordinate CA provider that has the specified `id`.", + "operationId": "subcaproviders_getById", + "parameters": [ + { + "description": "Sub CA provider UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderInformation" + } + } + }, + "description": "Specified sub CA provider found; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Specified sub CA provider was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a Sub CA provider details", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + }, + "patch": { + "description": "Updates (replaces) details of the subordinate CA provider that has the specified `id`. Only fields specified in the request will be updated.", + "operationId": "subcaproviders_update", + "parameters": [ + { + "description": "Sub CA provider UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderUpdateRequest" + } + } + }, + "description": "Sub CA provider's details to update.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderInformation" + } + } + }, + "description": "Sub CA provider updated; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Specified Sub CA provider was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a Sub CA provider details", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + }, + "delete": { + "description": "Deletes the subordinate CA provider that has the specified `id`.", + "operationId": "subcaproviders_delete", + "parameters": [ + { + "description": "Sub CA provider UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderDeleteResponse" + } + } + }, + "description": "Specified Sub CA provider was deleted." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Specified sub CA provider was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove a Sub CA provider", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + } + }, + "/v1/distributedissuers/policies": { + "post": { + "description": "Add a new a Workload Issuance Policy for an Issuer to use to ensure compliance with company restrictions for creating certificates.", + "operationId": "policies_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyCreateRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedPolicyInformation" + } + } + }, + "description": "Workload Issuance policy was created; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a new Workload Issuance policy", + "tags": [ + "Workload Identity Manager Policies" + ] + }, + "get": { + "description": "Retrieves all policy details for all Workload Issuance policies. Policies are sets of rules that constrain how certificates can be issued, as well as set default values for some fields.", + "operationId": "policies_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyResponse" + } + } + }, + "description": "All Workload Issuance policies; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all Workload", + "tags": [ + "Workload Identity Manager Policies" + ] + } + }, + "/v1/distributedissuers/policies/{id}": { + "get": { + "description": "Retrieves the details of the Workload Issuance policy with the specified `id`.", + "operationId": "policies_getById", + "parameters": [ + { + "description": "Workload Issuance policy UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedPolicyInformation" + } + } + }, + "description": "Specified Workload Issuance policy found; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Specified Workload Issuance policy was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a Workload Issuance policy details", + "tags": [ + "Workload Identity Manager Policies" + ] + }, + "patch": { + "description": "Updates (replaces) details of the Workload Issuance policy that has the specified `id`. Only fields specified in the request will be updated. Fields not included in the request will be ignored.", + "operationId": "policies_update", + "parameters": [ + { + "description": "Workload Issuance policy UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedPolicyInformation" + } + } + }, + "description": "Workload Issuance policy updated." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Workload Issuance policy was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a Workload Issuance policy details", + "tags": [ + "Workload Identity Manager Policies" + ] + }, + "delete": { + "description": "Deletes the Workload Issuance policy that has the specified `id`.", + "operationId": "policies_delete", + "parameters": [ + { + "description": "Workload Issuance policy UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyDeleteResponse" + } + } + }, + "description": "Specified Workload Issuance policy was deleted" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Specified Workload Issuance policy was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove a Workload Issuance policy", + "tags": [ + "Workload Identity Manager Policies" + ] + } + }, + "/v1/distributedissuers/intermediatecertificates": { + "get": { + "description": "Retrieves the details of all Issuer intermediate certificates. These are the CA certificates issued to the Issuer instances that allow them to issue short-lived certificates.", + "operationId": "intermediatecertificates_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntermediateCertificateResponse" + } + } + }, + "description": "All Issuer intermediate certificates and details." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all Issuer", + "tags": [ + "Workload Identity Manager Intermediate Certificates" + ] + } + }, + "/v1/certificaterequests/{id}/approval/{decision}": { + "post": { + "description": "Approve or reject certificate request that is waiting for user action", + "operationId": "certificaterequests_approve", + "parameters": [ + { + "description": "UUID of a Certificate Request", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "User's decision - either approve or reject", + "in": "path", + "name": "decision", + "required": true, + "schema": { + "enum": [ + "APPROVE", + "REJECT" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApprovalDecisionRequest" + } + } + }, + "description": "In case of rejection contains the reason for that" + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestInformation2" + } + } + }, + "description": "Certificate Request approved/rejected" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Certificate Request not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Approve or reject pending certificate request", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificaterequests/approval/bulk/{decision}": { + "post": { + "description": "Initiate approval or rejection of multiple certificate requests that are waiting for user action", + "operationId": "certificaterequests_bulk_approve", + "parameters": [ + { + "description": "User's decision - either approve or reject", + "in": "path", + "name": "decision", + "required": true, + "schema": { + "enum": [ + "APPROVE", + "REJECT" + ], + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkApprovalRequest" + } + } + }, + "description": "In case of rejection contains the reason for that." + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkApprovalResponse" + } + } + }, + "description": "Bulk Approval of Certificate Request is accepted and processing" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Approve or reject multiple pending approval", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificaterequests/approvalrules": { + "post": { + "description": "Create certificate request workflow approval rule", + "operationId": "certificaterequests_approval_rule_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRulesRequest" + } + } + }, + "description": "Properties of the new approval rule.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule is created. Details in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create an approval rule for certificate", + "tags": [ + "Certificate Approvals" + ] + }, + "get": { + "description": "Retrieve all certificate request workflow approval rules for the current company.", + "operationId": "certificaterequests_approval_rules_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRulesResponseOpenApi" + } + } + }, + "description": "All approval rules for the current company; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get all approval rules", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificaterequests/approvalrules/{id}": { + "get": { + "description": "Retrieve certificate request workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "certificaterequests_approval_rule_getById", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an approval rule.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule matching specified id" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Approval rule not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve approval rule by id", + "tags": [ + "Certificate Approvals" + ] + }, + "put": { + "description": "Can be used to update specific fields of the approval rule that has the specified `id`", + "operationId": "certificaterequests_approval_rule_update", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an approval rule.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRulesUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule updated" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Approval rule Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update certificate request workflow approval rule", + "tags": [ + "Certificate Approvals" + ] + }, + "delete": { + "description": "Delete certificate request workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "certificaterequests_approval_rule_delete", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleDeleteResponseOpenApi" + } + } + }, + "description": "Specified approval rule was deleted" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Specified approval rule was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete certificate request workflow approval rule", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificaterequests/approvalrequests/{entityId}": { + "get": { + "description": "Retrieve approval request by specified certificate request id", + "operationId": "certificaterequests_approvalrequest", + "parameters": [ + { + "description": "Entity UUID of the approval request", + "in": "path", + "name": "entityId", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApprovalRequestInformation" + } + } + }, + "description": "Approval Request information" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Approval Request not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve approval request for specific certificate", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificates/revocations/approvalrules": { + "post": { + "description": "Create certificate revocation workflow approval rule", + "operationId": "certificaterevocations_approval_rule_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRulesRequest" + } + } + }, + "description": "Properties of the new approval rule.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule is created. Details in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create an approval rule for certificate", + "tags": [ + "Certificate Revocation Approvals" + ] + }, + "get": { + "description": "Retrieve all certificate revocation workflow approval rules for the current company.", + "operationId": "certificaterevocations_approval_rules_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRulesResponseOpenApi" + } + } + }, + "description": "All approval rules for the current company; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get all certificate revocation approval rules", + "tags": [ + "Certificate Revocation Approvals" + ] + } + }, + "/v1/certificates/revocations/approvalrules/{id}": { + "get": { + "description": "Retrieve certificate revocation workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "certificaterevocations_approval_rule_getById", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an approval rule.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule matching specified id" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Approval rule not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve certificate revocation approval rule by", + "tags": [ + "Certificate Revocation Approvals" + ] + }, + "put": { + "description": "Can be used to update specific fields of the approval rule that has the specified `id`", + "operationId": "certificaterevocations_approval_rule_update", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an approval rule.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRulesUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule updated" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Approval rule Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update certificate revocation workflow approval ru", + "tags": [ + "Certificate Revocation Approvals" + ] + }, + "delete": { + "description": "Delete certificate revocation workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "certificaterevocations_approval_rule_delete", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleDeleteResponseOpenApi" + } + } + }, + "description": "Specified approval rule was deleted" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Specified approval rule was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete certificate revocation workflow approval ru", + "tags": [ + "Certificate Revocation Approvals" + ] + } + }, + "/v1/plugins": { + "get": { + "description": "Retrieve all the plugins for the tenant.", + "operationId": "get-v1-plugins", + "parameters": [ + { + "description": "Filter by provided plugin type.", + "in": "query", + "name": "pluginTypes", + "schema": { + "items": { + "$ref": "#/components/schemas/PluginType" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + { + "description": "Include disabled plugins if set to true.", + "in": "query", + "name": "includeDisabled", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "plugins": { + "items": { + "$ref": "#/components/schemas/Plugin" + }, + "type": "array" + } + }, + "required": [ + "plugins" + ], + "type": "object" + } + } + }, + "description": "Success. All plugins retrieved." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all plugins", + "tags": [ + "Plugins" + ] + }, + "post": { + "description": "Create a custom plugin for your tenant's exclusive use. The user must be a SYSTEM_ADMIN or a PKI_ADMIN.", + "operationId": "post-v1-plugins", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublicPluginCreationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PluginResponse" + } + } + }, + "description": "Success. Plugin created." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a local plugin", + "tags": [ + "Plugins" + ] + } + }, + "/v1/plugins/{id}": { + "get": { + "description": "Retrieve a plugin with the specified ID.", + "operationId": "get-v1-plugins-id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plugin" + } + } + }, + "description": "Success. Plugin retrieved." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve plugin by ID", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "patch": { + "description": "Update a plugin with specified ID. Plugin must be owned by the tenant and the user must be a SYSTEM_ADMIN or a PKI_ADMIN.", + "operationId": "patch-v1-plugins-id", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublicPluginUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success. Plugin updated." + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a local plugin", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "description": "Delete a plugin with the specified ID. Plugin must be owned by the tenant and the user must be a SYSTEM_ADMIN or a PKI_ADMIN.", + "operationId": "delete-v1-plugins-id", + "responses": { + "204": { + "description": "No Content." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a local plugin", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/v1/plugins/{id}/disablements": { + "post": { + "description": "Set a plugin to be disabled for your tenant.", + "operationId": "post-v1-plugins-id-exclusions", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PluginResponse" + } + } + }, + "description": "Successfully disabled the plugin for the current tenant." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Disable a plugin", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID that is currently marked as disabled.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ] + }, + "delete": { + "description": "Remove a plugin exclusion from your tenant.", + "operationId": "delete-v1-plugins-id-exclusions", + "responses": { + "204": { + "description": "No Content. Successfully deleted the plugin disablement." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove plugin disablement", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID that is currently marked as disabled.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/v1/plugins/disablements": { + "get": { + "description": "Retrieve all the disabled plugins for the current tenant.", + "operationId": "get-v1-plugins-exclusions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PluginResponse" + } + } + }, + "description": "Successfully retrieved all the disabled plugins for the current tenant." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all disabled plugins", + "tags": [ + "Plugins" + ] + } + }, + "/v1/serviceaccounts": { + "get": { + "description": "Retrieves all the Service Accounts the user has access to", + "operationId": "get-v1-serviceaccounts", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetServiceAccountsResponseBody" + } + } + }, + "description": "The list of all Service Account details the user has access to" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves all the Service Accounts the", + "tags": [ + "Service Accounts" + ] + }, + "post": { + "description": "Creates a Service Account with the information provided. The service account is later used for machine to machine authentication. For rsaKey authentication service accounts publicKey key is required. Provide authenticationType field for creating other service accounts with another type of authentication.", + "operationId": "create-v1-serviceaccounts", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateServiceAccountRequestBody" + } + } + }, + "description": "The Service Account data", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateServiceAccountResponseBody" + } + } + }, + "description": "The id assigned to the created Service Account. If the Service Account has CyberArk registry purpose and is created with ociToken authentication type, the ociRegistryToken and ociAccountName are returned in the response." + }, + "400": { + "description": "BadRequest. Return ErrInvalidPayload when creating rsaKey authentication service accounts and publicKey not provided." + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Creates a Service Account", + "tags": [ + "Service Accounts" + ] + } + }, + "/v1/serviceaccounts/{id}": { + "get": { + "description": "Retrieves the information of an Service Account associated to the given id", + "operationId": "get-v1-serviceaccounts-byId", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to retrieve", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetServiceAccountsByClientIDResponseBody" + } + } + }, + "description": "The Service Account details for the given id" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Gets a Service Account", + "tags": [ + "Service Accounts" + ] + }, + "patch": { + "description": "Updates the specified fields for a given service account matching the provided id. Providing either a new credentialLifetime or a new publicKey will result of the corresponding credentials associated to this Service Account", + "operationId": "patch-v1-serviceaccounts-byId", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to update", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchServiceAccountByClientIDRequestBody" + } + } + }, + "description": "The data to update", + "required": true + }, + "responses": { + "204": { + "description": "The Service Account was updated successfully" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Updates a Service Account", + "tags": [ + "Service Accounts" + ] + }, + "delete": { + "description": "Deletes the Service Account corresponding to the provided id. Deleting a Service Account also invalidates its associated credentials.", + "operationId": "delete-v1-serviceaccounts-byId", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to delete", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } + } + ], + "responses": { + "204": { + "description": "The Service Account was deleted successfully" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Deletes a Service Account", + "tags": [ + "Service Accounts" + ] + } + }, + "/v1/serviceaccounts/scopes": { + "get": { + "description": "Retrieves all the Service Accounts Scopes available for the user", + "operationId": "get-v1-serviceaccountscopes", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetServiceAccountScopesResponseBody" + } + } + }, + "description": "The list of all Service Account Scopes available for the user" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves all the Service Accounts Scopes", + "tags": [ + "Service Accounts" + ] + } + }, + "/v1/serviceaccounts/{id}/ocitoken": { + "put": { + "description": "Regenerate the OCI registry token for a given service account matching the provided id. Providing a new OCI registry token to this Service Account and sending it back to the client back. Calling this endpoint will remove the current token for the service account and create a new one. Old token can not be used.", + "operationId": "put-v1-serviceaccounts-byId-ocitoken", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to regenerate the OCI registry token", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutServiceAccountByClientIDOCITokenResponseBody" + } + } + }, + "description": "The Service Account OCI registry token has been regenerated" + }, + "400": { + "description": "BadRequest. This also happens when trying to regenerate token for account without token based authentication" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Regenerate the OCI registry token for", + "tags": [ + "Service Accounts" + ] + } + }, + "/v1/serviceaccounts/{id}/credentials": { + "put": { + "description": "Updates the specified credentials for a given service account matching the provided id. Providing either a new credentialLifetime or a new publicKey will result of the corresponding credentials associated to this Service Account", + "operationId": "put-v1-serviceaccounts-byId-credentials", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to update", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutServiceAccountByClientIDCredentialsRequestBody" + } + } + }, + "description": "The data to update", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutServiceAccountByClientIDCredentialsResponseBody" + } + } + }, + "description": "The Service Account Credentials were updated successfully" + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Updates a Service Account credentials", + "tags": [ + "Service Accounts" + ] + } + } + }, + "servers": [ + { + "url": "https://api.strata.paloaltonetworks.com", + "description": "Strata Cloud Manager API" + } + ], + "tags": [ + { + "name": "Certificates", + "description": "APIs for Certificates." + }, + { + "name": "Certificate Installations", + "description": "APIs for Certificate Installations." + }, + { + "name": "Certificate Discovery", + "description": "APIs for Certificate Discovery." + }, + { + "name": "Certificate Import", + "description": "APIs for Certificate Import." + }, + { + "name": "Private Key Import", + "description": "APIs for Private Key Import." + }, + { + "name": "Certificate Request", + "description": "APIs for Certificate Request." + }, + { + "name": "Certificate Policy", + "description": "APIs for Certificate Policy." + }, + { + "name": "Application", + "description": "APIs for Application." + }, + { + "name": "Credential Management", + "description": "APIs for Credential Management." + }, + { + "name": "Machine Identities", + "description": "APIs for Machine Identities." + }, + { + "name": "Machine Types", + "description": "APIs for Machine Types." + }, + { + "name": "Machines", + "description": "APIs for Machines." + }, + { + "name": "Users", + "description": "APIs for Users." + }, + { + "name": "User Accounts", + "description": "APIs for User Accounts." + }, + { + "name": "Teams", + "description": "APIs for Teams." + }, + { + "name": "Event Logs", + "description": "APIs for Event Logs." + }, + { + "name": "VSatellite", + "description": "APIs for VSatellite." + }, + { + "name": "Webhooks", + "description": "APIs for Webhooks." + }, + { + "name": "Certificate Inventory Monitoring", + "description": "APIs for Certificate Inventory Monitoring." + }, + { + "name": "Certificate Auto-renewal Monitoring", + "description": "APIs for Certificate Auto-renewal Monitoring." + }, + { + "name": "Certificate Expiration Reports", + "description": "APIs for Certificate Expiration Reports." + }, + { + "name": "Tags", + "description": "APIs for Tags." + }, + { + "name": "Workload Identity Manager Configurations", + "description": "APIs for Workload Identity Manager Configurations." + }, + { + "name": "Workload Identity Manager Sub CA Providers", + "description": "APIs for Workload Identity Manager Sub CA Providers." + }, + { + "name": "Workload Identity Manager Policies", + "description": "APIs for Workload Identity Manager Policies." + }, + { + "name": "Workload Identity Manager Intermediate Certificates", + "description": "APIs for Workload Identity Manager Intermediate Certificates." + }, + { + "name": "Certificate Approvals", + "description": "APIs for Certificate Approvals." + }, + { + "name": "Certificate Revocation Approvals", + "description": "APIs for Certificate Revocation Approvals." + }, + { + "name": "Plugins", + "description": "APIs for Plugins." + }, + { + "name": "Service Accounts", + "description": "APIs for Service Accounts." + } + ] +} \ No newline at end of file diff --git a/products/scm/api/config/ngts/ngts-api.md b/products/scm/api/config/ngts/ngts-api.md new file mode 100644 index 000000000..825ecef0b --- /dev/null +++ b/products/scm/api/config/ngts/ngts-api.md @@ -0,0 +1,55 @@ +--- +id: ngts-api +title: NGTS API +sidebar_label: NGTS API +keywords: + - Strata Cloud Manager + - NGTS + - Certificates + - Reference + - API +--- + +Welcome to the NGTS API reference section. This reference is your key to a comprehensive understanding of the NGTS APIs. Here you can start working with NGTS APIs as quickly as possible. Developers can try out our APIs right from our docs and see what's working (or not) with real-time logs. So let's jump right in! + +The NGTS APIs are designed for administrators to perform critical tasks, such as discovering and monitoring TLS keys and certificates and managing your TLS machine identities. This section provides detailed information about these APIs, including operations, types, inputs and outputs, and error codes. + +:::note +Using the navigation on the left, you'll find details for each endpoint and type of object used in the API. +::: + +## NGTS REST APIs + +The NGTS REST API provides programmatic access to functionality that is available via the NGTS web user interface (UI). Any task that can be performed using the UI can also be accomplished using the REST API. This feature allows you to automate operations that are present in the UI for greater consistency and scale. + +The REST API follows best practices in API design. For example, it uses JSON for encapsulating objects returned by the API, proper HTTP request verbs and status codes, and comprehensive error messages in failed requests to aid developers in diagnosing issues. + +## Common use cases + +- Auditing your organization's NGTS account to understand what certificates are in inventory. +- Requesting certificates from NGTS for use by applications, such as HTTPS-enabled web servers. (Certificate request API) +- Searching NGTS to understand what certificates have been issued by your organization. +- Extracting data for custom reports based on certificate data and summary information to help track key and certificate management policy compliance. + +## What about my API key? + +The API endpoint pages let you enter your API key and run API calls directly. Simply enter your API key in the **Authentication** box for any call. + +## Base URL + +All API requests use the following base URL. HTTPS is required for all requests. + +``` +https://api.strata.paloaltonetworks.com +``` + +## JSON + +Request and response bodies are encoded as JSON. + +- Top-level resources have an "object" property. This property can be used to determine the type of resource (e.g., "database," "user," etc.) +- Property names are in camelCase (not snake_case or kebab-case). + +## Code samples + +Samples requests and responses are shown for each endpoint. Requests are shown using cURL, Go, Java, JavaScript, Python, and more. These samples make it easy to copy, paste, and modify as you build your integration. diff --git a/products/scm/sidebars.ts b/products/scm/sidebars.ts index b7e157206..94f6195ae 100644 --- a/products/scm/sidebars.ts +++ b/products/scm/sidebars.ts @@ -282,6 +282,18 @@ module.exports = { }, ], }, + { + type: "category", + label: "NGTS Configuration", + collapsed: true, + items: [ + { + type: "doc", + id: "scm/api/config/ngts/ngts-api", + }, + require("./api/config/ngts/sidebar"), + ], + }, { type: "category", label: "Incidents API", diff --git a/src/pages/strata-cloud-manager/index.js b/src/pages/strata-cloud-manager/index.js index 90ef869fe..23d37a328 100644 --- a/src/pages/strata-cloud-manager/index.js +++ b/src/pages/strata-cloud-manager/index.js @@ -192,6 +192,13 @@ export default function SCMLandingPage() { icon: "api-doc", }, ], + "NGTS Configuration": [ + { + to: "scm/api/config/ngts/ngts-api", + label: "NGTS API", + icon: "api-doc", + }, + ], Posture: [ { to: "scm/api/config/posture-management/introduction-posture", diff --git a/static/img/homepage-banner/2.svg b/static/img/homepage-banner/2.svg new file mode 100644 index 000000000..443583823 --- /dev/null +++ b/static/img/homepage-banner/2.svg @@ -0,0 +1,3 @@ + + + From 9a14932e8e091864aa64e40abfbf358f5003b3d8 Mon Sep 17 00:00:00 2001 From: Rajit Shah Date: Thu, 26 Mar 2026 16:06:51 -0500 Subject: [PATCH 2/5] chore(ngts): update spec to latest CI-generated version Replaces manually generated spec with output from ua-repo CI pipeline (Generate PANW Spec job, MR-353). Spec is now produced automatically by devhub-manager + transform-to-panw-spec.py on every siteconf.yaml change. Co-Authored-By: Claude Sonnet 4.6 (1M context) --- .../scm/config/ngts/tlsprotect-cloud.json | 44370 ++++++++-------- 1 file changed, 22174 insertions(+), 22196 deletions(-) diff --git a/openapi-specs/scm/config/ngts/tlsprotect-cloud.json b/openapi-specs/scm/config/ngts/tlsprotect-cloud.json index ae392e9fe..e85632bea 100644 --- a/openapi-specs/scm/config/ngts/tlsprotect-cloud.json +++ b/openapi-specs/scm/config/ngts/tlsprotect-cloud.json @@ -1,13162 +1,11965 @@ { - "components": { - "parameters": { - "AuthTypesParam": { - "description": "The authentication types separated by commas.", - "explode": false, - "in": "query", - "name": "authTypes", - "schema": { - "items": { - "$ref": "#/components/schemas/AuthType" - }, - "minItems": 1, - "type": "array" - } - }, - "CMSConfigIdParam": { - "description": "The id of the Credential Manager Service configuration.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/CMSConfId" - } - }, - "CMSCredentialDetailsParam": { - "description": "The option of whether or not return full credential details. Only Admin users can use this parameter.", - "in": "query", - "name": "details", - "schema": { - "type": "boolean" - } - }, - "CMSTypesParam": { - "description": "The privileged access management types separated by commas.", - "explode": false, - "in": "query", - "name": "cmsTypes", - "schema": { - "items": { - "$ref": "#/components/schemas/CMSType" + "openapi": "3.0.1", + "info": { + "title": "TLS Protect Cloud API for Strata Cloud Manager", + "description": "Use the TLS Protect Cloud APIs to manage certificates, certificate requests, applications, machine identities, users, teams, event logs, and more. This Open API spec file was created on March 26, 2026. © 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.", + "version": "1.0.0", + "license": { + "name": "MIT", + "url": "https://opensource.org/license/mit" + } + }, + "servers": [ + { + "url": "https://api.strata.paloaltonetworks.com", + "description": "Strata Cloud Manager API" + } + ], + "tags": [ + { + "name": "Certificates", + "description": "APIs for Certificates." + }, + { + "name": "Certificate Installations", + "description": "APIs for Certificate Installations." + }, + { + "name": "Certificate Discovery", + "description": "APIs for Certificate Discovery." + }, + { + "name": "Certificate Import", + "description": "APIs for Certificate Import." + }, + { + "name": "Private Key Import", + "description": "APIs for Private Key Import." + }, + { + "name": "Certificate Request", + "description": "APIs for Certificate Request." + }, + { + "name": "Certificate Policy", + "description": "APIs for Certificate Policy." + }, + { + "name": "Application", + "description": "APIs for Application." + }, + { + "name": "Credential Management", + "description": "APIs for Credential Management." + }, + { + "name": "Machine Identities", + "description": "APIs for Machine Identities." + }, + { + "name": "Machine Types", + "description": "APIs for Machine Types." + }, + { + "name": "Machines", + "description": "APIs for Machines." + }, + { + "name": "Users", + "description": "APIs for Users." + }, + { + "name": "User Accounts", + "description": "APIs for User Accounts." + }, + { + "name": "Teams", + "description": "APIs for Teams." + }, + { + "name": "Event Logs", + "description": "APIs for Event Logs." + }, + { + "name": "VSatellite", + "description": "APIs for VSatellite." + }, + { + "name": "Webhooks", + "description": "APIs for Webhooks." + }, + { + "name": "Certificate Inventory Monitoring", + "description": "APIs for Certificate Inventory Monitoring." + }, + { + "name": "Certificate Auto-renewal Monitoring", + "description": "APIs for Certificate Auto-renewal Monitoring." + }, + { + "name": "Certificate Expiration Reports", + "description": "APIs for Certificate Expiration Reports." + }, + { + "name": "Tags", + "description": "APIs for Tags." + }, + { + "name": "Workload Identity Manager Configurations", + "description": "APIs for Workload Identity Manager Configurations." + }, + { + "name": "Workload Identity Manager Sub CA Providers", + "description": "APIs for Workload Identity Manager Sub CA Providers." + }, + { + "name": "Workload Identity Manager Policies", + "description": "APIs for Workload Identity Manager Policies." + }, + { + "name": "Workload Identity Manager Intermediate Certificates", + "description": "APIs for Workload Identity Manager Intermediate Certificates." + }, + { + "name": "Certificate Approvals", + "description": "APIs for Certificate Approvals." + }, + { + "name": "Certificate Revocation Approvals", + "description": "APIs for Certificate Revocation Approvals." + }, + { + "name": "Plugins", + "description": "APIs for Plugins." + }, + { + "name": "Service Accounts", + "description": "APIs for Service Accounts." + } + ], + "paths": { + "/outagedetection/v1/certificates": { + "get": { + "description": "This endpoint allows you to retrieve all your certificates according to a specified criteria. This API provides a quick way to gather certificate details in order to install the certificates where they are needed.\n\nUse the `subject` query parameter to limit the search based on the certificate subject common name.", + "operationId": "certificates_getAll", + "parameters": [ + { + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } }, - "minItems": 1, - "type": "array" - } - }, - "CredentialIdParam": { - "description": "The credential Id.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "$ref": "#/components/schemas/CredentialId" - } - }, - "CredentialIdsParam": { - "description": "The credential Ids separated by commas.", - "explode": false, - "in": "query", - "name": "ids", - "schema": { - "items": { - "$ref": "#/components/schemas/CredentialId" + { + "in": "query", + "name": "excludeSupersededInstances", + "schema": { + "default": false, + "type": "boolean" + } }, - "minItems": 1, - "type": "array" - } - }, - "TeamIdsParam": { - "description": "The team Ids separated by commas.", - "explode": false, - "in": "query", - "name": "teamIds", - "schema": { - "items": { - "$ref": "#/components/schemas/TeamId" + { + "description": "Ability to enter regular expression to match specific criteria.", + "in": "query", + "name": "subject", + "schema": { + "type": "string" + } }, - "minItems": 1, - "type": "array" - } - } - }, - "requestBodies": { - "AddCredentialsBodyRequest": { - "content": { - "application/json": { + { + "description": "Indicates the maximum integer number of certificates returned.", + "in": "query", + "name": "limit", "schema": { - "$ref": "#/components/schemas/AddCredentialsRequest" + "default": 1000, + "maximum": 10000, + "minimum": 1, + "type": "number" } } - }, - "description": "The body request to add credentials to existing Credential Manager Service configurations." - }, - "CreateCMSConfigurationsBodyRequest": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateCMSConfigurationsRequest" - } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + } + }, + "description": "Certificate(s) response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request conditions failed." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request conditions failed." } }, - "description": "The body request to create the given Credential Manager Service configuration using their details." - }, - "TestCMSConfigurationBodyRequest": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestCMSConfigurationRequest" - } + "security": [ + { + "tppl-api-key": [] } - }, - "description": "The body request to test the given Credential Manager Service configuration using their details." + ], + "summary": "Retrieve all certificate data", + "tags": [ + "Certificates" + ] }, - "TestCredentialBodyRequest": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestCredentialRequest" + "post": { + "description": "Adds to the inventory one or more certificates to the inventory.the certificates are specified in raw base64-encoded format (PEM without header/footer). Chain CA certificates are optional but may be provided using `issuerCertificates`.", + "operationId": "certificateimports_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportRequest2" + } } } }, - "description": "The body request to test the given credential." - }, - "UpdateCMSConfigurationsBodyRequest": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCMSConfigurationRequest" - } + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportResponse2" + } + } + }, + "description": "Certificates were imported; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "description": "The body request to update the given Credential Manager Service configuration using their details." - }, - "UpdateCredentialBodyRequest": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateCredentialRequest" - } + "security": [ + { + "tppl-api-key": [] } - }, - "description": "The body request to update the given credential." + ], + "summary": "Import a set of raw certificates", + "tags": [ + "Certificate Import" + ] } }, - "responses": { - "200DeleteCredentials": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteCredentialsResponse" - } - } - }, - "description": "The credentials deleted successfully." - }, - "200GetCMSConfiguration": { - "content": { - "application/json": { + "/outagedetection/v1/certificates/{id}": { + "get": { + "description": "Retrieves the details of the certificate that has the specified `id`.", + "operationId": "certificates_getById", + "parameters": [ + { + "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`).", + "in": "query", + "name": "ownershipTree", "schema": { - "$ref": "#/components/schemas/CMSConfigurationResponse" + "default": false, + "type": "boolean" } - } - }, - "description": "The Credential Manager Service configuration received." - }, - "200GetCMSConfigurations": { - "content": { - "application/json": { + }, + { + "in": "query", + "name": "excludeSupersededInstances", "schema": { - "$ref": "#/components/schemas/GetCMSConfigurationsResponse" + "default": false, + "type": "boolean" } - } - }, - "description": "The Credential Manager Service configurations received." - }, - "200GetCredential": { - "content": { - "application/json": { + }, + { + "description": "UUID of a Certificate.", + "in": "path", + "name": "id", + "required": true, "schema": { - "$ref": "#/components/schemas/CredentialResponse" + "format": "uuid", + "type": "string" } } - }, - "description": "The retrieved credential." - }, - "200GetCredentials": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCredentialsResponse" - } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInformation" + } + } + }, + "description": "Certificate was found; details in response body." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Certificate was not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "description": "The retrieved credentials for a company." - }, - "200TestCMSConfiguration": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestCMSConfigurationResponse" - } + "security": [ + { + "tppl-api-key": [] } - }, - "description": "Ok. Contains the result of testing the Credential Manager Service configuration." - }, - "200TestCredential": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestCredentialResponse" - } - } - }, - "description": "Connection test to credential successful." - }, - "200UpdateCMSConfiguration": { - "content": { - "application/json": { + ], + "summary": "Get a certificate details", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/{id}/contents": { + "get": { + "description": "Exports the certificate that has the specified `id` in PEM or DER format. Chain CA certificates are included for PEM format when `chainOrder` is EE_FIRST or ROOT_FIRST.", + "operationId": "certificates_getContentsById", + "parameters": [ + { + "description": "Specify an 'accept' header parameter's value", + "in": "header", + "name": "Accept", "schema": { - "$ref": "#/components/schemas/CMSConfigurationResponse" + "enum": [ + "text/plain", + "application/octet-stream" + ], + "type": "string" } - } - }, - "description": "The Credential Manager Service configurations updated." - }, - "200UpdateCredential": { - "content": { - "application/json": { + }, + { + "description": "UUID of a Certificate.", + "in": "path", + "name": "id", + "required": true, "schema": { - "$ref": "#/components/schemas/CredentialResponse" + "format": "uuid", + "type": "string" } - } - }, - "description": "The credentials updated successfully." - }, - "201AddCredentials": { - "content": { - "application/json": { + }, + { + "description": "Format of certificate in response.", + "in": "query", + "name": "format", "schema": { - "$ref": "#/components/schemas/AddCredentialsResponse" + "enum": [ + "PEM", + "DER" + ], + "type": "string" } - } - }, - "description": "The credentials added successfully." - }, - "201CreateCMSConfigurations": { - "content": { - "application/json": { + }, + { + "description": "Order of certificates in response.", + "in": "query", + "name": "chainOrder", "schema": { - "$ref": "#/components/schemas/CreateCMSConfigurationsResponse" + "enum": [ + "EE_ONLY", + "EE_FIRST", + "ROOT_FIRST" + ], + "type": "string" } } - }, - "description": "The Credential Manager Service configurations created." - }, - "400BadRequest": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse5" - } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "string" + } + }, + "application/octet-stream": { + "schema": { + "type": "string" + } + }, + "text/plain": { + "schema": { + "type": "string" + } + } + }, + "description": "Raw certificate in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Certificate not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "description": "Bad request." - }, - "401Unauthorized": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse5" - } + "security": [ + { + "tppl-api-key": [] } - }, - "description": "Unauthorized. Missing or invalid credentials." - }, - "403Forbidden": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + ], + "summary": "Download a certificate", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/validation": { + "post": { + "description": "Submits one or more certificates for TLS validation.", + "operationId": "certificates_validation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateValidationRequest" + } } } }, - "description": "Forbidden. The user does not have the permission to do this action." - }, - "404NotFound": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse5" - } + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateValidationResponse" + } + } + }, + "description": "Certificates submitted for validation response." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "description": "Not found. The resource was not found." - }, - "500InternalServerErrorContent": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse5" - } + "security": [ + { + "tppl-api-key": [] } - }, - "description": "Internal Server Error." + ], + "summary": "Request validation for a set of", + "tags": [ + "Certificates" + ] } }, - "schemas": { - "ActivityLogCondition": { - "description": "A Condition for filtering", - "properties": { - "field": { - "description": "Represents a field for filtering", - "example": "activityType", - "type": "string" - }, - "operator": { - "$ref": "#/components/schemas/ActivityLogFilterOperator" + "/outagedetection/v1/certificates/retirement": { + "post": { + "description": "This endpoint retires one or more certificates by using the **certificateIds** parameter to match a specified value.", + "operationId": "certificateretirement_retireCertificates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRetirementRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + } + }, + "description": "Certificate retirement response." }, - "value": { - "description": "represents a field's value", - "example": "Authentication", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request conditions failed." }, - "values": { - "description": "represents a field's values", - "example": [ - "Authentication", - "Users" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Request conditions failed." } }, - "type": "object" - }, - "ActivityLogEntriesResponse": { - "properties": { - "activityLogEntries": { - "description": "A collection of activity log entries", - "items": { - "$ref": "#/components/schemas/ActivityLogEntryInformation" - }, - "type": "array" - }, - "count": { - "description": "The number of activity log entries.", - "example": 2, - "format": "int64", - "type": "integer" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retire certificates", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/recovery": { + "post": { + "description": "Recover the certificates specified by `certificateIds`, including any previous versions of those certificates.", + "operationId": "certificateretirement_recoverCertificates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRecoveryRequest" + } + } } }, - "type": "object" - }, - "ActivityLogEntryInformation": { - "properties": { - "activityDate": { - "description": "The date when a log entry was produced", - "example": "2023-01-24T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "activityName": { - "description": "An activity name", - "example": "Login Succeeded", - "type": "string" - }, - "activityType": { - "description": "An activity type", - "example": "Authentication", - "type": "string" - }, - "companyId": { - "description": "UUID of a company", - "example": "85595df0-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" - }, - "criticality": { - "description": "An activity criticality", - "example": 0, - "format": "int32", - "type": "integer" - }, - "id": { - "description": "UUID of a log entry", - "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + } + }, + "description": "Certificates were recovered. Total number and details are in the response body." }, - "message": { - "description": "An activity log message", - "example": "user logged in", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "payload": { - "additionalProperties": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "object" + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ActivityLogFilter": { - "properties": { - "expression": { - "$ref": "#/components/schemas/BaseActivityLogFilter" - }, - "ordering": { - "$ref": "#/components/schemas/BaseActivityLogOrdering" - }, - "paging": { - "$ref": "#/components/schemas/Page1" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "ActivityLogFilterOperand": { - "properties": { - "operand": { - "$ref": "#/components/schemas/ActivityLogCondition" + ], + "summary": "Recover a set of certificates", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificates/deletion": { + "post": { + "description": "Permanently deletes the retired certificates specified by `certificateIds` from the inventory.", + "operationId": "certificateretirement_deleteCertificates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateDeletionRequest" + } + } }, - "operator": { - "$ref": "#/components/schemas/UnaryOperator" - } + "required": true }, - "type": "object" - }, - "ActivityLogFilterOperands": { - "properties": { - "operands": { - "description": "A list of conditions that will be used for filtering", - "example": [ - { - "field": "activityType", - "operator": "EQ", - "value": "Authentication" - }, - { - "field": "activityName", - "operator": "EQ", - "value": "Login Succeeded" + "responses": { + "204": { + "description": "Certificates were deleted." + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } } - ], - "items": { - "$ref": "#/components/schemas/BaseActivityLogFilter" }, - "type": "array" + "description": "Incomplete or malformed request." }, - "operator": { - "$ref": "#/components/schemas/NaryOperator" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ActivityLogFilterOperator": { - "description": "An operator for filtering", - "enum": [ - "EQ", - "LT", - "LTE", - "GT", - "GTE", - "IN" + "security": [ + { + "tppl-api-key": [] + } ], - "example": "EQ", - "type": "string" - }, - "ActivityLogName": { - "properties": { - "key": { - "type": "string" + "summary": "Delete a set of retired certificates", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificatesearch": { + "post": { + "description": "This endpoint retrieves certificate data according to specified search criteria based on commonly used field search parameters. Some examples are `signatureHashAlgorithm`, `validityEnd`, and `issuerCN`. For more information, see [common search parameters](https://docs.venafi.cloud/api/about-api-search-fields/).\n", + "operationId": "certificates_search_getByExpression", + "parameters": [ + { + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } }, - "readableName": { - "type": "string" + { + "in": "query", + "name": "excludeSupersededInstances", + "schema": { + "default": false, + "type": "boolean" + } } - }, - "type": "object" - }, - "ActivityLogOrder": { - "properties": { - "direction": { - "$ref": "#/components/schemas/Direction" - }, - "field": { - "description": "A field, that will be used for ordering", - "example": "activityDate", - "type": "string" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter2" + } + } } }, - "type": "object" - }, - "ActivityLogType": { - "properties": { - "key": { - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/CertificateResponse" + } + } + }, + "description": "Certificate response." }, - "readableName": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request conditions failed." }, - "values": { - "items": { - "$ref": "#/components/schemas/ActivityLogName" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Request conditions failed." } }, - "type": "object" - }, - "AddCredentialRequest": { - "description": "The properties representing a credential to add.", - "properties": { - "authType": { - "$ref": "#/components/schemas/AuthType" - }, - "cmsConfigId": { - "$ref": "#/components/schemas/CMSConfId" - }, - "cmsType": { - "$ref": "#/components/schemas/CMSType" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve certificate data matching search criteria", + "tags": [ + "Certificates" + ] + } + }, + "/outagedetection/v1/certificateinstances": { + "get": { + "description": "Use this endpoint allows you to retrieve certificate instances according to specified criteria. Total certificate instances are the sum of the number of certificate installations, plus the total number of certificates that have no installations. Trusted CA certificates are not counted. For more information, see [certificate instances](https://docs.venafi.cloud/CSH_view_instances).\n\nUse query parameters to limit your search based on certificate criteria.", + "operationId": "certificateinstances_getAll", + "parameters": [ + { + "in": "query", + "name": "source", + "schema": { + "enum": [ + "UNKNOWN", + "USER_PROVIDED", + "USER_IMPORTED", + "USER_SCAN", + "TRUSTNET_SCAN", + "ON_PREM_CA_IMPORT", + "EXTERNAL_CA_IMPORT", + "FILE_IMPORT", + "EXTERNAL_SCAN", + "DOMAIN_SCAN", + "SMART_SCAN_INTERNAL", + "SMART_SCAN_EXTERNAL", + "SMART_VALIDATION_INTERNAL", + "SMART_VALIDATION_EXTERNAL", + "MACHINE_DISCOVERY", + "KUBERNETES_DISCOVERY", + "AWS_DISCOVERY", + "AZURE_DISCOVERY", + "GCP_DISCOVERY" + ], + "type": "string" + } }, - "credentialDetails": { - "$ref": "#/components/schemas/CreateCredentialDetails" + { + "in": "query", + "name": "ipAddress", + "schema": { + "type": "string" + } }, - "name": { - "$ref": "#/components/schemas/CredentialName" + { + "in": "query", + "name": "hostname", + "schema": { + "type": "string" + } }, - "teamsIds": { - "$ref": "#/components/schemas/TeamsIds" + { + "in": "query", + "name": "limit", + "schema": { + "format": "int32", + "type": "integer" + } } - }, - "required": [ - "name", - "cmsType", - "authType", - "credentialDetails" ], - "type": "object" - }, - "AddCredentialsRequest": { - "description": "Array of credentials to add.", - "properties": { - "credentials": { - "items": { - "$ref": "#/components/schemas/AddCredentialRequest" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" + } + } }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "credentials" - ], - "type": "object" - }, - "AddCredentialsResponse": { - "description": "The response for the add credentials action.", - "properties": { - "count": { - "type": "integer" + "description": "Certificate response." }, - "credentialsAdded": { - "items": { - "$ref": "#/components/schemas/CredentialResponse" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "credentialsAdded", - "count" - ], - "type": "object" - }, - "AdvancedSettingsInformation": { - "properties": { - "enableIssuanceAuditLog": { - "description": "Whether audit log entries must be generated for each issued certificate", - "example": false, - "type": "boolean" - }, - "includeRawCertDataInAuditLog": { - "description": "Whether the raw certificate data must be included in the audit log entry", - "example": false, - "type": "boolean" + "description": "Request conditions failed." }, - "requireFIPSCompliantBuild": { - "description": "Whether FIPS-compliant build is required", - "example": false, - "type": "boolean" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request conditions failed." } }, - "type": "object" - }, - "AnyValue1": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue10": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue2": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue3": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue4": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue5": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue6": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue7": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue8": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "AnyValue9": { - "description": "Can be any value - string, number, boolean, array or object." - }, - "ApiClientInformation": { - "description": "Represents the information of the client that is calling the API", - "example": { - "identifier": "192.168.1.63", - "type": "Venafi VCert CLI" - }, - "properties": { - "identifier": { - "description": "Client identifier", - "example": "199.121.8.74", - "type": "string" - }, - "type": { - "description": "Client type", - "example": "Venafi VCert CLI", - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "ApiKeyInformation": { - "properties": { - "apiKeyStatus": { - "$ref": "#/components/schemas/ApiKeyStatus" - }, - "apiVersion": { - "$ref": "#/components/schemas/ApiVersion" - }, - "companyId": { - "description": "UUID of a company.", - "format": "uuid", - "type": "string" - }, - "creationDate": { - "description": "The date and time the API key was created.", - "format": "date-time", - "type": "string" - }, - "key": { - "description": "UUID of an API key.", - "format": "uuid", - "type": "string" - }, - "memberedTeams": { - "description": "Membered teams of the user associated with this API key.", - "items": { - "description": "Membered teams of the user associated with this API key.", + ], + "summary": "Retrieve Certificate Instances", + "tags": [ + "Certificate Installations" + ] + } + }, + "/outagedetection/v1/certificateinstances/{id}": { + "get": { + "description": "Retrieves the details of the certificate installation that has the specified `id`.", + "operationId": "certificateinstances_getById", + "parameters": [ + { + "description": "UUID of a certificate installation.", + "in": "path", + "name": "id", + "required": true, + "schema": { "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceInformation" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Certificate installation was found; details in response body." }, - "productRoles": { - "additionalProperties": { - "description": "Product roles of the user associated with this API key.", - "items": { - "$ref": "#/components/schemas/Role2" - }, - "type": "array", - "uniqueItems": true + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "description": "Product roles of the user associated with this API key.", - "type": "object" + "description": "Incomplete or malformed request." }, - "systemRoles": { - "description": "System roles of the user associated with this API key.", - "items": { - "$ref": "#/components/schemas/SystemRole" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array", - "uniqueItems": true - }, - "urlPrefix": { - "description": "Tenant URL Prefix.", - "type": "string" - }, - "userId": { - "description": "UUID of a user.", - "format": "uuid", - "type": "string" - }, - "username": { - "description": "Email address of the registered user.", - "type": "string" - }, - "validityEndDate": { - "description": "The date and time the API key will no longer be valid.", - "format": "date-time", - "type": "string" + "description": "Certificate installation not found." }, - "validityStartDate": { - "description": "The date and time the API key became valid.", - "format": "date-time", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ApiKeyStatus": { - "enum": [ - "PENDING_ACTIVATION", - "ACTIVE", - "INACTIVE", - "PENDING_ROTATION", - "ROTATED", - "EXPIRED" - ], - "type": "string" - }, - "ApiVersion": { - "description": "Indicates version of the API.", - "enum": [ - "ALL", - "V1" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "string" - }, - "AppId": { - "description": "The application ID from the CyberArk provider.", - "type": "string" - }, - "Application": { - "description": "Application ID to associate with the service account", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - }, - "ApplicationInformation": { - "properties": { - "certificateIssuingTemplateAliasIdMap": { - "additionalProperties": { - "format": "uuid", - "type": "string" - }, - "type": "object" - }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "fullyQualifiedDomainNames": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "id": { - "format": "uuid", - "type": "string" - }, - "ipRanges": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "modificationDate": { - "format": "date-time", - "type": "string" - }, - "name": { - "type": "string" - }, - "ownerIdsAndTypes": { - "items": { - "$ref": "#/components/schemas/OwnerIdAndType" - }, - "type": "array" - }, - "ownership": { - "$ref": "#/components/schemas/ApplicationOwnership" - }, - "owningServiceAccounts": { - "items": { - "$ref": "#/components/schemas/ServiceAccountInformation" - }, - "type": "array" + "summary": "Get a certificate installation details", + "tags": [ + "Certificate Installations" + ] + } + }, + "/outagedetection/v1/certificateinstances/validation": { + "post": { + "description": "Submits one or more certificate installation for TLS validation.", + "operationId": "certificateinstances_validation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateInstanceValidationRequest" + } + } }, - "owningTeams": { - "items": { - "$ref": "#/components/schemas/TeamInformation1" + "required": true + }, + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Response" + } + } }, - "type": "array" + "description": "Certificate installations were submitted for validation." }, - "owningUsers": { - "items": { - "$ref": "#/components/schemas/UserInformation1" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "ports": { - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ApplicationOwnership": { - "properties": { - "owningTeams": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "owningUsers": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Request validation for a set of", + "tags": [ + "Certificate Installations" + ] + } + }, + "/outagedetection/v1/certificateinstancesearch": { + "post": { + "description": "Use this endpoint to retrieve certificate instance data according to specified search criteria based on commonly used field search parameters. Some examples are `signatureHashAlgorithm`, `validityEnd`, and `issuerCN`. For more information, see [common search parameters](https://docs.venafi.cloud/api/about-api-search-fields/#common-search-parameters)", + "operationId": "certificateinstances_search_getByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter2" + } + } } }, - "type": "object" - }, - "ApplicationRenewalConfiguration": { - "properties": { - "renewalActions": { - "description": "A set of options that can be used to specify the actions that should be taken when the auto-renewal process runs.", - "example": { - "provision": false, - "renew": true - }, - "properties": { - "provision": { - "description": "If true, the system with attempt to provision any certificates associated with this application after a successful auto-renewal.", - "type": "boolean" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" + } }, - "renew": { - "description": "If true, the system will attempt to renew any certificates associated with this application that are expected to expire within the configured number of days.", - "type": "boolean" + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" + } } }, - "required": [ - "renew", - "provision" - ], - "type": "object" + "description": "Certificate Instances Response" }, - "renewalWindow": { - "description": "A set of options to control the time window in which auto-renewal of certificates should be attempted.", - "example": { - "days": 16, - "inherit": false + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "properties": { - "days": { - "description": "Any certificates associated with this application that are expected to expire within the specified number of days will be acted on.", - "format": "int64", - "minimum": 1, - "type": "integer" + "description": "Request Conditions Failed" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } }, - "inherit": { - "description": "If true, \"days\" value configured for this application will be ignored and the value configured at the tenant level will be used.", - "type": "boolean" + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } } }, - "required": [ - "inherit" - ], - "type": "object" + "description": "Request Conditions Failed" } }, - "required": [ - "renewalActions", - "renewalWindow" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "ApplicationRequest": { - "properties": { - "certificateIssuingTemplateAliasIdMap": { - "additionalProperties": { - "description": "Represents a mapping of certificate issuing template aliases to their UUIDs.", - "format": "uuid", - "type": "string" - }, - "description": "Represents a mapping of certificate issuing template aliases to their UUIDs.", - "example": { - "dev-cit": "20bcb9a1-0f9c-407e-9673-b048c3d6479d", - "qa-cit": "448de2a0-1159-40f0-b3ae-e4f712577e87" - }, - "type": "object" - }, - "description": { - "description": "A description for an applications", - "example": "this application will hold dev certificates", - "type": "string" - }, - "externalIpRanges": { - "description": "Represents a collection of external IP ranges.", - "example": [ - "127.254.0.0/16", - "192.2.3.0/32" - ], - "items": { - "type": "string" - }, - "type": "array" + "summary": "Retrieve certificate instance data matching search", + "tags": [ + "Certificate Installations" + ] + } + }, + "/v1/integrationservices": { + "get": { + "description": "Retrieves the details of all services (Ex: Discovery services and Automated key pair services).", + "operationId": "integrationsservices_getAll", + "parameters": [ + { + "description": "Total number of services.", + "in": "query", + "name": "totalCount", + "schema": { + "default": false, + "type": "boolean" + } }, - "fqdns": { - "description": "A collection of FQDNs", - "example": [ - "venafi.docs.com", - "api.venafi" - ], - "items": { + { + "description": "UUID of VSatellite instance associated to the service if any.", + "in": "query", + "name": "edgeInstanceId", + "schema": { + "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceDetailsResponse" + } + } }, - "type": "array" + "description": "Details of all services in response body." }, - "fullyQualifiedDomainNames": { - "description": "Represents a collection of fully qualified domain names (FQDNs).", - "example": [ - "internal.venafi.docs", - "internal.api.venafi" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "internalFqdns": { - "description": "Represents a collection of fully qualified domain names (FQDNs) used for internal purposes.", - "example": [ - "internal.venafi.docs", - "internal.api.venafi" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a list of services", + "tags": [ + "Certificate Discovery" + ] + }, + "post": { + "description": "Create a new service ", + "operationId": "integrationsservices_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceCreationRequest" + } + } }, - "internalIpRanges": { - "description": "epresents a collection of internal IP ranges.", - "example": [ - "127.254.0.0/16", - "127.2.3.0/32" - ], - "items": { - "type": "string" + "description": "Details of the service to be created", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceInformation" + } + } }, - "type": "array" + "description": "A service created." }, - "internalPorts": { - "description": "Represents a collection of external ports.", - "example": [ - "8080", - "9090" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } }, - "type": "array" - }, - "ipRanges": { - "description": "Represents a collection of CIDR (Classless Inter-Domain Routing) ranges.", - "example": [ - "127.254.0.0/16", - "192.2.3.0/32" - ], - "items": { + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a service", + "tags": [ + "Certificate Discovery" + ] + } + }, + "/v1/integrationservices/{id}": { + "get": { + "description": "Retrieves the details of the service that has the specified `id`.", + "operationId": "integrationsservices_getById", + "parameters": [ + { + "description": "UUID of a service", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a service", + "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceInformation" + } + } }, - "type": "array" - }, - "name": { - "description": "An application name", - "example": "dev app", - "type": "string" + "description": "Service was found; details in response body." }, - "ownerIdsAndTypes": { - "description": "Represents a collection of ownership UUIDs and types.", - "example": [ - { - "ownerId": "f94c36a4-31b3-4aaf-a5c9-83fc7277db9f", - "ownerType": "USER" - }, - { - "ownerId": "2f796153-33e8-48d6-82e0-cc3b259f78ec", - "ownerType": "TEAM" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } } - ], - "items": { - "$ref": "#/components/schemas/OwnerIdAndType" }, - "type": "array" + "description": "Incomplete or malformed request." }, - "ports": { - "description": "Represents a collection of network ports.", - "example": [ - "443", - "7776" - ], - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } }, - "type": "array" + "description": "Service not found." }, - "startTargetedDiscovery": { - "description": "Specifies whether to start target discovery.", - "type": "boolean" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "fullyQualifiedDomainNames", - "internalPorts", - "ipRanges", - "name", - "ownerIdsAndTypes", - "ports" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" + "summary": "Get service details", + "tags": [ + "Certificate Discovery" + ] }, - "ApplicationResponse": { - "properties": { - "applications": { - "items": { - "$ref": "#/components/schemas/ApplicationInformation" - }, - "type": "array" - }, - "ownershipCount": { - "format": "int32", - "type": "integer" + "delete": { + "description": "Deletes the service that has the specified `id`.", + "operationId": "integrationsservices_delete", + "parameters": [ + { + "description": "UUID of a service", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a service", + "format": "uuid", + "type": "string" + } }, - "totalCount": { - "format": "int32", - "type": "integer" + { + "description": "retireCertificates\" (boolean): Number of certificates associated to the service that were retired when the service was deleted.", + "in": "query", + "name": "retireCertificates", + "schema": { + "default": false, + "type": "boolean" + } } - }, - "type": "object" - }, - "ApplicationsAssignRequest": { - "properties": { - "action": { - "enum": [ - "REPLACE", - "ADD", - "DELETE", - "DELETE_ALL" - ], - "type": "string" + ], + "responses": { + "204": { + "description": "Integration Service Deleted" }, - "certificateIds": { - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Incomplete or malformed request." }, - "targetedApplicationIds": { - "items": { - "format": "uuid", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "action", - "certificateIds", - "targetedApplicationIds" - ], - "type": "object" - }, - "ApplicationsAssignResponse": { - "properties": { - "certificates": { - "items": { - "$ref": "#/components/schemas/CertificateInformation" + "description": "Service not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ApprovalDecisionRequest": { - "properties": { - "reason": { - "description": "Reason for user's decision", - "example": "I reject this request because the certificate won't be needed anymore.", - "maxLength": 1024, - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" + ], + "summary": "Remove a service", + "tags": [ + "Certificate Discovery" + ] }, - "ApprovalRequestInformation": { - "properties": { - "approvalRule": { - "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + "patch": { + "description": "Can be used to update specific fields. Only fields specified in the request will be updated. An empty set of edgeInstancesIds value will clear the set.", + "operationId": "integrationsservices_update", + "parameters": [ + { + "description": "Integration Service ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Integration Service ID", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceUpdateRequest" + } + } }, - "approvers": { - "description": "A collection of approvers specified by type and id", - "items": { - "$ref": "#/components/schemas/ApproverProperty" + "description": "Details of the service to be updated", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationServiceInformation" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Integration Service information" }, - "approversOutcome": { - "description": "A collection of approver outcomes", - "items": { - "$ref": "#/components/schemas/ApproverOutcomeInformation" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } }, - "type": "array", - "uniqueItems": true - }, - "autoRejectionThreshold": { - "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", - "example": 5, - "maximum": 99, - "minimum": 1, - "type": "number" - }, - "companyId": { - "description": "UUID of a company", - "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", - "format": "uuid", - "type": "string" - }, - "creationDate": { - "description": "The date a approval request was created", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "entityId": { - "description": "UUID of a certificate request", - "example": "5ece3180-b1e0-11ed-862d-ad36b18e787b", - "format": "uuid", - "type": "string" - }, - "finalApprover": { - "$ref": "#/components/schemas/ApproverPropertyOpenApi" - }, - "id": { - "description": "UUID of a approval request", - "example": "5ece3180-b1e0-11ed-862d-ad36b18e787d", - "format": "uuid", - "type": "string" - }, - "modificationDate": { - "description": "The date a approval request was modified", - "example": "2023-01-11T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "requestorId": { - "description": "UUID of a requestor", - "example": "8268d820-a08d-11ed-bbc0-252385d6d389", - "format": "uuid", - "type": "string" + "description": "Request Conditions Failed" }, - "requiredApprovalsCount": { - "description": "Count of a required approvals", - "example": 2, - "format": "int32", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Integration Service Not Found" }, - "status": { - "description": "Status of an approval request", - "enum": [ - "NOT_REQUIRED", - "PENDING_APPROVAL", - "PENDING_FINAL_APPROVAL", - "APPROVED", - "REJECTED", - "EXPIRED", - "AUTO_APPROVED" - ], - "example": "PENDING_APPROVAL", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse8" + } + } + }, + "description": "Request Conditions Failed" } }, - "type": "object" - }, - "ApproverOutcomeInformation": { - "properties": { - "companyId": { - "description": "UUID of a company", - "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", - "format": "uuid", - "type": "string" - }, - "creationDate": { - "description": "The date a approver outcome was created", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "id": { - "description": "UUID of an approver outcome", - "example": "5ece3180-b1e0-11ed-862d-ad36b18e787c", - "format": "uuid", - "type": "string" - }, - "reason": { - "description": "Reason of an outcome", - "example": "Not needed", - "type": "string" - }, - "status": { - "description": "Status of an approval request", - "enum": [ - "APPROVED", - "REJECTED" - ], - "example": "APPROVED", - "type": "string" - }, - "userId": { - "description": "UUID of a user", - "example": "8268d820-a08d-11ed-bbc0-252385d6d389", - "format": "uuid", - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "ApproverProperty": { - "properties": { - "id": { - "format": "uuid", - "type": "string" - }, - "type": { - "enum": [ - "USER", - "TEAM" - ], - "type": "string" + ], + "summary": "Update Service properties", + "tags": [ + "Certificate Discovery" + ] + } + }, + "/v1/certificates/imports": { + "post": { + "description": "Import a list of certificates and their associated private key pairs", + "operationId": "certificates_import", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportRequest1" + } + } } }, - "type": "object" - }, - "ApproverPropertyOpenApi": { - "description": "Approver with id that can be only user type", - "properties": { - "id": { - "description": "UUID specific to the approver user/team", - "example": "8268d820-a08d-11ed-bbc0-252385d6d389", - "format": "uuid", - "type": "string" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportResponse1" + } + } + }, + "description": "Certificates and private keys imported" }, - "type": { - "description": "Approver type", - "example": "USER", - "type": "string" - } - }, - "type": "object" - }, - "AuthType": { - "description": "The type of the authentication:\n * `password`\n * `username_password`\n", - "enum": [ - "password", - "username_password" - ], - "type": "string" - }, - "AwsCloudProviderInformation": { - "properties": { - "accountIds": { - "description": "Array of AWS account IDs each of which should be a 12-digit identifier", - "example": [ - "123456789012" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } }, - "minItems": 1, - "type": "array" + "description": "Request Conditions Failed" }, - "regions": { - "description": "Array of AWS regions", - "example": [ - "us-west-1" - ], - "items": { - "enum": [ - "us-east-1", - "us-east-2", - "us-west-1", - "us-west-2", - "af-south-1", - "ap-east-1", - "ap-south-2", - "ap-southeast-3", - "ap-southeast-4", - "ap-south-1", - "ap-northeast-3", - "ap-northeast-2", - "ap-southeast-1", - "ap-southeast-2", - "ap-northeast-1", - "ca-central-1", - "eu-central-1", - "eu-west-1", - "eu-west-2", - "eu-south-1", - "eu-west-3", - "eu-south-2", - "eu-north-1", - "eu-central-2", - "me-south-1", - "me-central-1", - "sa-east-1", - "us-gov-east-1", - "us-gov-west-1" - ], - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } }, - "type": "array" + "description": "Request Conditions Failed" } }, - "required": [ - "accountIds", - "regions" - ], - "type": "object" - }, - "AzureCloudProviderInformation": { - "properties": { - "subscriptionIds": { - "description": "Array of Azure subscription IDs each of which should be UUID", - "example": [ - "8d10da13-8125-4ba9-a717-bf7490507b3d" - ], - "items": { - "format": "uuid", - "type": "string" - }, - "minItems": 1, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "required": [ - "subscriptionIds" ], - "type": "object" - }, - "BaseActivityLogFilter": { - "description": "Root expression for filtering", - "oneOf": [ - { - "$ref": "#/components/schemas/ActivityLogFilterOperands" - }, - { - "$ref": "#/components/schemas/ActivityLogFilterOperand" - }, + "summary": "Import a list of certificates and", + "tags": [ + "Private Key Import" + ] + } + }, + "/v1/certificates/imports/{id}": { + "get": { + "description": "Retrieve import details", + "operationId": "certificatesImport_getByImportId", + "parameters": [ { - "$ref": "#/components/schemas/ActivityLogCondition" + "description": "Import id associated with the result of importing a list of certificates and private keys", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } } ], - "type": "object" - }, - "BaseActivityLogOrdering": { - "description": "Specify the ordering of a search result", - "properties": { - "orders": { - "items": { - "$ref": "#/components/schemas/ActivityLogOrder" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateImportStatusDetailResponse" + } + } }, - "type": "array" - } - }, - "type": "object" - }, - "BaseFilter": { - "description": "Root expression for filtering", - "oneOf": [ - { - "$ref": "#/components/schemas/FilterOperands" + "description": "Import details matching the specified import id" }, - { - "$ref": "#/components/schemas/FilterOperand" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Import details not found" }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse1" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ { - "$ref": "#/components/schemas/Condition" + "tppl-api-key": [] } ], - "type": "object" - }, - "BaseOrdering": { - "description": "Specify the ordering of a search result", - "properties": { - "orders": { - "items": { - "$ref": "#/components/schemas/Order" + "summary": "Retrieve import details", + "tags": [ + "Private Key Import" + ] + } + }, + "/outagedetection/v1/certificaterequests": { + "get": { + "description": "Retrieves the details of all certificate requests.", + "operationId": "certificaterequests_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestResponse" + } + } }, - "type": "array" + "description": "The response body contains the details of the certificate requests" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all certificate", + "tags": [ + "Certificate Request" + ] }, - "BulkApprovalRequest": { - "properties": { - "ids": { - "description": "Set of UUIDs of the certificate requests", - "example": [ - "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" - ], - "items": { - "description": "Set of UUIDs of the certificate requests", - "format": "uuid", - "type": "string" + "post": { + "description": "Creates a certificate request for the specified `applicationId` and using the specified `certificateIssuingTemplateId`. Indicate a renewal by specifying `existingCertificateId`. Set `isVaaSGenerated` to true, specify `csrAttributes` to request a certificate using *Automated Secure Keypair*. The `validityPeriod` value must be in the ISO8601 format for time duration. Examples of ISO8601 format time duration include _P1Y_ for one year, _P10D_ for ten days, and _PT12H_ for twelve hours.", + "operationId": "certificaterequests_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestResponse" + } + } }, - "maxItems": 100, - "type": "array", - "uniqueItems": true + "description": "A certificate request has been created, and its details can be found in the response body." }, - "reason": { - "description": "Reason for user's decision", - "example": "I reject this request because the certificate won't be needed anymore.", - "maxLength": 1024, - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "The request is either incomplete or malformed." }, - "wsClientId": { - "description": "The ws client id, that will be used when the execution finishes", - "example": "someid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "The request is either incomplete or malformed." } }, - "required": [ - "ids" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "BulkApprovalResponse": { - "properties": { - "operationId": { - "type": "string" + "summary": "Create a certificate request", + "tags": [ + "Certificate Request" + ] + } + }, + "/outagedetection/v1/certificaterequests/{id}": { + "get": { + "description": "Retrieves the details of the certificate request with the specified `id`.", + "operationId": "certificaterequests_getById", + "parameters": [ + { + "description": "UUID of a Certificate Request", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Certificate Request", + "format": "uuid", + "type": "string" + } } - }, - "type": "object" - }, - "CMSAuthenticationType": { - "description": "The authentication type for the privileged access management:\n * `certificate` - For authentication with a Certificate bundle\n * `userPassword` - For authentication with user and password\n", - "enum": [ - "certificate", - "userPassword" ], - "type": "string" - }, - "CMSConfId": { - "description": "The Credential Manager Service configuration ID.", - "example": "72e4c1f6-d85f-11ed-afa1-0242ac120002", - "format": "uuid", - "type": "string" - }, - "CMSConfigurationResponse": { - "description": "The information representing a Credential Manager Service configuration for response.", - "properties": { - "cmsDetails": { - "$ref": "#/components/schemas/ResponseCMSDetails" - }, - "cmsType": { - "$ref": "#/components/schemas/CMSType" - }, - "companyId": { - "$ref": "#/components/schemas/CompanyId" - }, - "createdBy": { - "$ref": "#/components/schemas/CreatedBy" - }, - "createdOn": { - "$ref": "#/components/schemas/CreatedOn" - }, - "id": { - "$ref": "#/components/schemas/CMSConfId" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestInformation2" + } + } + }, + "description": "A certificate request has been found, and its details are in the response body." }, - "lastModifiedBy": { - "$ref": "#/components/schemas/LastModifiedBy" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "The request is either incomplete or malformed." }, - "lastModifiedOn": { - "$ref": "#/components/schemas/LastModifiedOn" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "The certificate request was not found." }, - "name": { - "$ref": "#/components/schemas/Name" - }, - "vSatelliteIds": { - "$ref": "#/components/schemas/VSatelliteIds" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "The request is either incomplete or malformed." } }, - "type": "object" - }, - "CMSType": { - "description": "The type of the privileged access management:\n * `cyberark` - For CyberArk privileged access management\n * `hashicorp` - For HashiCorp privileged access management\n", - "enum": [ - "cyberark", - "hashicorp" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "string" - }, - "CMSURL": { - "description": "The baseUrl of the privileged access management provider.", - "format": "uri", - "type": "string" - }, - "CSRAttributesInformation": { - "description": "Represents CSR attributes for certificate requests. Required when isVaaSGenerated is set to true and reuseCSR to false.", - "example": { - "commonName": "localhost", - "country": "MX", - "keyTypeParameters": { - "keyCurve": "P256", - "keyLength": 4096, - "keyType": "RSA" - }, - "locality": "Merida", - "organization": "venafi", - "organizationalUnits": [ - "devops" - ], - "state": "Yucatan", - "subjectAlternativeNamesByType": { - "dnsNames": [ - "localhost" - ] + "summary": "Get a certificate request details", + "tags": [ + "Certificate Request" + ] + } + }, + "/outagedetection/v1/certificaterequests/{id}/resubmission": { + "post": { + "description": "Resubmits the certificate request that has the specified `id`.", + "operationId": "certificaterequests_resubmitById", + "parameters": [ + { + "description": "UUID of a Certificate Request", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Certificate Request", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestResubmissionRequest" + } + } } }, - "properties": { - "commonName": { - "type": "string" - }, - "country": { - "type": "string" - }, - "keyTypeParameters": { - "$ref": "#/components/schemas/KeyTypeParameters1" - }, - "locality": { - "type": "string" - }, - "organization": { - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestResponse" + } + } + }, + "description": "Certificate Request was resubmitted; details in response body." }, - "organizationalUnits": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "state": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Certificate Request not found." }, - "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/SubjectAlternativeNamesByType" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "Capability": { - "enum": [ - "DEFAULT", - "ISSUANCE", - "VALIDATION", - "ENTERPRISE", - "PROVISIONING", - "SINGLE_SIGN_ON", - "DISTRIBUTED_ISSUER", - "CLOUD_PROVIDERS", - "CREDENTIAL_MANAGER", - "KUBERNETES_DISCOVERY", - "KUBERNETES_ENTERPRISE_COMPONENTS", - "KUBERNETES_ENTERPRISE_COMPONENTS_CERT_MANAGER", - "KUBERNETES_ENTERPRISE_COMPONENTS_VEI", - "KUBERNETES_ENTERPRISE_COMPONENTS_APE", - "KUBERNETES_ENTERPRISE_COMPONENTS_OS", - "KUBERNETES_INTEGRATION_TLSPDC" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "string" - }, - "CapabilityInformation": { - "properties": { - "isTrial": { - "type": "boolean" - }, - "name": { - "$ref": "#/components/schemas/Capability" - }, - "productExpiryDate": { - "format": "date-time", - "type": "string" - }, - "productGraceExpiryDate": { - "format": "date-time", - "type": "string" + "summary": "Resubmit a certificate request", + "tags": [ + "Certificate Request" + ] + } + }, + "/outagedetection/v1/certificaterequests/validation": { + "post": { + "description": "This operation validates a proposed certificate request without actually submitting it.Checks for compliance with the specified issuing template and verifies all other references are valid (e.g., `existingCertificateId` is the UUID of an inventory certificate).", + "operationId": "certificaterequests_validation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestRequest" + } + } } }, - "required": [ - "isTrial", - "name", - "productExpiryDate" - ], - "type": "object" - }, - "CertificateAuthorityProductInformation1": { - "properties": { - "certificateType": { - "enum": [ - "OTHER", - "DOMAIN_VALIDATED_SSL" - ], - "type": "string" - }, - "hashAlgorithm": { - "enum": [ - "MD5", - "SHA1", - "MD2", - "SHA224", - "SHA256", - "SHA384", - "SHA512", - "UNKNOWN", - "GOSTR3411_94" - ], - "type": "string" - }, - "productName": { - "type": "string" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificationRequestInformation" + } + } + }, + "description": "Certificate Request was validated." }, - "productTypes": { - "items": { - "enum": [ - "SSL", - "CODESIGN" - ], - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "PnYnMnDTnHnMnS", - "type": "string" - } - }, - "type": "object" - }, - "CertificateAuthorityProductInformation2": { - "description": "Product specific for external certificate authority", - "discriminator": { - "propertyName": "certificateAuthority" - }, - "properties": { - "certificateAuthority": { - "type": "string" - }, - "certificateType": { - "enum": [ - "OTHER", - "DOMAIN_VALIDATED_SSL" - ], - "type": "string" - }, - "hashAlgorithm": { - "enum": [ - "MD5", - "SHA1", - "MD2", - "SHA224", - "SHA256", - "SHA384", - "SHA512", - "UNKNOWN", - "GOSTR3411_94" - ], - "type": "string" - }, - "productName": { - "type": "string" - }, - "productTypes": { - "items": { - "enum": [ - "SSL", - "CODESIGN" - ], - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "readOnly": true, - "type": "array" - }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "PnYnMnDTnHnMnS", - "type": "string" + "description": "Incomplete or malformed request." } }, - "required": [ - "certificateAuthority" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "CertificateCredentialData": { - "properties": { - "certificateBundle": { - "description": "The Base64 encoding certificate bundle encrypted content.", - "format": "byte", - "type": "string" - }, - "certificateId": { - "description": "The Id of the certificate selected from the Certificate Inventory", - "format": "uuid", - "type": "string" + "summary": "Validate a certificate request", + "tags": [ + "Certificate Request" + ] + } + }, + "/outagedetection/v1/certificaterequestssearch": { + "post": { + "description": "Retrieves the details of certificate requests that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", + "operationId": "getCertificateRequestsByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter2" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestDocumentResponse" + } + } + }, + "description": "The response body contains the details of the certificate requests." }, - "certificatePassword": { - "description": "The password to decrypt the certificate bundle.", - "format": "password", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "The request is either incomplete or malformed." }, - "fingerprint": { - "description": "The fingerprint of the certificate selected from the Certificate Inventory", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "The request is either incomplete or malformed." } }, - "type": "object" - }, - "CertificateDeletionRequest": { - "properties": { - "certificateIds": { - "description": "Unique certificate id(s) containing numbers, letters and dashes.", - "example": [ - "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", - "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" - ], - "items": { + "summary": "Get the details of certificate requests", + "tags": [ + "Certificate Request" + ] + } + }, + "/v1/certificateissuingtemplates": { + "get": { + "description": "Retrieves the details of issuing templates ordered by `priority` and `certificateAuthority`.", + "operationId": "certificateissuingtemplate_getAll", + "parameters": [ + { + "description": "UUID of a Certificate Authority Account.", + "in": "query", + "name": "certificateAuthorityAccountId", + "schema": { "format": "uuid", "type": "string" - }, - "type": "array" + } } - }, - "required": [ - "certificateIds" ], - "type": "object" - }, - "CertificateExpirationInventoryMonitoringConfig": { - "allOf": [ - { - "$ref": "#/components/schemas/InventoryMonitoringConfig" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateResponse" + } + } + }, + "description": "Details of Issuing Templates in response body." }, - { - "properties": { - "applicationIds": { - "description": "Application IDs that the webhook applies to", - "items": { - "description": "Application IDs that the webhook applies to", - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "enabled": { - "description": "Enables or disables webhook messages.", - "type": "boolean" - }, - "includeUnassignedCertificates": { - "description": "Enables or disables notifications for unassigned certificates.", - "type": "boolean" - }, - "thresholds": { - "description": "Array of certificate expiration thresholds, in days, for when notifications will be sent. Limit is 3 values.", - "items": { - "description": "Array of certificate expiration thresholds, in days, for when notifications will be sent. Limit is 3 values.", - "format": "int32", - "type": "integer" - }, - "type": "array" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } } }, - "type": "object" + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] } ], - "type": "object" + "summary": "Get the details of issuing templates", + "tags": [ + "Certificate Policy" + ] }, - "CertificateImportInfo": { - "description": "Base64 encoding certificate content.", - "properties": { - "apiClientInformation": { - "$ref": "#/components/schemas/ApiClientInformation" - }, - "applicationIds": { - "description": "A collection of application IDs", - "example": [ - "47c9d920-da21-11ed-a63c-d508f08eeaa0", - "9303e940-df9d-11ed-8850-f18176fc5513" - ], - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" - }, - "certificate": { - "description": "Certificate base64 encoded format (PEM without header/footer", - "type": "string" - }, - "certificateUsageMetadata": { - "description": "A collection of certificate request metadata", - "example": [ - { - "appName": "venafi app1", - "automationMetadata": "automation data 008", - "nodeName": "venafi node 007" - }, - { - "appName": "venafi app2", - "automationMetadata": "automation data 0013", - "nodeName": "venafi node 005" + "post": { + "description": "Creates an issuing template.", + "operationId": "certificateissuingtemplate_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateRequest" } - ], - "items": { - "$ref": "#/components/schemas/CertificateUsageMetadata" - }, - "type": "array" - }, - "issuerCertificates": { - "description": "A collection of issuer certificates", - "example": [ - "Venafi issuer", - "QA Venafi issuer" - ], - "items": { - "type": "string" - }, - "type": "array" + } } }, - "required": [ - "certificate" - ], - "type": "object" - }, - "CertificateImportInformation": { - "description": "List of the certificates and private key pairs to import", - "properties": { - "certificate": { - "description": "Certificate to import", - "type": "string" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateResponse" + } + } + }, + "description": "Issuing Template was created; details in response body." }, - "dekEncryptedPassword": { - "description": "Password to decrypt the certificate", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." }, - "dekEncryptedPrivateKey": { - "description": "Format of the private key", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Issuing Template not found." }, - "passwordEncryptedPrivateKey": { - "description": "Private key for certificate to import", - "type": "string" + "409": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Issuing Template already exists." }, - "pkcs12Keystore": { - "description": "pkcs12 keystore base64 encoded string", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "certificate", - "dekEncryptedPrivateKey", - "passwordEncryptedPrivateKey" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "CertificateImportRequest1": { - "properties": { - "certificates": { - "description": "Base64 encoding certificate content.", - "items": { - "$ref": "#/components/schemas/CertificateImportInfo" - }, - "type": "array" - }, - "overrideBlocklist": { - "description": "What is this?? Need a description here.", - "type": "boolean" + "summary": "Add an issuing template", + "tags": [ + "Certificate Policy" + ] + } + }, + "/v1/certificateissuingtemplates/{id}": { + "get": { + "description": "Retrieve the details of the issuing template that has the specified `id`.", + "operationId": "certificateissuingtemplate_getById", + "parameters": [ + { + "description": "UUID of an Issuing Template.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Issuing Template.", + "format": "uuid", + "type": "string" + } } - }, - "required": [ - "certificates" ], - "type": "object" - }, - "CertificateImportRequest2": { - "properties": { - "edgeInstanceId": { - "description": "Id for edge instance", - "format": "uuid", - "type": "string" - }, - "encryptionKeyId": { - "description": "Id for data encryption key", - "minLength": 1, - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" + } + } + }, + "description": "Issuing Template was found; details in response body." }, - "importInformation": { - "description": "List of the certificates and private key pairs to import", - "items": { - "$ref": "#/components/schemas/CertificateImportInformation" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "maxItems": 100, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "edgeInstanceId", - "encryptionKeyId", - "importInformation" - ], - "type": "object" - }, - "CertificateImportResponse1": { - "properties": { - "certificateInformations": { - "description": "A collection of information about certificates that were newly imported.", - "items": { - "$ref": "#/components/schemas/ImportedCertificateInformation" + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "array" + "description": "Issuing Template not found." }, - "statistics": { - "additionalProperties": { - "description": "Certificate import statistics", - "format": "int32", - "type": "integer" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "description": "Certificate import statistics", - "type": "object" + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CertificateImportResponse2": { - "properties": { - "creationDate": { - "description": "Import creation date of certificates and private keys", - "format": "date-time", - "type": "string" - }, - "id": { - "description": "Import id used to check the status of the bulk operation", - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" + ], + "summary": "Get an issuing template details", + "tags": [ + "Certificate Policy" + ] }, - "CertificateImportStatusDetail": { - "description": "Status detail information for each certificate and private key imported related to the import id", - "properties": { - "certificateBytes": { - "description": "Bytes of the imported certificate", - "format": "byte", - "type": "string" - }, - "fingerprint": { - "description": "Unique identifier for the imported certificate", - "type": "string" - }, - "reason": { - "description": "Reason for the status result", - "type": "string" - }, - "status": { - "description": "Result status for the import", - "enum": [ - "IMPORTED", - "FAILED", - "SKIPPED", - "PROCESSING" - ], - "type": "string" + "put": { + "description": "Updates all the details of the issuing template that has the specified `id`.", + "operationId": "certificateissuingtemplate_update", + "parameters": [ + { + "description": "UUID of an Issuing Template.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Issuing Template.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateRequest" + } + } } }, - "type": "object" - }, - "CertificateImportStatusDetailResponse": { - "properties": { - "id": { - "description": "Import id", - "format": "uuid", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" + } + } + }, + "description": "Issuing Template was updated; details in response body." }, - "results": { - "description": "Status detail information for each certificate and private key imported related to the import id", - "items": { - "$ref": "#/components/schemas/CertificateImportStatusDetail" + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" + } + } }, - "type": "array" + "description": "Issuing Template exists." }, - "status": { - "description": "Status of bulk import", - "enum": [ - "PROCESSING", - "COMPLETED", - "WAITING", - "FAILED" - ], - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Request Conditions Failed" + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Issuing Template not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Overwrite an issuing template details", + "tags": [ + "Certificate Policy" + ] }, - "CertificateInformation": { - "properties": { - "applicationIds": { - "description": "A collection of application IDs", - "example": [ - "561baf7c-98b7-49af-ab9c-7b3a9fea3028", - "4adeba6f-0c94-4595-a5b6-babea458249f" - ], - "items": { + "delete": { + "description": "Deletes the issuing template that has the specified `id`.", + "operationId": "certificateissuingtemplate_delete", + "parameters": [ + { + "description": "UUID of an Issuing Template.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Issuing Template.", "format": "uuid", "type": "string" - }, - "type": "array" - }, - "archivedDate": { - "description": "The date a certificate was archived", - "example": "2022-05-24T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "authorityKeyIdentifierHash": { - "description": "An authority key identifier hash", - "example": "40572B10F85DDAF18BFF987372178532AB875BCA", - "type": "string" - }, - "certificateAuthorityAccountId": { - "description": "UUID of a certificate authority account", - "format": "uuid", - "type": "string" - }, - "certificateName": { - "description": "A certificate name", - "example": "venafi.com", - "type": "string" - }, - "certificateRequestId": { - "description": "UUID of a certificate request", - "example": "2e8964a0-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" - }, - "certificateStatus": { - "description": "Certificate's status", - "enum": [ - "ACTIVE", - "RETIRED", - "DELETED" - ], - "example": "ACTIVE", - "type": "string" - }, - "companyId": { - "description": "UUID of a company", - "example": "85595df0-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" - }, - "dekHash": { - "description": "A certificate dek hash", - "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", - "type": "string" - }, - "encryptionType": { - "description": "A certificate encryption type", - "enum": [ - "RSA", - "DSA", - "EC", - "GOST3410", - "ECGOST3410", - "RESERVED3", - "UNKNOWN" - ], - "example": "EC", - "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Issuing Template was deleted" }, - "extendedKeyUsage": { - "description": "A collection of certificate extended key usages", - "example": [ - "1.3.6.1.5.5.7.3.2", - "1.3.6.1.5.5.7.3.1" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "array" - }, - "fingerprint": { - "description": "A certificate fingerprint", - "example": "6D4C95512C117B004191F1A096ECAD13242FCD9F", - "type": "string" + "description": "Incomplete or malformed request." }, - "id": { - "description": "UUID of a certificate", - "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Issuing Template not found." }, - "inhibitAnyPolicy": { - "description": "Inhibit any policy", - "example": 150, - "format": "int32", - "type": "integer" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove an issuing template", + "tags": [ + "Certificate Policy" + ] + } + }, + "/v1/certificateissuingtemplates/domainssynchronization": { + "post": { + "description": "Loads domain list from CA and updates the issuing templates with it", + "operationId": "domainssynchronization", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IssuingTemplatesDomainsSyncRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IssuingTemplateDomainsSyncResponse" + } + } + }, + "description": "List with the information about the status of the sync of every issuing template" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Synchronize issuing templates domains with CA", + "tags": [ + "Certificate Policy" + ] + } + }, + "/outagedetection/v1/applications": { + "get": { + "description": "Returns the details of applications matching the below provided criteria.", + "operationId": "applications_getAll", + "parameters": [ + { + "description": "Indicates whether or not the response should include the `owningUsers` and `owningTeams` details.", + "in": "query", + "name": "ownerDetails", + "schema": { + "default": false, + "type": "boolean" + } }, - "inhibitPolicyMapping": { - "description": "Inhibit policy mapping", - "example": 200, - "format": "int32", - "type": "integer" + { + "description": "Indicates whether or not the response should exclude applications that are not editable by the current user.", + "in": "query", + "name": "ownershipCheck", + "schema": { + "default": false, + "type": "boolean" + } }, - "instances": { - "description": "A collection of certificate instances information", - "example": [ - { - "certificateId": "7ec12010-9051-11ed-8e50-b994b27d2ece", - "certificateInstanceId": "7ec1bc50-9051-11ed-8e50-b994b27d2ece", - "certificateSource": "USER_SCAN", - "deploymentStatus": "IN_USE", - "hostname": "venafi.com", - "instanceChainValidationStatus": [ - "OK" - ], - "ipAddress": "23.185.0.2", - "lastScanDate": "2023-01-09T19:12:05.314+00:00", - "lastValidatedAttempt": "2023-01-09T19:12:05.446+00:00", - "modificationDate": "2023-01-09T19:12:14.865+00:00", - "port": 443, - "serviceIds": [ - "1d61e9e0-9046-11ed-bf12-53a1b041cf25" - ], - "sslProtocols": [ - "TLSv1.3", - "TLSv1.2" - ], - "sslValidationErrorArguments": [], - "sslValidationStatus": "OK" + { + "description": "Indicates whether or not the response should exclude applications with no issuing templates assigned to them.", + "in": "query", + "name": "issuingTemplateAssigned", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "This parameter is deprecated for Application endpoints.", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationResponse" + } } - ], - "items": { - "$ref": "#/components/schemas/CertificateInstanceInformation" }, - "type": "array" + "description": "Details of applications in response body." }, - "issuerAlternativeNameDns": { - "description": "A collection of certificate issuer alternative names DNs", - "example": [ - "venafi.com", - "www.venafi.com" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "issuerAlternativeNameNonDns": { - "description": "A collection of certificate issuer alternative name none DNs", - "example": [ - "venafi issuer doman" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" - }, - "issuerC": { - "description": "A certificate issues Country", - "example": "US", - "type": "string" - }, - "issuerCN": { - "description": "A collection of certificate issuer Common names", - "example": [ - "HydrantID SSL CA G3" - ], - "items": { - "type": "string" + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of applications", + "tags": [ + "Application" + ] + }, + "post": { + "description": "Creates an application.", + "operationId": "applications_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationResponse" + } + } }, - "type": "array" + "description": "Application was created; details in response body." }, - "issuerCertificateIds": { - "description": "A collection of issuer certificate IDs", - "example": [ - "2e8964a0-9046-11ed-8e50-b994b27d2ece", - "d5b418a0-297e-11eb-bc4c-8b24e5a66fb6" - ], - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "issuerDN": { - "description": "A certificate issue DN", - "example": "cn=HydrantID SSL CA G3,o=HydrantID (Avalanche Cloud Corporation),c=US", - "type": "string" + "409": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Application already exists." }, - "issuerL": { - "description": "A certificate issues Locality", - "example": "Salt Lake City", - "type": "string" - }, - "issuerOU": { - "description": "A collection of certificate issuer Organization units", - "example": [ - "Issuer CA" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add an application", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/{id}": { + "get": { + "description": "Retrieves the details of the application that has the specified `id`.", + "operationId": "applications_getById", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", + "type": "string" + } }, - "issuerST": { - "description": "A certificate issuer State", - "example": "Utah", - "type": "string" + { + "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`).", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationInformation" + } + } + }, + "description": "Application Information" }, - "keyCurve": { - "description": "A certificate key curve", - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "example": "P256", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed." }, - "keyStrength": { - "description": "A certificate key strength", - "example": 2048, - "format": "int32", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Application not found." }, - "keyUsage": { - "description": "A collection of certificate key usages", - "example": [ - "digitalSignature", - "keyEncipherment" - ], - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get an application details", + "tags": [ + "Application" + ] + }, + "put": { + "description": "Updates (replaces) all details of the application that has the specified `id`.", + "operationId": "applications_update", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationInformation" + } + } }, - "type": "array" - }, - "lastNotification": { - "format": "int32", - "type": "integer" + "description": " Application was updated; details in response body" }, - "managedCertificateId": { - "description": "UUID of a managed certificate", - "example": "2f0e7320-9046-11ed-8ab8-19e0a618d9cd", - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "modificationDate": { - "description": "The last date a certificate was modified", - "example": "2022-03-24T09:12:28Z", - "format": "date-time", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Application not found." }, - "ocspNoCheck": { - "description": "If a certificate no ocsp check", - "example": false, - "type": "boolean" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update an application details", + "tags": [ + "Application" + ] + }, + "delete": { + "description": "Deletes the application that has the specified `id`.", + "operationId": "applications_delete", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Application was deleted." }, - "ownership": { - "$ref": "#/components/schemas/CertificateOwnership" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "pathLength": { - "description": "A certificate path length", - "example": 3, - "format": "int32", - "type": "integer" - }, - "requireExplicitPolicy": { - "description": "Required explicit policy is required", - "example": 1, - "format": "int32", - "type": "integer" - }, - "selfSigned": { - "description": "If the certificate is self singed", - "example": true, - "type": "boolean" - }, - "serialNumber": { - "description": "A certificate serial number", - "example": "0C51A562B02A19A222FFB4730C47A8E2", - "type": "string" - }, - "signatureAlgorithm": { - "description": "A certificate signature algorithm", - "enum": [ - "MD2_WITH_RSA_ENCRYPTION", - "MD5_WITH_RSA_ENCRYPTION", - "SHA1_WITH_RSA_ENCRYPTION", - "SHA1_WITH_RSA_ENCRYPTION2", - "SHA256_WITH_RSA_ENCRYPTION", - "SHA384_WITH_RSA_ENCRYPTION", - "SHA512_WITH_RSA_ENCRYPTION", - "ID_DSA_WITH_SHA1", - "dsaWithSHA1", - "EC_DSA_WITH_SHA1", - "EC_DSA_WITH_SHA224", - "EC_DSA_WITH_SHA256", - "EC_DSA_WITH_SHA384", - "EC_DSA_WITH_SHA512", - "UNKNOWN", - "SHA1_WITH_RSAandMGF1", - "GOST_R3411_94_WITH_GOST_R3410_2001", - "GOST_R3411_94_WITH_GOST_R3410_94" - ], - "example": "SHA256_WITH_RSA_ENCRYPTION", - "type": "string" - }, - "signatureHashAlgorithm": { - "description": "A certificate signature hash algorithm", - "enum": [ - "MD5", - "SHA1", - "MD2", - "SHA224", - "SHA256", - "SHA384", - "SHA512", - "UNKNOWN", - "GOSTR3411_94" - ], - "example": "SHA256", - "type": "string" - }, - "statusModificationDate": { - "description": "The date a certificate's status was modified", - "example": "2022-04-24T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "statusModificationUserId": { - "description": "UUID of the user that modified the certificate installation", - "example": "3c9964a0-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" - }, - "subjectAlternativeNameDns": { - "description": "A collection of certificate subject alternative names DNs", - "example": [ - "venafi.com", - "www.venafi.com" - ], - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Application not found." }, - "subjectAlternativeNameNonDns": { - "description": "A collection of certificate subject alternative name none DNs", - "example": [ - "venafi domain" - ], - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove an application", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/{id}/invitations": { + "post": { + "description": "Activates a URL that invites new users to become owners of the application with the specified `id`. The invitation link remains valid for 10 minutes.", + "operationId": "applications_invitations_create", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationResponse" + } + } }, - "type": "array" - }, - "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData1" + "description": "If successful, this operation returns a User Invitation link in the response body." }, - "subjectC": { - "description": "A certificate subject Country", - "example": "US", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "subjectCN": { - "description": "A collection of certificate subject CNs", - "example": [ - "venafi.com", - "cloud.venafi" - ], - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Creates an invitation link for an", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/{id}/scanaficonfiguration": { + "get": { + "description": "Retrieves the *Basic Discovery* (Scanafi) configuration for the application that has the specified `id`.", + "operationId": "applications_getScanafiConfigById", + "parameters": [ + { + "description": "UUID of an Application.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an Application.", + "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScanafiConfigResponseV1" + } + } }, - "type": "array" - }, - "subjectDN": { - "description": "A certificate subject DN", - "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", - "type": "string" + "description": "Basic Discovery configuration in response body." }, - "subjectKeyIdentifierHash": { - "description": "A subject key identifier hash", - "example": "4E0CE93D3240561F468C33A85F08FCD3B04CC9DC", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "subjectL": { - "description": "A certificate subject Locality", - "example": "Salt Lake City", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Application not found." }, - "subjectO": { - "description": "A certificate subject Organization", - "example": "Venafi, Inc.", - "type": "string" - }, - "subjectOU": { - "description": "A collection of certificate subject Organization units", - "example": [ - "devops", - "test" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" - }, - "subjectST": { - "description": "A certificate subject State", - "example": "Utah", - "type": "string" + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the Basic Discovery configuration for", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/{name}/certificateissuingtemplates/{alias}": { + "get": { + "description": "Retrieves the details of the certificate issuing template identified by the specified `alias` assigned to the application that has the specified `name`.", + "operationId": "certificateissuingtemplates_getByAlias", + "parameters": [ + { + "description": "Name of an Application.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "type": "string" + } }, - "tags": { - "description": "A collection of tags", - "example": [ - "owner:test.user", - "90-day" - ], - "items": { + { + "description": "Alias of an Issuing Template for the specified Application.", + "in": "path", + "name": "alias", + "required": true, + "schema": { "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" + } + } }, - "type": "array" + "description": "Issuing Template was found; details in response body." }, - "totalActiveInstanceCount": { - "description": "total active instances of a certificate", - "example": 50, - "format": "int32", - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "totalInstanceCount": { - "description": "total instances of a certificate", - "example": 100, - "format": "int32", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Issuing Template not found." }, - "validityEnd": { - "description": "The date a certificate validity ends", - "example": "2023-01-24T09:12:28Z", - "format": "date-time", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of an issuing", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/certificates": { + "patch": { + "description": "Update one or more application assignments for one or more certificates. Valid actions are ADD, REPLACE and DELETE.", + "operationId": "applications_assignToCertificates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationsAssignRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationsAssignResponse" + } + } + }, + "description": "Certificate application assignments were updated; details in response body." }, - "validityStart": { - "description": "The date a certificate validity starts", - "example": "2022-01-24T09:12:28Z", - "format": "date-time", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "versionType": { - "description": "A certificate version type", - "enum": [ - "OLD", - "CURRENT" - ], - "example": "CURRENT", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CertificateInstanceInformation": { - "properties": { - "applicationIds": { - "description": "A collection of application IDs", - "example": [ - "d3cce873-6957-4071-a65e-7676c0ae1123", - "322bcd99-286a-47ea-8dcd-8291ec5bff14" - ], - "items": { - "format": "uuid", + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Manage application assignments for a set", + "tags": [ + "Application" + ] + } + }, + "/outagedetection/v1/applications/name/{name}": { + "get": { + "description": "Retrieves the details of the application that has the specified `name`.", + "operationId": "applications_getByName", + "parameters": [ + { + "description": "Name of an Application.", + "in": "path", + "name": "name", + "required": true, + "schema": { "type": "string" - }, - "type": "array" - }, - "certificateId": { - "description": "UUID of a certificate", - "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" + } }, - "certificateInstanceId": { - "description": "UUID of a certificate instance", - "example": "f68daf30-4690-45bc-85b3-bb327024735e", - "format": "uuid", - "type": "string" + { + "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`).", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationInformation" + } + } + }, + "description": "Application was found; details in response body." }, - "certificateSource": { - "description": "Certificate source", - "enum": [ - "UNKNOWN", - "USER_PROVIDED", - "USER_IMPORTED", - "USER_SCAN", - "TRUSTNET_SCAN", - "ON_PREM_CA_IMPORT", - "EXTERNAL_CA_IMPORT", - "FILE_IMPORT", - "EXTERNAL_SCAN", - "DOMAIN_SCAN", - "SMART_SCAN_INTERNAL", - "SMART_SCAN_EXTERNAL", - "SMART_VALIDATION_INTERNAL", - "SMART_VALIDATION_EXTERNAL", - "MACHINE_DISCOVERY", - "KUBERNETES_DISCOVERY", - "AWS_DISCOVERY", - "AZURE_DISCOVERY", - "GCP_DISCOVERY" - ], - "example": "USER_SCAN", - "type": "string" - }, - "deploymentStatus": { - "description": "The deployment status", - "enum": [ - "UNKNOWN", - "IN_USE", - "SUPERSEDED" - ], - "example": "IN_USE", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "hostname": { - "description": "A hostname", - "example": "venafi.com", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Application not found." }, - "instanceChainValidationStatus": { - "description": "A collection of the instance chain validation status", - "example": [ - "OK" - ], - "items": { - "enum": [ - "OK", - "CHAIN_BUILDING_FAILED", - "INCOMPLETE_CHAIN", - "CHAIN_EXPIRE_BEFORE_EE", - "DISTRUSTED", - "UNKNOWN_ERROR", - "SELF_SIGNED" - ], - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get an application details by its", + "tags": [ + "Application" + ] + } + }, + "/v1/credentialmanagerconfigurations": { + "get": { + "description": "Retrieves a set of stored Credential Manager Service configurations.", + "operationId": "get-public-cms-conf", + "parameters": [ + { + "$ref": "#/components/parameters/CMSTypesParam" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200GetCMSConfigurations" }, - "ipAddress": { - "description": "An ip address", - "example": "14.183.1.32", - "type": "string" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "lastScanDate": { - "description": "The last scan date", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "lastValidatedAttempt": { - "description": "The last validation attempt date", - "example": "2023-01-11T09:12:28Z", - "format": "date-time", - "type": "string" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "modificationDate": { - "description": "The last modification date", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" + "404": { + "$ref": "#/components/responses/404NotFound" }, - "port": { - "description": "A port number", - "example": 443, - "format": "int32", - "type": "integer" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves a set of Credential Manager", + "tags": [ + "Credential Management" + ] + }, + "post": { + "description": "Adds a set of new Credential Manager Service configurations. Only one Credential Manager Service configuration per `cmsType` per company can exist.", + "operationId": "post-public-cms-conf", + "requestBody": { + "$ref": "#/components/requestBodies/CreateCMSConfigurationsBodyRequest" + }, + "responses": { + "201": { + "$ref": "#/components/responses/201CreateCMSConfigurations" }, - "serviceIds": { - "description": "A collection of service IDs", - "example": [ - "1d61e9e0-9046-11ed-bf12-53a1b041cf2" - ], - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "sslProtocols": { - "description": "A collection of ssl protocols", - "example": [ - "TLSv1.1", - "TLSv1.2" - ], - "items": { - "type": "string" - }, - "type": "array" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "sslValidationErrorArguments": { - "description": "A collection of ssl validation error arguments", - "example": [ - "B69950CC5F51EDDF55F36AD2BC898767BC43CC2A", - "24E5796GA7298E78EDE47D6FAED0790E8F464G54" - ], - "items": { - "type": "string" - }, - "type": "array" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "sslValidationStatus": { - "description": "SSL validation status", - "enum": [ - "HOSTNAME_NOT_RESOLVABLE", - "NO_CERTIFICATE_PRESENTED", - "INVALID_CERTIFICATE_FOUND", - "UNEXPECTED_CERTIFICATE_FOUND", - "OLD_VERSION_CERTIFICATE_FOUND", - "TARGET_UNREACHABLE", - "UNKNOWN_ERROR", - "OK" - ], - "example": "OK", - "type": "string" + "404": { + "$ref": "#/components/responses/404NotFound" }, - "sslValidationStatusMessage": { - "description": "SSL validation status message", - "example": "Certificate installation is using older versions of certificate", - "type": "string" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "type": "object" - }, - "CertificateInstanceValidationRequest": { - "properties": { - "instanceIds": { - "description": "Unique certificate instance id(s) containing numbers, letters and dashes.", - "example": [ - "7860eedb-c140-4354-b0ad-991cc7a7b4d1", - "0b0f6424-30bc-4ed8-ae83-cdeca3eaf60e" - ], - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "required": [ - "instanceIds" ], - "type": "object" + "summary": "Add a set of Credential Manager", + "tags": [ + "Credential Management" + ] }, - "CertificateIssuingTemplateInformation1": { - "properties": { - "certificateAuthority": { - "enum": [ - "MOCKCA", - "DIGICERT", - "GLOBALSIGN", - "BUILTIN", - "ENTRUST", - "MICROSOFT", - "ACME", - "ZTPKI", - "GLOBALSIGNMSSL", - "TPP", - "CONNECTOR" - ], - "type": "string" - }, - "certificateAuthorityAccountId": { - "format": "uuid", - "type": "string" + "put": { + "description": "Updates the information of an existing Credential Manager Service configuration.", + "operationId": "put-public-cms-conf", + "requestBody": { + "$ref": "#/components/requestBodies/UpdateCMSConfigurationsBodyRequest" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200UpdateCMSConfiguration" }, - "certificateAuthorityProductOptionId": { - "format": "uuid", - "type": "string" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "companyId": { - "format": "uuid", - "type": "string" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "creationDate": { - "format": "date-time", - "type": "string" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "csrUploadAllowed": { - "type": "boolean" + "404": { + "$ref": "#/components/responses/404NotFound" }, - "everyoneIsConsumer": { - "type": "boolean" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a Credential Manager Service configuration", + "tags": [ + "Credential Management" + ] + } + }, + "/v1/credentialmanagerconfigurations/{id}": { + "get": { + "description": "Retrieves a Credential Manager Service configuration by the specified `id`.", + "operationId": "get-public-cms-conf-id", + "responses": { + "200": { + "$ref": "#/components/responses/200GetCMSConfiguration" }, - "id": { - "format": "uuid", - "type": "string" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "keyGeneratedByVenafiAllowed": { - "type": "boolean" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "keyReuse": { - "type": "boolean" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "keyTypes": { - "items": { - "$ref": "#/components/schemas/KeyTypeInformation1" - }, - "type": "array" + "404": { + "$ref": "#/components/responses/404NotFound" }, - "modificationDate": { - "format": "date-time", - "type": "string" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves a Credential Manager Service configurati", + "tags": [ + "Credential Management" + ], + "parameters": [ + { + "$ref": "#/components/parameters/CMSConfigIdParam" + } + ] + }, + "delete": { + "description": "Deletes a Credential Manager Service configuration by the specified `id`.", + "operationId": "delete-public-cms-conf-id", + "responses": { + "204": { + "description": "The returned HTTP code if the Credential Manager Service configuration was deleted successfully." }, - "name": { - "type": "string" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "priority": { - "format": "int32", - "type": "integer" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "product": { - "$ref": "#/components/schemas/CertificateAuthorityProductInformation1" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "productEntitlement": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string" + "404": { + "$ref": "#/components/responses/404NotFound" }, - "productEntitlements": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string", - "writeOnly": true + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a Credential Manager Service configuration", + "tags": [ + "Credential Management" + ], + "parameters": [ + { + "$ref": "#/components/parameters/CMSConfigIdParam" + } + ] + } + }, + "/v1/credentialmanagerconfigurations/test": { + "post": { + "description": "Tests the connection to a configured privileged access management through selected VSatellites.", + "operationId": "post-public-cms-conf-test", + "requestBody": { + "$ref": "#/components/requestBodies/TestCMSConfigurationBodyRequest" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200TestCMSConfiguration" }, - "reason": { - "type": "string" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "recommendedSettings": { - "$ref": "#/components/schemas/RecommendedSettingsInformation1" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "resourceConsumerTeamIds": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "resourceConsumerUserIds": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "404": { + "$ref": "#/components/responses/404NotFound" }, - "sanDnsNameRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Test the connection to a privileged", + "tags": [ + "Credential Management" + ] + } + }, + "/v1/credentialmanagerconfigurations/{id}/test": { + "post": { + "description": "Tests the connection to a configured privileged access management through selected VSatellites using a specified `id`.", + "operationId": "post-public-cms-conf-test-id", + "responses": { + "200": { + "$ref": "#/components/responses/200TestCMSConfiguration" }, - "sanIpAddressRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "sanRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "sanRfc822NameRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "sanUniformResourceIdentifierRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "404": { + "$ref": "#/components/responses/404NotFound" }, - "status": { - "enum": [ - "AVAILABLE", - "UNAVAILABLE" - ], - "type": "string" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Test the connection to an external", + "tags": [ + "Credential Management" + ], + "parameters": [ + { + "$ref": "#/components/parameters/CMSConfigIdParam" + } + ] + } + }, + "/v1/credentials": { + "get": { + "description": "Retrieves a list of shared credentials for a company.", + "operationId": "get-public-cms-credential", + "parameters": [ + { + "$ref": "#/components/parameters/CMSCredentialDetailsParam" }, - "subjectCNRegexes": { - "items": { - "type": "string" - }, - "type": "array" + { + "$ref": "#/components/parameters/CMSTypesParam" }, - "subjectCValues": { - "items": { - "type": "string" - }, - "type": "array" + { + "$ref": "#/components/parameters/CredentialIdsParam" }, - "subjectLRegexes": { - "items": { - "type": "string" - }, - "type": "array" + { + "$ref": "#/components/parameters/TeamIdsParam" }, - "subjectORegexes": { - "items": { - "type": "string" - }, - "type": "array" + { + "$ref": "#/components/parameters/AuthTypesParam" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200GetCredentials" }, - "subjectOURegexes": { - "items": { - "type": "string" - }, - "type": "array" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "subjectSTRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "systemGenerated": { - "type": "boolean" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "PnYnMnDTnHnMnS", - "type": "string" + "422": { + "$ref": "#/components/responses/404NotFound" + }, + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves credentials for a company", + "tags": [ + "Credential Management" + ] }, - "CertificateIssuingTemplateInformation2": { - "properties": { - "certificateAuthority": { - "enum": [ - "MOCKCA", - "DIGICERT", - "GLOBALSIGN", - "BUILTIN", - "ENTRUST", - "MICROSOFT", - "ACME", - "ZTPKI", - "GLOBALSIGNMSSL", - "TPP", - "CONNECTOR" - ], - "type": "string" - }, - "certificateAuthorityAccountId": { - "format": "uuid", - "type": "string" - }, - "certificateAuthorityProductOptionId": { - "format": "uuid", - "type": "string" - }, - "companyId": { - "format": "uuid", - "type": "string" + "post": { + "description": "Adds a set of new shared credentials. The `name` for each credential must be unique.", + "operationId": "post-public-cms-credential", + "requestBody": { + "$ref": "#/components/requestBodies/AddCredentialsBodyRequest" + }, + "responses": { + "201": { + "$ref": "#/components/responses/201AddCredentials" }, - "creationDate": { - "format": "date-time", - "type": "string" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "csrUploadAllowed": { - "type": "boolean" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "description": { - "type": "string" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "driverGeneratedCsr": { - "type": "boolean" + "422": { + "$ref": "#/components/responses/404NotFound" }, - "driverId": { - "format": "uuid", - "type": "string" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a set of new shared", + "tags": [ + "Credential Management" + ] + }, + "put": { + "description": "Updates the information of an existing shared credential.", + "operationId": "put-public-cms-credential", + "requestBody": { + "$ref": "#/components/requestBodies/UpdateCredentialBodyRequest" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200UpdateCredential" }, - "everyoneIsConsumer": { - "type": "boolean" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "extendedKeyUsageValues": { - "items": { - "enum": [ - "SERVER", - "CLIENT" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "id": { - "format": "uuid", - "type": "string" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "keyGeneratedByVenafiAllowed": { - "type": "boolean" + "422": { + "$ref": "#/components/responses/404NotFound" }, - "keyPairId": { - "format": "uuid", - "type": "string" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a shared credential", + "tags": [ + "Credential Management" + ] + }, + "delete": { + "description": "Deletes existing shared credentials specified in the query parameter list of `ids`.", + "operationId": "delete-public-cms-credential", + "parameters": [ + { + "$ref": "#/components/parameters/CredentialIdsParam" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200DeleteCredentials" }, - "keyReuse": { - "type": "boolean" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "keyTypes": { - "items": { - "$ref": "#/components/schemas/KeyTypeInformation2" - }, - "type": "array" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "locationId": { - "format": "uuid", - "type": "string" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "modificationDate": { - "format": "date-time", - "type": "string" + "422": { + "$ref": "#/components/responses/404NotFound" }, - "name": { - "type": "string" - }, - "priority": { - "format": "int32", - "type": "integer" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete shared credentials", + "tags": [ + "Credential Management" + ] + } + }, + "/v1/credentials/{id}": { + "get": { + "description": "Retrieves the credential matching with provided `id`.", + "operationId": "get-public-cms-credential-id", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "description": "Credential ID.", + "schema": { + "type": "string", + "format": "uuid" + } }, - "product": { - "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" + { + "$ref": "#/components/parameters/CMSCredentialDetailsParam" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/200GetCredential" }, - "reason": { - "type": "string" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "recommendedSettings": { - "$ref": "#/components/schemas/RecommendedSettingsInformation2" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "referencingApplicationIds": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "resourceConsumerTeamIds": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "422": { + "$ref": "#/components/responses/404NotFound" }, - "resourceConsumerUserIds": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves shared credential by ID", + "tags": [ + "Credential Management" + ] + }, + "delete": { + "description": "Deletes the shared credential by the specified `id`.", + "operationId": "delete-public-cms-credential-id", + "responses": { + "204": { + "description": "The returned http code if the credential was deleted successfully." }, - "sanDnsNameRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "sanIpAddressRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "sanRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "sanRfc822NameRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "422": { + "$ref": "#/components/responses/404NotFound" }, - "sanUniformResourceIdentifierRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete shared credential by ID", + "tags": [ + "Credential Management" + ], + "parameters": [ + { + "$ref": "#/components/parameters/CredentialIdParam" + } + ] + } + }, + "/v1/credentials/test": { + "post": { + "description": "Tests the access to a shared credential using a specified `id` or by providing credential values. If both an `id` and parameters are provided, parameters override existing credential values.", + "operationId": "post-public-cms-credential-test-id", + "requestBody": { + "$ref": "#/components/requestBodies/TestCredentialBodyRequest" + }, + "responses": { + "200": { + "$ref": "#/components/responses/200TestCredential" }, - "status": { - "enum": [ - "AVAILABLE", - "UNAVAILABLE" - ], - "type": "string" + "400": { + "$ref": "#/components/responses/400BadRequest" }, - "subjectCNRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "401": { + "$ref": "#/components/responses/401Unauthorized" }, - "subjectCValues": { - "items": { - "type": "string" - }, - "type": "array" + "403": { + "$ref": "#/components/responses/403Forbidden" }, - "subjectLRegexes": { - "items": { - "type": "string" - }, - "type": "array" + "404": { + "$ref": "#/components/responses/404NotFound" }, - "subjectORegexes": { - "items": { - "type": "string" + "500": { + "$ref": "#/components/responses/500InternalServerErrorContent" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Test the access to shared credential", + "tags": [ + "Credential Management" + ] + } + }, + "/v1/machineidentities": { + "get": { + "description": "Retrieves the details of all machine identities..", + "operationId": "machineidentities_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityResponse" + } + } }, - "type": "array" + "description": "All Machine Identities for the company." }, - "subjectOURegexes": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "subjectSTRegexes": { - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" - }, - "systemGenerated": { - "type": "boolean" - }, - "trackingData": { - "$ref": "#/components/schemas/TrackingDataInformation" + "description": "Incomplete or malformed request." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all machine", + "tags": [ + "Machine Identities" + ] }, - "CertificateIssuingTemplateRequest": { - "properties": { - "certificateAuthority": { - "enum": [ - "MOCKCA", - "DIGICERT", - "GLOBALSIGN", - "BUILTIN", - "ENTRUST", - "MICROSOFT", - "ACME", - "ZTPKI", - "GLOBALSIGNMSSL", - "TPP", - "CONNECTOR" - ], - "type": "string" - }, - "certificateAuthorityProductOptionId": { - "format": "uuid", - "type": "string" - }, - "csrUploadAllowed": { - "type": "boolean" - }, - "description": { - "maxLength": 1024, - "type": "string" - }, - "driverGeneratedCsr": { - "type": "boolean" - }, - "driverId": { - "format": "uuid", - "type": "string" - }, - "everyoneIsConsumer": { - "type": "boolean" - }, - "extendedKeyUsageValues": { - "items": { - "enum": [ - "SERVER", - "CLIENT" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "keyGeneratedByVenafiAllowed": { - "type": "boolean" - }, - "keyPairId": { - "format": "uuid", - "type": "string" - }, - "keyReuse": { - "type": "boolean" - }, - "keyTypes": { - "items": { - "$ref": "#/components/schemas/KeyTypeParameters2" + "post": { + "description": "Creates a machine identity for a machine.", + "operationId": "machineidentities_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityCreationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityInformation" + } + } }, - "type": "array" - }, - "locationId": { - "format": "uuid", - "type": "string" - }, - "name": { - "maxLength": 64, - "type": "string" - }, - "priority": { - "format": "int32", - "type": "integer" - }, - "product": { - "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" - }, - "recommendedSettings": { - "$ref": "#/components/schemas/RecommendedSettingsRequest" + "description": "Machine Identity was created; details in response body." }, - "resourceConsumerTeamIds": { - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array", - "uniqueItems": true - }, - "resourceConsumerUserIds": { - "items": { + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a machine identity to a", + "tags": [ + "Machine Identities" + ] + } + }, + "/v1/machineidentities/{id}": { + "get": { + "description": "Retrieves the machine identity that has the specified `id`.", + "operationId": "machineidentities_getById", + "parameters": [ + { + "description": "UUID of a Machine Identity.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine Identity.", "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityInformation" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Machine Identity matching specified id" }, - "sanIpAddressRegexes": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Request Conditions Failed" }, - "sanRegexes": { - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Machine Identity not found" }, - "sanRfc822NameRegexes": { - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" - }, - "sanUniformResourceIdentifierRegexes": { - "items": { + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a machine identity details", + "tags": [ + "Machine Identities" + ] + }, + "delete": { + "description": "Deletes the machine identity that has the specified `id`.", + "operationId": "machineidentities_delete", + "parameters": [ + { + "description": "UUID of a Machine Identity.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine Identity.", + "format": "uuid", "type": "string" - }, - "type": "array" + } + } + ], + "responses": { + "204": { + "description": "Machine Identity was deleted." }, - "subjectCNRegexes": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "subjectCValues": { - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Machine Identity not found." }, - "subjectLRegexes": { - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" - }, - "subjectORegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subjectOURegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subjectSTRegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "trackingData": { - "$ref": "#/components/schemas/TrackingDataInformation" + "description": "Incomplete or malformed request." } }, - "required": [ - "certificateAuthority", - "certificateAuthorityProductOptionId", - "keyReuse", - "keyTypes", - "name", - "product" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" + "summary": "Remove a machine identity", + "tags": [ + "Machine Identities" + ] }, - "CertificateIssuingTemplateResponse": { - "properties": { - "certificateIssuingTemplates": { - "items": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" - }, - "type": "array" + "patch": { + "description": "CUpdates specific details of the machine identity that has the specified `id`.", + "operationId": "machineidentities_update", + "parameters": [ + { + "description": "UUID of a Machine Identity.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine Identity.", + "format": "uuid", + "type": "string" + } } - }, - "type": "object" - }, - "CertificateOwnership": { - "properties": { - "owningContainers": { - "items": { - "$ref": "#/components/schemas/ExtendedApplicationOwnership" - }, - "type": "array", - "uniqueItems": true + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityUpdateRequest" + } + } } }, - "type": "object" - }, - "CertificateRecoveryRequest": { - "properties": { - "applicationIds": { - "description": "Unique application id(s) containing numbers, letters and dashes.", - "example": [ - "47c9d920-da21-11ed-a63c-d508f08eeaa0", - "9303e940-df9d-11ed-8850-f18176fc5513" - ], - "items": { - "format": "uuid", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityInformation" + } + } }, - "type": "array" + "description": "Machine Identity was updated; details in response body." }, - "certificateIds": { - "description": "Unique certificate id(s) containing numbers, letters and dashes.", - "example": [ - "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", - "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" - ], - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "certificateIds" - ], - "type": "object" - }, - "CertificateRequestApprovalConditionsFilterRuleInformation": { - "properties": { - "applicationIds": { - "description": "A collection of application ids the rule will be applicable to", - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "certificateAuthorityAccountIds": { - "description": "A collection of certificate authority account ids the rule will be applicable to", - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Machine Identity not found." }, - "certificateIssuingTemplateIds": { - "description": "A collection of certificate issuing template ids the rule will be applicable to", - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CertificateRequestApprovalExceptionsFilterRuleInformation": { - "properties": { - "applicationIds": { - "description": "A collection of application ids the rule won't be applied to", - "format": "uuid", - "items": { + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a machine identity details", + "tags": [ + "Machine Identities" + ] + } + }, + "/v1/machineidentities/{id}/workflows": { + "post": { + "description": "Used to initiate a workflow like 'testConnection' for the machine that has the specified `id`.", + "operationId": "machineidentities_initiateWorkflow", + "parameters": [ + { + "description": "UUID of a Machine Identity.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine Identity.", "format": "uuid", "type": "string" - }, - "type": "array" - }, - "requestors": { - "description": "A collection of approvers, specified by type and id, for which the rule won't be applied", - "items": { - "$ref": "#/components/schemas/ApproverProperty" - }, - "type": "array", - "uniqueItems": true + } } - }, - "type": "object" - }, - "CertificateRequestApprovalRuleDeleteResponseOpenApi": { - "properties": { - "id": { - "description": "Approval rule `id`", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "Approval rule name", - "type": "string" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityWorkflowRequest" + } + } } }, - "type": "object" - }, - "CertificateRequestApprovalRuleOpenApi": { - "properties": { - "approvers": { - "description": "A collection of approvers specified by type and id", - "items": { - "$ref": "#/components/schemas/ApproverProperty" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityWorkflowInformation" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Workflow was initiated; details in response body." }, - "atLeast": { - "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", - "format": "int32", - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." }, - "autoApproveOnRenew": { - "default": false, - "description": "Automatically approve when renew a certificate", - "type": "boolean" - }, - "autoRejectionThreshold": { - "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", - "example": 5, - "maximum": 99, - "minimum": 1, - "type": "number" - }, - "conditions": { - "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" - }, - "creationDate": { - "description": "The date a approval rule was created", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "exceptions": { - "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" - }, - "finalApprover": { - "$ref": "#/components/schemas/ApproverPropertyOpenApi" - }, - "id": { - "description": "Approval rule `id`", - "format": "uuid", - "type": "string" - }, - "modificationDate": { - "description": "The date a approval rule was modified", - "example": "2023-01-11T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "name": { - "description": "Approval rule name", - "type": "string" - }, - "priority": { - "description": "Priority of the rule", - "format": "int32", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Machine identity not found." }, - "type": { - "description": "The type of the approval rule", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CertificateRequestApprovalRulesRequest": { - "properties": { - "approvers": { - "description": "A collection of approvers specified by type and id", - "items": { - "$ref": "#/components/schemas/ApproverProperty" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Initiate a machine workflow", + "tags": [ + "Machine Identities" + ] + } + }, + "/v1/machineidentitysearch": { + "post": { + "description": "Retrieves the details of machine identities that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", + "operationId": "getMachineIdentitiesByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentitySearchRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineIdentityDocumentResponse" + } + } }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "atLeast": { - "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", - "example": 2, - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "autoApproveOnRenew": { - "default": false, - "description": "Automatically approve when renew a certificate", - "type": "boolean" - }, - "autoRejectionThreshold": { - "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", - "example": 5, - "maximum": 99, - "minimum": 1, - "type": "number" - }, - "conditions": { - "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" - }, - "continueProcessingOnException": { - "default": false, - "description": "Continue with next approval rules when match an approval rule exception condition", - "type": "boolean" - }, - "exceptions": { - "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" - }, - "finalApprover": { - "description": "UUID of the final approver", - "example": "8268d820-a08d-11ed-bbc0-252385d6d390", - "format": "uuid", - "type": "string" + "description": "Details of Machine Identities in response body." }, - "name": { - "description": "Approval rule name", - "example": "Approval rule for built in CA", - "maxLength": 64, - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." }, - "type": { - "description": "The type of the approval rule", - "enum": [ - "ALL", - "AT_LEAST" - ], - "example": "AT_LEAST", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "approvers", - "conditions", - "name", - "type" - ], - "type": "object" - }, - "CertificateRequestApprovalRulesResponseOpenApi": { - "properties": { - "approvalRules": { - "items": { - "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + "summary": "Get the details of machine identities", + "tags": [ + "Machine Identities" + ] + } + }, + "/v1/machinetypes": { + "get": { + "deprecated": true, + "description": "Deprecated. This functionality is no longer supported. Use the Plugins API set instead.", + "operationId": "machineTypes_getAll", + "responses": { + "default": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } }, - "type": "array" + "description": "default response" } }, - "type": "object" - }, - "CertificateRequestApprovalRulesUpdateRequest": { - "properties": { - "approvers": { - "description": "A collection of approvers specified by type and id", - "items": { - "$ref": "#/components/schemas/ApproverProperty" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "List Machine Types", + "tags": [ + "Machine Types" + ] + } + }, + "/v1/machines": { + "get": { + "description": "Retrieves the details of all machines.", + "operationId": "machines_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachinesResponse" + } + } }, - "minItems": 1, - "type": "array", - "uniqueItems": true + "description": "Details of Machines in response body." }, - "atLeast": { - "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", - "example": 2, - "format": "int32", - "minimum": 1, - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." }, - "autoApproveOnRenew": { - "default": false, - "description": "Automatically approve when renew a certificate", - "type": "boolean" - }, - "autoRejectionThreshold": { - "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", - "example": 5, - "maximum": 99, - "minimum": 1, - "type": "number" - }, - "conditions": { - "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" - }, - "continueProcessingOnException": { - "default": false, - "description": "Continue with next approval rules when match an approval rule exception condition", - "type": "boolean" - }, - "exceptions": { - "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" - }, - "finalApprover": { - "description": "UUID of the final approver", - "example": "8268d820-a08d-11ed-bbc0-252385d6d390", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "Approval rule name", - "example": "Approval rule for built in CA", - "maxLength": 64, - "type": "string" - }, - "priority": { - "description": "Rule priority. The order in which the rules will be executed. Starts from 1 (highest priority).", - "example": 5, - "minimum": 1, - "type": "number" - }, - "type": { - "description": "The type of the approval rule", - "enum": [ - "ALL", - "AT_LEAST" - ], - "example": "AT_LEAST", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "approvers", - "conditions", - "name", - "type" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" + "summary": "Get the details of all machines", + "tags": [ + "Machines" + ] }, - "CertificateRequestDocumentInformation": { - "properties": { - "applicationId": { - "description": "UUID of an application ID", - "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", - "format": "uuid", - "type": "string" - }, - "approvedIds": { - "description": "A collection of IDs of all users that have already approved", - "items": { - "format": "uuid", - "type": "string" + "post": { + "description": "Creates a machine corresponding to the specified `pluginId`.", + "operationId": "machines_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineCreationRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } }, - "type": "array" + "description": "Machine was created; details in response body." }, - "approverTeamIds": { - "description": "A collection of all team IDs that are configured as approvers", - "items": { + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a machine", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}": { + "get": { + "description": "Retrieves the details of the machine that matches the specified `id`.", + "operationId": "machines_getById", + "parameters": [ + { + "description": "UUID of a Machine", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine", "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } }, - "type": "array" + "description": "Machine was found; details in the response body." }, - "approverUserIds": { - "description": "A collection of all user IDs that are configured as approvers", - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "caOrderId": { - "description": "A CA order ID", - "example": "63364861", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Machine not found." }, - "certificateIds": { - "description": "A collection of certificate ids", - "example": [ - "1441c6f0-9136-11ed-bd65-ed926a033704", - "12257370-9132-11ed-bd65-ed926a033704" - ], - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a machine details", + "tags": [ + "Machines" + ] + }, + "delete": { + "description": "Deletes a machine that has the specified `id`.", + "operationId": "machines_delete", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", "format": "uuid", "type": "string" - }, - "type": "array" + } + } + ], + "responses": { + "204": { + "description": "Machine deleted." }, - "certificateIssuingTemplateId": { - "description": "UUID of certificate issuing template", - "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Request conditions failed." }, - "certificateOwnerUserId": { - "description": "UUID of the certificate request's owner", - "example": "88932c30-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Certificate installation not found." }, - "companyId": { - "description": "UUID of a company", - "example": "85595df0-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" - }, - "creationDate": { - "description": "The date a certificate request was created", - "example": "2022-01-20T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "customAttributes": { - "$ref": "#/components/schemas/CustomAttributes1" - }, - "errorInformation": { - "$ref": "#/components/schemas/ErrorInformation4" - }, - "finalApproverId": { - "description": "UUID of the final approver if configured", - "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", - "format": "uuid", - "type": "string" - }, - "id": { - "description": "UUID of a certificate request", - "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", - "format": "uuid", - "type": "string" - }, - "keyCurve": { - "description": "Certificate request key curve", - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "example": "P521", - "type": "string" - }, - "keyLength": { - "description": "Certificate request key length", - "example": 2048, - "format": "int32", - "type": "integer" - }, - "keyType": { - "description": "Certificate request key type", - "enum": [ - "RSA", - "DSA", - "EC", - "GOST3410", - "ECGOST3410", - "RESERVED3", - "UNKNOWN" - ], - "example": "RSA", - "type": "string" - }, - "modificationDate": { - "description": "The date a certificate request was modified", - "example": "2023-01-24T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The status of the certificate request", - "enum": [ - "NEW", - "PENDING", - "PENDING_APPROVAL", - "PENDING_FINAL_APPROVAL", - "REJECTED_APPROVAL", - "REQUESTED", - "ISSUED", - "REJECTED", - "CANCELLED", - "REVOKED", - "FAILED", - "DELETED" - ], - "example": "ISSUED", - "type": "string" - }, - "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData1" - }, - "subjectCN": { - "description": "Certificate request subject CN", - "example": "venafi.com", - "type": "string" - }, - "subjectDN": { - "description": "Certificate request subject DN", - "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", - "type": "string" - }, - "tags": { - "description": "A collection of tags", - "example": [ - "test", - "category:security" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P10M", - "type": "string" - } - }, - "type": "object" - }, - "CertificateRequestDocumentResponse": { - "properties": { - "certificateRequests": { - "description": "A collection of certificate request information", - "example": [ - { - "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", - "caOrderId": "3a:5f:7e:9f:8c:e4:b6:f7:25:a7:81:0d:f0:ac:28:ec:fe:05:9b:30", - "certificateIds": [ - "a27dfc10-c357-11ed-946f-7db55f9ae03e", - "a275beb0-c357-11ed-946f-7db55f9ae03e", - "a24c16a0-c357-11ed-946f-7db55f9ae03e" - ], - "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", - "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", - "companyId": "98996d90-b797-11ed-a508-c13aa0641666", - "creationDate": "2023-03-15T17:34:26.466+00:00", - "id": "a1c0c690-c357-11ed-a00c-e3953fcf04eb", - "keyLength": 4096, - "keyType": "RSA", - "modificationDate": "2023-03-15T17:34:27.479+00:00", - "status": "ISSUED", - "subjectAlternativeNamesByType": { - "dNSName": [ - "localhost" - ] - }, - "subjectCN": "localhost", - "subjectDN": "cn=localhost,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", - "validityPeriod": "P10D" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } } - ], - "items": { - "$ref": "#/components/schemas/CertificateRequestDocumentInformation" }, - "type": "array" - }, - "numFound": { - "description": "The number of certificate requests that were found", - "example": 10, - "format": "int64", - "type": "integer" + "description": "Request conditions failed." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a machine", + "tags": [ + "Machines" + ] }, - "CertificateRequestInformation1": { - "properties": { - "apiClientInformation": { - "$ref": "#/components/schemas/ApiClientInformation" - }, - "applicationId": { - "description": "UUID of an application ID", - "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", - "format": "uuid", - "type": "string" - }, - "approvedIds": { - "description": "A collection of IDs of all users that have already approved", - "items": { + "patch": { + "description": "Updates specific details of the machine that matches the specified `id`.", + "operationId": "machines_update", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Machine was updated; details in the response body." }, - "approverTeamIds": { - "description": "A collection of all team IDs that are configured as approvers", - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Incomplete or malformed request." }, - "approverUserIds": { - "description": "A collection of all user IDs that are configured as approvers", - "items": { - "format": "uuid", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array", - "uniqueItems": true - }, - "caOrderId": { - "description": "A CA order ID", - "example": "63364861", - "type": "string" + "description": "Machine not found." }, - "certificateIds": { - "description": "A collection of certificate IDs", - "example": [ - "1441c6f0-9136-11ed-bd65-ed926a033704", - "12257370-9132-11ed-bd65-ed926a033704" - ], - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a machine details", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}/workflows": { + "post": { + "description": "Triggers the beginning of the workflow.", + "operationId": "machines_initiateWorkflow", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineWorkflowRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } }, - "type": "array" - }, - "certificateIssuingTemplateId": { - "description": "UUID of a certificate issuing template", - "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", - "format": "uuid", - "type": "string" - }, - "certificateOwnerUserId": { - "description": "UUID of the certificate request's owner", - "example": "88932c30-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" - }, - "certificateSigningRequest": { - "description": "A certificate signing request (CSR) in PEM format", - "type": "string" + "description": "Workflow initiated successfully." }, - "certificateUsageMetadata": { - "description": "A collection of certificate request metadata", - "example": [ - { - "appName": "venafi app1", - "automationMetadata": "automation data 008", - "nodeName": "venafi node 007" - }, - { - "appName": "venafi app2", - "automationMetadata": "automation data 0013", - "nodeName": "venafi node 005" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } } - ], - "items": { - "$ref": "#/components/schemas/CertificateUsageMetadata" }, - "type": "array" - }, - "companyId": { - "description": "UUID of a company", - "example": "85595df0-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" - }, - "creationDate": { - "description": "The date a certificate request was created", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "customAttributesInformation": { - "$ref": "#/components/schemas/CustomAttributesInformation" + "description": "Request conditions failed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Initiate the workflow", + "tags": [ + "Machines" + ] + } + }, + "/v1/machinesearch": { + "post": { + "description": "Retrieves the details of machines that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", + "operationId": "getMachinesByExpression", + "parameters": [ + { + "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`)", + "in": "query", + "name": "ownershipTree", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachinesSearchRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineDocumentResponse" + } + } + }, + "description": "Details of Machines in response body." }, - "errorInformation": { - "$ref": "#/components/schemas/ErrorInformation4" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." }, - "finalApproverId": { - "description": "UUID of the final approver if configured", - "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "summary": "Get the details of machines matching", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}/batchprovisionings/abort": { + "post": { + "description": "Triggers the abort operation on the current batch provisioning process for the machine with the specified `id`.", + "operationId": "abort-v1-batchprovisionings-forMachineId", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Batch provisioning abort success." }, - "id": { - "description": "UUID of a certificate request", - "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", - "format": "uuid", - "type": "string" + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Operation forbidden." }, - "keyCurve": { - "description": "Certificate request key curve", - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "example": "P521", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Active batch provisioning not found." }, - "keyLength": { - "description": "Certificate request key length", - "example": 2048, - "format": "int32", - "type": "integer" + "405": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Abort batch provisioning not allowed." }, - "keyType": { - "description": "Certificate request key type", - "enum": [ - "RSA", - "DSA", - "EC", - "GOST3410", - "ECGOST3410", - "RESERVED3", - "UNKNOWN" - ], - "example": "RSA", - "type": "string" - }, - "modificationDate": { - "description": "The date a certificate request was modified", - "example": "2023-01-11T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The status of a certificate request", - "enum": [ - "NEW", - "PENDING", - "PENDING_APPROVAL", - "PENDING_FINAL_APPROVAL", - "REJECTED_APPROVAL", - "REQUESTED", - "ISSUED", - "REJECTED", - "CANCELLED", - "REVOKED", - "FAILED", - "DELETED" - ], - "example": "ISSUED", - "type": "string" - }, - "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData1" + "500": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Internal server error." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Abort active batch provisioning for a", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}/discovery": { + "get": { + "description": "Retrieves the details of the machine's discovery.", + "operationId": "machineDiscoveryResults_getByMachineId", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineDiscoveryResultInformation" + } + } + }, + "description": "Discovery result for machine was found; details in response body." }, - "subjectDN": { - "description": "Certificate request subject DN", - "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." }, - "tags": { - "description": "A collection of tags", - "example": [ - "test", - "category:security" - ], - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } }, - "type": "array", - "uniqueItems": true + "description": "The discovery result for the machine was not found. It is possible that discovery was never initiated. Run discovery and try again." }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P10M", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CertificateRequestInformation2": { - "properties": { - "caOrderId": { - "description": "A CA order ID", - "example": "63364861", - "type": "string" - }, - "certificateIds": { - "description": "A collection of certificate IDs", - "example": [ - "1441c6f0-9136-11ed-bd65-ed926a033704", - "12257370-9132-11ed-bd65-ed926a033704" - ], - "items": { + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the discovery results for a", + "tags": [ + "Machines" + ] + } + }, + "/v1/machines/{id}/discovery/abort": { + "post": { + "description": "Aborts an active discovery.", + "operationId": "machineDiscoveryResults_abortdiscovery", + "parameters": [ + { + "description": "UUID of a Machine.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a Machine.", "format": "uuid", "type": "string" + } + } + ], + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MachineInformation" + } + } }, - "type": "array" + "description": "Abort discovery success." }, - "certificateIssuingTemplateId": { - "description": "UUID of a certificate issuing template", - "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", - "format": "uuid", - "type": "string" + "403": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Operation forbidden." }, - "certificateName": { - "description": "A certificate name", - "example": "venafi.com", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Active discovery not found." }, - "certificateOwnerUserId": { - "description": "UUID of the certificate request's owner", - "example": "88932c30-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" + "405": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse5" + } + } + }, + "description": "Abort discovery not allowed." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Abort machine discovery", + "tags": [ + "Machines" + ] + } + }, + "/v1/users": { + "get": { + "description": "Retrieve list of users matching the criteria. Note that this operation might result in a larger-than-expected dataset.operation can potentially be expensive as resulting dataset may be large", + "operationId": "get-v1-users", + "parameters": [ + { + "description": "Current user status.", + "in": "query", + "name": "userStatus", + "schema": { + "items": { + "$ref": "#/components/schemas/UserStatus" + }, + "type": "array" + } }, - "certificateSigningRequest": { - "description": "A certificate signing request (CSR) in PEM format", - "type": "string" + { + "description": "Username string; Accepts regex", + "in": "query", + "name": "username", + "schema": { + "type": "string" + } }, - "companyId": { - "description": "UUID of a company", - "example": "85595df0-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" - }, - "creationDate": { - "description": "The date a certificate request was created", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "customAttributes": { - "$ref": "#/components/schemas/CustomAttributes2" - }, - "dekHash": { - "description": "A certificate dek hash", - "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", - "type": "string" - }, - "encryptedPrivateKey": { - "format": "byte", - "type": "string" - }, - "encryptionDetails": { - "$ref": "#/components/schemas/EncryptionDetails" - }, - "errorInformation": { - "$ref": "#/components/schemas/ErrorInformation9" - }, - "id": { - "description": "UUID of a certificate request", - "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", - "format": "uuid", - "type": "string" - }, - "keyCurve": { - "description": "Certificate request key curve", - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "example": "P521", - "type": "string" - }, - "keyLength": { - "description": "Certificate request key length", - "example": 2048, - "format": "int32", - "type": "integer" - }, - "keyType": { - "description": "Certificate request key type", - "enum": [ - "RSA", - "DSA", - "EC", - "GOST3410", - "ECGOST3410", - "RESERVED3", - "UNKNOWN" - ], - "example": "RSA", - "type": "string" - }, - "modificationDate": { - "description": "The date a certificate request was modified", - "example": "2023-01-11T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "product": { - "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" - }, - "productEntitlement": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string" - }, - "status": { - "description": "The status of a certificate request", - "enum": [ - "NEW", - "PENDING", - "PENDING_APPROVAL", - "PENDING_FINAL_APPROVAL", - "REJECTED_APPROVAL", - "REQUESTED", - "ISSUED", - "REJECTED", - "CANCELLED", - "REVOKED", - "FAILED", - "DELETED" - ], - "example": "ISSUED", - "type": "string" - }, - "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData2" - }, - "subjectDN": { - "description": "Certificate request subject DN", - "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", - "type": "string" + { + "description": "Optional disabled user filter flag; true will return disabled users; false will return non-disabled users; default will return all users", + "in": "query", + "name": "disabled", + "schema": { + "type": "boolean" + } }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P10M", - "type": "string" + { + "description": "Optional soft-deleted user filter flag; true will return soft-deleted users; false will return non-soft-deleted users; default will return all users", + "in": "query", + "name": "deleted", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserResponse" + } + } + }, + "description": "All users" } }, - "type": "object" - }, - "CertificateRequestRequest": { - "properties": { - "apiClientInformation": { - "$ref": "#/components/schemas/ApiClientInformation" - }, - "applicationId": { - "description": "Application UUID", - "example": "b00701b0-886f-11ed-9f39-3d586ab80cf2", - "format": "uuid", - "type": "string" - }, - "certificateIssuingTemplateId": { - "description": "Certificate issuing template UUID", - "example": "a305d810-886f-11ed-9ccf-0dbf748eb1ae", - "format": "uuid", - "type": "string" - }, - "certificateOwnerUserId": { - "description": "Certificate owner UUID", - "example": "a305d810-886f-11ed-9ccf-0dbf748eb1ae", - "format": "uuid", - "type": "string" - }, - "certificateSigningRequest": { - "description": "A certificate signing request(CSR) in PEM format. Required when reuseCSR and isVaaSGenerated are set to false.", - "type": "string" - }, - "certificateUsageMetadata": { - "description": "A collection of certificate request metadata", - "example": [ - { - "appName": "venafi app1", - "automationMetadata": "automation data 008", - "nodeName": "venafi node 007" - }, - { - "appName": "venafi app2", - "automationMetadata": "automation data 0013", - "nodeName": "venafi node 005" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve users matching specified criteria", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}": { + "get": { + "description": "Retrieve user with 'id' attribute matching specified value.", + "operationId": "get-v1-users-byId", + "parameters": [ + { + "description": "UUID of a user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation1" + } } - ], - "items": { - "$ref": "#/components/schemas/CertificateUsageMetadata" }, - "type": "array" - }, - "csrAttributes": { - "$ref": "#/components/schemas/CSRAttributesInformation" - }, - "customAttributes": { - "$ref": "#/components/schemas/CustomAttributesInformation" + "description": "User matching specified userId" }, - "existingCertificateId": { - "description": "Existing certificate UUID. Required when reuseCSR is set to true.", - "example": "b505d810-886f-11ed-9ccf-0dbf748eb1ae", - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Request conditions failed" }, - "isVaaSGenerated": { - "description": "Specify whether VaaS should generate the request.", - "example": true, - "type": "boolean" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "User not found" }, - "reuseCSR": { - "description": "Specifies whether an existing CSR is reused", - "example": true, - "type": "boolean" - }, - "tags": { - "description": "A collection of tags", - "example": [ - "test", - "category:security" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array", - "uniqueItems": true - }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P10M", - "type": "string" + "description": "Request conditions failed" } }, - "required": [ - "applicationId", - "certificateIssuingTemplateId", - "isVaaSGenerated" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "CertificateRequestResponse": { - "properties": { - "certificateRequests": { - "description": "A collection of certificate information", - "example": [ - { - "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", - "caOrderId": "3a:5f:7e:9f:8c:e4:b6:f7:25:a7:81:0d:f0:ac:28:ec:fe:05:9b:30", - "certificateIds": [ - "a27dfc10-c357-11ed-946f-7db55f9ae03e", - "a275beb0-c357-11ed-946f-7db55f9ae03e", - "a24c16a0-c357-11ed-946f-7db55f9ae03e" - ], - "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", - "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", - "companyId": "98996d90-b797-11ed-a508-c13aa0641666", - "creationDate": "2023-03-15T17:34:26.466+00:00", - "id": "a1c0c690-c357-11ed-a00c-e3953fcf04eb", - "keyLength": 4096, - "keyType": "RSA", - "modificationDate": "2023-03-15T17:34:27.479+00:00", - "status": "ISSUED", - "subjectAlternativeNamesByType": { - "dNSName": [ - "localhost" - ] - }, - "subjectCN": "localhost", - "subjectDN": "cn=localhost,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", - "validityPeriod": "P10D" - }, - { - "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", - "caOrderId": "6f:b7:27:c8:2c:bd:1a:b0:6f:43:fb:8a:6b:5b:a3:a6:c2:52:38:85", - "certificateIds": [ - "b767aef0-c357-11ed-946f-7db55f9ae03e", - "a275beb0-c357-11ed-946f-7db55f9ae03e", - "a24c16a0-c357-11ed-946f-7db55f9ae03e" - ], - "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", - "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", - "companyId": "98996d90-b797-11ed-a508-c13aa0641666", - "creationDate": "2023-03-15T17:35:02.384+00:00", - "id": "b7502f50-c357-11ed-a00c-e3953fcf04eb", - "keyLength": 4096, - "keyType": "RSA", - "modificationDate": "2023-03-15T17:35:02.544+00:00", - "status": "ISSUED", - "subjectAlternativeNamesByType": { - "dNSName": [ - "venafi.com" - ] - }, - "subjectCN": "venafi.com", - "subjectDN": "cn=venafi.com,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", - "validityPeriod": "P12D" + "summary": "Retrieve user details by user ID", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}/accounttype": { + "put": { + "description": "Update account type for user with 'id' attribute matching specified value.", + "operationId": "put-v1-users-byId-accounttype", + "parameters": [ + { + "description": "UUID of a user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccountTypeRequest" } - ], - "items": { - "$ref": "#/components/schemas/CertificateRequestInformation1" - }, - "type": "array" + } } }, - "type": "object" - }, - "CertificateRequestResubmissionRequest": { - "properties": { - "certificateIssuingTemplateId": { - "description": "Certificate issuing template UUID", - "example": "a305d810-886f-11ed-9ccf-dbf748eb1ae0", - "format": "uuid", - "type": "string" - }, - "certificateOwnerUserId": { - "description": "Certificate owner UUID", - "example": "a305d810-886f-11ed-4bbe-dbf748eb1ae0", - "format": "uuid", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation1" + } + } + }, + "description": "User account type was updated. Updated user details in response." }, - "certificateUsageMetadata": { - "description": "A collection of certificate request metadata", - "example": [ - { - "appName": "venafi app1", - "automationMetadata": "automation data 008", - "nodeName": "venafi node 007" - }, - { - "appName": "venafi app2", - "automationMetadata": "automation data 0013", - "nodeName": "venafi node 005" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } } - ], - "items": { - "$ref": "#/components/schemas/CertificateUsageMetadata" }, - "type": "array" + "description": "Incomplete or malformed request." }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P10M", - "type": "string" - } - }, - "type": "object" - }, - "CertificateResponse": { - "properties": { - "certificates": { - "description": "A collection of certificates", - "items": { - "$ref": "#/components/schemas/CertificateInformation" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array" + "description": "User was not found." }, - "count": { - "description": "The number of certificates.", - "example": 2, - "format": "int32", - "type": "integer" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CertificateRetirementRequest": { - "properties": { - "addToBlocklist": { - "description": "This parameter ensures the deleted certificate will not be discovered again.", - "example": true, - "type": "boolean" - }, - "certificateIds": { - "description": "Unique certificate id(s) containing numbers, letters and dashes.", - "example": [ - "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", - "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" - ], - "items": { + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update user account type", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}/locallogin": { + "put": { + "description": "Enable/disable local login for specified user.", + "operationId": "put-v1-users-byId-locallogin", + "parameters": [ + { + "description": "UUID of a user.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user.", "format": "uuid", "type": "string" - }, - "type": "array" + } } - }, - "required": [ - "certificateIds" ], - "type": "object" - }, - "CertificateRevocationApprovalConditionsFilterRuleInformation": { - "properties": { - "certificateAuthorityAccountIds": { - "description": "A collection of certificate authority account ids the rule will be applicable to", - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" - }, - "minItems": 1, - "type": "array" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocalLoginRequest" + } + } } }, - "required": [ - "certificateAuthorityAccountIds" - ], - "type": "object" - }, - "CertificateRevocationApprovalExceptionsFilterRuleInformation": { - "properties": { - "applicationIds": { - "description": "A collection of application ids the rule won't be applied to", - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation1" + } + } }, - "type": "array" + "description": "Local login property for the user was updated. Updated user details in response." }, - "requestors": { - "description": "A collection of approvers, specified by type and id, for which the rule won't be applied", - "items": { - "$ref": "#/components/schemas/ApproverProperty" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "User not found." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CertificateRevocationApprovalRuleDeleteResponseOpenApi": { - "properties": { - "id": { - "description": "Approval rule `id`", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "Approval rule name", - "type": "string" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Enable disable local login for user", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}/roles": { + "put": { + "description": "Update a user's currently assigned user role to limit or expand permissions. Learn more about [user roles](https://docs.venafi.cloud/CSH_user_roles_defined)", + "operationId": "put-v1-users-byId-roles", + "parameters": [ + { + "description": "UUID of a user.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RolesRequest" + } + } } }, - "type": "object" - }, - "CertificateRevocationApprovalRuleOpenApi": { - "properties": { - "approvers": { - "description": "A collection of approvers specified by type and id", - "items": { - "$ref": "#/components/schemas/ApproverProperty" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation1" + } + } }, - "type": "array", - "uniqueItems": true - }, - "atLeast": { - "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", - "format": "int32", - "type": "integer" - }, - "autoRejectionThreshold": { - "description": "Auto rejection threshold. After the defined number of days since revoke request creation, the request is automatically rejected, if it is not approved", - "example": 5, - "maximum": 99, - "minimum": 1, - "type": "number" - }, - "conditions": { - "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" - }, - "creationDate": { - "description": "The date a approval rule was created", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "exceptions": { - "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" - }, - "finalApprover": { - "$ref": "#/components/schemas/ApproverPropertyOpenApi" - }, - "id": { - "description": "Approval rule `id`", - "format": "uuid", - "type": "string" - }, - "modificationDate": { - "description": "The date a approval rule was modified", - "example": "2023-01-11T09:12:28Z", - "format": "date-time", - "type": "string" + "description": "User roles were updated. The newly assigned user role is given in the response." }, - "name": { - "description": "Approval rule name", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "priority": { - "description": "Priority of the rule", - "format": "int32", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "User not found." }, - "type": { - "description": "The type of the approval rule", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CertificateRevocationApprovalRulesRequest": { - "properties": { - "approvers": { - "description": "A collection of approvers specified by type and id", - "items": { - "$ref": "#/components/schemas/ApproverProperty" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update user roles", + "tags": [ + "Users" + ] + } + }, + "/v1/users/username/{username}": { + "get": { + "description": "Lets you use the 'username' attribute to get the details of the associated user; specified value should be an email address.", + "operationId": "get-v1-users-username-byUsername", + "parameters": [ + { + "in": "path", + "name": "username", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserResponse" + } + } }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "atLeast": { - "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", - "example": 2, - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "autoRejectionThreshold": { - "description": "Auto rejection threshold. After the defined number of days since revocation request creation, the request is automatically rejected, if it is not approved", - "example": 5, - "maximum": 99, - "minimum": 1, - "type": "number" - }, - "conditions": { - "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" - }, - "continueProcessingOnException": { - "default": false, - "description": "Continue with next approval rules when match an approval rule exception condition", - "type": "boolean" - }, - "exceptions": { - "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" + "description": "Details of the user matching specified username." }, - "finalApprover": { - "description": "UUID of the final approver", - "example": "8268d820-a08d-11ed-bbc0-252385d6d390", - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "name": { - "description": "Approval rule name", - "example": "Approval rule for built in CA", - "maxLength": 64, - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "User not found." }, - "type": { - "description": "The type of the approval rule", - "enum": [ - "ALL", - "AT_LEAST" - ], - "example": "AT_LEAST", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "approvers", - "conditions", - "name", - "type" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "CertificateRevocationApprovalRulesResponseOpenApi": { - "properties": { - "approvalRules": { - "items": { - "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" - }, - "type": "array" + "summary": "Retrieve user details by username", + "tags": [ + "Users" + ] + } + }, + "/v1/users/{id}/passwordexpiration": { + "put": { + "description": "Update if a user's password should be forced into an expired state for user with 'id' attribute matching specified value.", + "operationId": "put-v1-users-byId-passwordexpiration", + "parameters": [ + { + "description": "UUID of a user", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a user", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserForceLocalPasswordExpirationRequest" + } + } } }, - "type": "object" - }, - "CertificateRevocationApprovalRulesUpdateRequest": { - "properties": { - "approvers": { - "description": "A collection of approvers specified by type and id", - "items": { - "$ref": "#/components/schemas/ApproverProperty" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInformation1" + } + } }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "atLeast": { - "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", - "example": 2, - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "autoRejectionThreshold": { - "description": "Auto rejection threshold. After the defined number of days since revocation request creation, the request is automatically rejected, if it is not approved", - "example": 5, - "maximum": 99, - "minimum": 1, - "type": "number" - }, - "conditions": { - "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" - }, - "continueProcessingOnException": { - "default": false, - "description": "Continue with next approval rules when match an approval rule exception condition", - "type": "boolean" - }, - "exceptions": { - "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" - }, - "finalApprover": { - "description": "UUID of the final approver", - "example": "8268d820-a08d-11ed-bbc0-252385d6d390", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "Approval rule name", - "example": "Approval rule for built in CA", - "maxLength": 64, - "type": "string" - }, - "priority": { - "description": "Rule priority. The order in which the rules will be executed. Starts from 1 (highest priority).", - "example": 5, - "minimum": 1, - "type": "number" + "description": "User forceLocalPasswordExpiration value was updated. Updated user details in response." }, - "type": { - "description": "The type of the approval rule", - "enum": [ - "ALL", - "AT_LEAST" - ], - "example": "AT_LEAST", - "type": "string" - } - }, - "required": [ - "approvers", - "conditions", - "name", - "type" - ], - "type": "object" - }, - "CertificateUsageMetadata": { - "properties": { - "appName": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "automationMetadata": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "User was not found." }, - "nodeName": { - "type": "string" - } - }, - "type": "object" - }, - "CertificateValidationRequest": { - "properties": { - "certificateIds": { - "description": "Unique certificate id(s) containing numbers, letters and dashes.", - "example": [ - "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", - "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" - ], - "items": { - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "required": [ - "certificateIds" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "CertificateValidationResponse": { - "properties": { - "fingerprints": { - "description": "A collection of certificate's fingerprints", - "example": [ - "2C85B0AD64F55AA70BAC75F69711578DC505C3F9", - "051ECFBD202B0383A7745F479F978C8E9FA9ADE1" - ], - "items": { - "type": "string" + "summary": "Update if a user must change", + "tags": [ + "Users" + ] + } + }, + "/v1/useraccounts": { + "get": { + "description": "Retrieve user account information for API key specified in header: User details, User's API key details and Associated company details.", + "operationId": "useraccounts_getByAuth", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccountResponse" + } + } }, - "type": "array" - } - }, - "type": "object" - }, - "CertificationRequestInformation": { - "properties": { - "hashAlgorithm": { - "description": "A certificate request signature hash algorithm", - "enum": [ - "MD5", - "SHA1", - "MD2", - "SHA224", - "SHA256", - "SHA384", - "SHA512", - "UNKNOWN", - "GOSTR3411_94" - ], - "example": "SHA256", - "type": "string" - }, - "keyCurve": { - "description": "Certificate request key length", - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "example": "P256", - "type": "string" - }, - "keyLength": { - "description": "Certificate request key length", - "example": 2048, - "format": "int32", - "type": "integer" - }, - "keyType": { - "description": "Certificate request key type", - "enum": [ - "RSA", - "DSA", - "EC", - "GOST3410", - "ECGOST3410", - "RESERVED3", - "UNKNOWN" - ], - "example": "RSA", - "type": "string" - }, - "publicKeyHash": { - "description": "A certificate request public hash key", - "example": "0048AA1D7E2F0017F9CA2E687D8776A1A340553D", - "type": "string" + "description": "Authenticated user's account information: user details, user's API key details, and associated company details." }, - "signatureAlgorithm": { - "description": "A certificate request signature algorithm", - "enum": [ - "MD2_WITH_RSA_ENCRYPTION", - "MD5_WITH_RSA_ENCRYPTION", - "SHA1_WITH_RSA_ENCRYPTION", - "SHA1_WITH_RSA_ENCRYPTION2", - "SHA256_WITH_RSA_ENCRYPTION", - "SHA384_WITH_RSA_ENCRYPTION", - "SHA512_WITH_RSA_ENCRYPTION", - "ID_DSA_WITH_SHA1", - "dsaWithSHA1", - "EC_DSA_WITH_SHA1", - "EC_DSA_WITH_SHA224", - "EC_DSA_WITH_SHA256", - "EC_DSA_WITH_SHA384", - "EC_DSA_WITH_SHA512", - "UNKNOWN", - "SHA1_WITH_RSAandMGF1", - "GOST_R3411_94_WITH_GOST_R3410_2001", - "GOST_R3411_94_WITH_GOST_R3410_94" - ], - "example": "SHA256_WITH_RSA_ENCRYPTION", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData1" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "User account was not found for the specified API Key." }, - "subjectDN": { - "description": "A certificate request subject DN", - "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "Channel": { - "enum": [ - "email" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "string" - }, - "ChartDetails": { - "properties": { - "name": { - "type": "string" + "summary": "Retrieve an authenticated user account details", + "tags": [ + "User Accounts" + ] + } + }, + "/v1/teams": { + "get": { + "description": "Retrieve teams for the current company", + "operationId": "teams_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamsResponse" + } + } + }, + "description": "List of teams." }, - "version": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ClientAuthenticationInformation": { - "discriminator": { - "propertyName": "type" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/JwtStandardClaimsAuthenticationInformation" - }, - { - "$ref": "#/components/schemas/JwtJwksAuthenticationInformation" - }, + "security": [ { - "$ref": "#/components/schemas/JwtOidcAuthenticationInformation" - } - ], - "properties": { - "type": { - "type": "string" + "tppl-api-key": [] } - }, - "required": [ - "type" ], - "type": "object" + "summary": "Retrieve teams for the current company", + "tags": [ + "Teams" + ] }, - "ClientAuthenticationOpenApi": { - "discriminator": { - "mapping": { - "JWT_JWKS": "#/components/schemas/JwtJwksAuthenticationOpenApi", - "JWT_OIDC": "#/components/schemas/JwtOidcAuthenticationOpenApi", - "JWT_STANDARD_CLAIMS": "#/components/schemas/JwtStandardClaimsAuthenticationOpenApi" - }, - "propertyName": "type" - }, - "properties": { - "type": { - "type": "string" + "post": { + "description": "Creates a team for the company with which the authenticated user is associated.", + "operationId": "teams_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTeamRequest" + } + } } }, - "type": "object" - }, - "ClientAuthenticationRequestOpenApi": { - "properties": { - "clientAuthentication": { - "oneOf": [ - { - "$ref": "#/components/schemas/JwtStandardClaimsAuthenticationOpenApi" - }, - { - "$ref": "#/components/schemas/JwtJwksAuthenticationOpenApi" - }, - { - "$ref": "#/components/schemas/JwtOidcAuthenticationOpenApi" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation1" + } } - ], - "type": "object" - } - }, - "type": "object" - }, - "ClientAuthorizationInformation": { - "properties": { - "customClaimsAliases": { - "$ref": "#/components/schemas/CustomClaimsAliasesInformation" - } - }, - "type": "object" - }, - "CloudProvidersInformation": { - "properties": { - "aws": { - "$ref": "#/components/schemas/AwsCloudProviderInformation" + }, + "description": "Team created" }, - "azure": { - "$ref": "#/components/schemas/AzureCloudProviderInformation" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "google": { - "$ref": "#/components/schemas/GoogleCloudProviderInformation" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "CompanyId": { - "description": "The company ID", - "format": "uuid", - "readOnly": true, - "type": "string" - }, - "CompanyInformation": { - "properties": { - "active": { - "type": "boolean" - }, - "companyType": { - "$ref": "#/components/schemas/CompanyType" - }, - "creationDate": { - "format": "date-time", - "type": "string" - }, - "domains": { - "items": { + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add a team", + "tags": [ + "Teams" + ] + } + }, + "/v1/teams/{id}": { + "get": { + "description": "Retrieve the details of a team that has the specified `id`.", + "operationId": "teams_getById", + "parameters": [ + { + "description": " UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": " UUID of a team.", + "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation1" + } + } }, - "type": "array" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "instanceId": { - "type": "string" - }, - "name": { - "type": "string" + "description": "Team's details." }, - "productEntitlements": { - "items": { - "$ref": "#/components/schemas/ProductEntitlementInformation" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array" - }, - "tsgId": { - "type": "string" + "description": "Incomplete or malformed request." }, - "urlPrefix": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "id", - "productEntitlements" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" + "summary": "Get a team details", + "tags": [ + "Teams" + ] }, - "CompanyType": { - "enum": [ - "INTERNAL", - "CA", - "TPP_CUSTOMER", - "REGULAR", - "OTHER" + "delete": { + "description": "Deletes the team with specified `id`.", + "operationId": "teams_delete", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", + "format": "uuid", + "type": "string" + } + } ], - "type": "string" - }, - "Condition": { - "description": "A Condition for filtering", - "properties": { - "field": { - "description": "Represents a field for filtering", - "example": "certificateName", - "type": "string" - }, - "operator": { - "description": "An operator for filtering", - "enum": [ - "EQ", - "LT", - "LTE", - "GT", - "GTE", - "MATCH", - "FIND", - "IN" - ], - "example": "EQ", - "type": "string" + "responses": { + "204": { + "description": "Team was deleted." }, - "value": { - "description": "represents a field's value", - "example": "venafi.com", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "values": { - "description": "represents a field's values", - "example": [ - "venafi.com", - "www.venafi.com" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "delete a team", + "tags": [ + "Teams" + ] }, - "ConfigurationCreateRequest": { - "properties": { - "advancedSettings": { - "$ref": "#/components/schemas/AdvancedSettingsInformation" - }, - "clientAuthentication": { - "$ref": "#/components/schemas/ClientAuthenticationInformation" - }, - "clientAuthorization": { - "$ref": "#/components/schemas/ClientAuthorizationInformation" - }, - "cloudProviders": { - "$ref": "#/components/schemas/CloudProvidersInformation" - }, - "minTlsVersion": { - "description": "Minimum required TLS protocol version", - "enum": [ - "TLS12", - "TLS13" - ], - "type": "string" - }, - "name": { - "description": "Name of the configuration", - "example": "Some configuration", - "maxLength": 64, - "type": "string" - }, - "policyIds": { - "description": "Array of UUIDs of policies to associate with the new configuration", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { + "patch": { + "description": "Updates the details of a team that matches the specified team `id`.", + "operationId": "teams_update", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTeamRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation1" + } + } }, - "minItems": 1, - "type": "array" + "description": "Successfully updated team properties." }, - "serviceAccountIds": { - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "subCaProviderId": { - "description": "UUID of Sub CA provider to associate with the new configuration", - "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "name", - "policyIds", - "subCaProviderId" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "ConfigurationDeleteResponse": { - "properties": { - "id": { - "description": "UUID of the configuration", - "example": "7268d820-a08d-11ed-bbc0-252385d6d389", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "Name of the configuration", - "example": "Some configuration", - "type": "string" + "summary": "Update team details", + "tags": [ + "Teams" + ] + } + }, + "/v1/teams/{id}/members": { + "post": { + "description": "Adds members to the team with specified team's`id`.", + "operationId": "teams_members_add", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamMembersRequest" + } + } } }, - "type": "object" - }, - "ConfigurationInformation": { - "properties": { - "advancedSettings": { - "$ref": "#/components/schemas/AdvancedSettingsInformation" - }, - "clientAuthentication": { - "$ref": "#/components/schemas/ClientAuthenticationInformation" - }, - "clientAuthorization": { - "$ref": "#/components/schemas/ClientAuthorizationInformation" - }, - "cloudProviders": { - "$ref": "#/components/schemas/CloudProvidersInformation" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation1" + } + } + }, + "description": "Successfully added team members. Updated team details in the response." }, - "companyId": { - "description": "UUID specific to your company", - "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "controllerAllowedPolicyIds": { - "description": "Array of UUIDs of policies that the kubernetes controller is permitted to use", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Add team members", + "tags": [ + "Teams" + ] + }, + "delete": { + "description": "Removes team members with the specified team's `id`.", + "operationId": "teams_members_delete", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamMembersRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation1" + } + } }, - "type": "array" + "description": "Members were removed. Updated team details in response." }, - "creationDate": { - "description": "When the configuration was initially created", - "example": "2022-10-10T14:50:41.710+00:00", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "id": { - "description": "UUID of the configuration", - "example": "7268d820-a08d-11ed-bbc0-252385d6d389", - "format": "uuid", - "type": "string" - }, - "longLivedCertCount": { - "description": "Number of long lived certificates", - "example": 2, - "format": "int64", - "type": "integer" - }, - "minTlsVersion": { - "description": "Minimum required TLS protocol version", - "enum": [ - "TLS12", - "TLS13" - ], - "type": "string" - }, - "modificationDate": { - "description": "When the configuration was last modified", - "example": "2023-12-12T20:00:10.500+00:00", - "type": "string" - }, - "name": { - "description": "Name of the configuration", - "example": "Some configuration", - "type": "string" - }, - "policyIds": { - "description": "Array of UUIDs of policies to associate with the configuration", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array" - }, - "serviceAccountIds": { - "items": { + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove team members", + "tags": [ + "Teams" + ] + } + }, + "/v1/teams/{id}/owners": { + "post": { + "description": "Adds owners to the team with the specified team's `id`.", + "operationId": "teams_members_owners_add", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamOwnersRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation1" + } + } }, - "type": "array" - }, - "shortLivedCertCount": { - "description": "Number of short lived certificates", - "example": 20, - "format": "int64", - "type": "integer" + "description": "Successfully added Team owners." }, - "ultraShortLivedCertCount": { - "description": "Number of ultra short lived certificates", - "example": 200, - "format": "int64", - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." }, - "unixSocketAllowedPolicyIds": { - "description": "Array of UUIDs of policies that are permitted to be used when using the unix socket", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ConfigurationResponse": { - "properties": { - "configurations": { - "items": { - "$ref": "#/components/schemas/ExtendedConfigurationInformation" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" + ], + "summary": "Add team owners", + "tags": [ + "Teams" + ] }, - "ConfigurationUpdateRequest": { - "properties": { - "advancedSettings": { - "$ref": "#/components/schemas/AdvancedSettingsInformation" - }, - "clientAuthentication": { - "$ref": "#/components/schemas/ClientAuthenticationRequestOpenApi" - }, - "clientAuthorization": { - "$ref": "#/components/schemas/ClientAuthorizationInformation" - }, - "cloudProviders": { - "$ref": "#/components/schemas/CloudProvidersInformation" - }, - "minTlsVersion": { - "description": "Minimum required TLS protocol version", - "enum": [ - "TLS12", - "TLS13" - ], - "type": "string" - }, - "name": { - "description": "Name of the configuration", - "example": "Some configuration", - "maxLength": 64, - "type": "string" - }, - "policyIds": { - "description": "Array of UUIDs of policies to associate with the configuration", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { + "delete": { + "description": "Removes owners from the team with the specified team's `id`.", + "operationId": "teams_members_owners_remove", + "parameters": [ + { + "description": "UUID of a team.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of a team.", "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamOwnersRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TeamInformation1" + } + } }, - "type": "array" + "description": "Owners were removed. Updated team details in response." }, - "serviceAccountIds": { - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "subCaProviderId": { - "description": "UUID of Sub CA provider to associate with the configuration", - "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse4" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ConnectorsCreationRequest": { - "properties": { - "name": { - "type": "string" - }, - "properties": { - "$ref": "#/components/schemas/WebhookProperties" + "security": [ + { + "tppl-api-key": [] } - }, - "required": [ - "name", - "properties" ], - "type": "object" - }, - "ConnectorsInformation": { - "properties": { - "id": { - "description": "Unique identifier of the connector.", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "Human-readable name of the connector.", - "type": "string" - }, - "properties": { - "$ref": "#/components/schemas/WebhookProperties" - }, - "status": { - "description": "Current status of the connector (for example, enabled or disabled).", - "type": "string" + "summary": "Remove team owners", + "tags": [ + "Teams" + ] + } + }, + "/v1/activitylogsearch": { + "post": { + "description": "Request specific event log data that matches your filter criteria and include a total count of entries in the response.", + "operationId": "activitylogs_getByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityLogFilter" + } + } } }, - "required": [ - "id", - "name", - "status", - "properties" - ], - "type": "object" - }, - "ConnectorsResponse": { - "properties": { - "connectors": { - "items": { - "$ref": "#/components/schemas/ConnectorsInformation" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityLogEntriesResponse" + } + } }, - "type": "array" - } - }, - "required": [ - "connectors" - ], - "type": "object" - }, - "ConnectorsUpdateRequest": { - "properties": { - "properties": { - "$ref": "#/components/schemas/WebhookProperties" - } - }, - "required": [ - "properties" - ], - "type": "object" - }, - "CreateCMSConfigurationRequest": { - "description": "The information representing a Credential Manager Service configuration for creation purpose.", - "properties": { - "cmsDetails": { - "$ref": "#/components/schemas/CreateCMSDetails" - }, - "cmsType": { - "$ref": "#/components/schemas/CMSType" + "description": "Total count and list of matching log entries." }, - "name": { - "$ref": "#/components/schemas/Name" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." }, - "vSatelliteIds": { - "$ref": "#/components/schemas/VSatelliteIds" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "cmsType", - "vSatelliteIds", - "cmsDetails" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "CreateCMSConfigurationsRequest": { - "description": "The array of Credential Manager Service configurations to create.", - "properties": { - "cmsConfigurations": { - "items": { - "$ref": "#/components/schemas/CreateCMSConfigurationRequest" - }, - "minItems": 1, - "type": "array" + "summary": "Retrieve count and activity log entries", + "tags": [ + "Event Logs" + ] + } + }, + "/v1/activitylogsearch/export": { + "post": { + "description": "Request specific event log data that matches your filter criteria. You can even specify the format in the header as either JSON or CSV.", + "operationId": "activitylogs_getAllByExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActivityLogFilter" + } + } } }, - "required": [ - "cmsConfigurations" - ], - "type": "object" - }, - "CreateCMSConfigurationsResponse": { - "description": "The array of Credential Manager Service configurations created.", - "properties": { - "cmsConfigurationsCreated": { - "items": { - "$ref": "#/components/schemas/CMSConfigurationResponse" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ExportedActivityLogEntryInformation" + }, + "type": "array" + } + }, + "text/csv": { + "schema": { + "type": "string" + } + } }, - "minItems": 1, - "type": "array" + "description": "List of matching log entries." }, - "count": { - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + }, + "text/csv": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "cmsConfigurationsCreated", - "count" - ], - "type": "object" - }, - "CreateCMSDetails": { - "oneOf": [ - { - "$ref": "#/components/schemas/CreateCyberArkDetails" - }, + "security": [ { - "$ref": "#/components/schemas/CreateHashiCorpDetails" + "tppl-api-key": [] } + ], + "summary": "Export filtered event log data to", + "tags": [ + "Event Logs" ] - }, - "CreateCredentialDetails": { - "oneOf": [ - { - "$ref": "#/components/schemas/CreateCyberArkCredDetails" + } + }, + "/v1/activitytypes": { + "get": { + "description": "Retrieve types of activities used for event logging, such as failed login attempts or events that are critical. Learn more about [event logging](https://docs.venafi.cloud/vaas/logging/c-about-activity-logging/).", + "operationId": "activitylogtypes_get", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ActivityLogType" + }, + "type": "array" + } + } + }, + "description": "Types of activities in event logging; details in response body" }, - { - "$ref": "#/components/schemas/CreateHashiCorpCredDetails" - } - ] - }, - "CreateCyberArkCredDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkDetailsRequiredProp" - } - ] - }, - "CreateCyberArkDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkConfigurationRequiredProp" - } - ] - }, - "CreateHashiCorpCredDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/HashiCorpDetailsRequiredProp" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse6" + } + } + }, + "description": "Incomplete or malformed request." } - ] - }, - "CreateHashiCorpDetails": { - "allOf": [ + }, + "security": [ { - "$ref": "#/components/schemas/HashiCorpConfigurationRequiredProp" + "tppl-api-key": [] } + ], + "summary": "Retrieve types of activities used for", + "tags": [ + "Event Logs" ] - }, - "CreateServiceAccountRequestBody": { - "allOf": [ - { - "$ref": "#/components/schemas/ServiceAccountBaseObject" - }, + } + }, + "/v1/edgeinstances/{id}/update": { + "post": { + "description": "Triggering an update for a satellite instance (manual)", + "operationId": "create-edgeinstances-update", + "parameters": [ { - "required": [ - "name", - "scopes" - ], - "type": "object" + "description": "Satellite Instance ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Satellite Instance ID", + "format": "uuid", + "type": "string" + } } ], - "example": { - "applications": [ - "dc96438b-7a80-464b-a09b-9e5ec746c3e3", - "5bce5ff4-a69b-4e78-9b7e-6d4029995000" - ], - "authenticationType": "rsaKey", - "credentialLifetime": 30, - "name": "Firefly SA", - "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", - "publicKey": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEAzRCyRWzXlyhFp3RcUrum1Q6j7YR8jyL0L1fWnh7zgt4=\\n-----END PUBLIC KEY-----", - "scopes": [ - "distributed-issuance" - ] - } - }, - "CreateServiceAccountResponseBody": { - "example": { - "id": "933507dd-0286-11ef-bc25-8a00a468403f", - "privateKey": "-----BEGIN PRIVATE KEY-----\n\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\u22c6\n-----END PRIVATE KEY-----\n", - "publicKey": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEAzRCyRWzXlyhFp3RcUrum1Q6j7YR8jyL0L1fWnh7zgt4=\\n-----END PUBLIC KEY-----" - }, - "properties": { - "id": { - "description": "The ID for this service account", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - }, - "ociAccountName": { - "description": "The OCI account name generated for a robot in case of the registry scope", - "type": "string" + "responses": { + "202": { + "description": "Satellite Start Manual Update" }, - "ociRegistryToken": { - "description": "The OCI registry token generated for a robot in case of the registry scope", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" }, - "privateKey": { - "description": "The generated private key for the service account when not providing a public key on the create payload", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Satellite Instance Not Found" }, - "publicKey": { - "description": "The generated public key for the service account when not providing a public key on the create payload", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" } }, - "type": "object" - }, - "CreateTeamRequest": { - "properties": { - "members": { - "items": { + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Trigger manual update of Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeencryptionkeys": { + "get": { + "description": "Retrieve the list of satellite encryption keys based on query parameters", + "operationId": "edgeencryptionkeys_getAll", + "parameters": [ + { + "in": "query", + "name": "edgeInstanceId", + "schema": { "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EncryptionKeysResponse" + } + } }, - "type": "array", - "uniqueItems": true - }, - "name": { - "maxLength": 100, - "type": "string" - }, - "owners": { - "items": { - "format": "uuid", + "description": "List of SatelliteEncryption keys" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Satellite Encryption Keys", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeencryptionkeys/{id}": { + "get": { + "description": "Retrieve satellite encryption key with 'id' attribute matching specified value; specified value should be string not numeric", + "operationId": "edgeencryptionkeys_getById", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EncryptionKeyInformation" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Encryption key information" }, - "role": { - "$ref": "#/components/schemas/TeamRole" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" }, - "userMatchingRules": { - "items": { - "$ref": "#/components/schemas/UserMatchingRule" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } }, - "type": "array" - } - }, - "required": [ - "name", - "owners", - "role" - ], - "type": "object" - }, - "CreatedBy": { - "description": "The ID of the user whom created the credential.", - "type": "string" - }, - "CreatedOn": { - "description": "The date in ISO 8601 full-date format when the credential was created.", - "format": "date", - "type": "string" - }, - "CredentialId": { - "description": "The ID of the Credential in our System.", - "example": "94e86140-d85f-11ed-afa1-0242ac120002", - "format": "uuid", - "type": "string" - }, - "CredentialName": { - "description": "The name of the Credential in our System.", - "type": "string" - }, - "CredentialResponse": { - "description": "The properties representing a Credential for response purposes.", - "properties": { - "authType": { - "$ref": "#/components/schemas/AuthType" - }, - "cmsConfigId": { - "$ref": "#/components/schemas/CMSConfId" - }, - "cmsType": { - "$ref": "#/components/schemas/CMSType" - }, - "createdBy": { - "$ref": "#/components/schemas/CreatedBy" - }, - "createdOn": { - "$ref": "#/components/schemas/CreatedOn" - }, - "credentialDetails": { - "$ref": "#/components/schemas/ResponseCredentialDetails" - }, - "id": { - "$ref": "#/components/schemas/CredentialId" - }, - "lastModifiedBy": { - "$ref": "#/components/schemas/LastModifiedBy" - }, - "lastModifiedOn": { - "$ref": "#/components/schemas/LastModifiedOn" - }, - "name": { - "$ref": "#/components/schemas/CredentialName" - }, - "references": { - "$ref": "#/components/schemas/References" + "description": "Encryption key not found" }, - "teamsIds": { - "$ref": "#/components/schemas/TeamsIds" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" } }, - "required": [ - "id", - "name", - "cmsConfigId", - "authType", - "cmsType" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "CustomAttributes1": { - "description": "Certificate request custom attributes", - "example": { - "dnsNames": [ - "www.venafi.com", - "venafi.com" - ] - }, - "properties": { - "dnsNames": { - "items": { + "summary": "Retrieve SatelliteEncryption Key By Id", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeinstances": { + "get": { + "description": "Retrieve list of all satellite instances for company", + "operationId": "edgeinstances_getAll", + "parameters": [ + { + "in": "query", + "name": "environmentId", + "schema": { + "format": "uuid", "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "overwriteSans": { - "type": "boolean" + } } - }, - "type": "object" - }, - "CustomAttributes2": { - "description": "A certificate request custom attributes", - "example": { - "dnsNames": [ - "www.venafi.com", - "venafi.com" - ] - }, - "properties": { - "dnsNames": { - "items": { - "type": "string" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeInstanceResponse" + } + } }, - "type": "array", - "uniqueItems": true - }, - "overwriteSans": { - "type": "boolean" + "description": "Satelliteinstances matching specified id" } }, - "type": "object" - }, - "CustomAttributesInformation": { - "description": "Represents custom attributes for certificate requests", - "properties": { - "dnsNames": { - "items": { + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Satellite Instances", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeinstances/{id}": { + "get": { + "description": "Retrieve satellite instance with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "edgeinstances_getById", + "parameters": [ + { + "description": "Satellite Instance ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Satellite Instance ID", + "format": "uuid", "type": "string" - }, - "type": "array", - "uniqueItems": true + } }, - "overwriteSans": { - "description": "Defines if the csr sans should be overwritten by the custom attributes dns sans", - "type": "boolean" + { + "in": "query", + "name": "statusDetails", + "schema": { + "default": false, + "type": "boolean" + } } - }, - "required": [ - "dnsNames" ], - "type": "object" - }, - "CustomClaimsAliasesInformation": { - "properties": { - "allowAllPolicies": { - "maxLength": 128, - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeInstanceInformation" + } + } + }, + "description": "Satellite instance matching specified id" }, - "allowedPolicies": { - "maxLength": 128, - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" }, - "configuration": { - "maxLength": 128, - "type": "string" - } - }, - "type": "object" - }, - "CyberArkConfiguration": { - "allOf": [ - { - "properties": { - "appID": { - "$ref": "#/components/schemas/AppId" - }, - "baseUrl": { - "$ref": "#/components/schemas/CMSURL" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } } }, - "type": "object" + "description": "Satellite instance not found" }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ { - "$ref": "#/components/schemas/CertificateCredentialData" - } - ], - "description": "The configuration for the CyberArk app. It's required to set the value for the `cmsType` property to `cyberark`." - }, - "CyberArkConfigurationRequiredProp": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkConfiguration" + "tppl-api-key": [] } ], - "description": "The configuration for the CyberArk app. It's required to set the value for the `cmsType` property to `cyberark`.", - "required": [ - "appID", - "baseUrl" + "summary": "Retrieve Satellite Instance By Id", + "tags": [ + "VSatellite" ] }, - "CyberArkDetails": { - "description": "The CyberArk Credential information.", - "properties": { - "folder": { - "description": "The folder property into the CyberArk Safe.", - "type": "string" + "put": { + "description": "Update satellite instance with specified new value", + "operationId": "edgeinstances_update", + "parameters": [ + { + "description": "Satellite Instance ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Satellite Instance ID", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeInstanceRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeInstanceInformation" + } + } + }, + "description": "Satellite Instance Updated" }, - "objectName": { - "description": "The account's name which represents the credential in the CyberArk instance.", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" }, - "safe": { - "description": "The CyberArk Safe property.", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Satellite Instance Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" } }, - "type": "object" - }, - "CyberArkDetailsRequiredProp": { - "allOf": [ + "security": [ { - "$ref": "#/components/schemas/CyberArkDetails" + "tppl-api-key": [] } ], - "required": [ - "objectName", - "safe" + "summary": "Update Satellite Instance", + "tags": [ + "VSatellite" ] - }, - "DailyPatternInformation": { - "allOf": [ - { - "$ref": "#/components/schemas/SchedulerPatternInformation2" - }, - { - "properties": { - "duration": { - "description": "Duration in ISO-8601 format", - "enum": [ - "PT8H", - "PT12H", - "PT24H" - ], - "example": "PT24H", - "type": "string" - }, - "startTime": { - "description": "Start time in HH:mm:ss format", - "pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", - "type": "string" + } + }, + "/v1/pairingcodes/satellite": { + "post": { + "description": "Generate new pairing code for satellite instance registration", + "operationId": "pairingcodes_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PairingCodeRequest" } - }, - "type": "object" + } } - ], - "required": [ - "duration", - "startTime" - ], - "type": "object" - }, - "DeleteCredentialsResponse": { - "description": "The response for the delete credentials action.", - "properties": { - "count": { - "type": "integer" + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PairingCodeInformation" + } + } + }, + "description": "Pairing Code Created" }, - "idsCredentialsDeleted": { - "items": { - "$ref": "#/components/schemas/CredentialId" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } }, - "minItems": 1, - "type": "array" + "description": "Request Conditions Failed" } }, - "required": [ - "idsCredentialsDeleted", - "count" - ], - "type": "object" - }, - "Deployment": { - "properties": { - "executionTarget": { - "default": "vsat", - "description": "HELP", - "type": "string" - }, - "image": { - "description": "URL for where the plugin image resides.", - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "required": [ - "image", - "executionTarget" ], - "title": "Deployment", - "type": "object", - "x-examples": { - "Example 1": { - "deployment": { - "executionTarget": "vsat", - "image": "public.ecr.aws/docker/library/nginx:mainline-alpine3.18-slim" + "summary": "Create Pairing Code for Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/recoverycodes/satellite": { + "post": { + "description": "Generate new recovery code for satellite instance restoration", + "operationId": "recoverycodes_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecoveryCodeRequest" + } } } - } - }, - "Details": { - "properties": { - "credentialsExpiringOn": { - "description": "The exact date on which the credentials will expire", - "format": "date-time", - "type": "string" - }, - "enabled": { - "description": "Indicates if the given service account must be enabled or disabled where disable means that the credentials cannot be used for", - "type": "boolean" + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RecoveryCodeInformation" + } + } + }, + "description": "Recovery Code Created" }, - "id": { - "description": "The ID for this service account", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - }, - "lastUsedOn": { - "description": "The last time the account credentials were used to authenticate a machine", - "format": "date-time", - "type": "string" - }, - "updatedBy": { - "description": "The UUID of the latest user that modified the account", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create Recovery Code for Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeworkers": { + "get": { + "description": "Retrieve list of all satellite workers for company", + "operationId": "edgeworkers_getAll", + "parameters": [ + { + "in": "query", + "name": "edgeInstanceId", + "schema": { + "format": "uuid", + "type": "string" } - }, - "updatedOn": { - "description": "The last time the account details were updated", - "format": "date-time", - "type": "string" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkersResponse" + } + } + }, + "description": "List of Satellite workers" } }, - "type": "object" - }, - "Direction": { - "description": "An ordering direction", - "enum": [ - "ASC", - "DESC" + "security": [ + { + "tppl-api-key": [] + } ], - "example": "DESC", - "type": "string" + "summary": "Retrieve Satellite Workers", + "tags": [ + "VSatellite" + ] }, - "EdgeInstanceConnectionDetails": { - "properties": { - "activeMessageCount": { - "format": "int32", - "type": "integer" - }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "edgeInstanceId": { - "format": "uuid", - "type": "string" - }, - "expiredMessageCount": { - "format": "int32", - "type": "integer" - }, - "failedMessageCount": { - "format": "int32", - "type": "integer" - }, - "lastConnectedDate": { - "format": "date-time", - "type": "string" - }, - "lastDisconnectedDate": { - "format": "date-time", - "type": "string" - }, - "timestamp": { - "format": "date-time", - "type": "string" + "post": { + "description": "Create satellite worker and generate the pairing information", + "operationId": "edgeworkers_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerRequest" + } + } } }, - "type": "object" - }, - "EdgeInstanceHealthDetails": { - "properties": { - "companyId": { - "format": "uuid", - "type": "string" - }, - "edgeInstanceId": { - "format": "uuid", - "type": "string" - }, - "hsmStatus": { - "$ref": "#/components/schemas/HSMEdgeStatus" - }, - "installedCharts": { - "items": { - "$ref": "#/components/schemas/NamespaceChartDetails" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerInformation" + } + } }, - "type": "array" + "description": "Satellite worker information" }, - "nodeStatus": { - "items": { - "$ref": "#/components/schemas/NodeStatusDetails" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } }, - "type": "array" + "description": "Request conditions failed" }, - "systemstatus": { - "items": { - "$ref": "#/components/schemas/NamespaceStatusDetails" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } }, - "type": "array" - }, - "timestamp": { - "format": "date-time", - "type": "string" - }, - "version": { - "type": "string" + "description": "Request conditions failed" } }, - "type": "object" - }, - "EdgeInstanceInformation": { - "properties": { - "address": { - "type": "string" - }, - "canRestore": { - "type": "boolean" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create Satellite Worker", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeworkers/{id}/pair": { + "post": { + "operationId": "edgeworkers_pair", + "parameters": [ + { + "description": "EdgeWorker ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "EdgeWorker ID", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerInformation" + } + } + }, + "description": "Satellite worker paired with Satellitehub" }, - "clientId": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request conditions failed" }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "deploymentDate": { - "format": "date-time", - "type": "string" - }, - "edgeStatus": { - "$ref": "#/components/schemas/EdgeStatus" - }, - "edgeType": { - "$ref": "#/components/schemas/EdgeType" - }, - "encryptionKeyDeploymentDate": { - "format": "date-time", - "type": "string" - }, - "encryptionKeyId": { - "type": "string" - }, - "environmentId": { - "format": "uuid", - "type": "string" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "integrationServicesCount": { - "format": "int64", - "type": "integer" - }, - "kubernetesVersion": { - "type": "string" - }, - "lastSeenOnDate": { - "format": "date-time", - "type": "string" - }, - "modificationDate": { - "format": "date-time", - "type": "string" - }, - "name": { - "type": "string" - }, - "pairingCodeId": { - "format": "uuid", - "type": "string" - }, - "primaryInstanceId": { - "format": "uuid", - "type": "string" - }, - "productEntitlements": { - "items": { - "$ref": "#/components/schemas/ProductEntitlement2" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } }, - "type": "array" - }, - "reconciliationFailed": { - "type": "boolean" - }, - "satelliteVersion": { - "type": "string" - }, - "serviceAccountId": { - "format": "uuid", - "type": "string" - }, - "statusDetails": { - "$ref": "#/components/schemas/EdgeInstanceStatusDetailsInformation" - }, - "upgradeOrderPriority": { - "format": "int32", - "type": "integer" + "description": "Request conditions failed" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Pair Satellite Worker with Satellite Instance", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/edgeworkers/{id}": { + "delete": { + "description": "Delete satellite worker", + "operationId": "edgeworker_delete", + "parameters": [ + { + "description": "EdgeWorker ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "EdgeWorker ID", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdgeWorkerDeleteResponse" + } + } + }, + "description": "Satellite worker deleted" }, - "upgradeStatus": { - "$ref": "#/components/schemas/UpgradeStatus" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Request Conditions Failed" }, - "version": { - "format": "int32", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } + }, + "description": "Satellite worker not found" }, - "workerStatusDetails": { - "items": { - "$ref": "#/components/schemas/EdgeWorkerStatusDetailsInformation" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse10" + } + } }, - "type": "array" + "description": "Request Conditions Failed" } }, - "type": "object" - }, - "EdgeInstanceRequest": { - "properties": { - "name": { - "minLength": 1, - "type": "string" - }, - "upgradeOrderPriority": { - "format": "int32", - "maximum": 100, - "minimum": 1, - "type": "integer" + "security": [ + { + "tppl-api-key": [] } - }, - "required": [ - "name" ], - "type": "object" - }, - "EdgeInstanceResponse": { - "properties": { - "edgeInstances": { - "items": { - "$ref": "#/components/schemas/EdgeInstanceInformation" + "summary": "Delete Satellite Worker", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/updatesconfig": { + "get": { + "description": "Retrieve updates configuration for tenant", + "operationId": "updatesconfig_get", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatesConfigResponse" + } + } }, - "type": "array" + "description": "Tenant updates configuration" } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve Updates configuration", + "tags": [ + "VSatellite" + ] }, - "EdgeInstanceStatusDetailsInformation": { - "properties": { - "connectionDetails": { - "items": { - "$ref": "#/components/schemas/EdgeInstanceConnectionDetails" - }, - "type": "array" + "patch": { + "description": "Create or update updates configuration. The default update window is set to daily, with a start time at 12:00 AM and duration of 24 hours. This schedule allows updates to be performed on demand as soon as they become available.\n **Example Default Request Body:**\n\n ```json\n {\n \"updateConfigSchedulerPattern\": {\n \"recurrenceType\": \"DAY\",\n \"startTime\": \"00:00:00\",\n \"duration\": \"PT24H\"\n }\n }\n ```\n", + "operationId": "updatesconfig_patch", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatesConfigRequest" + } + } }, - "healthDetails": { - "items": { - "$ref": "#/components/schemas/EdgeInstanceHealthDetails" + "description": "Modify updates configuration using patch behavior. All top level properties are optional", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdatesConfigResponse" + } + } }, - "type": "array" + "description": "Updates configuration created/updated" } }, - "type": "object" - }, - "EdgeStatus": { - "enum": [ - "ACTIVE", - "LOST_CONNECTION", - "REGISTERED", - "PAIRED", - "LOST_CONNECTION_DURING_INSTALL", - "INSTALLED", - "INSTALL_FAILED", - "UNHEALTHY", - "ERROR", - "INSTALLING" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "string" - }, - "EdgeType": { - "enum": [ - "ALL", - "HUB", - "SATELLITE" + "summary": "Create or Update Configuration", + "tags": [ + "VSatellite" + ] + } + }, + "/v1/connectors/{id}": { + "put": { + "description": "Can be used to update specific fields. Only fields specified in the request will be updated.\nWhen the connector’s target is a webhook (`generic`, `slack`, or `teams`), updating the connector triggers the same outbound connectivity check as creation. The service performs a live POST request Certificate Manager - SaaS to the configured `connection.url`. If the endpoint is unreachable (for example, due to DNS failure, TLS handshake issues, or network/firewall restrictions), the update request fails with a descriptive error.\n", + "operationId": "connectors_update", + "parameters": [ + { + "description": "Connector ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Connector ID", + "format": "uuid", + "type": "string" + } + } ], - "type": "string" - }, - "EdgeWorkerDeleteResponse": { - "properties": { - "id": { - "format": "uuid", - "type": "string" - }, - "pairingCode": { - "type": "string" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsUpdateRequest" + } + } } }, - "type": "object" - }, - "EdgeWorkerHealthDetails": { - "properties": { - "age": { - "format": "int64", - "type": "integer" - }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "cpuUsage": { - "format": "int32", - "type": "integer" - }, - "edgeInstanceId": { - "format": "uuid", - "type": "string" - }, - "edgeWorkerId": { - "format": "uuid", - "type": "string" - }, - "host": { - "type": "string" - }, - "memoryUsage": { - "format": "int64", - "type": "integer" - }, - "port": { - "format": "int32", - "type": "integer" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsInformation" + } + } + }, + "description": "Connector Updated" }, - "services": { - "items": { - "$ref": "#/components/schemas/WorkerServiceStatusDetails" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Request Conditions Failed" }, - "status": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Connector Not Found" }, - "timestamp": { - "format": "date-time", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed" } }, - "type": "object" - }, - "EdgeWorkerInformation": { - "properties": { - "companyId": { - "format": "uuid", - "type": "string" - }, - "edgeInstanceId": { - "format": "uuid", - "type": "string" - }, - "environmentId": { - "format": "uuid", - "type": "string" - }, - "hiddenPairingCode": { - "type": "string" - }, - "host": { - "type": "string" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "lastSeenOnDate": { - "format": "date-time", - "type": "string" - }, - "pairingCode": { - "type": "string" - }, - "pairingPublicKey": { - "type": "string" - }, - "port": { - "format": "int32", - "type": "integer" - }, - "status": { - "$ref": "#/components/schemas/WorkerStatus" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" + ], + "summary": "Update Connector properties", + "tags": [ + "Webhooks" + ] }, - "EdgeWorkerRequest": { - "properties": { - "edgeInstanceId": { - "format": "uuid", - "type": "string" + "delete": { + "description": "Delete a Connector.\nDeleting a connector removes its configuration for delivering events to the target endpoint, but it does not modify any customer firewall allowlisting or network settings. If your webhook endpoint requires allowlisting Venafi Cloud NAT IP addresses, that configuration must be managed separately.\n", + "operationId": "connectors_delete", + "parameters": [ + { + "description": "Connector ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "Connector ID", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Connector Deleted" }, - "host": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed" }, - "port": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "EdgeWorkerStatusDetailsInformation": { - "properties": { - "edgeWorkerId": { - "format": "uuid", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Connector Not Found" }, - "healthDetails": { - "items": { - "$ref": "#/components/schemas/EdgeWorkerHealthDetails" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Request Conditions Failed" } }, - "type": "object" - }, - "EdgeWorkersResponse": { - "properties": { - "edgeWorkers": { - "items": { - "$ref": "#/components/schemas/EdgeWorkerInformation" - }, - "type": "array" - } - }, - "type": "object" - }, - "EncryptionDetails": { - "properties": { - "encryptionType": { - "enum": [ - "RSA", - "DSA", - "EC", - "GOST3410", - "ECGOST3410", - "RESERVED3", - "UNKNOWN" - ], - "type": "string" - }, - "value": { - "$ref": "#/components/schemas/AnyValue9" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "EncryptionKeyInformation": { - "properties": { - "companyId": { - "format": "uuid", - "type": "string" - }, - "id": { - "type": "string" - }, - "key": { - "type": "string" + ], + "summary": "Delete a Connector", + "tags": [ + "Webhooks" + ] + } + }, + "/v1/connectors": { + "get": { + "description": "Retrieve a list of all Connectors for a company", + "operationId": "connectors_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsResponse" + } + } + }, + "description": "Success" }, - "keyAlgorithm": { - "$ref": "#/components/schemas/KeyAlgorithm" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed" }, - "lastBackupDate": { - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "EncryptionKeysResponse": { - "properties": { - "encryptionKeys": { - "items": { - "$ref": "#/components/schemas/EncryptionKeyInformation" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Request Conditions Failed" } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all Connectors for a company", + "tags": [ + "Webhooks" + ] }, - "EntityTag": { - "properties": { - "value": { - "type": "string" - }, - "weak": { - "type": "boolean" + "post": { + "description": "Create a Connector for your company. When the connector’s target is a webhook (`generic`, `slack`, or `teams`), the service performs a live outbound POST request from Certificate Manager - SaaS to the specified `connection.url` during creation. This validates DNS resolution, TLS handshake, and network reachability. If the URL is unreachable (for example, blocked by firewall rules or incorrect DNS), the connector creation request fails with a timeout or connection error. This behavior is expected and prevents creating connectors that cannot receive webhook notifications.", + "operationId": "connectors_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsCreationRequest" + } + } } }, - "type": "object" - }, - "Error": { - "description": "Hold the error details.", - "properties": { - "args": { - "description": "List of arguments used to generate the error message.", - "items": { - "type": "object" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectorsInformation" + } + } }, - "type": "array" - }, - "code": { - "description": "The error code.", - "type": "integer" + "description": "Connector Created" }, - "message": { - "description": "The error message.", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Request Conditions Failed" } }, - "required": [ - "code", - "message" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "ErrorInformation1": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue1" + "summary": "Create a Connector", + "tags": [ + "Webhooks" + ] + } + }, + "/outagedetection/v1/inventorymonitoringconfig/{type}": { + "get": { + "description": "Retrieves the details of the inventory monitoring configuration by configuration type", + "operationId": "inventorymonitoringconfiguration_getByType", + "parameters": [ + { + "description": "Configuration type", + "in": "path", + "name": "type", + "required": true, + "schema": { + "description": "Configuration type", + "enum": [ + "CERTIFICATE_EXPIRATION" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InventoryMonitoringConfigurationResponse" + } + } }, - "type": "array" - }, - "code": { - "format": "int32", - "type": "integer" + "description": "Details of inventory monitoring configuration in response body." }, - "message": { - "type": "string" - } - }, - "type": "object" - }, - "ErrorInformation10": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue10" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "code": { - "format": "int32", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Inventory monitoring configuration not found." }, - "message": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ErrorInformation2": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue2" - }, - "type": "array" - }, - "code": { - "format": "int32", - "type": "integer" - }, - "message": { - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" + ], + "summary": "Get the details of the current", + "tags": [ + "Certificate Inventory Monitoring" + ] }, - "ErrorInformation3": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue3" - }, - "type": "array" - }, - "code": { - "format": "int32", - "type": "integer" - }, - "message": { - "type": "string" + "put": { + "description": "Updates existing inventory monitoring configuration", + "operationId": "inventorymonitoringconfiguration_update", + "parameters": [ + { + "description": "Configuration type", + "in": "path", + "name": "type", + "required": true, + "schema": { + "description": "Type of the configuration", + "enum": [ + "CERTIFICATE_EXPIRATION" + ], + "type": "string" + } } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InventoryMonitoringConfigRequest" + } + } + }, + "description": "Updates properties of the inventory monitoring configuration.", + "required": true }, - "type": "object" - }, - "ErrorInformation4": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue4" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InventoryMonitoringConfigurationResponse" + } + } }, - "type": "array" + "description": "Inventory monitoring configuration was updated." }, - "code": { - "format": "int32", - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "message": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ErrorInformation5": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue5" - }, - "type": "array" - }, - "code": { - "format": "int32", - "type": "integer" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Updates existing inventory monitoring configuratio", + "tags": [ + "Certificate Inventory Monitoring" + ] + } + }, + "/outagedetection/v1/inventorymonitoringconfig/{type}/scheduler": { + "put": { + "description": "Update inventory monitoring scheduler by type", + "operationId": "inventorymonitoringconfigurationscheduler_update", + "parameters": [ + { + "description": "Configuration type", + "in": "path", + "name": "type", + "required": true, + "schema": { + "description": "Configuration type", + "enum": [ + "CERTIFICATE_EXPIRATION" + ], + "type": "string" + } }, - "message": { - "type": "string" + { + "description": "Start the scheduler now", + "in": "query", + "name": "runNow", + "schema": { + "default": true, + "description": "Start the scheduler now", + "type": "boolean" + } } - }, - "type": "object" - }, - "ErrorInformation6": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue6" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InventoryMonitoringSchedulerInformation" + } + } }, - "type": "array" + "description": "Inventory monitoring scheduler was updated." }, - "code": { - "format": "int32", - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." }, - "message": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse7" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "ErrorInformation7": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue7" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update inventory monitoring scheduler by type", + "tags": [ + "Certificate Inventory Monitoring" + ] + } + }, + "/v1/expirationnotifications/tenantconfiguration": { + "get": { + "description": "Retrieve the certificate expiration notification configuration for the current tenant", + "operationId": "get-v1-tenant-expiration-notification-configuration", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" + } + } }, - "type": "array" + "description": "Success" }, - "code": { - "format": "int32", - "type": "integer" + "400": { + "description": "BadRequest" }, - "message": { - "type": "string" + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve the certificate expiration notification c", + "tags": [ + "Certificate Inventory Monitoring" + ] }, - "ErrorInformation8": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue8" + "put": { + "description": "Update the certificate expiration notification configuration for the current tenant", + "operationId": "put-v1-tenant-expiration-notification-configuration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" + } + } + }, + "description": "The options to apply", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" + } + } }, - "type": "array" + "description": "Success. The tenant configuration was successfully updated." }, - "code": { - "format": "int32", - "type": "integer" + "400": { + "description": "BadRequest" }, - "message": { - "type": "string" + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "ErrorInformation9": { - "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue9" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update the certificate expiration notification con", + "tags": [ + "Certificate Inventory Monitoring" + ] + } + }, + "/v1/autorenewal/tenantconfiguration": { + "get": { + "description": "Retrieve the certificate expiration monitoring configuration for the current tenant", + "operationId": "get-v1-tenant-renewal-configuration", + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "id": "12a05220-4352-11ee-ac28-c1379e5decf9", + "renewalWindow": { + "days": 30 + } + }, + "schema": { + "$ref": "#/components/schemas/TenantRenewalConfiguration" + } + } }, - "type": "array" + "description": "Success" }, - "code": { - "format": "int32", - "type": "integer" + "400": { + "description": "BadRequest" }, - "message": { - "type": "string" + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "ErrorResponse1": { - "properties": { - "errors": { - "description": "Short, human readable, description of the error.", - "items": { - "$ref": "#/components/schemas/ErrorInformation1" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" + ], + "summary": "Retrieve the monitoring configuration", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] }, - "ErrorResponse10": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation9" - }, - "type": "array" - } + "put": { + "description": "Update the certificate expiration monitoring configuration for the current tenant", + "operationId": "put-v1-tenant-renewal-configuration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantRenewalConfiguration" + } + } + }, + "description": "The options to apply", + "required": true }, - "type": "object" - }, - "ErrorResponse11": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation10" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantRenewalConfiguration" + } + } }, - "type": "array" + "description": "Success. The tenant configuration was successfully updated." + }, + "400": { + "description": "BadRequest" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "ErrorResponse2": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation2" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "ErrorResponse3": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation3" + ], + "summary": "Update the monitoring configuration", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + } + }, + "/v1/autorenewal/trigger": { + "post": { + "description": "The certificate renewal check is normally scheduled to run daily. This operation attempts to start the process for the current tenant now.", + "operationId": "post-v1-run-autorenewal", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatusResponse" + } + } }, - "type": "array" + "description": "Success. The auto-renewal check process was triggered." } }, - "type": "object" - }, - "ErrorResponse4": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation4" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "ErrorResponse5": { - "description": "Holds the response body returned for errors.", - "properties": { - "errors": { - "description": "List of encountered errors.", - "items": { - "$ref": "#/components/schemas/Error" + ], + "summary": "Attempt to initiate the certificate renewal", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + } + }, + "/v1/autorenewal/status": { + "get": { + "description": "Get details about the status of the certificate auto-renewal monitoring process.", + "operationId": "get-v1-status", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatusResponse" + } + } }, - "type": "array" + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "ErrorResponse6": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation5" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "ErrorResponse7": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation6" - }, - "type": "array" + ], + "summary": "Get the current certificate auto-renewal monitorin", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + } + }, + "/v1/autorenewal/{application_id}/configuration": { + "get": { + "description": "Retrieve the certificate expiration monitoring configuration for the specified application", + "operationId": "get-v1-application-renewal-configuration", + "parameters": [ + { + "description": "The ID of the application that you would like to retrieve configuration for", + "example": "22153ae0-4352-11ee-b95c-3531a284802b", + "in": "path", + "name": "application_id", + "required": true, + "schema": { + "format": "UUID", + "type": "string" + } } - }, - "type": "object" - }, - "ErrorResponse8": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation7" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRenewalConfiguration" + } + } }, - "type": "array" + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve the monitoring configuration", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] }, - "ErrorResponse9": { - "properties": { - "errors": { - "items": { - "$ref": "#/components/schemas/ErrorInformation8" - }, - "type": "array" + "put": { + "description": "Update the certificate expiration monitoring configuration for the specified application", + "operationId": "put-v1-application-renewal-configuration", + "parameters": [ + { + "description": "The ID of the application you want to update", + "example": "22153ae0-4352-11ee-b95c-3531a284802b", + "in": "path", + "name": "application_id", + "required": true, + "schema": { + "format": "UUID", + "type": "string" + } } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRenewalConfiguration" + } + } + }, + "description": "The options to apply", + "required": true }, - "type": "object" - }, - "ExportedActivityLogEntryInformation": { - "properties": { - "activityDate": { - "description": "The date when a log entry was produced", - "example": "2023-01-24T09:12:28Z", - "format": "date-time", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationRenewalConfiguration" + } + } + }, + "description": "Success. The application configuration was successfully updated." }, - "activityName": { - "description": "An activity name", - "example": "Login Succeeded", - "type": "string" + "400": { + "description": "BadRequest" }, - "activityType": { - "description": "An activity type", - "example": "Authentication", - "type": "string" + "401": { + "description": "Unauthorized" }, - "criticality": { - "description": "An activity criticality", - "example": 0, - "format": "int32", - "type": "integer" + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update the monitoring configuration", + "tags": [ + "Certificate Auto-renewal Monitoring" + ] + } + }, + "/v1/expirationreports/tenantconfiguration": { + "get": { + "description": "Retrieve the certificate expiration reports configuration for the current tenant", + "operationId": "get-v1-tenant-expiration-reports-configuration", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" + } + } + }, + "description": "Success" }, - "id": { - "description": "UUID of a log entry", - "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" + "400": { + "description": "BadRequest" }, - "message": { - "description": "An activity log message", - "example": "user logged in", - "type": "string" + "401": { + "description": "Unauthorized" }, - "payload": { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "Expression": { - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve the certificate expiration reports config", + "tags": [ + "Certificate Expiration Reports" + ] }, - "ExtendedApplicationOwnership": { - "properties": { - "id": { - "format": "uuid", - "type": "string" + "put": { + "description": "Update the certificate expiration reports configuration for the current tenant", + "operationId": "put-v1-tenant-expiration-reports-configuration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" + } + } }, - "owningTeams": { - "items": { - "format": "uuid", - "type": "string" + "description": "The options to apply", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" + } + } }, - "type": "array", - "uniqueItems": true + "description": "Success. The tenant configuration was successfully updated." }, - "owningUsers": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "400": { + "description": "BadRequest" }, - "type": { - "type": "string" + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "ExtendedCertificateInformation": { - "properties": { - "applicationIds": { - "description": "A collection of application IDs", - "example": [ - "561baf7c-98b7-49af-ab9c-7b3a9fea3028", - "4adeba6f-0c94-4595-a5b6-babea458249f" - ], - "items": { - "format": "uuid", - "type": "string" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update the certificate expiration reports configur", + "tags": [ + "Certificate Expiration Reports" + ] + } + }, + "/v1/expirationreports/trigger": { + "post": { + "description": "The certificate reports job is normally scheduled per the tenant configuration. This operation attempts to start the process for the current tenant now.", + "operationId": "post-v1-run-reports", + "responses": { + "204": { + "description": "Success. The reports check process was triggered." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Attempt to initiate the certificate reports", + "tags": [ + "Certificate Expiration Reports" + ] + } + }, + "/v1/tags": { + "get": { + "description": "Retrieve details of all available tags", + "operationId": "tags_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagResponse" + } + } }, - "type": "array" - }, - "archivedDate": { - "description": "The date a certificate was archived", - "example": "2022-05-24T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "authorityKeyIdentifierHash": { - "description": "An authority key identifier hash", - "example": "40572B10F85DDAF18BFF987372178532AB875BCA", - "type": "string" - }, - "certificateAuthorityAccountId": { - "description": "UUID of a certificate authority account", - "format": "uuid", - "type": "string" - }, - "certificateName": { - "description": "A certificate name", - "example": "venafi.com", - "type": "string" - }, - "certificateRequestId": { - "description": "UUID of a certificate request", - "example": "2e8964a0-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" - }, - "certificateStatus": { - "description": "Certificate's status", - "enum": [ - "ACTIVE", - "RETIRED", - "DELETED" - ], - "example": "ACTIVE", - "type": "string" - }, - "companyId": { - "description": "UUID of a company", - "example": "85595df0-8e14-11ed-87e3-755db050f29d", - "format": "uuid", - "type": "string" - }, - "dekHash": { - "description": "A certificate dek hash", - "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", - "type": "string" - }, - "encryptionType": { - "description": "A certificate encryption type", - "enum": [ - "RSA", - "DSA", - "EC", - "GOST3410", - "ECGOST3410", - "RESERVED3", - "UNKNOWN" - ], - "example": "EC", - "type": "string" + "description": "Details of tags in response body" }, - "extendedKeyUsage": { - "description": "A collection of certificate extended key usages", - "example": [ - "1.3.6.1.5.5.7.3.2", - "1.3.6.1.5.5.7.3.1" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" - }, - "fingerprint": { - "description": "A certificate fingerprint", - "example": "6D4C95512C117B004191F1A096ECAD13242FCD9F", - "type": "string" - }, - "id": { - "description": "UUID of a certificate", - "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" - }, - "inhibitAnyPolicy": { - "description": "Inhibit any policy", - "example": 150, - "format": "int32", - "type": "integer" - }, - "inhibitPolicyMapping": { - "description": "Inhibit policy mapping", - "example": 200, - "format": "int32", - "type": "integer" + "description": "Incomplete or malformed request" }, - "instances": { - "description": "A collection of certificate instances information", - "example": [ - { - "certificateId": "7ec12010-9051-11ed-8e50-b994b27d2ece", - "certificateInstanceId": "7ec1bc50-9051-11ed-8e50-b994b27d2ece", - "certificateSource": "USER_SCAN", - "deploymentStatus": "IN_USE", - "hostname": "venafi.com", - "instanceChainValidationStatus": [ - "OK" - ], - "ipAddress": "23.185.0.2", - "lastScanDate": "2023-01-09T19:12:05.314+00:00", - "lastValidatedAttempt": "2023-01-09T19:12:05.446+00:00", - "modificationDate": "2023-01-09T19:12:14.865+00:00", - "port": 443, - "serviceIds": [ - "1d61e9e0-9046-11ed-bf12-53a1b041cf25" - ], - "sslProtocols": [ - "TLSv1.3", - "TLSv1.2" - ], - "sslValidationErrorArguments": [], - "sslValidationStatus": "OK" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } } - ], - "items": { - "$ref": "#/components/schemas/CertificateInstanceInformation" }, - "type": "array" + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all tags", + "tags": [ + "Tags" + ] + }, + "post": { + "description": "Create tag with optional values", + "operationId": "tags_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagRequest" + } + } }, - "issuerAlternativeNameDns": { - "description": "A collection of certificate issuer alternative names DNs", - "example": [ - "venafi.com", - "www.venafi.com" - ], - "items": { - "type": "string" + "description": "Properties of the new tag.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagInformation" + } + } }, - "type": "array" + "description": "Tag is created. Details in response body" }, - "issuerAlternativeNameNonDns": { - "description": "A collection of certificate issuer alternative name none DNs", - "example": [ - "venafi issuer doman" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" - }, - "issuerC": { - "description": "A certificate issues Country", - "example": "US", - "type": "string" + "description": "Incomplete or malformed request" }, - "issuerCN": { - "description": "A collection of certificate issuer Common names", - "example": [ - "HydrantID SSL CA G3" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" - }, - "issuerCertificateIds": { - "description": "A collection of issuer certificate IDs", - "example": [ - "2e8964a0-9046-11ed-8e50-b994b27d2ece", - "d5b418a0-297e-11eb-bc4c-8b24e5a66fb6" - ], - "items": { - "format": "uuid", + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a tag", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/{name}": { + "get": { + "description": "Retrieve a tag with 'name' attribute matching a specified value", + "operationId": "tags_getByName", + "parameters": [ + { + "description": "Name of the tag.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag.", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagInformation" + } + } }, - "type": "array" + "description": "Details of tag in response body" }, - "issuerCertificates": { - "description": "A collection of certificate information", - "items": { - "$ref": "#/components/schemas/CertificateInformation" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" - }, - "issuerDN": { - "description": "A certificate issue DN", - "example": "cn=HydrantID SSL CA G3,o=HydrantID (Avalanche Cloud Corporation),c=US", - "type": "string" - }, - "issuerL": { - "description": "A certificate issues Locality", - "example": "Salt Lake City", - "type": "string" + "description": "Incomplete or malformed request" }, - "issuerOU": { - "description": "A collection of certificate issuer Organization units", - "example": [ - "Issuer CA" - ], - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" - }, - "issuerST": { - "description": "A certificate issuer State", - "example": "Utah", - "type": "string" + "description": "Tag not found" }, - "keyCurve": { - "description": "A certificate key curve", - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "example": "P256", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve tag by name", + "tags": [ + "Tags" + ] + }, + "delete": { + "description": "Delete a tag with 'name' attribute matching a specified value", + "operationId": "tags_deleteByName", + "parameters": [ + { + "description": "Name of the tag.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag.", + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Tag is deleted" }, - "keyStrength": { - "description": "A certificate key strength", - "example": 2048, - "format": "int32", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Tag not found" }, - "keyUsage": { - "description": "A collection of certificate key usages", - "example": [ - "digitalSignature", - "keyEncipherment" - ], - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete tag by name", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/{name}/values": { + "get": { + "description": "Retrieve tag values for a tag with 'name' attribute matching specified value", + "operationId": "tags_get_values", + "parameters": [ + { + "description": "Name of the tag.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag.", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagValuesResponse" + } + } }, - "type": "array" - }, - "lastNotification": { - "format": "int32", - "type": "integer" - }, - "managedCertificateId": { - "description": "UUID of a managed certificate", - "example": "2f0e7320-9046-11ed-8ab8-19e0a618d9cd", - "format": "uuid", - "type": "string" + "description": "Tag values in response body" }, - "modificationDate": { - "description": "The last date a certificate was modified", - "example": "2022-03-24T09:12:28Z", - "format": "date-time", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" }, - "ocspNoCheck": { - "description": "If a certificate no ocsp check", - "example": false, - "type": "boolean" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Tag not found" }, - "ownership": { - "$ref": "#/components/schemas/CertificateOwnership" - }, - "pathLength": { - "description": "A certificate path length", - "example": 3, - "format": "int32", - "type": "integer" - }, - "requireExplicitPolicy": { - "description": "Required explicit policy is required", - "example": 1, - "format": "int32", - "type": "integer" - }, - "selfSigned": { - "description": "If the certificate is self singed", - "example": true, - "type": "boolean" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve values for a tag", + "tags": [ + "Tags" + ] + }, + "post": { + "description": "Create tag values for a tag with 'name' attribute matching specified value", + "operationId": "tag_values_create", + "parameters": [ + { + "description": "Name of the tag.", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag.", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagValuesRequest" + } + } }, - "serialNumber": { - "description": "A certificate serial number", - "example": "0C51A562B02A19A222FFB4730C47A8E2", - "type": "string" + "description": "The values of the tag.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagValuesResponse" + } + } + }, + "description": "Tag values created" }, - "signatureAlgorithm": { - "description": "A certificate signature algorithm", - "enum": [ - "MD2_WITH_RSA_ENCRYPTION", - "MD5_WITH_RSA_ENCRYPTION", - "SHA1_WITH_RSA_ENCRYPTION", - "SHA1_WITH_RSA_ENCRYPTION2", - "SHA256_WITH_RSA_ENCRYPTION", - "SHA384_WITH_RSA_ENCRYPTION", - "SHA512_WITH_RSA_ENCRYPTION", - "ID_DSA_WITH_SHA1", - "dsaWithSHA1", - "EC_DSA_WITH_SHA1", - "EC_DSA_WITH_SHA224", - "EC_DSA_WITH_SHA256", - "EC_DSA_WITH_SHA384", - "EC_DSA_WITH_SHA512", - "UNKNOWN", - "SHA1_WITH_RSAandMGF1", - "GOST_R3411_94_WITH_GOST_R3410_2001", - "GOST_R3411_94_WITH_GOST_R3410_94" - ], - "example": "SHA256_WITH_RSA_ENCRYPTION", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" }, - "signatureHashAlgorithm": { - "description": "A certificate signature hash algorithm", - "enum": [ - "MD5", - "SHA1", - "MD2", - "SHA224", - "SHA256", - "SHA384", - "SHA512", - "UNKNOWN", - "GOSTR3411_94" - ], - "example": "SHA256", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create tag values", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/{name}/values/{value}": { + "delete": { + "description": "Delete a value associated with a tag", + "operationId": "tags_deleteValueByName", + "parameters": [ + { + "description": "Name of the tag", + "in": "path", + "name": "name", + "required": true, + "schema": { + "description": "Name of the tag", + "type": "string" + } }, - "statusModificationDate": { - "description": "The date a certificate's status was modified", - "example": "2022-04-24T09:12:28Z", - "format": "date-time", - "type": "string" + { + "description": "Name of the value to delete", + "in": "path", + "name": "value", + "required": true, + "schema": { + "description": "Name of the value to delete", + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Tag value deleted" }, - "statusModificationUserId": { - "description": "UUID of the user that modified the certificate installation", - "example": "3c9964a0-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Tag not found" }, - "subjectAlternativeNameDns": { - "description": "A collection of certificate subject alternative names DNs", - "example": [ - "venafi.com", - "www.venafi.com" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a tag value", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/values": { + "get": { + "description": "Retrieve tag values for all tags", + "operationId": "tags_getAllValues", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagValuesResponse" + } + } + }, + "description": "Tag values in response body" }, - "subjectAlternativeNameNonDns": { - "description": "A collection of certificate subject alternative name none DNs", - "example": [ - "venafi domain" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" + "description": "Incomplete or malformed request" }, - "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData1" - }, - "subjectC": { - "description": "A certificate subject Country", - "example": "US", - "type": "string" - }, - "subjectCN": { - "description": "A collection of certificate subject CNs", - "example": [ - "venafi.com", - "cloud.venafi" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" - }, - "subjectDN": { - "description": "A certificate subject DN", - "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", - "type": "string" - }, - "subjectKeyIdentifierHash": { - "description": "A subject key identifier hash", - "example": "4E0CE93D3240561F468C33A85F08FCD3B04CC9DC", - "type": "string" + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve values for all tags", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/creation": { + "post": { + "description": "Create tags in bulk with optional values", + "operationId": "tags_bulk_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsBulkRequest" + } + } }, - "subjectL": { - "description": "A certificate subject Locality", - "example": "Salt Lake City", - "type": "string" + "description": "Properties of the new tags.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAndValuesResponse" + } + } + }, + "description": "Tags are created. Details in response body" }, - "subjectO": { - "description": "A certificate subject Organization", - "example": "Venafi, Inc.", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" }, - "subjectOU": { - "description": "A collection of certificate subject Organization units", - "example": [ - "devops", - "test" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create tags in bulk", + "tags": [ + "Tags" + ] + } + }, + "/v1/tags/deletion": { + "post": { + "description": "Delete tags in bulk by specified keys and values", + "operationId": "tags_bulk_delete", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsBulkRequest" + } + } }, - "subjectST": { - "description": "A certificate subject State", - "example": "Utah", - "type": "string" + "description": "Properties of the tags to delete.", + "required": true + }, + "responses": { + "202": { + "description": "Tags are deleted" }, - "tags": { - "description": "A collection of tags", - "example": [ - "owner:test.user", - "90-day" - ], - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" - }, - "totalActiveInstanceCount": { - "description": "total active instances of a certificate", - "example": 50, - "format": "int32", - "type": "integer" + "description": "Tags not found" }, - "totalInstanceCount": { - "description": "total instances of a certificate", - "example": 100, - "format": "int32", - "type": "integer" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete tags in bulk", + "tags": [ + "Tags" + ] + } + }, + "/v1/tagsassignment": { + "patch": { + "description": "Replace, add, or delete one or more tags or tag values to/from one or more entities", + "operationId": "tags_assignToEntities", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAssignRequest" + } + } }, - "validityEnd": { - "description": "The date a certificate validity ends", - "example": "2023-01-24T09:12:28Z", - "format": "date-time", - "type": "string" + "description": "Properties of the assignments.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAssignResponse" + } + } + }, + "description": "Tag assign response" }, - "validityStart": { - "description": "The date a certificate validity starts", - "example": "2022-01-24T09:12:28Z", - "format": "date-time", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" }, - "versionType": { - "description": "A certificate version type", - "enum": [ - "OLD", - "CURRENT" - ], - "example": "CURRENT", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } + }, + "description": "Incomplete or malformed request" } }, - "type": "object" - }, - "ExtendedCertificateInstanceInformation": { - "properties": { - "applicationIds": { - "description": "A collection of application IDs", - "example": [ - "d3cce873-6957-4071-a65e-7676c0ae1123", - "322bcd99-286a-47ea-8dcd-8291ec5bff14" - ], - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" - }, - "certificate": { - "$ref": "#/components/schemas/CertificateInformation" - }, - "certificateId": { - "description": "UUID of a certificate", - "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", - "format": "uuid", - "type": "string" - }, - "certificateInstanceId": { - "description": "UUID of a certificate instance", - "example": "f68daf30-4690-45bc-85b3-bb327024735e", - "format": "uuid", - "type": "string" - }, - "certificateSource": { - "description": "Certificate source", - "enum": [ - "UNKNOWN", - "USER_PROVIDED", - "USER_IMPORTED", - "USER_SCAN", - "TRUSTNET_SCAN", - "ON_PREM_CA_IMPORT", - "EXTERNAL_CA_IMPORT", - "FILE_IMPORT", - "EXTERNAL_SCAN", - "DOMAIN_SCAN", - "SMART_SCAN_INTERNAL", - "SMART_SCAN_EXTERNAL", - "SMART_VALIDATION_INTERNAL", - "SMART_VALIDATION_EXTERNAL", - "MACHINE_DISCOVERY", - "KUBERNETES_DISCOVERY", - "AWS_DISCOVERY", - "AZURE_DISCOVERY", - "GCP_DISCOVERY" - ], - "example": "USER_SCAN", - "type": "string" - }, - "deploymentStatus": { - "description": "The deployment status", - "enum": [ - "UNKNOWN", - "IN_USE", - "SUPERSEDED" - ], - "example": "IN_USE", - "type": "string" - }, - "hostname": { - "description": "A hostname", - "example": "venafi.com", - "type": "string" - }, - "instanceChainValidationStatus": { - "description": "A collection of the instance chain validation status", - "example": [ - "OK" - ], - "items": { - "enum": [ - "OK", - "CHAIN_BUILDING_FAILED", - "INCOMPLETE_CHAIN", - "CHAIN_EXPIRE_BEFORE_EE", - "DISTRUSTED", - "UNKNOWN_ERROR", - "SELF_SIGNED" - ], - "type": "string" - }, - "type": "array" - }, - "ipAddress": { - "description": "An ip address", - "example": "14.183.1.32", - "type": "string" - }, - "lastScanDate": { - "description": "The last scan date", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "lastValidatedAttempt": { - "description": "The last validation attempt date", - "example": "2023-01-11T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "modificationDate": { - "description": "The last modification date", - "example": "2023-01-10T09:12:28Z", - "format": "date-time", - "type": "string" - }, - "port": { - "description": "A port number", - "example": 443, - "format": "int32", - "type": "integer" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Replace Add Or Delete Tags", + "tags": [ + "Tags" + ] + } + }, + "/v1/tagsassignment/aggregates": { + "post": { + "description": "Bulk operation to retrieve number of entities per tag", + "operationId": "tags_assignmentAggregates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAssignmentAggregatesRequest" + } + } }, - "serviceIds": { - "description": "A collection of service IDs", - "example": [ - "1d61e9e0-9046-11ed-bf12-53a1b041cf2" - ], - "items": { - "format": "uuid", - "type": "string" + "description": "Entity Type and list of tags and/or tag:value pairs.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagsAssignmentAggregatesResponse" + } + } }, - "type": "array" + "description": "Entity type and total count per tag in response body" }, - "sslProtocols": { - "description": "A collection of ssl protocols", - "example": [ - "TLSv1.1", - "TLSv1.2" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" + "description": "Incomplete or malformed request" }, - "sslValidationErrorArguments": { - "description": "A collection of ssl validation error arguments", - "example": [ - "B69950CC5F51EDDF55F36AD2BC898767BC43CC2A", - "24E5796GA7298E78EDE47D6FAED0790E8F464G54" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse2" + } + } }, - "type": "array" - }, - "sslValidationStatus": { - "description": "SSL validation status", - "enum": [ - "HOSTNAME_NOT_RESOLVABLE", - "NO_CERTIFICATE_PRESENTED", - "INVALID_CERTIFICATE_FOUND", - "UNEXPECTED_CERTIFICATE_FOUND", - "OLD_VERSION_CERTIFICATE_FOUND", - "TARGET_UNREACHABLE", - "UNKNOWN_ERROR", - "OK" - ], - "example": "OK", - "type": "string" - }, - "sslValidationStatusMessage": { - "description": "SSL validation status message", - "example": "Certificate installation is using older versions of certificate", - "type": "string" + "description": "Incomplete or malformed request" } }, - "type": "object" - }, - "ExtendedCertificateInstanceResponse": { - "properties": { - "count": { - "format": "int32", - "type": "integer" - }, - "instances": { - "items": { - "$ref": "#/components/schemas/ExtendedCertificateInstanceInformation" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Bulk operation to retrieve number of", + "tags": [ + "Tags" + ] + } + }, + "/v1/distributedissuers/configurations": { + "post": { + "description": "Adds a new Issuer Configuration, which links the following together - Sub CA Provider, Policies used to determine which certificates can be issued, and the IdP (Identity Provider) the Issuer should trust when receiving signed JWTs from its clients.", + "operationId": "configurations_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurationCreateRequest" + } + } } }, - "type": "object" - }, - "ExtendedConfigurationInformation": { - "properties": { - "advancedSettings": { - "$ref": "#/components/schemas/AdvancedSettingsInformation" - }, - "clientAuthentication": { - "$ref": "#/components/schemas/ClientAuthenticationInformation" - }, - "clientAuthorization": { - "$ref": "#/components/schemas/ClientAuthorizationInformation" - }, - "cloudProviders": { - "$ref": "#/components/schemas/CloudProvidersInformation" - }, - "companyId": { - "description": "UUID specific to your company", - "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", - "format": "uuid", - "type": "string" - }, - "controllerAllowedPolicyIds": { - "description": "Array of UUIDs of policies that the kubernetes controller is permitted to use", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedConfigurationInformation" + } + } }, - "type": "array" - }, - "creationDate": { - "description": "When the configuration was initially created", - "example": "2022-10-10T14:50:41.710+00:00", - "type": "string" - }, - "id": { - "description": "UUID of the configuration", - "example": "7268d820-a08d-11ed-bbc0-252385d6d389", - "format": "uuid", - "type": "string" - }, - "longLivedCertCount": { - "description": "Number of long lived certificates", - "example": 2, - "format": "int64", - "type": "integer" - }, - "minTlsVersion": { - "description": "Minimum required TLS protocol version", - "enum": [ - "TLS12", - "TLS13" - ], - "type": "string" - }, - "modificationDate": { - "description": "When the configuration was last modified", - "example": "2023-12-12T20:00:10.500+00:00", - "type": "string" - }, - "name": { - "description": "Name of the configuration", - "example": "Some configuration", - "type": "string" + "description": "Issuer configuration successfully created; details in response body." }, - "policies": { - "items": { - "$ref": "#/components/schemas/PolicyInformation" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "policyDefinitions": { - "items": { - "$ref": "#/components/schemas/PolicyInformation" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a new Issuer configuration", + "tags": [ + "Workload Identity Manager Configurations" + ] + }, + "get": { + "description": "Retrieves a list of all Issuer Configurations. Configurations link together Sub CA Providers, Workload Issuance Policies and Identity Provider information. Together these allow an instance of an Issuer to obtain a Sub CA certificate and use it to issue certificates.", + "operationId": "configurations_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurationResponse" + } + } + }, + "description": "All Issuer configurations." }, - "policyIds": { - "description": "Array of UUIDs of policies to associate with the configuration", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "serviceAccountIds": { - "items": { - "format": "uuid", + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all Issuer", + "tags": [ + "Workload Identity Manager Configurations" + ] + } + }, + "/v1/distributedissuers/configurations/{id}": { + "get": { + "description": "Retrieves the details of the existing Issuer configuration for the specified `id`.", + "operationId": "configurations_getById", + "parameters": [ + { + "description": "Issuer configuration UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedConfigurationInformation" + } + } }, - "type": "array" - }, - "shortLivedCertCount": { - "description": "Number of short lived certificates", - "example": 20, - "format": "int64", - "type": "integer" + "description": "Specified Issuer configuration found; details in response body." }, - "subCaProvider": { - "$ref": "#/components/schemas/SubCaProviderInformation" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." }, - "ultraShortLivedCertCount": { - "description": "Number of ultra short lived certificates", - "example": 200, - "format": "int64", - "type": "integer" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Specified Issuer configuration was not found." }, - "unixSocketAllowedPolicyIds": { - "description": "Array of UUIDs of policies that are permitted to be used when using the unix socket", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get configurations details for a specific", + "tags": [ + "Workload Identity Manager Configurations" + ] }, - "ExtendedPolicyInformation": { - "properties": { - "companyId": { - "description": "UUID specific to your company", - "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", - "format": "uuid", - "type": "string" - }, - "configurations": { - "items": { - "$ref": "#/components/schemas/ConfigurationInformation" - }, - "type": "array" - }, - "creationDate": { - "description": "When the policy was initially created", - "example": "2022-10-10T14:50:41.710+00:00", - "type": "string" - }, - "extendedKeyUsages": { - "description": "Extended key usages", - "example": [ - "CLIENT_AUTH", - "SERVER_AUTH" - ], - "items": { - "enum": [ - "ANY", - "SERVER_AUTH", - "CLIENT_AUTH", - "CODE_SIGNING", - "EMAIL_PROTECTION", - "IPSEC_ENDSYSTEM", - "IPSEC_TUNNEL", - "IPSEC_USER", - "TIME_STAMPING", - "OCSP_SIGNING", - "DVCS", - "SBGP_CERT_AA_SERVER_AUTH", - "SCVP_RESPONDER", - "EAP_OVER_PPP", - "EAP_OVER_LAN", - "SCVP_SERVER", - "SCVP_CLIENT", - "IPSEC_IKE", - "CAPWAP_AC", - "CAPWAP_WTP", - "IPSEC_IKE_INTERMEDIATE", - "SMARTCARD_LOGON" - ], + "patch": { + "description": "Updates (replaces) fields on an Issuer configuration that has the specified `id`. Only fields specified in the request will be updated. Fields not specified in the request are not modified.", + "operationId": "configurations_update", + "parameters": [ + { + "description": "Issuer configuration UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" - }, - "type": "array" - }, - "id": { - "description": "UUID of the policy", - "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", - "format": "uuid", - "type": "string" - }, - "keyAlgorithm": { - "$ref": "#/components/schemas/KeyAlgorithmInformation" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurationUpdateRequest" + } + } }, - "keyUsages": { - "description": "Key usages", - "example": [ - "keyEncipherment", - "digitalSignature" - ], - "items": { - "enum": [ - "digitalSignature", - "nonRepudiation", - "keyEncipherment", - "dataEncipherment", - "keyAgreement", - "keyCertSign", - "cRLSign", - "encipherOnly", - "decipherOnly" - ], - "type": "string" + "description": "Issuer configuration's details to update.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedConfigurationInformation" + } + } }, - "type": "array" - }, - "modificationDate": { - "description": "When the policy was last modified", - "example": "2023-12-12T20:00:10.500+00:00", - "type": "string" - }, - "name": { - "description": "Name of the policy", - "example": "Some policy", - "type": "string" + "description": "Specified Issuer configuration updated; details in response body." }, - "sans": { - "$ref": "#/components/schemas/SansInformation" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." }, - "subject": { - "$ref": "#/components/schemas/SubjectAttributesInformation" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Specified Issuer configuration was not found." }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P30D", - "format": "PnYnMnDTnHnMnS", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update an Issuer configuration details", + "tags": [ + "Workload Identity Manager Configurations" + ] }, - "Facet": { - "properties": { - "domain": { - "additionalProperties": { - "$ref": "#/components/schemas/AnyValue4" + "delete": { + "description": "Deletes the Issuer configuration for the specified `id`. Before deleting a configuration, be sure no Issuer instances use that configuration, or they will no longer function.", + "operationId": "configurations_delete", + "parameters": [ + { + "description": "Issuer configuration UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurationDeleteResponse" + } + } }, - "type": "object" + "description": "Specified Issuer configuration was deleted." }, - "facets": { - "items": { - "$ref": "#/components/schemas/Facet" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "Filter1": { - "format": "json", - "type": "string" - }, - "Filter2": { - "properties": { - "expression": { - "$ref": "#/components/schemas/BaseFilter" + "description": "Incomplete or malformed request." }, - "ordering": { - "$ref": "#/components/schemas/BaseOrdering" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Issuer configuration was not found." }, - "paging": { - "$ref": "#/components/schemas/Page2" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "FilterOperand": { - "properties": { - "operand": { - "$ref": "#/components/schemas/Condition" - }, - "operator": { - "description": "An operator for filtering", - "enum": [ - "NOT" - ], - "example": "NOT", - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "FilterOperands": { - "properties": { - "operands": { - "description": "A list of conditions that will be used for filtering", - "example": [ - { - "field": "certificateStatus", - "operator": "EQ", - "value": "ACTIVE" - }, - { - "field": "certificateName", - "operator": "EQ", - "value": "venafi.com" + ], + "summary": "Remove an Issuer configuration", + "tags": [ + "Workload Identity Manager Configurations" + ] + } + }, + "/v1/distributedissuers/subcaproviders": { + "post": { + "description": "Creates a sub ca provider", + "operationId": "subcaproviders_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderCreateRequest" } - ], - "items": { - "$ref": "#/components/schemas/BaseFilter" - }, - "type": "array" + } }, - "operator": { - "description": "An operator for filtering", - "enum": [ - "AND", - "OR" - ], - "example": "OR", - "type": "string" - } - }, - "type": "object" - }, - "GeneralNamesData1": { - "description": "A certificate subject alternative name by type", - "example": { - "dNSName": [ - "www.venafi.com", - "venafi.com" - ] + "description": "Details of the new sub CA provider.", + "required": true }, - "properties": { - "dNSName": { - "items": { - "type": "string" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderInformation" + } + } }, - "type": "array" + "description": "Sub CA Provider was created; details in response body;" }, - "directoryName": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "ediPartyName": { - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" - }, - "iPAddress": { - "items": { - "type": "string" + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a new Sub CA provider", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + }, + "get": { + "description": "Returns a list of all the subordinate CA providers along with their details.", + "operationId": "subcaprovider_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderResponse" + } + } }, - "type": "array" + "description": "All Sub CA providers with details." }, - "otherName": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "registeredID": { - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all Sub", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + } + }, + "/v1/distributedissuers/subcaproviders/{id}": { + "get": { + "description": "Retrieves the details of the subordinate CA provider that has the specified `id`.", + "operationId": "subcaproviders_getById", + "parameters": [ + { + "description": "Sub CA provider UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderInformation" + } + } }, - "type": "array" + "description": "Specified sub CA provider found; details in response body." }, - "rfc822Name": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "uniformResourceIdentifier": { - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Specified sub CA provider was not found." }, - "x400Address": { - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get a Sub CA provider details", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] }, - "GeneralNamesData2": { - "description": "A certificate request subject alternative name (SAN) type", - "example": { - "dNSName": [ - "www.venafi.com", - "venafi.com" - ] - }, - "properties": { - "dNSName": { - "items": { + "patch": { + "description": "Updates (replaces) details of the subordinate CA provider that has the specified `id`. Only fields specified in the request will be updated.", + "operationId": "subcaproviders_update", + "parameters": [ + { + "description": "Sub CA provider UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" - }, - "type": "array" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderUpdateRequest" + } + } }, - "directoryName": { - "items": { - "type": "string" + "description": "Sub CA provider's details to update.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderInformation" + } + } }, - "type": "array" + "description": "Sub CA provider updated; details in response body." }, - "ediPartyName": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "iPAddress": { - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Specified Sub CA provider was not found." }, - "otherName": { - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" - }, - "registeredID": { - "items": { + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a Sub CA provider details", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + }, + "delete": { + "description": "Deletes the subordinate CA provider that has the specified `id`.", + "operationId": "subcaproviders_delete", + "parameters": [ + { + "description": "Sub CA provider UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubCaProviderDeleteResponse" + } + } }, - "type": "array" + "description": "Specified Sub CA provider was deleted." }, - "rfc822Name": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." }, - "uniformResourceIdentifier": { - "items": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Specified sub CA provider was not found." }, - "x400Address": { - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "GetCMSConfigurationsResponse": { - "description": "The array of Credential Manager Service configurations received.", - "properties": { - "cmsConfigurations": { - "items": { - "$ref": "#/components/schemas/CMSConfigurationResponse" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove a Sub CA provider", + "tags": [ + "Workload Identity Manager Sub CA Providers" + ] + } + }, + "/v1/distributedissuers/policies": { + "post": { + "description": "Add a new a Workload Issuance Policy for an Issuer to use to ensure compliance with company restrictions for creating certificates.", + "operationId": "policies_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyCreateRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedPolicyInformation" + } + } }, - "minItems": 1, - "type": "array" + "description": "Workload Issuance policy was created; details in response body." }, - "count": { - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "cmsConfigurations", - "count" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" + "summary": "Create a new Workload Issuance policy", + "tags": [ + "Workload Identity Manager Policies" + ] }, - "GetCredentialsResponse": { - "description": "Array of credentials received.", - "properties": { - "count": { - "type": "integer" + "get": { + "description": "Retrieves all policy details for all Workload Issuance policies. Policies are sets of rules that constrain how certificates can be issued, as well as set default values for some fields.", + "operationId": "policies_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyResponse" + } + } + }, + "description": "All Workload Issuance policies; details in response body." }, - "credentials": { - "items": { - "$ref": "#/components/schemas/CredentialResponse" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "credentials", - "count" - ], - "type": "object" - }, - "GetServiceAccountScopesResponseBody": { - "example": [ + "security": [ { - "authenticationType": "rsaKey", - "id": "distributed-issuance", - "readableName": "Distributed Issuance" + "tppl-api-key": [] } ], - "items": { - "$ref": "#/components/schemas/ScopeDetails" - }, - "type": "array" - }, - "GetServiceAccountsByClientIDResponseBody": { - "$ref": "#/components/schemas/ServiceAccountDetails" - }, - "GetServiceAccountsResponseBody": { - "example": [ - { - "authenticationType": "rsaKey", - "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", - "credentialLifetime": 365, - "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", - "enabled": true, - "id": "933507dd-0286-11ef-bc25-8a00a468403f", - "name": "Service Account I", - "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", - "scopes": [ - "distributed-issuance" - ], - "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", - "updatedOn": "2024-01-01T00:00:00.000000Z" - }, + "summary": "Get the details of all Workload", + "tags": [ + "Workload Identity Manager Policies" + ] + } + }, + "/v1/distributedissuers/policies/{id}": { + "get": { + "description": "Retrieves the details of the Workload Issuance policy with the specified `id`.", + "operationId": "policies_getById", + "parameters": [ { - "authenticationType": "rsaKey", - "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", - "credentialLifetime": 365, - "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", - "enabled": true, - "id": "933507dd-0286-11ef-bc25-8a00a468403a", - "name": "Service Account II", - "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", - "scopes": [ - "distributed-issuance" - ], - "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", - "updatedOn": "2024-01-01T00:00:00.000000Z" + "description": "Workload Issuance policy UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } } ], - "items": { - "$ref": "#/components/schemas/ServiceAccountDetailsNoKey" - }, - "type": "array" - }, - "GoogleCloudProviderInformation": { - "properties": { - "projectIdentifiers": { - "description": "Array of Google project identifiers each of which should be a string with int64 number or 6 to 30 lowercase letters, digits, or hyphens, should start with a letter and not contain trailing hyphens", - "example": [ - "415104041262", - "tokyo-rain-123" - ], - "items": { - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedPolicyInformation" + } + } }, - "minItems": 1, - "type": "array" + "description": "Specified Workload Issuance policy found; details in response body." }, - "regions": { - "description": "Array of Google regions", - "example": [ - "us-west1" - ], - "items": { - "enum": [ - "asia-east1", - "asia-east2", - "asia-northeast1", - "asia-northeast2", - "asia-northeast3", - "asia-south1", - "asia-south2", - "asia-southeast1", - "asia-southeast2", - "australia-southeast1", - "australia-southeast2", - "europe-central2", - "europe-north1", - "europe-southwest1", - "europe-west1", - "europe-west12", - "europe-west2", - "europe-west3", - "europe-west4", - "europe-west6", - "europe-west8", - "europe-west9", - "me-central1", - "me-west1", - "northamerica-northeast1", - "northamerica-northeast2", - "southamerica-east1", - "southamerica-west1", - "us-central1", - "us-east1", - "us-east4", - "us-east5", - "us-south1", - "us-west1", - "us-west2", - "us-west3", - "us-west4" - ], - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" - } - }, - "required": [ - "projectIdentifiers", - "regions" - ], - "type": "object" - }, - "HSMEdgeStatus": { - "enum": [ - "HSM_ERROR", - "HSM_NOT_CONFIGURED", - "HSM_LOST_CONNECTION", - "HSM_HEALTHY" - ], - "type": "string" - }, - "HashiCorpConfiguration": { - "allOf": [ - { - "properties": { - "authType": { - "$ref": "#/components/schemas/CMSAuthenticationType" - }, - "url": { - "$ref": "#/components/schemas/CMSURL" + "description": "Incomplete or malformed request." + }, + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } } }, - "required": [ - "authType" - ], - "type": "object" + "description": "Specified Workload Issuance policy was not found." }, - { - "oneOf": [ - { - "$ref": "#/components/schemas/CertificateCredentialData" - }, - { - "$ref": "#/components/schemas/UserPasswordAuthenticationData" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } } - ] + }, + "description": "Incomplete or malformed request." } - ], - "description": "The configuration for the HashiCorp app. It's required to set the value for the `cmsType` property to `hashicorp`." - }, - "HashiCorpConfigurationRequiredProp": { - "allOf": [ + }, + "security": [ { - "$ref": "#/components/schemas/HashiCorpConfiguration" + "tppl-api-key": [] } ], - "description": "The configuration for the HashiCorp app. It's required to set the value for the `cmsType` property to `hashicorp`.", - "required": [ - "url" + "summary": "Get a Workload Issuance policy details", + "tags": [ + "Workload Identity Manager Policies" ] }, - "HashiCorpDetails": { - "description": "The HashiCorp Credential information.", - "properties": { - "secretKeyName": { - "description": "The HashiCorp secret key name property.", - "type": "string" - }, - "secretPath": { - "description": "The HashiCorp secret path property.", - "type": "string" - } - }, - "type": "object" - }, - "HashiCorpDetailsRequiredProp": { - "allOf": [ + "patch": { + "description": "Updates (replaces) details of the Workload Issuance policy that has the specified `id`. Only fields specified in the request will be updated. Fields not included in the request will be ignored.", + "operationId": "policies_update", + "parameters": [ { - "$ref": "#/components/schemas/HashiCorpDetails" + "description": "Workload Issuance policy UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } } ], - "required": [ - "secretPath", - "secretKeyName" - ] - }, - "ImportedCertificateInformation": { - "properties": { - "apiClientInformation": { - "$ref": "#/components/schemas/ApiClientInformation" - }, - "base64Certificate": { - "description": "Certificate base64 encoded format (PEM without header/footer", - "type": "string" - }, - "certificateSource": { - "description": "A certificate source", - "enum": [ - "UNKNOWN", - "USER_PROVIDED", - "USER_IMPORTED", - "USER_SCAN", - "TRUSTNET_SCAN", - "ON_PREM_CA_IMPORT", - "EXTERNAL_CA_IMPORT", - "FILE_IMPORT", - "EXTERNAL_SCAN", - "DOMAIN_SCAN", - "SMART_SCAN_INTERNAL", - "SMART_SCAN_EXTERNAL", - "SMART_VALIDATION_INTERNAL", - "SMART_VALIDATION_EXTERNAL", - "MACHINE_DISCOVERY", - "KUBERNETES_DISCOVERY", - "AWS_DISCOVERY", - "AZURE_DISCOVERY", - "GCP_DISCOVERY" - ], - "example": "USER_PROVIDED", - "type": "string" - }, - "certificateUsageMetadata": { - "description": "A collection of certificate request metadata", - "example": [ - { - "appName": "venafi app1", - "automationMetadata": "automation data 008", - "nodeName": "venafi node 007" - }, - { - "appName": "venafi app2", - "automationMetadata": "automation data 0013", - "nodeName": "venafi node 005" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedPolicyInformation" + } } - ], - "items": { - "$ref": "#/components/schemas/CertificateUsageMetadata" }, - "type": "array" - }, - "companyId": { - "description": "UUID of a company", - "example": "2d558b30-da16-11ed-8e4f-8339a1bc8d58", - "format": "uuid", - "type": "string" - }, - "fingerprint": { - "description": "A certificate fingerprint", - "example": "2C85B0AD64F55AA70BAC75F69711578DC505C3F9", - "type": "string" + "description": "Workload Issuance policy updated." }, - "id": { - "description": "UUID of a Certificate", - "example": "16cb6940-e2de-11ed-a644-4fab0ea00b60", - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." }, - "issuerCertificateIds": { - "description": "A collection of issuer certificates", - "example": [ - "Venafi issuer", - "QA Venafi issuer" - ], - "items": { - "format": "uuid", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "type": "array" + "description": "Workload Issuance policy was not found." }, - "managedCertificateId": { - "description": "UUID of a managed certificate", - "example": "17488880-e2de-11ed-aed6-79d407efea73", - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a Workload Issuance policy details", + "tags": [ + "Workload Identity Manager Policies" + ] }, - "IntegrationServiceCreationRequest": { - "properties": { - "edgeInstancesIds": { - "description": "A unique id of the vSatellite containing numbers, letters and dashes.", - "items": { - "format": "uuid", + "delete": { + "description": "Deletes the Workload Issuance policy that has the specified `id`.", + "operationId": "policies_delete", + "parameters": [ + { + "description": "Workload Issuance policy UUID", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PolicyDeleteResponse" + } + } }, - "type": "array", - "uniqueItems": true - }, - "environmentId": { - "description": "Unique environment id containing numbers, letters and dashes.", - "example": "2e8cfc70-74ce-11ed-9051-cfa579eae364", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "The name of the service.", - "example": "Internet discovery", - "minLength": 1, - "type": "string" - }, - "scheduleEnabled": { - "description": "Determines if the discovery services are on a schedule.", - "example": true, - "type": "boolean" - }, - "schedulePattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation1" + "description": "Specified Workload Issuance policy was deleted" }, - "serviceType": { - "description": "The type of the service being executed", - "enum": [ - "BASIC_DISCOVERY", - "ENHANCED_DISCOVERY", - "EXTERNAL_SCAN", - "INTERNET_DISCOVERY", - "SMART_DISCOVERY_EXTERNAL", - "KEY_GENERATION", - "MSCA", - "ACME" - ], - "example": "ENHANCED_DISCOVERY", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." }, - "targets": { - "$ref": "#/components/schemas/TargetsInformation" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Specified Workload Issuance policy was not found." }, - "workTypes": { - "description": "The work type of the service being executed.", - "items": { - "enum": [ - "DISCOVER", - "MANAGE" - ], - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } }, - "minItems": 1, - "type": "array", - "uniqueItems": true + "description": "Incomplete or malformed request." } }, - "required": [ - "environmentId", - "name", - "serviceType", - "workTypes" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "IntegrationServiceDetailsResponse": { - "properties": { - "integrationsServices": { - "description": "A object containing details of the service (e.g, name, status work type, schedule).", - "items": { - "$ref": "#/components/schemas/IntegrationServiceInformation" + "summary": "Remove a Workload Issuance policy", + "tags": [ + "Workload Identity Manager Policies" + ] + } + }, + "/v1/distributedissuers/intermediatecertificates": { + "get": { + "description": "Retrieves the details of all Issuer intermediate certificates. These are the CA certificates issued to the Issuer instances that allow them to issue short-lived certificates.", + "operationId": "intermediatecertificates_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntermediateCertificateResponse" + } + } }, - "type": "array" + "description": "All Issuer intermediate certificates and details." }, - "totalCount": { - "description": "This represents the total number of services that have been created.", - "example": 10, - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "IntegrationServiceInformation": { - "properties": { - "companyId": { - "description": "Unique company id containing in UUID format.", - "example": "2b391680-74ce-11ed-bf7a-a3d5ccdf275c", - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." }, - "edgeInstancesIds": { - "description": "A unique id of the vSatellite containing in UUID format.", - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse3" + } + } + }, + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Get the details of all Issuer", + "tags": [ + "Workload Identity Manager Intermediate Certificates" + ] + } + }, + "/v1/certificaterequests/{id}/approval/{decision}": { + "post": { + "description": "Approve or reject certificate request that is waiting for user action", + "operationId": "certificaterequests_approve", + "parameters": [ + { + "description": "UUID of a Certificate Request", + "in": "path", + "name": "id", + "required": true, + "schema": { "format": "uuid", "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "encryptionKeyId": { - "description": "Encryption key UUID", - "example": "41bb5280-7193-11ed-a059-a7f274bd0b5b", - "format": "uuid", - "type": "string" - }, - "environmentId": { - "description": "Unique environment id containing in UUID format.", - "example": "2e8cfc70-74ce-11ed-9051-cfa579eae364", - "format": "uuid", - "type": "string" - }, - "id": { - "description": "A unique id containing in UUID format.", - "example": "2e8d71a0-74ce-11ed-9051-cfa579eae364", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "The name of the service.", - "example": "Internet discovery", - "type": "string" - }, - "schedulePattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation1" - }, - "schedulerEnabled": { - "description": "Determines if the discovery services are on a schedule.", - "example": true, - "type": "boolean" - }, - "serviceType": { - "description": "The type of the service being executed.", - "enum": [ - "BASIC_DISCOVERY", - "ENHANCED_DISCOVERY", - "EXTERNAL_SCAN", - "INTERNET_DISCOVERY", - "SMART_DISCOVERY_EXTERNAL", - "KEY_GENERATION", - "MSCA", - "ACME" - ], - "example": "ENHANCED_DISCOVERY", - "type": "string" - }, - "status": { - "description": "The current status of the service.", - "enum": [ - "ACTIVE", - "DISABLED", - "RUNNING", - "WARNING", - "DRAFT", - "ERROR" - ], - "example": "DISABLED", - "type": "string" - }, - "statusMessage": { - "description": "The corresponding status message of the service.", - "example": "Integration service is disable", - "type": "string" - }, - "systemGenerated": { - "description": "If an integration service was generated automatically", - "example": true, - "type": "boolean" - }, - "targets": { - "$ref": "#/components/schemas/TargetsInformation" + } }, - "workTypes": { - "description": "The work type of the service being executed.", - "items": { + { + "description": "User's decision - either approve or reject", + "in": "path", + "name": "decision", + "required": true, + "schema": { "enum": [ - "DISCOVER", - "MANAGE" + "APPROVE", + "REJECT" ], "type": "string" - }, - "type": "array", - "uniqueItems": true + } } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApprovalDecisionRequest" + } + } + }, + "description": "In case of rejection contains the reason for that" }, - "type": "object" - }, - "IntegrationServiceUpdateRequest": { - "properties": { - "edgeInstancesIds": { - "description": "A unique id of the vSatellite containing in UUID format.", - "items": { - "format": "uuid", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestInformation1" + } + } }, - "type": "array", - "uniqueItems": true - }, - "name": { - "description": "The name of the service.", - "example": "Internet discovery", - "type": "string" - }, - "scheduleEnabled": { - "description": "Determines if the discovery services are on a schedule.", - "example": true, - "type": "boolean" + "description": "Certificate Request approved/rejected" }, - "schedulePattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation1" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" }, - "targets": { - "$ref": "#/components/schemas/TargetsInformation" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Certificate Request not found" }, - "workTypes": { - "description": "The work type of the service being executed.", - "items": { + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Approve or reject pending certificate request", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificaterequests/approval/bulk/{decision}": { + "post": { + "description": "Initiate approval or rejection of multiple certificate requests that are waiting for user action", + "operationId": "certificaterequests_bulk_approve", + "parameters": [ + { + "description": "User's decision - either approve or reject", + "in": "path", + "name": "decision", + "required": true, + "schema": { "enum": [ - "DISCOVER", - "MANAGE" + "APPROVE", + "REJECT" ], "type": "string" - }, - "maxItems": 2147483647, - "minItems": 1, - "type": "array", - "uniqueItems": true + } } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkApprovalRequest" + } + } + }, + "description": "In case of rejection contains the reason for that." }, - "type": "object" - }, - "IntermediateCertificateInformation": { - "properties": { - "certificate": { - "description": "Intermediate certificate bytes in PEM format", - "format": "PEM", - "type": "string" - }, - "commonName": { - "description": "Common name of the Intermediate certificate", - "example": "example.com", - "type": "string" - }, - "companyId": { - "description": "UUID specific to your company", - "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", - "format": "uuid", - "type": "string" - }, - "configuration": { - "$ref": "#/components/schemas/ConfigurationInformation" - }, - "creationDate": { - "description": "When the intermediate certificate was created", - "example": "2022-10-10T14:50:41.710+00:00", - "type": "string" - }, - "errorInformation": { - "$ref": "#/components/schemas/ErrorInformation2" - }, - "fingerprint": { - "description": "Intermediate certificate fingerprint", - "type": "string" - }, - "id": { - "description": "UUID of the intermediate certificate", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", - "format": "uuid", - "type": "string" - }, - "issuerCertificates": { - "description": "Intermediate certificate chain bytes in PEM format", - "items": { - "description": "Intermediate certificate chain bytes in PEM format", - "type": "string" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkApprovalResponse" + } + } }, - "type": "array" - }, - "longLivedCertCount": { - "description": "Number of long lived certificates", - "example": 1, - "format": "int64", - "type": "integer" - }, - "modificationDate": { - "description": "When the intermediate certificate was last modified", - "example": "2023-12-12T20:00:10.500+00:00", - "type": "string" - }, - "shortLivedCertCount": { - "description": "Number of short lived certificates", - "example": 10, - "format": "int64", - "type": "integer" - }, - "status": { - "description": "Status of the Intermediate certificate request", - "example": "ISSUED", - "type": "string" - }, - "ultraShortLivedCertCount": { - "description": "Number of ultra short lived certificates", - "example": 100, - "format": "int64", - "type": "integer" - }, - "validityEnd": { - "description": "Intermediate certificate validity end date", - "type": "string" + "description": "Bulk Approval of Certificate Request is accepted and processing" }, - "validityStart": { - "description": "Intermediate certificate validity start date", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request" }, - "workflowId": { - "description": "Intermediate certificate workflow id", - "type": "string" - } - }, - "type": "object" - }, - "IntermediateCertificateResponse": { - "properties": { - "intermediateCertificates": { - "items": { - "$ref": "#/components/schemas/IntermediateCertificateInformation" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "array" + "description": "Incomplete or malformed request" } }, - "type": "object" - }, - "InventoryMonitoringConfig": { - "discriminator": { - "mapping": { - "CERTIFICATE_EXPIRATION": "#/components/schemas/CertificateExpirationInventoryMonitoringConfig" - }, - "propertyName": "inventoryMonitoringConfigurationType" - }, - "properties": { - "inventoryMonitoringConfigurationType": { - "type": "string" + "security": [ + { + "tppl-api-key": [] } + ], + "summary": "Approve or reject multiple pending approval", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificaterequests/approvalrules": { + "post": { + "description": "Create certificate request workflow approval rule", + "operationId": "certificaterequests_approval_rule_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRulesRequest" + } + } + }, + "description": "Properties of the new approval rule.", + "required": true }, - "type": "object" - }, - "InventoryMonitoringConfigRequest": { - "properties": { - "inventoryMonitoringConfiguration": { - "oneOf": [ - { - "$ref": "#/components/schemas/CertificateExpirationInventoryMonitoringConfig" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + } } - ], - "type": "object" + }, + "description": "Approval rule is created. Details in response body" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "InventoryMonitoringConfiguration": { - "discriminator": { - "propertyName": "inventoryMonitoringConfigurationType" - }, - "properties": { - "inventoryMonitoringConfigurationType": { - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "required": [ - "inventoryMonitoringConfigurationType" ], - "type": "object" + "summary": "Create an approval rule for certificate", + "tags": [ + "Certificate Approvals" + ] }, - "InventoryMonitoringConfigurationResponse": { - "properties": { - "companyId": { - "description": "UUID specific to your company", - "example": "2b391680-74ce-11ed-bf7a-a3d5ccdf275c", - "format": "uuid", - "type": "string" + "get": { + "description": "Retrieve all certificate request workflow approval rules for the current company.", + "operationId": "certificaterequests_approval_rules_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRulesResponseOpenApi" + } + } + }, + "description": "All approval rules for the current company; details in response body." }, - "configuration": { - "$ref": "#/components/schemas/InventoryMonitoringConfiguration" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." }, - "id": { - "description": "UUID of the configuration", - "example": "2e8d71a0-74ce-11ed-9051-cfa579eae364", - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "InventoryMonitoringSchedulerInformation": { - "properties": { - "name": { - "description": "Name of the configuration", - "type": "string" - }, - "status": { - "description": "Status of the configuration", - "enum": [ - "PENDING", - "RUNNING", - "DONE", - "FAILED" - ], - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "InvitationInformation": { - "properties": { - "companyId": { - "format": "uuid", - "type": "string" - }, - "id": { - "format": "uuid", - "type": "string" + ], + "summary": "Get all approval rules", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificaterequests/approvalrules/{id}": { + "get": { + "description": "Retrieve certificate request workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "certificaterequests_approval_rule_getById", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an approval rule.", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule matching specified id" }, - "productRoles": { - "additionalProperties": { - "items": { - "enum": [ - "SECURITY_ADMIN", - "DEVOPS_LEAD", - "DEVOPS_USER", - "OUTAGEDETECTION_ADMIN", - "RESOURCE_OWNER", - "PKI_ADMIN", - "GUEST", - "PLATFORM_ADMIN" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "object" + "description": "Request Conditions Failed" }, - "properties": { - "additionalProperties": { - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "object" + "description": "Approval rule not found" }, - "userId": { - "format": "uuid", - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Request Conditions Failed" } }, - "type": "object" - }, - "InvitationRequest": { - "properties": { - "role": { - "enum": [ - "SECURITY_ADMIN", - "DEVOPS_LEAD", - "DEVOPS_USER", - "OUTAGEDETECTION_ADMIN", - "RESOURCE_OWNER", - "PKI_ADMIN", - "GUEST", - "PLATFORM_ADMIN" - ], - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "required": [ - "role" ], - "type": "object" + "summary": "Retrieve approval rule by id", + "tags": [ + "Certificate Approvals" + ] }, - "InvitationResponse": { - "properties": { - "invitations": { - "items": { - "$ref": "#/components/schemas/InvitationInformation" - }, - "type": "array" + "put": { + "description": "Can be used to update specific fields of the approval rule that has the specified `id`", + "operationId": "certificaterequests_approval_rule_update", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an approval rule.", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRulesUpdateRequest" + } + } } }, - "type": "object" - }, - "IssuingTemplateDomainsSyncInformation": { - "properties": { - "error": { - "$ref": "#/components/schemas/ErrorInformation9" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule updated" }, - "issuingTemplateId": { - "format": "uuid", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Request Conditions Failed" }, - "status": { - "enum": [ - "COMPLETED", - "FAILED" - ], - "type": "string" - } - }, - "type": "object" - }, - "IssuingTemplateDomainsSyncResponse": { - "properties": { - "issuingTemplatesInformationList": { - "items": { - "$ref": "#/components/schemas/IssuingTemplateDomainsSyncInformation" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "array" + "description": "Approval rule Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Request Conditions Failed" } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update certificate request workflow approval rule", + "tags": [ + "Certificate Approvals" + ] }, - "IssuingTemplatesDomainsSyncRequest": { - "properties": { - "action": { - "enum": [ - "REPLACE" - ], - "type": "string" - }, - "certificateAuthorityAccountId": { - "format": "uuid", - "type": "string" - }, - "issuingTemplatesIds": { - "description": "Set of UUIDs of the issuing templates", - "example": [ - "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" - ], - "items": { - "description": "Set of UUIDs of the issuing templates", + "delete": { + "description": "Delete certificate request workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "certificaterequests_approval_rule_delete", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { "format": "uuid", "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true + } } - }, - "required": [ - "action", - "certificateAuthorityAccountId", - "issuingTemplatesIds" ], - "type": "object" - }, - "JwtClient": { - "properties": { - "allowedPolicyIds": { - "description": "Array of UUIDs of policies that the client is permitted to use", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { - "format": "uuid", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleDeleteResponseOpenApi" + } + } }, - "type": "array" - }, - "issuer": { - "description": "Issuer of the JWT", - "example": "https://kubernetes.default.svc", - "type": "string" + "description": "Specified approval rule was deleted" }, - "jwksUri": { - "description": "URL used to pull the trusted singing keys used for validation", - "example": "https://www.example.com:6443/jwks", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." }, - "name": { - "description": "Name of the client", - "example": "Some client", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Specified approval rule was not found." }, - "subjects": { - "description": "Array of subjects of the JWT", - "example": [ - "system:serviceaccount:venafi:application-team-1" - ], - "items": { - "type": "string" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "array" + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "JwtClientInformation": { - "properties": { - "allowedPolicyIds": { - "description": "Array of UUIDs of policies that the client is permitted to use", - "example": [ - "8ae92800-b1e0-11ed-859d-b39255f965ee" - ], - "format": "uuid", - "items": { + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete certificate request workflow approval rule", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificaterequests/approvalrequests/{entityId}": { + "get": { + "description": "Retrieve approval request by specified certificate request id", + "operationId": "certificaterequests_approvalrequest", + "parameters": [ + { + "description": "Entity UUID of the approval request", + "in": "path", + "name": "entityId", + "required": true, + "schema": { "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApprovalRequestInformation" + } + } }, - "minItems": 1, - "type": "array" - }, - "issuer": { - "description": "Issuer of the JWT", - "example": "https://kubernetes.default.svc", - "maxLength": 2048, - "type": "string" - }, - "jwksUri": { - "description": "URL used to pull the trusted singing keys used for validation", - "example": "https://www.example.com:6443/jwks", - "maxLength": 2048, - "type": "string" - }, - "name": { - "description": "Name of the client", - "example": "Some client", - "maxLength": 64, - "type": "string" + "description": "Approval Request information" }, - "subjects": { - "description": "Array of subjects of the JWT", - "example": [ - "system:serviceaccount:venafi:application-team-1" - ], - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "allowedPolicyIds", - "issuer", - "name", - "subjects" - ], - "type": "object" - }, - "JwtJwksAuthenticationInformation": { - "allOf": [ - { - "$ref": "#/components/schemas/ClientAuthenticationInformation" + "description": "Incomplete or malformed request" }, - { - "properties": { - "urls": { - "description": "Array of JWT JWKS urls", - "example": [ - "https://jwks.example.com" - ], - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } } }, - "type": "object" - } - ], - "required": [ - "urls" - ], - "type": "object" - }, - "JwtJwksAuthenticationOpenApi": { - "allOf": [ - { - "$ref": "#/components/schemas/ClientAuthenticationOpenApi" + "description": "Approval Request not found" }, - { - "properties": { - "urls": { - "description": "Array of JWT JWKS urls", - "example": [ - "https://jwks.example.com" - ], - "items": { - "type": "string" - }, - "type": "array" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } } }, - "type": "object" + "description": "Incomplete or malformed request" } - ], - "type": "object" - }, - "JwtOidcAuthenticationInformation": { - "allOf": [ - { - "$ref": "#/components/schemas/ClientAuthenticationInformation" - }, + }, + "security": [ { - "properties": { - "audience": { - "description": "OpenId audience", - "example": "Client1", - "maxLength": 256, - "type": "string" - }, - "baseUrl": { - "description": "JWT OpenId base URL", - "example": "https://openid.example.com", - "maxLength": 2048, - "type": "string" - } - }, - "type": "object" + "tppl-api-key": [] } ], - "required": [ - "audience", - "baseUrl" - ], - "type": "object" - }, - "JwtOidcAuthenticationOpenApi": { - "allOf": [ - { - "$ref": "#/components/schemas/ClientAuthenticationOpenApi" + "summary": "Retrieve approval request for specific certificate", + "tags": [ + "Certificate Approvals" + ] + } + }, + "/v1/certificates/revocations/approvalrules": { + "post": { + "description": "Create certificate revocation workflow approval rule", + "operationId": "certificaterevocations_approval_rule_create", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRulesRequest" + } + } }, - { - "properties": { - "audience": { - "description": "OpenId audience", - "example": "Alpha testers", - "type": "string" - }, - "baseUrl": { - "description": "JWT OpenId base URL", - "example": "https://oidc.example.com/", - "type": "string" + "description": "Properties of the new approval rule.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" + } } }, - "type": "object" - } - ], - "type": "object" - }, - "JwtStandardClaimsAuthenticationInformation": { - "allOf": [ - { - "$ref": "#/components/schemas/ClientAuthenticationInformation" + "description": "Approval rule is created. Details in response body" }, - { - "properties": { - "audience": { - "description": "Recipients that the JWT is intended for", - "example": "Client1", - "maxLength": 256, - "type": "string" - }, - "clients": { - "description": "List with clients, identified by processing JWTs that include standard/registered claims", - "items": { - "$ref": "#/components/schemas/JwtClientInformation" - }, - "minItems": 1, - "type": "array" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } } }, - "type": "object" - } - ], - "required": [ - "audience", - "clients" - ], - "type": "object" - }, - "JwtStandardClaimsAuthenticationOpenApi": { - "allOf": [ - { - "$ref": "#/components/schemas/ClientAuthenticationOpenApi" + "description": "Incomplete or malformed request." }, - { - "properties": { - "audience": { - "description": "Recipients that the JWT is intended for", - "example": "Client1", - "type": "string" - }, - "clients": { - "description": "List with clients, identified by processing JWTs that include standard/registered claims", - "items": { - "$ref": "#/components/schemas/JwtClient" - }, - "type": "array" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } } }, - "type": "object" + "description": "Incomplete or malformed request." + } + }, + "security": [ + { + "tppl-api-key": [] } ], - "type": "object" - }, - "KeyAlgorithm": { - "enum": [ - "RSA", - "ED25519", - "VSAT_HPKE" - ], - "type": "string" + "summary": "Create an approval rule for certificate", + "tags": [ + "Certificate Revocation Approvals" + ] }, - "KeyAlgorithmInformation": { - "description": "Key algorithm", - "properties": { - "allowedValues": { - "description": "Key algorithm allowed values", - "items": { - "enum": [ - "RSA_2048", - "RSA_3072", - "RSA_4096", - "EC_P256", - "EC_P384", - "EC_P521", - "EC_ED25519" - ], - "type": "string" + "get": { + "description": "Retrieve all certificate revocation workflow approval rules for the current company.", + "operationId": "certificaterevocations_approval_rules_getAll", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRulesResponseOpenApi" + } + } }, - "minItems": 1, - "type": "array" + "description": "All approval rules for the current company; details in response body." }, - "defaultValue": { - "description": "Key algorithm default value", - "enum": [ - "RSA_2048", - "RSA_3072", - "RSA_4096", - "EC_P256", - "EC_P384", - "EC_P521", - "EC_ED25519" - ], - "example": "RSA_4096", - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." } }, - "required": [ - "allowedValues", - "defaultValue" - ], - "type": "object" - }, - "KeyTypeInformation1": { - "discriminator": { - "propertyName": "keyType" - }, - "properties": { - "keyType": { - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "KeyTypeInformation2": { - "discriminator": { - "propertyName": "keyType" - }, - "properties": { - "keyType": { - "type": "string" + ], + "summary": "Get all certificate revocation approval rules", + "tags": [ + "Certificate Revocation Approvals" + ] + } + }, + "/v1/certificates/revocations/approvalrules/{id}": { + "get": { + "description": "Retrieve certificate revocation workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "certificaterevocations_approval_rule_getById", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an approval rule.", + "format": "uuid", + "type": "string" + } } - }, - "type": "object" - }, - "KeyTypeParameters1": { - "properties": { - "keyCurve": { - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "type": "string" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" + } + } + }, + "description": "Approval rule matching specified id" }, - "keyLength": { - "format": "int32", - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Request Conditions Failed" }, - "keyType": { - "enum": [ - "RSA", - "EC" - ], - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Approval rule not found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Request Conditions Failed" } }, - "required": [ - "keyCurve", - "keyLength", - "keyType" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" + "summary": "Retrieve certificate revocation approval rule by", + "tags": [ + "Certificate Revocation Approvals" + ] }, - "KeyTypeParameters2": { - "properties": { - "keyCurves": { - "items": { - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], + "put": { + "description": "Can be used to update specific fields of the approval rule that has the specified `id`", + "operationId": "certificaterevocations_approval_rule_update", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "description": "UUID of an approval rule.", + "format": "uuid", "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRulesUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" + } + } }, - "type": "array" + "description": "Approval rule updated" }, - "keyLengths": { - "items": { - "format": "int32", - "type": "integer" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "array" + "description": "Request Conditions Failed" }, - "keyType": { - "enum": [ - "RSA", - "EC" - ], - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Approval rule Not Found" + }, + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Request Conditions Failed" } }, - "required": [ - "keyType" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" - }, - "LastModifiedBy": { - "description": "The ID of the user whom modified the credential.", - "type": "string" - }, - "LastModifiedOn": { - "description": "The date in ISO 8601 full-date format when the credential was modified.", - "format": "date", - "type": "string" + "summary": "Update certificate revocation workflow approval ru", + "tags": [ + "Certificate Revocation Approvals" + ] }, - "Link": { - "properties": { - "params": { - "additionalProperties": { + "delete": { + "description": "Delete certificate revocation workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", + "operationId": "certificaterevocations_approval_rule_delete", + "parameters": [ + { + "description": "UUID of an approval rule.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "format": "uuid", "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleDeleteResponseOpenApi" + } + } }, - "type": "object" - }, - "rel": { - "type": "string" + "description": "Specified approval rule was deleted" }, - "rels": { - "items": { - "type": "string" + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } }, - "type": "array" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" + "description": "Incomplete or malformed request." }, - "uri": { - "format": "uri", - "type": "string" + "404": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Specified approval rule was not found." }, - "uriBuilder": { - "$ref": "#/components/schemas/UriBuilder" + "412": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse9" + } + } + }, + "description": "Incomplete or malformed request." } }, - "type": "object" - }, - "LocalLoginRequest": { - "properties": { - "localLoginDisabled": { - "type": "boolean" - } + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete certificate revocation workflow approval ru", + "tags": [ + "Certificate Revocation Approvals" + ] + } + }, + "/v1/plugins": { + "get": { + "description": "Retrieve all the plugins for the tenant.", + "operationId": "get-v1-plugins", + "parameters": [ + { + "description": "Filter by provided plugin type.", + "in": "query", + "name": "pluginTypes", + "schema": { + "items": { + "$ref": "#/components/schemas/PluginType" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + { + "description": "Include disabled plugins if set to true.", + "in": "query", + "name": "includeDisabled", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "plugins": { + "items": { + "$ref": "#/components/schemas/Plugin" + }, + "type": "array" + } + }, + "required": [ + "plugins" + ], + "type": "object" + } + } + }, + "description": "Success. All plugins retrieved." + } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all plugins", + "tags": [ + "Plugins" + ] }, - "LocalizationResource": { - "description": "Translation map for the UI being rendered. This map is used with the manifest schema. The keys represent the values provided for the \"x-localizationKey\" property in the domain entity definition, and each key's value is used to represent field labels, enum values, or error messages.", - "nullable": true, - "properties": { - "en": { - "type": "object" + "post": { + "description": "Create a custom plugin for your tenant's exclusive use. The user must be a SYSTEM_ADMIN or a PKI_ADMIN.", + "operationId": "post-v1-plugins", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublicPluginCreationRequest" + } + } } }, - "title": "LocalizationResources", - "type": "object", - "x-examples": { - "Example 1": { - "en": { - "address": { - "label": "Server Hostname" - }, - "binding": { - "label": "Server Store Details" - }, - "certificateName": { - "description": "How the certificate should appear on the server.", - "label": "Certificate Name" - }, - "chainName": { - "label": "Chain Bundle Name" - }, - "discovery": { - "expiredCertificatesLabel": "Exclude expired certificates", - "inactiveProfilesLabel": "Exclude certificates that are not in use by either a virtual server or a monitor.", - "partitionDescription": "A comma separated list of partition names.", - "partitionLabel": "Partition(s)" - }, - "discoveryType": { - "all": "Both Monitors and Virtual Servers", - "label": "Resource Types to Discover", - "monitor": "Monitors", - "virtualServer": "Virtual Servers" - }, - "keystore": { - "label": "Certificate Information" - }, - "parentProfile": { - "description": "No value is interpreted as \"clientssl\" or \"serverssl\" depending on the Profile Type selected.", - "label": "Parent Profile" - }, - "partition": { - "description": "No value is interpreted as the \"Common\" partition.", - "label": "Partition" - }, - "password": { - "hidePassword": "Hide Password", - "label": "Password", - "showPassword": "Show Password" - }, - "port": { - "description": "No value is interpreted as 443.", - "label": "Port" - }, - "serverName": { - "description": "An alternative DNS name used for Server Name Indication.", - "label": "SNI" - }, - "sslProfile": { - "label": "SSL Profile" - }, - "sslProfileType": { - "client": "Client SSL Profile", - "label": "Profile Type", - "server": "Server SSL Profile" - }, - "username": { - "label": "Username" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PluginResponse" + } + } + }, + "description": "Success. Plugin created." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Create a local plugin", + "tags": [ + "Plugins" + ] + } + }, + "/v1/plugins/{id}": { + "get": { + "description": "Retrieve a plugin with the specified ID.", + "operationId": "get-v1-plugins-id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plugin" + } } + }, + "description": "Success. Plugin retrieved." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve plugin by ID", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } } - } + ] }, - "MachineBatchProvisioningResultInformation": { - "properties": { - "endDate": { - "format": "date-time", - "type": "string" - }, - "errorMessage": { - "type": "string" - }, - "machineIdentitiesCount": { - "format": "int64", - "type": "integer" - }, - "machineIdentitiesFailedCount": { - "format": "int64", - "type": "integer" - }, - "machineIdentitiesSucceedCount": { - "format": "int64", - "type": "integer" + "patch": { + "description": "Update a plugin with specified ID. Plugin must be owned by the tenant and the user must be a SYSTEM_ADMIN or a PKI_ADMIN.", + "operationId": "patch-v1-plugins-id", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublicPluginUpdateRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Success. Plugin updated." }, - "startDate": { - "format": "date-time", - "type": "string" + "401": { + "description": "Unauthorized" }, - "type": { - "enum": [ - "MANUAL", - "SCHEDULED" - ], - "type": "string" + "403": { + "description": "Forbidden" } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Update a local plugin", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ] }, - "MachineCreationRequest": { - "properties": { - "connectionDetails": { - "$ref": "#/components/schemas/AnyValue10" - }, - "dekId": { - "minLength": 1, - "type": "string" - }, - "edgeInstanceId": { - "format": "uuid", - "type": "string" - }, - "machineTypeId": { - "deprecated": true, - "format": "uuid", - "type": "string" - }, - "name": { - "minLength": 1, - "type": "string" - }, - "owningTeamId": { - "format": "uuid", - "type": "string" - }, - "pluginId": { - "format": "uuid", - "type": "string" - }, - "status": { - "enum": [ - "DRAFT", - "VERIFIED", - "UNVERIFIED", - "DELETING" - ], - "type": "string" - }, - "tags": { - "items": { + "delete": { + "description": "Delete a plugin with the specified ID. Plugin must be owned by the tenant and the user must be a SYSTEM_ADMIN or a PKI_ADMIN.", + "operationId": "delete-v1-plugins-id", + "responses": { + "204": { + "description": "No Content." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Delete a local plugin", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" + } + } + ] + } + }, + "/v1/plugins/{id}/disablements": { + "post": { + "description": "Set a plugin to be disabled for your tenant.", + "operationId": "post-v1-plugins-id-exclusions", + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PluginResponse" + } + } }, - "type": "array" + "description": "Successfully disabled the plugin for the current tenant." } }, - "required": [ - "connectionDetails", - "dekId", - "edgeInstanceId", - "name", - "pluginId" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" + "summary": "Disable a plugin", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID that is currently marked as disabled.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ] }, - "MachineDiscoveryResultInformation": { - "properties": { - "certificatesCountCurrent": { - "format": "int64", - "type": "integer" - }, - "certificatesCountTotal": { - "format": "int64", - "type": "integer" - }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "discoveryStatus": { - "enum": [ - "NEVER INITIATED", - "INITIATED", - "RUNNING", - "COMPLETED", - "ABORTED", - "ABORTING", - "FAILED" - ], - "type": "string" - }, - "endDate": { - "format": "date-time", - "type": "string" - }, - "errorCount": { - "format": "int32", - "type": "integer" - }, - "machineIdentitiesCount": { - "format": "int64", - "type": "integer" + "delete": { + "description": "Remove a plugin exclusion from your tenant.", + "operationId": "delete-v1-plugins-id-exclusions", + "responses": { + "204": { + "description": "No Content. Successfully deleted the plugin disablement." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Remove plugin disablement", + "tags": [ + "Plugins" + ], + "parameters": [ + { + "description": "Plugin ID that is currently marked as disabled.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ] + } + }, + "/v1/plugins/disablements": { + "get": { + "description": "Retrieve all the disabled plugins for the current tenant.", + "operationId": "get-v1-plugins-exclusions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PluginResponse" + } + } + }, + "description": "Successfully retrieved all the disabled plugins for the current tenant." + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieve all disabled plugins", + "tags": [ + "Plugins" + ] + } + }, + "/v1/serviceaccounts": { + "get": { + "description": "Retrieves all the Service Accounts the user has access to", + "operationId": "get-v1-serviceaccounts", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetServiceAccountsResponseBody" + } + } + }, + "description": "The list of all Service Account details the user has access to" }, - "machineIdentitiesDeletedCount": { - "format": "int64", - "type": "integer" + "400": { + "description": "BadRequest" }, - "machineIdentitiesMissingCount": { - "format": "int64", - "type": "integer" + "401": { + "description": "Unauthorized" }, - "startDate": { - "format": "date-time", - "type": "string" + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "MachineDocumentInformation": { - "properties": { - "companyId": { - "format": "uuid", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "type": "string" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "integrationId": { - "format": "uuid", - "type": "string" - }, - "machineIdentitiesCount": { - "format": "int32", - "type": "integer" - }, - "machineName": { - "type": "string" - }, - "machineType": { - "deprecated": true, - "type": "string" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Retrieves all the Service Accounts the", + "tags": [ + "Service Accounts" + ] + }, + "post": { + "description": "Creates a Service Account with the information provided. The service account is later used for machine to machine authentication. For rsaKey authentication service accounts publicKey key is required. Provide authenticationType field for creating other service accounts with another type of authentication.", + "operationId": "create-v1-serviceaccounts", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateServiceAccountRequestBody" + } + } }, - "machineTypeId": { - "deprecated": true, - "format": "uuid", - "type": "string" + "description": "The Service Account data", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateServiceAccountResponseBody" + } + } + }, + "description": "The id assigned to the created Service Account. If the Service Account has CyberArk registry purpose and is created with ociToken authentication type, the ociRegistryToken and ociAccountName are returned in the response." }, - "modificationDate": { - "format": "date-time", - "type": "string" + "400": { + "description": "BadRequest. Return ErrInvalidPayload when creating rsaKey authentication service accounts and publicKey not provided." }, - "ownership": { - "$ref": "#/components/schemas/MachineOwnership" + "401": { + "description": "Unauthorized" }, - "owningTeam": { - "format": "uuid", - "type": "string" + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Creates a Service Account", + "tags": [ + "Service Accounts" + ] + } + }, + "/v1/serviceaccounts/{id}": { + "get": { + "description": "Retrieves the information of an Service Account associated to the given id", + "operationId": "get-v1-serviceaccounts-byId", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to retrieve", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetServiceAccountsByClientIDResponseBody" + } + } + }, + "description": "The Service Account details for the given id" }, - "pluginId": { - "format": "uuid", - "type": "string" + "400": { + "description": "BadRequest" }, - "pluginName": { - "type": "string" + "401": { + "description": "Unauthorized" }, - "status": { - "enum": [ - "DRAFT", - "VERIFIED", - "UNVERIFIED", - "DELETING" - ], - "type": "string" + "500": { + "description": "InternalServerError" } }, - "type": "object" + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Gets a Service Account", + "tags": [ + "Service Accounts" + ] }, - "MachineDocumentResponse": { - "properties": { - "machines": { - "items": { - "$ref": "#/components/schemas/MachineDocumentInformation" - }, - "type": "array" - }, - "totalCount": { - "format": "int64", - "type": "integer" + "patch": { + "description": "Updates the specified fields for a given service account matching the provided id. Providing either a new credentialLifetime or a new publicKey will result of the corresponding credentials associated to this Service Account", + "operationId": "patch-v1-serviceaccounts-byId", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to update", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchServiceAccountByClientIDRequestBody" + } + } + }, + "description": "The data to update", + "required": true }, - "type": "object" - }, - "MachineIdentityCreationRequest": { - "properties": { - "binding": { - "$ref": "#/components/schemas/AnyValue10" + "responses": { + "204": { + "description": "The Service Account was updated successfully" }, - "certificateId": { - "format": "uuid", - "type": "string" + "400": { + "description": "BadRequest" }, - "keystore": { - "$ref": "#/components/schemas/AnyValue10" + "401": { + "description": "Unauthorized" }, - "machineId": { - "format": "uuid", - "type": "string" + "500": { + "description": "InternalServerError" } }, - "required": [ - "certificateId", - "machineId" + "security": [ + { + "tppl-api-key": [] + } ], - "type": "object" + "summary": "Updates a Service Account", + "tags": [ + "Service Accounts" + ] }, - "MachineIdentityDocumentInformation": { - "properties": { - "applicationIds": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" + "delete": { + "description": "Deletes the Service Account corresponding to the provided id. Deleting a Service Account also invalidates its associated credentials.", + "operationId": "delete-v1-serviceaccounts-byId", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to delete", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } + } + ], + "responses": { + "204": { + "description": "The Service Account was deleted successfully" }, - "binding": { - "$ref": "#/components/schemas/AnyValue10" - }, - "certificateFingerprint": { - "type": "string" - }, - "certificateId": { - "format": "uuid", - "type": "string" - }, - "certificateName": { - "type": "string" - }, - "certificateValidityEnd": { - "format": "date-time", - "type": "string" - }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "type": "string" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "keystore": { - "$ref": "#/components/schemas/AnyValue10" - }, - "lastSeenOn": { - "format": "date-time", - "type": "string" - }, - "machineId": { - "format": "uuid", - "type": "string" - }, - "machineName": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/AnyValue10" + "400": { + "description": "BadRequest" }, - "modificationDate": { - "format": "date-time", - "type": "string" + "401": { + "description": "Unauthorized" }, - "status": { - "enum": [ - "NEW", - "PENDING", - "INSTALLED", - "DISCOVERED", - "VALIDATED", - "MISSING", - "FAILED" - ], - "type": "string" + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "MachineIdentityDocumentResponse": { - "properties": { - "machineIdentities": { - "items": { - "$ref": "#/components/schemas/MachineIdentityDocumentInformation" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "MachineIdentityInformation": { - "properties": { - "binding": { - "$ref": "#/components/schemas/AnyValue10" - }, - "certificateId": { - "format": "uuid", - "type": "string" - }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "type": "string" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "keystore": { - "$ref": "#/components/schemas/AnyValue10" - }, - "lastSeenOn": { - "format": "date-time", - "type": "string" - }, - "machineId": { - "format": "uuid", - "type": "string" + ], + "summary": "Deletes a Service Account", + "tags": [ + "Service Accounts" + ] + } + }, + "/v1/serviceaccounts/scopes": { + "get": { + "description": "Retrieves all the Service Accounts Scopes available for the user", + "operationId": "get-v1-serviceaccountscopes", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetServiceAccountScopesResponseBody" + } + } + }, + "description": "The list of all Service Account Scopes available for the user" }, - "metadata": { - "$ref": "#/components/schemas/AnyValue10" + "400": { + "description": "BadRequest" }, - "modificationDate": { - "format": "date-time", - "type": "string" + "401": { + "description": "Unauthorized" }, - "status": { - "enum": [ - "NEW", - "PENDING", - "INSTALLED", - "DISCOVERED", - "VALIDATED", - "MISSING", - "FAILED" - ], - "type": "string" + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "MachineIdentityResponse": { - "properties": { - "machineIdentities": { - "items": { - "$ref": "#/components/schemas/MachineIdentityInformation" - }, - "type": "array" + "security": [ + { + "tppl-api-key": [] } - }, - "type": "object" - }, - "MachineIdentitySearchRequest": { - "properties": { - "expression": { - "$ref": "#/components/schemas/Expression" - }, - "ordering": { - "$ref": "#/components/schemas/Ordering" - }, - "paging": { - "$ref": "#/components/schemas/Paging" + ], + "summary": "Retrieves all the Service Accounts Scopes", + "tags": [ + "Service Accounts" + ] + } + }, + "/v1/serviceaccounts/{id}/ocitoken": { + "put": { + "description": "Regenerate the OCI registry token for a given service account matching the provided id. Providing a new OCI registry token to this Service Account and sending it back to the client back. Calling this endpoint will remove the current token for the service account and create a new one. Old token can not be used.", + "operationId": "put-v1-serviceaccounts-byId-ocitoken", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to regenerate the OCI registry token", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } } - }, - "type": "object" - }, - "MachineIdentityUpdateRequest": { - "properties": { - "binding": { - "$ref": "#/components/schemas/AnyValue10" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutServiceAccountByClientIDOCITokenResponseBody" + } + } + }, + "description": "The Service Account OCI registry token has been regenerated" }, - "certificateId": { - "format": "uuid", - "type": "string" + "400": { + "description": "BadRequest. This also happens when trying to regenerate token for account without token based authentication" }, - "keystore": { - "$ref": "#/components/schemas/AnyValue10" - } - }, - "type": "object" - }, - "MachineIdentityWorkflowInformation": { - "properties": { - "workflowId": { - "type": "string" + "401": { + "description": "Unauthorized" }, - "workflowName": { - "type": "string" + "500": { + "description": "InternalServerError" } }, - "type": "object" - }, - "MachineIdentityWorkflowRequest": { - "properties": { - "workflowInput": { - "$ref": "#/components/schemas/ProvisionCertificateWorkflowInputInformation" - }, - "workflowName": { - "type": "string" + "security": [ + { + "tppl-api-key": [] } - }, - "required": [ - "workflowName" ], - "type": "object" - }, - "MachineInformation": { - "properties": { - "batchProvisioningResult": { - "$ref": "#/components/schemas/MachineBatchProvisioningResultInformation" - }, - "batchProvisioningSchedulerEnabled": { - "type": "boolean" - }, - "batchProvisioningSchedulerPattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation3" - }, - "batchProvisioningStatus": { - "enum": [ - "NEVER_INITIATED", - "INITIATED", - "RUNNING", - "COMPLETED", - "ABORTED", - "ABORTING", - "FAILED" - ], - "type": "string" - }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "type": "string" - }, - "discoveryJson": { - "$ref": "#/components/schemas/AnyValue10" - }, - "discoverySchedulerEnabled": { - "type": "boolean" - }, - "discoverySchedulerPattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation3" - }, - "discoveryStatus": { - "enum": [ - "NEVER INITIATED", - "INITIATED", - "RUNNING", - "COMPLETED", - "ABORTED", - "ABORTING", - "FAILED" - ], - "type": "string" - }, - "edgeInstanceId": { - "format": "uuid", - "type": "string" + "summary": "Regenerate the OCI registry token for", + "tags": [ + "Service Accounts" + ] + } + }, + "/v1/serviceaccounts/{id}/credentials": { + "put": { + "description": "Updates the specified credentials for a given service account matching the provided id. Providing either a new credentialLifetime or a new publicKey will result of the corresponding credentials associated to this Service Account", + "operationId": "put-v1-serviceaccounts-byId-credentials", + "parameters": [ + { + "description": "The ID corresponding to the Service Account you want to update", + "in": "path", + "name": "id", + "required": true, + "schema": { + "example": "933507dd-0286-11ef-bc25-8a00a468403f", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutServiceAccountByClientIDCredentialsRequestBody" + } + } }, - "id": { - "format": "uuid", - "type": "string" + "description": "The data to update", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutServiceAccountByClientIDCredentialsResponseBody" + } + } + }, + "description": "The Service Account Credentials were updated successfully" }, - "integrationId": { - "format": "uuid", - "type": "string" + "400": { + "description": "BadRequest" }, - "machineType": { - "deprecated": true, - "type": "string" + "401": { + "description": "Unauthorized" }, - "modificationDate": { - "format": "date-time", - "type": "string" + "500": { + "description": "InternalServerError" + } + }, + "security": [ + { + "tppl-api-key": [] + } + ], + "summary": "Updates a Service Account credentials", + "tags": [ + "Service Accounts" + ] + } + } + }, + "components": { + "parameters": { + "AuthTypesParam": { + "description": "The authentication types separated by commas.", + "explode": false, + "in": "query", + "name": "authTypes", + "schema": { + "items": { + "$ref": "#/components/schemas/AuthType" }, - "name": { - "type": "string" + "minItems": 1, + "type": "array" + } + }, + "CMSConfigIdParam": { + "description": "The id of the Credential Manager Service configuration.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/CMSConfId" + } + }, + "CMSCredentialDetailsParam": { + "description": "The option of whether or not return full credential details. Only Admin users can use this parameter.", + "in": "query", + "name": "details", + "schema": { + "type": "boolean" + } + }, + "CMSTypesParam": { + "description": "The privileged access management types separated by commas.", + "explode": false, + "in": "query", + "name": "cmsTypes", + "schema": { + "items": { + "$ref": "#/components/schemas/CMSType" }, - "owningTeamId": { - "format": "uuid", - "type": "string" + "minItems": 1, + "type": "array" + } + }, + "CredentialIdParam": { + "description": "The credential Id.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "$ref": "#/components/schemas/CredentialId" + } + }, + "CredentialIdsParam": { + "description": "The credential Ids separated by commas.", + "explode": false, + "in": "query", + "name": "ids", + "schema": { + "items": { + "$ref": "#/components/schemas/CredentialId" }, - "pluginId": { - "format": "uuid", - "type": "string" + "minItems": 1, + "type": "array" + } + }, + "TeamIdsParam": { + "description": "The team Ids separated by commas.", + "explode": false, + "in": "query", + "name": "teamIds", + "schema": { + "items": { + "$ref": "#/components/schemas/TeamId" }, - "status": { - "enum": [ - "DRAFT", - "VERIFIED", - "UNVERIFIED", - "DELETING" - ], - "type": "string" + "minItems": 1, + "type": "array" + } + } + }, + "requestBodies": { + "AddCredentialsBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCredentialsRequest" + } } }, - "type": "object" + "description": "The body request to add credentials to existing Credential Manager Service configurations." }, - "MachineOwnership": { - "properties": { - "owningTeams": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "CreateCMSConfigurationsBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCMSConfigurationsRequest" + } } }, - "type": "object" + "description": "The body request to create the given Credential Manager Service configuration using their details." }, - "MachineUpdateRequest": { - "properties": { - "batchProvisioningSchedulerEnabled": { - "type": "boolean" - }, - "batchProvisioningSchedulerPattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation3" - }, - "connectionDetails": { - "$ref": "#/components/schemas/AnyValue10" - }, - "discoveryJson": { - "$ref": "#/components/schemas/AnyValue10" - }, - "discoverySchedulerEnabled": { - "type": "boolean" - }, - "discoverySchedulerPattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation3" - }, - "edgeInstanceId": { - "format": "uuid", - "type": "string" - }, - "name": { - "type": "string" - }, - "owningTeamId": { - "format": "uuid", - "type": "string" - }, - "status": { - "enum": [ - "DRAFT", - "VERIFIED", - "UNVERIFIED", - "DELETING" - ], - "type": "string" + "TestCMSConfigurationBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCMSConfigurationRequest" + } } }, - "type": "object" + "description": "The body request to test the given Credential Manager Service configuration using their details." }, - "MachineWorkflowRequest": { - "properties": { - "workflowInput": { - "$ref": "#/components/schemas/AnyValue10" - }, - "workflowName": { - "type": "string" + "TestCredentialBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCredentialRequest" + } } }, - "type": "object" + "description": "The body request to test the given credential." }, - "MachinesResponse": { - "properties": { - "machines": { - "items": { - "$ref": "#/components/schemas/MachineInformation" - }, - "type": "array" + "UpdateCMSConfigurationsBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCMSConfigurationRequest" + } } }, - "type": "object" + "description": "The body request to update the given Credential Manager Service configuration using their details." }, - "MachinesSearchRequest": { - "properties": { - "expression": { - "$ref": "#/components/schemas/Expression" - }, - "ordering": { - "$ref": "#/components/schemas/Ordering" - }, - "paging": { - "$ref": "#/components/schemas/Paging" + "UpdateCredentialBodyRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateCredentialRequest" + } } }, - "type": "object" + "description": "The body request to update the given credential." + } + }, + "responses": { + "200DeleteCredentials": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteCredentialsResponse" + } + } + }, + "description": "The credentials deleted successfully." }, - "Manifest": { + "200GetCMSConfiguration": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CMSConfigurationResponse" + } + } + }, + "description": "The Credential Manager Service configuration received." + }, + "200GetCMSConfigurations": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCMSConfigurationsResponse" + } + } + }, + "description": "The Credential Manager Service configurations received." + }, + "200GetCredential": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialResponse" + } + } + }, + "description": "The retrieved credential." + }, + "200GetCredentials": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCredentialsResponse" + } + } + }, + "description": "The retrieved credentials for a company." + }, + "200TestCMSConfiguration": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCMSConfigurationResponse" + } + } + }, + "description": "Ok. Contains the result of testing the Credential Manager Service configuration." + }, + "200TestCredential": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestCredentialResponse" + } + } + }, + "description": "Connection test to credential successful." + }, + "200UpdateCMSConfiguration": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CMSConfigurationResponse" + } + } + }, + "description": "The Credential Manager Service configurations updated." + }, + "200UpdateCredential": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialResponse" + } + } + }, + "description": "The credentials updated successfully." + }, + "201AddCredentials": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCredentialsResponse" + } + } + }, + "description": "The credentials added successfully." + }, + "201CreateCMSConfigurations": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCMSConfigurationsResponse" + } + } + }, + "description": "The Credential Manager Service configurations created." + }, + "400BadRequest": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Bad request." + }, + "401Unauthorized": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Unauthorized. Missing or invalid credentials." + }, + "403Forbidden": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Forbidden. The user does not have the permission to do this action." + }, + "404NotFound": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Not found. The resource was not found." + }, + "500InternalServerErrorContent": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse11" + } + } + }, + "description": "Internal Server Error." + } + }, + "schemas": { + "ActivityLogCondition": { + "description": "A Condition for filtering", "properties": { - "deployment": { - "$ref": "#/components/schemas/Deployment" - }, - "description": { - "description": "Description text for the plugin.", + "field": { + "description": "Represents a field for filtering", + "example": "activityType", "type": "string" }, - "domainSchema": { - "type": "object" + "operator": { + "$ref": "#/components/schemas/ActivityLogFilterOperator" }, - "hooks": { - "properties": { - "mapping": { - "type": "object" + "value": { + "description": "represents a field's value", + "example": "Authentication", + "type": "string" + }, + "values": { + "description": "represents a field's values", + "example": [ + "Authentication", + "Users" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ActivityLogEntriesResponse": { + "properties": { + "activityLogEntries": { + "description": "A collection of activity log entries", + "items": { + "$ref": "#/components/schemas/ActivityLogEntryInformation" + }, + "type": "array" + }, + "count": { + "description": "The number of activity log entries.", + "example": 2, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "ActivityLogEntryInformation": { + "properties": { + "activityDate": { + "description": "The date when a log entry was produced", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "activityName": { + "description": "An activity name", + "example": "Login Succeeded", + "type": "string" + }, + "activityType": { + "description": "An activity type", + "example": "Authentication", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "criticality": { + "description": "An activity criticality", + "example": 0, + "format": "int32", + "type": "integer" + }, + "id": { + "description": "UUID of a log entry", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "message": { + "description": "An activity log message", + "example": "user logged in", + "type": "string" + }, + "payload": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "ActivityLogFilter": { + "properties": { + "expression": { + "$ref": "#/components/schemas/BaseActivityLogFilter" + }, + "ordering": { + "$ref": "#/components/schemas/BaseActivityLogOrdering" + }, + "paging": { + "$ref": "#/components/schemas/Page1" + } + }, + "type": "object" + }, + "ActivityLogFilterOperand": { + "properties": { + "operand": { + "$ref": "#/components/schemas/ActivityLogCondition" + }, + "operator": { + "$ref": "#/components/schemas/UnaryOperator" + } + }, + "type": "object" + }, + "ActivityLogFilterOperands": { + "properties": { + "operands": { + "description": "A list of conditions that will be used for filtering", + "example": [ + { + "field": "activityType", + "operator": "EQ", + "value": "Authentication" }, - "requestConverters": { - "items": {}, - "nullable": true, - "type": "array" + { + "field": "activityName", + "operator": "EQ", + "value": "Login Succeeded" } - }, - "required": [ - "mapping" ], - "type": "object" + "items": { + "$ref": "#/components/schemas/BaseActivityLogFilter" + }, + "type": "array" }, - "localizationResources": { - "$ref": "#/components/schemas/LocalizationResource" + "operator": { + "$ref": "#/components/schemas/NaryOperator" + } + }, + "type": "object" + }, + "ActivityLogFilterOperator": { + "description": "An operator for filtering", + "enum": [ + "EQ", + "LT", + "LTE", + "GT", + "GTE", + "IN" + ], + "example": "EQ", + "type": "string" + }, + "ActivityLogName": { + "properties": { + "key": { + "type": "string" }, - "name": { - "description": "Name of the plugin.", + "readableName": { "type": "string" + } + }, + "type": "object" + }, + "ActivityLogOrder": { + "properties": { + "direction": { + "$ref": "#/components/schemas/Direction" }, - "pluginType": { - "$ref": "#/components/schemas/PluginType" + "field": { + "description": "A field, that will be used for ordering", + "example": "activityDate", + "type": "string" + } + }, + "type": "object" + }, + "ActivityLogType": { + "properties": { + "key": { + "type": "string" }, - "workTypes": { - "description": "Defines the type of workflows supported for the plugin.", + "readableName": { + "type": "string" + }, + "values": { "items": { - "$ref": "#/components/schemas/WorkType" + "$ref": "#/components/schemas/ActivityLogName" }, - "minItems": 1, - "type": "array", - "uniqueItems": true + "type": "array" + } + }, + "type": "object" + }, + "AddCredentialRequest": { + "description": "The properties representing a credential to add.", + "properties": { + "authType": { + "$ref": "#/components/schemas/AuthType" + }, + "cmsConfigId": { + "$ref": "#/components/schemas/CMSConfId" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "credentialDetails": { + "$ref": "#/components/schemas/CreateCredentialDetails" + }, + "name": { + "$ref": "#/components/schemas/CredentialName" + }, + "teamsIds": { + "$ref": "#/components/schemas/TeamsIds" } }, "required": [ "name", - "workTypes", - "deployment", - "domainSchema", - "hooks" + "cmsType", + "authType", + "credentialDetails" ], - "title": "Manifest", - "type": "object", - "x-examples": { - "Example 1": { - "deployment": { - "executionTarget": "vsat", - "image": "public.ecr.aws/docker/library/nginx:mainline-alpine3.18-slim" + "type": "object" + }, + "AddCredentialsRequest": { + "description": "Array of credentials to add.", + "properties": { + "credentials": { + "items": { + "$ref": "#/components/schemas/AddCredentialRequest" }, - "description": "Description text.", - "domainSchema": { - "binding": { - "properties": { - "parentProfile": { - "description": "parentProfile.description", - "type": "string", - "x-labelLocalizationKey": "parentProfile.label", - "x-rank": 1 - }, - "serverName": { - "description": "serverName.description", - "format": "hostname", - "type": "string", - "x-labelLocalizationKey": "serverName.label", - "x-rank": 3, - "x-rule": { - "condition": { - "type": "#/properties/sslProfileType" - }, - "effect": "SHOW" - } - }, - "sslProfile": { - "type": "string", - "x-labelLocalizationKey": "sslProfile.label", - "x-rank": 2 - }, - "sslProfileType": { - "oneOf": [ - { - "const": "client", - "x-labelLocalizationKey": "sslProfileType.client" - }, - { - "const": "server", - "x-labelLocalizationKey": "sslProfileType.server" - } - ], - "x-labelLocalizationKey": "sslProfileType.label", - "x-rank": 0 - } - }, - "required": [ - "sslProfile", - "sslProfileType" - ], - "type": "object", - "x-labelLocalizationKey": "binding.label", - "x-primaryKey": [ - "#/sslProfileType", - "#/sslProfile" - ] - }, - "certificateBundle": { - "properties": { - "certificate": { - "contentEncoding": "base64", - "type": "string" - }, - "certificateChain": { - "contentEncoding": "base64", - "type": "string" - }, - "privateKey": { - "contentEncoding": "base64", - "type": "string", - "x-encrypted-base64": true - } - }, - "required": [ - "certificate", - "privateKey", - "certificateChain" - ], - "type": "object" - }, - "connection": { - "properties": { - "hostnameOrAddress": { - "type": "string", - "x-labelLocalizationKey": "address.label", - "x-rank": 0 - }, - "password": { - "type": "string", - "x-controlOptions": { - "hidePasswordLabel": "password.hidePassword", - "password": true, - "showPasswordLabel": "password.showPassword" - }, - "x-encrypted": true, - "x-labelLocalizationKey": "password.label", - "x-rank": 3 - }, - "port": { - "description": "port.description", - "maximum": 65535, - "minimum": 1, - "type": "integer", - "x-labelLocalizationKey": "port.label", - "x-rank": 1 - }, - "username": { - "type": "string", - "x-encrypted": true, - "x-labelLocalizationKey": "username.label", - "x-rank": 2 - } - }, - "required": [ - "hostnameOrAddress", - "username", - "password" - ], - "type": "object" - }, - "discovery": { - "properties": { - "discoveryType": { - "oneOf": [ - { - "const": "all", - "x-labelLocalizationKey": "discoveryType.all" - }, - { - "const": "monitor", - "x-labelLocalizationKey": "discoveryType.monitor" - }, - { - "const": "virtualServer", - "x-labelLocalizationKey": "discoveryType.virtualServer" - } - ], - "x-labelLocalizationKey": "discoveryType.label", - "x-rank": 0 - }, - "excludeExpiredCertificates": { - "type": "boolean", - "x-labelLocalizationKey": "discovery.expiredCertificatesLabel", - "x-rank": 2 - }, - "excludeInactiveProfiles": { - "type": "boolean", - "x-labelLocalizationKey": "discovery.inactiveProfilesLabel", - "x-rank": 3 - }, - "partition": { - "default": "Common", - "description": "discovery.partitionDescription", - "maxLength": 64, - "type": "string", - "x-labelLocalizationKey": "discovery.partitionLabel", - "x-rank": 1 - } - }, - "type": "object" - }, - "discoveryControl": { - "properties": { - "maxResults": { - "type": "int" - } - }, - "required": [ - "maxResults" - ], - "type": "object" - }, - "discoveryPage": { - "properties": { - "discoveryType": { - "type": "string" - }, - "paginator": { - "type": "string" - } - }, - "type": "object" - }, - "keystore": { - "properties": { - "certificateName": { - "description": "certificateName.description", - "type": "string", - "x-labelLocalizationKey": "certificateName.label", - "x-rank": 0 - }, - "chainName": { - "type": "string", - "x-labelLocalizationKey": "chainName.label", - "x-rank": 1 - }, - "partition": { - "description": "partition.description", - "maxLength": 64, - "type": "string", - "x-labelLocalizationKey": "partition.label", - "x-rank": 2, - "x-targetConfigurationRef": "/partitions" - } - }, - "required": [ - "certificateName", - "chainName" - ], - "type": "object", - "x-labelLocalizationKey": "keystore.label", - "x-primaryKey": [ - "#/certificateName", - "#/partition" - ] - } - }, - "hooks": { - "mapping": { - "configureInstallationEndpoint": "/v1/configureinstallationendpoint", - "discoverCertificates": "/v1/discovercertificates", - "installCertificateBundle": "/v1/installcertificatebundle", - "testConnection": "/v1/testconnection" - }, - "requestConverters": [ - "arguments-decrypter" - ] - }, - "localizationResources": { - "en": { - "address": { - "label": "Server Hostname" - }, - "binding": { - "label": "Server Store Details" - }, - "certificateName": { - "description": "How the certificate should appear on the server.", - "label": "Certificate Name" - }, - "chainName": { - "label": "Chain Bundle Name" - }, - "discovery": { - "expiredCertificatesLabel": "Exclude expired certificates.", - "inactiveProfilesLabel": "Exclude certificates that are not in use by either a virtual server or a monitor.", - "partitionDescription": "A comma separated list of partition names.", - "partitionLabel": "Partition(s)" - }, - "discoveryType": { - "all": "Both Monitors and Virtual Servers", - "label": "Resource Types to Discover", - "monitor": "Monitors", - "virtualServer": "Virtual Servers" - }, - "keystore": { - "label": "Certificate Information" - }, - "parentProfile": { - "description": "No value is interpreted as \"clientssl\" or \"serverssl\" depending on the Profile Type selected.", - "label": "Parent Profile" - }, - "partition": { - "description": "No value is interpreted as the \"Common\" partition.", - "label": "Partition" - }, - "password": { - "hidePassword": "Hide Password", - "label": "Password", - "showPassword": "Show Password" - }, - "port": { - "description": "No value is interpreted as 443.", - "label": "Port" - }, - "serverName": { - "description": "An alternative DNS name used for Server Name Indication.", - "label": "SNI" - }, - "sslProfile": { - "label": "SSL Profile" - }, - "sslProfileType": { - "client": "Client SSL Profile", - "label": "Profile Type", - "server": "Server SSL Profile" - }, - "username": { - "label": "Username" - } - } - }, - "name": "Sample Manifest" - } - } - }, - "MediaType": { - "properties": { - "parameters": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "subtype": { - "type": "string" - }, - "type": { - "type": "string" - }, - "wildcardSubtype": { - "type": "boolean" - }, - "wildcardType": { - "type": "boolean" - } - }, - "type": "object" - }, - "MetadataInformation": { - "properties": { - "companyId": { - "format": "uuid", - "type": "string" - }, - "productEntitlement": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string" - } - }, - "type": "object" - }, - "Name": { - "description": "The Name of CMS configuration", - "type": "string" - }, - "NamespaceChartDetails": { - "properties": { - "charts": { - "items": { - "$ref": "#/components/schemas/ChartDetails" - }, - "type": "array" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "NamespaceStatusDetails": { - "properties": { - "name": { - "type": "string" - }, - "pods": { - "items": { - "$ref": "#/components/schemas/PodStatusDetails" - }, - "type": "array" - }, - "timestamp": { - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "NaryOperator": { - "description": "An operator for filtering", - "enum": [ - "AND", - "OR" - ], - "example": "OR", - "type": "string" - }, - "NewCookie": { - "properties": { - "comment": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "expiry": { - "format": "date-time", - "type": "string" - }, - "httpOnly": { - "type": "boolean" - }, - "maxAge": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "sameSite": { - "enum": [ - "NONE", - "LAX", - "STRICT" - ], - "type": "string" - }, - "secure": { - "type": "boolean" - }, - "value": { - "type": "string" - }, - "version": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "NodeCondition": { - "properties": { - "Status": { - "type": "string", - "writeOnly": true - }, - "Type": { - "type": "string", - "writeOnly": true - }, - "status": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "NodeInfo": { - "properties": { - "kubelet_version": { - "type": "string" - } - }, - "type": "object" - }, - "NodeStatusDetails": { - "properties": { - "conditions": { - "items": { - "$ref": "#/components/schemas/NodeCondition" - }, - "type": "array" - }, - "info": { - "$ref": "#/components/schemas/NodeInfo" - } - }, - "type": "object" - }, - "Operator": { - "enum": [ - "EQUALS", - "NOT_EQUALS", - "CONTAINS", - "NOT_CONTAINS", - "STARTS_WITH", - "ENDS_WITH" - ], - "type": "string" - }, - "Order": { - "properties": { - "direction": { - "description": "An ordering direction", - "enum": [ - "ASC", - "DESC" - ], - "example": "DESC", - "type": "string" - }, - "field": { - "description": "A field, that will be used for ordering", - "example": "modificationDate", - "type": "string" - } - }, - "type": "object" - }, - "OrderObject": { - "properties": { - "direction": { - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "field": { - "type": "string" - } - }, - "type": "object" - }, - "Ordering": { - "properties": { - "orders": { - "items": { - "$ref": "#/components/schemas/OrderObject" - }, - "type": "array" - } - }, - "type": "object" - }, - "OwnerIdAndType": { - "properties": { - "ownerId": { - "format": "uuid", - "type": "string" - }, - "ownerType": { - "enum": [ - "USER", - "TEAM", - "SERVICE_ACCOUNT" - ], - "type": "string" - } - }, - "required": [ - "ownerId", - "ownerType" - ], - "type": "object" - }, - "Page1": { - "description": "Specify pagination on the search request", - "properties": { - "pageNumber": { - "description": "page number", - "example": 0, - "format": "int32", - "type": "integer" - }, - "pageSize": { - "description": "page size", - "example": 10, - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Page2": { - "description": "Specify pagination on the search request", - "properties": { - "pageNumber": { - "description": "page number", - "example": 0, - "format": "int32", - "type": "integer" - }, - "pageSize": { - "description": "page size", - "example": 10, - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Paging": { - "properties": { - "pageNumber": { - "format": "int32", - "type": "integer" - }, - "pageSize": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "PairingCodeInformation": { - "properties": { - "companyId": { - "format": "uuid", - "type": "string" - }, - "environmentId": { - "format": "uuid", - "type": "string" - }, - "expirationDate": { - "format": "date-time", - "type": "string" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "pairingCode": { - "type": "string" - }, - "productEntitlements": { - "items": { - "$ref": "#/components/schemas/ProductEntitlement2" - }, - "type": "array" - }, - "reuseCount": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "PairingCodeRequest": { - "properties": { - "environmentId": { - "format": "uuid", - "type": "string" - }, - "primaryInstanceId": { - "format": "uuid", - "type": "string" - }, - "reuseCount": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "PatchServiceAccountByClientIDRequestBody": { - "allOf": [ - { - "$ref": "#/components/schemas/ServiceAccountPatchBaseObject" - }, - { - "properties": { - "enabled": { - "description": "Indicates if the given service account must be enabled or disabled where disable means that the credentials cannot be used for authentication", - "type": "boolean" - } - }, - "type": "object" - } - ], - "example": { - "credentialLifetime": 365, - "enabled": true, - "name": "New name", - "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", - "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAor3JRni8bObnKbmWzRubiNyKMoCXLVrswqiMm2h8zl8=\n-----END PUBLIC KEY-----\n", - "scopes": [ - "distributed-issuance" - ] - } - }, - "Persona": { - "enum": [ - "Application Owners", - "All PKI Admins", - "All Admins" - ], - "type": "string" - }, - "Plugin": { - "properties": { - "creationTime": { - "description": "Represents the date when the plugin was created.", - "format": "date-time", - "type": "string" - }, - "disabled": { - "description": "Indicates whether the tenant has disabled the plugin from its list of plugins.", - "type": "boolean" - }, - "id": { - "description": "Represents the plugin ID.", - "type": "string" - }, - "lastModifiedOn": { - "description": "Date the plugin was last modified.", - "format": "date-time", - "type": "string" - }, - "maintainer": { - "description": "Refers to the organization, individual, email, location, or website responsible for maintaining the plugin.", - "nullable": true, - "type": "string" - }, - "manifest": { - "$ref": "#/components/schemas/Manifest" - }, - "name": { - "description": "Represents the name of the plugin. This must be unique.", - "type": "string" - }, - "pluginType": { - "$ref": "#/components/schemas/PluginType" - }, - "revision": { - "description": "Represents the number of times the plugins has been updated.", - "type": "integer" - }, - "workTypes": { - "description": "Represents the type of workflow the plugin supports.", - "items": { - "$ref": "#/components/schemas/WorkType" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "id", - "name", - "revision", - "pluginType", - "workTypes", - "manifest", - "lastModifiedOn", - "creationTime" - ], - "title": "Plugin", - "type": "object" - }, - "PluginResponse": { - "properties": { - "plugins": { - "items": { - "$ref": "#/components/schemas/Plugin" - }, - "type": "array" - } - }, - "required": [ - "plugins" - ], - "title": "PluginResponse", - "type": "object" - }, - "PluginType": { - "description": "Used for differentiation between different types of plugins.", - "enum": [ - "MACHINE", - "CA", - "TPP", - "CREDENTIAL_MANAGER" - ], - "title": "PluginType", - "type": "string" - }, - "PodStatusDetails": { - "properties": { - "age": { - "format": "int64", - "type": "integer" - }, - "cpuUsage": { - "format": "int32", - "type": "integer" - }, - "image": { - "type": "string" - }, - "memoryUsage": { - "format": "int64", - "type": "integer" - }, - "name": { - "type": "string" - }, - "restartCount": { - "format": "int32", - "type": "integer" - }, - "status": { - "type": "string" - } - }, - "type": "object" - }, - "PolicyCreateRequest": { - "properties": { - "extendedKeyUsages": { - "description": "Extended key usages", - "example": [ - "CLIENT_AUTH", - "SERVER_AUTH" - ], - "items": { - "enum": [ - "ANY", - "SERVER_AUTH", - "CLIENT_AUTH", - "CODE_SIGNING", - "EMAIL_PROTECTION", - "IPSEC_ENDSYSTEM", - "IPSEC_TUNNEL", - "IPSEC_USER", - "TIME_STAMPING", - "OCSP_SIGNING", - "DVCS", - "SBGP_CERT_AA_SERVER_AUTH", - "SCVP_RESPONDER", - "EAP_OVER_PPP", - "EAP_OVER_LAN", - "SCVP_SERVER", - "SCVP_CLIENT", - "IPSEC_IKE", - "CAPWAP_AC", - "CAPWAP_WTP", - "IPSEC_IKE_INTERMEDIATE", - "SMARTCARD_LOGON" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "keyAlgorithm": { - "$ref": "#/components/schemas/KeyAlgorithmInformation" - }, - "keyUsages": { - "description": "Key usages", - "example": [ - "keyEncipherment", - "digitalSignature" - ], - "items": { - "enum": [ - "digitalSignature", - "nonRepudiation", - "keyEncipherment", - "dataEncipherment", - "keyAgreement", - "keyCertSign", - "cRLSign", - "encipherOnly", - "decipherOnly" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "name": { - "description": "Name of the policy", - "example": "Some policy", - "maxLength": 64, - "type": "string" - }, - "sans": { - "$ref": "#/components/schemas/SansInformation" - }, - "subject": { - "$ref": "#/components/schemas/SubjectAttributesInformation" - }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P30D", - "format": "PnYnMnDTnHnMnS", - "type": "string" - } - }, - "required": [ - "extendedKeyUsages", - "keyAlgorithm", - "keyUsages", - "name", - "sans", - "subject", - "validityPeriod" - ], - "type": "object" - }, - "PolicyDeleteResponse": { - "properties": { - "id": { - "description": "UUID of the policy", - "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", - "format": "uuid", - "type": "string" - }, - "name": { - "description": "Name of the policy", - "example": "Some policy", - "type": "string" - } - }, - "type": "object" - }, - "PolicyInformation": { - "properties": { - "companyId": { - "description": "UUID specific to your company", - "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", - "format": "uuid", - "type": "string" - }, - "creationDate": { - "description": "When the policy was initially created", - "example": "2022-10-10T14:50:41.710+00:00", - "type": "string" - }, - "extendedKeyUsages": { - "description": "Extended key usages", - "example": [ - "CLIENT_AUTH", - "SERVER_AUTH" - ], - "items": { - "enum": [ - "ANY", - "SERVER_AUTH", - "CLIENT_AUTH", - "CODE_SIGNING", - "EMAIL_PROTECTION", - "IPSEC_ENDSYSTEM", - "IPSEC_TUNNEL", - "IPSEC_USER", - "TIME_STAMPING", - "OCSP_SIGNING", - "DVCS", - "SBGP_CERT_AA_SERVER_AUTH", - "SCVP_RESPONDER", - "EAP_OVER_PPP", - "EAP_OVER_LAN", - "SCVP_SERVER", - "SCVP_CLIENT", - "IPSEC_IKE", - "CAPWAP_AC", - "CAPWAP_WTP", - "IPSEC_IKE_INTERMEDIATE", - "SMARTCARD_LOGON" - ], - "type": "string" - }, - "type": "array" - }, - "id": { - "description": "UUID of the policy", - "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", - "format": "uuid", - "type": "string" - }, - "keyAlgorithm": { - "$ref": "#/components/schemas/KeyAlgorithmInformation" - }, - "keyUsages": { - "description": "Key usages", - "example": [ - "keyEncipherment", - "digitalSignature" - ], - "items": { - "enum": [ - "digitalSignature", - "nonRepudiation", - "keyEncipherment", - "dataEncipherment", - "keyAgreement", - "keyCertSign", - "cRLSign", - "encipherOnly", - "decipherOnly" - ], - "type": "string" - }, - "type": "array" - }, - "modificationDate": { - "description": "When the policy was last modified", - "example": "2023-12-12T20:00:10.500+00:00", - "type": "string" - }, - "name": { - "description": "Name of the policy", - "example": "Some policy", - "type": "string" - }, - "sans": { - "$ref": "#/components/schemas/SansInformation" - }, - "subject": { - "$ref": "#/components/schemas/SubjectAttributesInformation" - }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P30D", - "format": "PnYnMnDTnHnMnS", - "type": "string" - } - }, - "type": "object" - }, - "PolicyResponse": { - "properties": { - "policies": { - "items": { - "$ref": "#/components/schemas/ExtendedPolicyInformation" - }, - "type": "array" - } - }, - "type": "object" - }, - "PolicyUpdateRequest": { - "properties": { - "extendedKeyUsages": { - "description": "Extended key usages", - "example": [ - "CLIENT_AUTH", - "SERVER_AUTH" - ], - "items": { - "enum": [ - "ANY", - "SERVER_AUTH", - "CLIENT_AUTH", - "CODE_SIGNING", - "EMAIL_PROTECTION", - "IPSEC_ENDSYSTEM", - "IPSEC_TUNNEL", - "IPSEC_USER", - "TIME_STAMPING", - "OCSP_SIGNING", - "DVCS", - "SBGP_CERT_AA_SERVER_AUTH", - "SCVP_RESPONDER", - "EAP_OVER_PPP", - "EAP_OVER_LAN", - "SCVP_SERVER", - "SCVP_CLIENT", - "IPSEC_IKE", - "CAPWAP_AC", - "CAPWAP_WTP", - "IPSEC_IKE_INTERMEDIATE", - "SMARTCARD_LOGON" - ], - "type": "string" - }, - "type": "array" - }, - "keyAlgorithm": { - "$ref": "#/components/schemas/KeyAlgorithmInformation" - }, - "keyUsages": { - "description": "Key usages", - "example": [ - "keyEncipherment", - "digitalSignature" - ], - "items": { - "enum": [ - "digitalSignature", - "nonRepudiation", - "keyEncipherment", - "dataEncipherment", - "keyAgreement", - "keyCertSign", - "cRLSign", - "encipherOnly", - "decipherOnly" - ], - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name of the policy", - "example": "Some policy", - "maxLength": 64, - "type": "string" - }, - "sans": { - "$ref": "#/components/schemas/SansInformation" - }, - "subject": { - "$ref": "#/components/schemas/SubjectAttributesInformation" - }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P30D", - "format": "PnYnMnDTnHnMnS", - "type": "string" - } - }, - "type": "object" - }, - "ProductEntitlement1": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string" - }, - "ProductEntitlement2": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string" - }, - "ProductEntitlementInformation": { - "properties": { - "capabilities": { - "items": { - "$ref": "#/components/schemas/CapabilityInformation" - }, - "type": "array" - }, - "label": { - "$ref": "#/components/schemas/ProductEntitlement1" - }, - "visibilityConstraintsInformation": { - "$ref": "#/components/schemas/VisibilityConstraintsInformation" - } - }, - "required": [ - "capabilities", - "label", - "visibilityConstraintsInformation" - ], - "type": "object" - }, - "PropertyInformation": { - "properties": { - "allowedValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "defaultValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "maxOccurrences": { - "format": "int32", - "type": "integer" - }, - "minOccurrences": { - "format": "int32", - "type": "integer" - }, - "type": { - "enum": [ - "IGNORED", - "FORBIDDEN", - "OPTIONAL", - "REQUIRED", - "LOCKED" - ], - "type": "string" - } - }, - "type": "object" - }, - "ProviderConfigInformation": { - "properties": { - "api_key": { - "type": "string" - }, - "endpoint": { - "type": "string" - } - }, - "type": "object" - }, - "ProviderInformation": { - "properties": { - "config": { - "$ref": "#/components/schemas/ProviderConfigInformation" - }, - "inputs": { - "items": { - "$ref": "#/components/schemas/ProviderInputInformation" - }, - "type": "array" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "ProviderInputInformation": { - "properties": { - "hosts": { - "items": { - "type": "string" - }, - "type": "array" - }, - "ports": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subnet": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "ProvisionCertificateWorkflowInputInformation": { - "properties": { - "wsClientId": { - "minLength": 1, - "type": "string" - } - }, - "required": [ - "wsClientId" - ], - "type": "object" - }, - "PublicPluginCreationRequest": { - "properties": { - "maintainer": { - "description": "Refers to the organization, individual, email, location, or website responsible for maintaining the plugin.", - "nullable": true, - "type": "string" - }, - "manifest": { - "$ref": "#/components/schemas/Manifest" - }, - "pluginType": { - "$ref": "#/components/schemas/PluginType" - } - }, - "required": [ - "manifest", - "pluginType" - ], - "title": "PublicPluginCreationRequest", - "type": "object", - "x-stoplight": { - "id": "sto5fs3n5bxmf" - } - }, - "PublicPluginUpdateRequest": { - "properties": { - "image": { - "nullable": true, - "type": "string" - }, - "maintainer": { - "nullable": true, - "type": "string" - }, - "manifest": { - "$ref": "#/components/schemas/Manifest" - } - }, - "title": "PublicPluginUpdateRequest", - "type": "object", - "x-stoplight": { - "id": "8ypau6to0udah" - } - }, - "PutServiceAccountByClientIDCredentialsRequestBody": { - "example": { - "extendCredentialLifetime": true - }, - "properties": { - "extendCredentialLifetime": { - "description": "Extend the credential lifetime", - "type": "boolean" - } - }, - "required": [ - "extendCredentialLifetime" - ], - "type": "object" - }, - "PutServiceAccountByClientIDCredentialsResponseBody": { - "properties": { - "credentialExpiresIn": { - "description": "Expiration in hours for service account credentials", - "format": "float", - "type": "number", - "x-go-type": "float64" - } - }, - "type": "object" - }, - "PutServiceAccountByClientIDOCITokenResponseBody": { - "properties": { - "ociRegistryToken": { - "description": "The OCI registry token generated for a robot in case of the registry scope", - "type": "string" - } - }, - "type": "object" - }, - "Recipient": { - "properties": { - "id": { - "description": "The ID of a user or team who should be included as a recipient.", - "format": "UUID", - "type": "string" - }, - "type": { - "description": "The type of the recipient.", - "enum": [ - "User", - "Team" - ], - "type": "string" - } - }, - "required": [ - "type", - "id" - ], - "type": "object" - }, - "RecommendedSettingsInformation1": { - "properties": { - "key": { - "$ref": "#/components/schemas/RecommendedSettingsKeyTypeInformation1" - }, - "sanRegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subjectCNRegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subjectCValue": { - "type": "string" - }, - "subjectLValue": { - "type": "string" - }, - "subjectOUValue": { - "type": "string" - }, - "subjectOValue": { - "type": "string" - }, - "subjectSTValue": { - "type": "string" - } - }, - "type": "object" - }, - "RecommendedSettingsInformation2": { - "properties": { - "key": { - "$ref": "#/components/schemas/RecommendedSettingsKeyTypeInformation2" - }, - "keyGeneratedBy": { - "type": "string" - }, - "sanRegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subjectCNRegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subjectCValue": { - "type": "string" - }, - "subjectLValue": { - "type": "string" - }, - "subjectOUValue": { - "type": "string" - }, - "subjectOValue": { - "type": "string" - }, - "subjectSTValue": { - "type": "string" - } - }, - "type": "object" - }, - "RecommendedSettingsKeyTypeInformation1": { - "properties": { - "curve": { - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "type": "string" - }, - "length": { - "format": "int32", - "type": "integer" - }, - "type": { - "enum": [ - "RSA", - "EC" - ], - "type": "string" - } - }, - "type": "object" - }, - "RecommendedSettingsKeyTypeInformation2": { - "properties": { - "curve": { - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "type": "string" - }, - "length": { - "format": "int32", - "type": "integer" - }, - "type": { - "enum": [ - "RSA", - "EC" - ], - "type": "string" - } - }, - "type": "object" - }, - "RecommendedSettingsKeyTypeParameter": { - "properties": { - "curve": { - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "type": "string" - }, - "length": { - "format": "int32", - "type": "integer" - }, - "type": { - "enum": [ - "RSA", - "EC" - ], - "type": "string" - } - }, - "type": "object" - }, - "RecommendedSettingsRequest": { - "properties": { - "key": { - "$ref": "#/components/schemas/RecommendedSettingsKeyTypeParameter" - }, - "keyGeneratedBy": { - "type": "string" - }, - "sanRegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subjectCNRegexes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "subjectCValue": { - "pattern": "^(([A-Z]{2})|(\\.\\*))$", - "type": "string" - }, - "subjectLValue": { - "pattern": "[^\\*]*", - "type": "string" - }, - "subjectOUValue": { - "pattern": "[^\\*]*", - "type": "string" - }, - "subjectOValue": { - "pattern": "[^\\*]*", - "type": "string" - }, - "subjectSTValue": { - "pattern": "[^\\*]*", - "type": "string" - } - }, - "type": "object" - }, - "RecoveryCodeInformation": { - "properties": { - "companyId": { - "format": "uuid", - "type": "string" - }, - "dataPlaneDomain": { - "type": "string" - }, - "expirationDate": { - "format": "date-time", - "type": "string" - }, - "hiddenRecoveryCode": { - "type": "string" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "productEntitlements": { - "items": { - "$ref": "#/components/schemas/ProductEntitlement2" - }, - "type": "array" - }, - "recoveryCode": { - "type": "string" - }, - "tsgId": { - "type": "string" - } - }, - "type": "object" - }, - "RecoveryCodeRequest": { - "properties": { - "edgeInstanceId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "edgeInstanceId" - ], - "type": "object" - }, - "Reference": { - "description": "The machine referenced.", - "properties": { - "id": { - "format": "uuid", - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/ReferenceType" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "ReferenceType": { - "description": "The type of the reference:\n * `machine`\n", - "enum": [ - "machine" - ], - "type": "string" - }, - "References": { - "description": "The machines referenced.", - "items": { - "$ref": "#/components/schemas/Reference" - }, - "type": "array", - "uniqueItems": true - }, - "Response": { - "properties": { - "allowedMethods": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "closed": { - "type": "boolean" - }, - "cookies": { - "additionalProperties": { - "$ref": "#/components/schemas/NewCookie" - }, - "type": "object" - }, - "date": { - "format": "date-time", - "type": "string" - }, - "entity": { - "$ref": "#/components/schemas/AnyValue4" - }, - "entityTag": { - "$ref": "#/components/schemas/EntityTag" - }, - "headers": { - "additionalProperties": { - "items": { - "$ref": "#/components/schemas/AnyValue4" - }, - "type": "array" - }, - "properties": { - "empty": { - "type": "boolean" - } - }, - "type": "object" - }, - "language": { - "properties": { - "country": { - "type": "string" - }, - "displayCountry": { - "type": "string" - }, - "displayLanguage": { - "type": "string" - }, - "displayName": { - "type": "string" - }, - "displayScript": { - "type": "string" - }, - "displayVariant": { - "type": "string" - }, - "extensionKeys": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "iso3Country": { - "type": "string" - }, - "iso3Language": { - "type": "string" - }, - "language": { - "type": "string" - }, - "script": { - "type": "string" - }, - "unicodeLocaleAttributes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "unicodeLocaleKeys": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "variant": { - "type": "string" - } - }, - "type": "object" - }, - "lastModified": { - "format": "date-time", - "type": "string" - }, - "length": { - "format": "int32", - "type": "integer" - }, - "links": { - "items": { - "$ref": "#/components/schemas/Link" - }, - "type": "array", - "uniqueItems": true - }, - "location": { - "format": "uri", - "type": "string" - }, - "mediaType": { - "$ref": "#/components/schemas/MediaType" - }, - "metadata": { - "additionalProperties": { - "items": { - "$ref": "#/components/schemas/AnyValue4" - }, - "type": "array" - }, - "properties": { - "empty": { - "type": "boolean" - } - }, - "type": "object" - }, - "status": { - "format": "int32", - "type": "integer" - }, - "statusInfo": { - "$ref": "#/components/schemas/StatusType" - }, - "stringHeaders": { - "additionalProperties": { - "items": { - "type": "string" - }, - "type": "array" - }, - "properties": { - "empty": { - "type": "boolean" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ResponseCMSDetails": { - "description": "An string containing the JSON content representing the details of the specific privileged access management.", - "oneOf": [ - { - "$ref": "#/components/schemas/ResponseCyberArkDetails" - }, - { - "$ref": "#/components/schemas/ResponseHashiCorpDetails" - } - ] - }, - "ResponseCredentialDetails": { - "oneOf": [ - { - "$ref": "#/components/schemas/ResponseCyberArkCredDetails" - }, - { - "$ref": "#/components/schemas/ResponseHashiCorpCredDetails" - } - ] - }, - "ResponseCyberArkCredDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkDetailsRequiredProp" - } - ] - }, - "ResponseCyberArkDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkConfiguration" - } - ] - }, - "ResponseHashiCorpCredDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/HashiCorpDetailsRequiredProp" - } - ] - }, - "ResponseHashiCorpDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/HashiCorpConfiguration" - } - ] - }, - "Role1": { - "enum": [ - "SYSTEM_ADMIN", - "OUTAGE_DETECTION_PLATFORM_ADMIN", - "OUTAGE_DETECTION_PKI_ADMIN", - "OUTAGE_DETECTION_RESOURCE_OWNER", - "OUTAGE_DETECTION_GUEST" - ], - "type": "string" - }, - "Role2": { - "enum": [ - "SECURITY_ADMIN", - "DEVOPS_LEAD", - "DEVOPS_USER", - "OUTAGEDETECTION_ADMIN", - "RESOURCE_OWNER", - "PKI_ADMIN", - "GUEST", - "PLATFORM_ADMIN" - ], - "type": "string" - }, - "RolesRequest": { - "properties": { - "roles": { - "additionalProperties": { - "$ref": "#/components/schemas/Role2" - }, - "type": "object" - }, - "systemAdmin": { - "type": "boolean" - } - }, - "type": "object" - }, - "SSOStatus": { - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "type": "string" - }, - "SansInformation": { - "description": "Subject alternative names", - "properties": { - "dnsNames": { - "$ref": "#/components/schemas/PropertyInformation" - }, - "ipAddresses": { - "$ref": "#/components/schemas/PropertyInformation" - }, - "rfc822Names": { - "$ref": "#/components/schemas/PropertyInformation" - }, - "uniformResourceIdentifiers": { - "$ref": "#/components/schemas/PropertyInformation" - } - }, - "type": "object" - }, - "ScanafiConfigResponseV1": { - "properties": { - "id": { - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataInformation" - }, - "provider": { - "$ref": "#/components/schemas/ProviderInformation" - } - }, - "type": "object" - }, - "SchedulerPatternInformation1": { - "description": "Determines schedule pattern (e.g., days of the week, recurrence time).", - "discriminator": { - "propertyName": "recurrenceType" - }, - "properties": { - "recurrenceType": { - "type": "string" - } - }, - "required": [ - "recurrenceType" - ], - "type": "object" - }, - "SchedulerPatternInformation2": { - "discriminator": { - "mapping": { - "DAY": "#/components/schemas/DailyPatternInformation", - "WEEK": "#/components/schemas/WeeklyPatternInformation" - }, - "propertyName": "recurrenceType" - }, - "properties": { - "recurrenceType": { - "type": "string" - } - }, - "required": [ - "recurrenceType" - ], - "type": "object" - }, - "SchedulerPatternInformation3": { - "discriminator": { - "propertyName": "recurrenceType" - }, - "properties": { - "recurrenceType": { - "type": "string" - } - }, - "required": [ - "recurrenceType" - ], - "type": "object" - }, - "Scope": { - "description": "The service account authorization scopes", - "example": "distributed-issuance", - "type": "string" - }, - "ScopeDetails": { - "description": "The service account authorization scopes detailed", - "example": { - "authenticationType": "rsaKey", - "id": "distributed-issuance", - "readableName": "Distributed Issuance" - }, - "properties": { - "authenticationType": { - "description": "Type of authentication used in the scope", - "type": "string" - }, - "id": { - "description": "ID for the given scope", - "type": "string" - }, - "readableName": { - "description": "User friendly name for the scope", - "type": "string" - } - }, - "required": [ - "id", - "readableName" - ], - "type": "object" - }, - "ServiceAccountBaseObject": { - "allOf": [ - { - "$ref": "#/components/schemas/ServiceAccountBaseObjectNoKey" - }, - { - "properties": { - "publicKey": { - "description": "The client generated public key", - "maxLength": 2000, - "type": "string" - } - }, - "type": "object" - } - ] - }, - "ServiceAccountBaseObjectNoKey": { - "properties": { - "applications": { - "description": "The list of applications for which the account is authorized", - "example": [ - "dc96438b-7a80-464b-a09b-9e5ec746c3e3", - "5bce5ff4-a69b-4e78-9b7e-6d4029995000" - ], - "items": { - "$ref": "#/components/schemas/Application" - }, - "type": "array", - "uniqueItems": true - }, - "audience": { - "description": "The intended audience or recipients of the entity", - "example": "Audience", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "authenticationType": { - "description": "Type of authentication used in the scope. Currently supporting two types rsaKey and ociToken", - "example": "rsaKey", - "type": "string" - }, - "companyId": { - "description": "The UUID of the company/tenant", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - }, - "credentialLifetime": { - "description": "The number of days for which the credentials will be valid before expiring and requiring renewal", - "example": 365, - "maximum": 365, - "minimum": 1, - "type": "integer" - }, - "issuerURL": { - "description": "The URL of the entity issuer, providing the source or origin", - "example": "https://accounts.google.com/", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "jwksURI": { - "description": "The URI pointing to the JSON Web Key Set (JWKS) for the entity, facilitating secure authentication", - "example": "https://www.googleapis.com/oauth2/v3/certs", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "name": { - "description": "User friendly name for the given account", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "owner": { - "description": "The UUID of the owning team", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - }, - "scopes": { - "description": "The list of scopes for which the account is authorized", - "example": [ - "distributed-issuance" - ], - "items": { - "$ref": "#/components/schemas/Scope" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "subject": { - "description": "The subject of the entity, representing the main topic or title.", - "example": "Subject", - "maxLength": 250, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ServiceAccountBasePatchObjectNoKey": { - "properties": { - "applications": { - "description": "The list of applications for which the account is authorized", - "example": [ - "dc96438b-7a80-464b-a09b-9e5ec746c3e3", - "5bce5ff4-a69b-4e78-9b7e-6d4029995000" - ], - "items": { - "$ref": "#/components/schemas/Application" - }, - "type": "array", - "uniqueItems": true - }, - "audience": { - "description": "The intended audience or recipients of the entity", - "example": "Audience", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "credentialLifetime": { - "description": "The number of days for which the credentials will be valid before expiring and requiring renewal", - "maximum": 365, - "minimum": 1, - "type": "integer" - }, - "issuerURL": { - "description": "The URL of the entity issuer, providing the source or origin", - "example": "https://accounts.google.com/", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "jwksURI": { - "description": "The URI pointing to the JSON Web Key Set (JWKS) for the entity, facilitating secure authentication", - "example": "https://www.googleapis.com/oauth2/v3/certs", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "name": { - "description": "User friendly name for the given account", - "maxLength": 250, - "minLength": 1, - "type": "string" - }, - "owner": { - "description": "The UUID of the owning team", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - }, - "scopes": { - "description": "The list of scopes for which the account is authorized", - "items": { - "$ref": "#/components/schemas/Scope" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "subject": { - "description": "The subject of the entity, representing the main topic or title.", - "example": "Subject", - "maxLength": 250, - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "ServiceAccountDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/ServiceAccountBaseObject" - }, - { - "$ref": "#/components/schemas/Details" - } - ] - }, - "ServiceAccountDetailsNoKey": { - "allOf": [ - { - "$ref": "#/components/schemas/ServiceAccountBaseObjectNoKey" - }, - { - "$ref": "#/components/schemas/Details" - } - ], - "example": { - "authenticationType": "rsaKey", - "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", - "credentialLifetime": 365, - "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", - "enabled": true, - "id": "933507dd-0286-11ef-bc25-8a00a468403f", - "name": "Service Account I", - "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", - "scopes": [ - "distributed-issuance" - ], - "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", - "updatedOn": "2024-01-01T00:00:00.000000Z" - } - }, - "ServiceAccountInformation": { - "properties": { - "applications": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "applicationsAdded": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "applicationsRemoved": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "authType": { - "type": "string" - }, - "authenticationType": { - "type": "string" - }, - "companyId": { - "format": "uuid", - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "name": { - "type": "string" - }, - "owner": { - "format": "uuid", - "type": "string" - }, - "ownership": { - "additionalProperties": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "type": "object" - }, - "roles": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "scopes": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "serviceAccount": { - "type": "boolean" - }, - "tenantId": { - "format": "uuid", - "type": "string" - }, - "userAccount": { - "type": "boolean" - } - }, - "type": "object" - }, - "ServiceAccountPatchBaseObject": { - "allOf": [ - { - "$ref": "#/components/schemas/ServiceAccountBasePatchObjectNoKey" - }, - { - "properties": { - "publicKey": { - "description": "The client generated public key", - "maxLength": 2000, - "type": "string" - } - }, - "type": "object" - } - ] - }, - "StatusResponse": { - "description": "Details about the current in-progress certificate auto-renewal process, and the most recently completed process.", - "properties": { - "current": { - "$ref": "#/components/schemas/StatusResponseItem" - }, - "previous": { - "$ref": "#/components/schemas/StatusResponseItem" - } - }, - "required": [ - "current" - ], - "type": "object" - }, - "StatusResponseItem": { - "description": "Details about the upcoming certificate auto-renewal run.", - "example": { - "applications": 13, - "certificates": { - "eligible": 47, - "renewal": { - "failed": 1, - "successful": 9, - "triggered": 3 - } - }, - "state": "running", - "timestamp": "2023-08-25T20:59:36.688019837Z" - }, - "properties": { - "applications": { - "description": "The number of applications that have auto-renewal enabled.", - "example": 13, - "format": "int64", - "type": "integer" - }, - "certificates": { - "description": "A set of statistics related to the certificates that were included in the auto-renewal process.", - "example": { - "eligible": 47, - "renewal": { - "failed": 1, - "successful": 9, - "triggered": 3 - } - }, - "properties": { - "eligible": { - "description": "The number of certificates that belong to an application that has auto-renewal enabled.", - "format": "int64", - "type": "integer" - }, - "renewal": { - "properties": { - "failed": { - "description": "The number of certificates for which renewal failed", - "format": "int64", - "type": "integer" - }, - "successful": { - "description": "The number of certificates for which renewal completed successfully", - "format": "int64", - "type": "integer" - }, - "triggered": { - "description": "The number of certificates for which the renewal has been started", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "triggered", - "successful", - "failed" - ], - "type": "object" - } - }, - "required": [ - "eligible", - "renewal" - ], - "type": "object" - }, - "state": { - "description": "A string representing the status of a specific run of the auto-renewal process.", - "enum": [ - "pending", - "triggered", - "running", - "complete", - "awaiting results", - "no enabled apps", - "no automated keypair service active", - "failure" - ], - "example": "running", - "type": "string" - }, - "timestamp": { - "description": "The date and time when certificate auto-renewal is estimated to begin.", - "example": "2023-08-25T20:59:36.688019837Z", - "format": "date-time", - "type": "string" + "minItems": 1, + "type": "array" } }, "required": [ - "timestamp", - "state", - "applications", - "certificates" + "credentials" ], "type": "object" }, - "StatusType": { + "AddCredentialsResponse": { + "description": "The response for the add credentials action.", "properties": { - "family": { - "enum": [ - "INFORMATIONAL", - "SUCCESSFUL", - "REDIRECTION", - "CLIENT_ERROR", - "SERVER_ERROR", - "OTHER" - ], - "type": "string" - }, - "reasonPhrase": { - "type": "string" - }, - "statusCode": { - "format": "int32", + "count": { "type": "integer" - } - }, - "type": "object" - }, - "SubCaProviderCreateRequest": { - "properties": { - "caAccountId": { - "description": "UUID of the CA account used by this Sub CA provider", - "example": "4ece3180-b1e0-11ed-862d-ad36b18e787a", - "format": "uuid", - "type": "string" - }, - "caProductOptionId": { - "description": "UUID of the CA product option used by this Sub CA provider", - "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", - "format": "uuid", - "type": "string" - }, - "caType": { - "description": "Type of CA this Sub CA provider works with", - "enum": [ - "MOCKCA", - "DIGICERT", - "GLOBALSIGN", - "BUILTIN", - "ENTRUST", - "MICROSOFT", - "ACME", - "ZTPKI", - "GLOBALSIGNMSSL", - "TPP" - ], - "example": "BUILTIN", - "type": "string" - }, - "commonName": { - "description": "Common name", - "example": "example.com", - "maxLength": 64, - "type": "string" - }, - "country": { - "description": "Country", - "example": "US", - "maxLength": 64, - "type": "string" - }, - "keyAlgorithm": { - "description": "Key algorithm type", - "enum": [ - "RSA_2048", - "RSA_3072", - "RSA_4096", - "EC_P256", - "EC_P384", - "EC_P521", - "EC_ED25519" - ], - "example": "EC_P256", - "type": "string" - }, - "locality": { - "description": "Locality", - "example": "San Antonio", - "maxLength": 64, - "type": "string" - }, - "name": { - "description": "Name of the Sub CA provider", - "example": "Some Sub CA provider", - "maxLength": 64, - "type": "string" - }, - "organization": { - "description": "Organization", - "example": "Some organization", - "maxLength": 64, - "type": "string" - }, - "organizationalUnit": { - "description": "Organizational unit", - "example": "Some organizational unit", - "maxLength": 64, - "type": "string" - }, - "pkcs11": { - "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" - }, - "stateOrProvince": { - "description": "State or province", - "example": "Texas", - "maxLength": 64, - "type": "string" }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P30D", - "format": "PnYnMnDTnHnMnS", - "type": "string" + "credentialsAdded": { + "items": { + "$ref": "#/components/schemas/CredentialResponse" + }, + "minItems": 1, + "type": "array" } }, "required": [ - "caAccountId", - "caProductOptionId", - "caType", - "commonName", - "keyAlgorithm", - "name", - "validityPeriod" + "credentialsAdded", + "count" ], "type": "object" }, - "SubCaProviderDeleteResponse": { + "AdvancedSettingsInformation": { "properties": { - "id": { - "description": "UUID of the Sub CA provider", - "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", - "format": "uuid", - "type": "string" + "enableIssuanceAuditLog": { + "description": "Whether audit log entries must be generated for each issued certificate", + "example": false, + "type": "boolean" }, - "name": { - "description": "Name of the Sub CA provider", - "example": "Some Sub CA", - "type": "string" + "includeRawCertDataInAuditLog": { + "description": "Whether the raw certificate data must be included in the audit log entry", + "example": false, + "type": "boolean" + }, + "requireFIPSCompliantBuild": { + "description": "Whether FIPS-compliant build is required", + "example": false, + "type": "boolean" } }, "type": "object" }, - "SubCaProviderInformation": { + "AnyValue1": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue10": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue2": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue3": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue4": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue5": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue6": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue7": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue8": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "AnyValue9": { + "description": "Can be any value - string, number, boolean, array or object." + }, + "ApiClientInformation": { + "description": "Represents the information of the client that is calling the API", + "example": { + "identifier": "192.168.1.63", + "type": "Venafi VCert CLI" + }, "properties": { - "caAccountId": { - "description": "UUID of the CA account used by this Sub CA provider", - "example": "4ece3180-b1e0-11ed-862d-ad36b18e787a", - "format": "uuid", - "type": "string" - }, - "caProductOptionId": { - "description": "UUID of the CA product option used by this Sub CA provider", - "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", - "format": "uuid", + "identifier": { + "description": "Client identifier", + "example": "199.121.8.74", "type": "string" }, - "caType": { - "description": "Type of CA this Sub CA provider works with", - "enum": [ - "MOCKCA", - "DIGICERT", - "GLOBALSIGN", - "BUILTIN", - "ENTRUST", - "MICROSOFT", - "ACME", - "ZTPKI", - "GLOBALSIGNMSSL", - "TPP" - ], - "example": "BUILTIN", + "type": { + "description": "Client type", + "example": "Venafi VCert CLI", "type": "string" + } + }, + "type": "object" + }, + "ApiKeyInformation": { + "properties": { + "apiKeyStatus": { + "$ref": "#/components/schemas/ApiKeyStatus" }, - "commonName": { - "description": "Common name", - "example": "example.com", - "type": "string" + "apiVersion": { + "$ref": "#/components/schemas/ApiVersion" }, "companyId": { - "description": "UUID specific to your company", - "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "description": "UUID of a company.", "format": "uuid", "type": "string" }, - "country": { - "description": "Country", - "example": "US", - "type": "string" - }, "creationDate": { - "description": "When the Sub CA provider was initially created", - "example": "2022-10-10T14:50:41.710+00:00", + "description": "The date and time the API key was created.", + "format": "date-time", "type": "string" }, - "id": { - "description": "UUID of the Sub CA provider", - "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "key": { + "description": "UUID of an API key.", "format": "uuid", "type": "string" }, - "keyAlgorithm": { - "description": "Key algorithm type", - "enum": [ - "RSA_2048", - "RSA_3072", - "RSA_4096", - "EC_P256", - "EC_P384", - "EC_P521", - "EC_ED25519" - ], - "example": "EC_P256", - "type": "string" - }, - "locality": { - "description": "Locality", - "example": "San Antonio", - "type": "string" - }, - "modificationDate": { - "description": "When the Sub CA provider was last modified", - "example": "2023-12-12T20:00:10.500+00:00", - "type": "string" - }, - "name": { - "description": "Name of the Sub CA provider", - "example": "Some Sub CA provider", - "type": "string" - }, - "organization": { - "description": "Organization", - "example": "Some organization", - "type": "string" - }, - "organizationalUnit": { - "description": "Organizational unit", - "example": "Some organizational unit", - "type": "string" - }, - "pkcs11": { - "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" + "memberedTeams": { + "description": "Membered teams of the user associated with this API key.", + "items": { + "description": "Membered teams of the user associated with this API key.", + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true }, - "stateOrProvince": { - "description": "State or province", - "example": "Texas", - "type": "string" + "productRoles": { + "additionalProperties": { + "description": "Product roles of the user associated with this API key.", + "items": { + "$ref": "#/components/schemas/Role1" + }, + "type": "array", + "uniqueItems": true + }, + "description": "Product roles of the user associated with this API key.", + "type": "object" }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "P30D", - "format": "PnYnMnDTnHnMnS", - "type": "string" - } - }, - "type": "object" - }, - "SubCaProviderPkcs11ConfigurationInformation": { - "properties": { - "allowedClientLibraries": { - "description": "A collection of strings each of which represents SHA256 hash of an allowed HSM client library", - "example": [ - "c34d199f2e30bb679cd9b8533b99975465aefe8b023be1b37972f1ab43ab7b2d" - ], + "systemRoles": { + "description": "System roles of the user associated with this API key.", "items": { - "type": "string" + "$ref": "#/components/schemas/SystemRole" }, - "type": "array" + "type": "array", + "uniqueItems": true }, - "partitionLabel": { - "description": "HSM Partition Label", - "example": "workload-identity-manager-hsm-partition", + "urlPrefix": { + "description": "Tenant URL Prefix.", "type": "string" }, - "partitionSerialNumber": { - "description": "HSM Partition Serial Number", - "example": "1444210958933", - "pattern": "^[A-Fa-fx0-9]{0,18}$", + "userId": { + "description": "UUID of a user.", + "format": "uuid", "type": "string" }, - "pin": { - "description": "HSM PIN", - "example": "1234", - "type": "string", - "writeOnly": true + "username": { + "description": "Email address of the registered user.", + "type": "string" }, - "signingEnabled": { - "description": "Indicates whether HSM signing is enabled or not", - "example": true, - "type": "boolean" + "validityEndDate": { + "description": "The date and time the API key will no longer be valid.", + "format": "date-time", + "type": "string" + }, + "validityStartDate": { + "description": "The date and time the API key became valid.", + "format": "date-time", + "type": "string" } }, "type": "object" }, - "SubCaProviderResponse": { - "properties": { - "subCaProviders": { - "items": { - "$ref": "#/components/schemas/SubCaProviderInformation" - }, - "type": "array" - } - }, - "type": "object" + "ApiKeyStatus": { + "enum": [ + "PENDING_ACTIVATION", + "ACTIVE", + "INACTIVE", + "PENDING_ROTATION", + "ROTATED", + "EXPIRED" + ], + "type": "string" }, - "SubCaProviderUpdateRequest": { + "ApiVersion": { + "description": "Indicates version of the API.", + "enum": [ + "ALL", + "V1" + ], + "type": "string" + }, + "AppId": { + "description": "The application ID from the CyberArk provider.", + "type": "string" + }, + "Application": { + "description": "Application ID to associate with the service account", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "ApplicationInformation": { "properties": { - "caProductOptionId": { - "description": "UUID of the CA product option used by this Sub CA provider", - "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", + "certificateIssuingTemplateAliasIdMap": { + "additionalProperties": { + "format": "uuid", + "type": "string" + }, + "type": "object" + }, + "companyId": { "format": "uuid", "type": "string" }, - "commonName": { - "description": "Common name", - "example": "example.com", - "maxLength": 64, + "creationDate": { + "format": "date-time", "type": "string" }, - "country": { - "description": "Country", - "example": "US", - "maxLength": 64, + "description": { "type": "string" }, - "keyAlgorithm": { - "description": "Key algorithm type", - "enum": [ - "RSA_2048", - "RSA_3072", - "RSA_4096", - "EC_P256", - "EC_P384", - "EC_P521", - "EC_ED25519" - ], - "example": "EC_P256", - "type": "string" + "fullyQualifiedDomainNames": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true }, - "locality": { - "description": "Locality", - "example": "San Antonio", - "maxLength": 64, + "id": { + "format": "uuid", "type": "string" }, - "name": { - "description": "Name of the Sub CA provider", - "example": "Some Sub CA", - "maxLength": 64, - "type": "string" + "ipRanges": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true }, - "organization": { - "description": "Organization", - "example": "Some organization", - "maxLength": 64, + "modificationDate": { + "format": "date-time", "type": "string" }, - "organizationalUnit": { - "description": "Organizational unit", - "example": "Some organizational unit", - "maxLength": 64, + "name": { "type": "string" }, - "pkcs11": { - "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" + "ownerIdsAndTypes": { + "items": { + "$ref": "#/components/schemas/OwnerIdAndType" + }, + "type": "array" }, - "stateOrProvince": { - "description": "State or province", - "example": "Texas", - "maxLength": 64, - "type": "string" + "ownership": { + "$ref": "#/components/schemas/ApplicationOwnership" }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "PnYnMnDTnHnMnS", - "type": "string" - } - }, - "type": "object" - }, - "SubjectAlternativeNamesByType": { - "properties": { - "dnsNames": { + "owningServiceAccounts": { "items": { - "type": "string" + "$ref": "#/components/schemas/ServiceAccountInformation" }, "type": "array" }, - "ipAddresses": { + "owningTeams": { "items": { - "type": "string" + "$ref": "#/components/schemas/TeamInformation2" }, "type": "array" }, - "rfc822Names": { + "owningUsers": { "items": { - "type": "string" + "$ref": "#/components/schemas/UserInformation2" }, "type": "array" }, - "uniformResourceIdentifiers": { + "ports": { "items": { "type": "string" }, - "type": "array" + "type": "array", + "uniqueItems": true } }, "type": "object" }, - "SubjectAttributesInformation": { - "description": "Subject attributes", + "ApplicationOwnership": { "properties": { - "commonName": { - "$ref": "#/components/schemas/PropertyInformation" - }, - "country": { - "$ref": "#/components/schemas/PropertyInformation" - }, - "locality": { - "$ref": "#/components/schemas/PropertyInformation" - }, - "organization": { - "$ref": "#/components/schemas/PropertyInformation" - }, - "organizationalUnit": { - "$ref": "#/components/schemas/PropertyInformation" + "owningTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true }, - "stateOrProvince": { - "$ref": "#/components/schemas/PropertyInformation" + "owningUsers": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true } }, "type": "object" }, - "SystemRole": { - "enum": [ - "SYSTEM_ADMIN", - "CONDOR_METRICS" - ], - "type": "string" - }, - "TagAssignmentErrorInformation": { - "description": "Error information for tags not assigned", - "example": { - "errorInformation": { - "message": "not assigned", - "statusCode": 1111 - } - }, + "ApplicationRenewalConfiguration": { "properties": { - "args": { - "items": { - "$ref": "#/components/schemas/AnyValue8" + "renewalActions": { + "description": "A set of options that can be used to specify the actions that should be taken when the auto-renewal process runs.", + "example": { + "provision": false, + "renew": true }, - "type": "array" - }, - "message": { - "type": "string" + "properties": { + "provision": { + "description": "If true, the system with attempt to provision any certificates associated with this application after a successful auto-renewal.", + "type": "boolean" + }, + "renew": { + "description": "If true, the system will attempt to renew any certificates associated with this application that are expected to expire within the configured number of days.", + "type": "boolean" + } + }, + "required": [ + "renew", + "provision" + ], + "type": "object" }, - "statusCode": { - "format": "int32", - "type": "integer" + "renewalWindow": { + "description": "A set of options to control the time window in which auto-renewal of certificates should be attempted.", + "example": { + "days": 16, + "inherit": false + }, + "properties": { + "days": { + "description": "Any certificates associated with this application that are expected to expire within the specified number of days will be acted on.", + "format": "int64", + "minimum": 1, + "type": "integer" + }, + "inherit": { + "description": "If true, \"days\" value configured for this application will be ignored and the value configured at the tenant level will be used.", + "type": "boolean" + } + }, + "required": [ + "inherit" + ], + "type": "object" } }, + "required": [ + "renewalActions", + "renewalWindow" + ], "type": "object" }, - "TagInformation": { + "ApplicationRequest": { "properties": { - "companyId": { - "description": "UUID specific to your company", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", - "format": "uuid", - "type": "string" + "certificateIssuingTemplateAliasIdMap": { + "additionalProperties": { + "description": "Represents a mapping of certificate issuing template aliases to their UUIDs.", + "format": "uuid", + "type": "string" + }, + "description": "Represents a mapping of certificate issuing template aliases to their UUIDs.", + "example": { + "dev-cit": "20bcb9a1-0f9c-407e-9673-b048c3d6479d", + "qa-cit": "448de2a0-1159-40f0-b3ae-e4f712577e87" + }, + "type": "object" }, - "id": { - "description": "UUID of the tag", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", - "format": "uuid", + "description": { + "description": "A description for an applications", + "example": "this application will hold dev certificates", "type": "string" }, - "isReserved": { - "description": "Used by Venafi to reserve system tags", - "example": false, - "type": "boolean" - }, - "key": { - "description": "Same as tag name, though all lowercase", - "example": "application", - "type": "string" + "externalIpRanges": { + "description": "Represents a collection of external IP ranges.", + "example": [ + "127.254.0.0/16", + "192.2.3.0/32" + ], + "items": { + "type": "string" + }, + "type": "array" }, - "name": { - "description": "Name of the tag", - "example": "Application", - "type": "string" - } - }, - "type": "object" - }, - "TagRequest": { - "description": "Array of tag and tag-value objects", - "properties": { - "name": { - "description": "Name of the tag", - "example": "Application", - "minLength": 1, - "type": "string" + "fqdns": { + "description": "A collection of FQDNs", + "example": [ + "venafi.docs.com", + "api.venafi" + ], + "items": { + "type": "string" + }, + "type": "array" }, - "values": { - "description": "Array of values associated with the tag", + "fullyQualifiedDomainNames": { + "description": "Represents a collection of fully qualified domain names (FQDNs).", "example": [ - "TLS Protect", - "Jetstack" + "internal.venafi.docs", + "internal.api.venafi" ], "items": { - "description": "Array of values associated with the tag", - "example": "[\"TLS Protect\",\"Jetstack\"]", "type": "string" }, "type": "array" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "TagResponse": { - "properties": { - "count": { - "description": "Number of tags returned", - "example": 7, - "format": "int32", - "type": "integer" }, - "tags": { + "internalFqdns": { + "description": "Represents a collection of fully qualified domain names (FQDNs) used for internal purposes.", + "example": [ + "internal.venafi.docs", + "internal.api.venafi" + ], "items": { - "$ref": "#/components/schemas/TagInformation" + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "TagValueInformation": { - "properties": { - "companyId": { - "description": "UUID specific to your company", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", - "format": "uuid", - "type": "string" }, - "id": { - "description": "The ID of the value", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", - "format": "uuid", - "type": "string" + "internalIpRanges": { + "description": "epresents a collection of internal IP ranges.", + "example": [ + "127.254.0.0/16", + "127.2.3.0/32" + ], + "items": { + "type": "string" + }, + "type": "array" }, - "tagId": { - "description": "The ID of the tag the value applies to", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", - "format": "uuid", - "type": "string" + "internalPorts": { + "description": "Represents a collection of external ports.", + "example": [ + "8080", + "9090" + ], + "items": { + "type": "string" + }, + "type": "array" }, - "value": { - "description": "Name of the value", - "example": "TLS Protect", - "type": "string" - } - }, - "type": "object" - }, - "TagValuesRequest": { - "properties": { - "values": { - "description": "Array of value names to associate with the tag", + "ipRanges": { + "description": "Represents a collection of CIDR (Classless Inter-Domain Routing) ranges.", + "example": [ + "127.254.0.0/16", + "192.2.3.0/32" + ], "items": { - "description": "Array of value names to associate with the tag", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", "type": "string" }, - "minItems": 1, "type": "array" - } - }, - "required": [ - "values" - ], - "type": "object" - }, - "TagValuesResponse": { - "properties": { - "count": { - "description": "Number of values returned", - "example": 7, - "format": "int32", - "type": "integer" }, - "values": { + "name": { + "description": "An application name", + "example": "dev app", + "type": "string" + }, + "ownerIdsAndTypes": { + "description": "Represents a collection of ownership UUIDs and types.", + "example": [ + { + "ownerId": "f94c36a4-31b3-4aaf-a5c9-83fc7277db9f", + "ownerType": "USER" + }, + { + "ownerId": "2f796153-33e8-48d6-82e0-cc3b259f78ec", + "ownerType": "TEAM" + } + ], "items": { - "$ref": "#/components/schemas/TagValueInformation" + "$ref": "#/components/schemas/OwnerIdAndType" }, "type": "array" - } - }, - "type": "object" - }, - "TagsAndValuesInformation": { - "properties": { - "tag": { - "$ref": "#/components/schemas/TagInformation" }, - "values": { + "ports": { + "description": "Represents a collection of network ports.", + "example": [ + "443", + "7776" + ], "items": { - "$ref": "#/components/schemas/TagValueInformation" + "type": "string" }, "type": "array" + }, + "startTargetedDiscovery": { + "description": "Specifies whether to start target discovery.", + "type": "boolean" } }, + "required": [ + "fullyQualifiedDomainNames", + "internalPorts", + "ipRanges", + "name", + "ownerIdsAndTypes", + "ports" + ], "type": "object" }, - "TagsAndValuesResponse": { + "ApplicationResponse": { "properties": { - "tagsAndValues": { + "applications": { "items": { - "$ref": "#/components/schemas/TagsAndValuesInformation" + "$ref": "#/components/schemas/ApplicationInformation" }, "type": "array" + }, + "ownershipCount": { + "format": "int32", + "type": "integer" + }, + "totalCount": { + "format": "int32", + "type": "integer" } }, "type": "object" }, - "TagsAssignRequest": { + "ApplicationsAssignRequest": { "properties": { "action": { - "description": "Action to perform", "enum": [ "REPLACE", "ADD", "DELETE", "DELETE_ALL" ], - "example": "REPLACE", "type": "string" }, - "entityIds": { - "description": "Array of UUIDs of the objects", - "example": [ - "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" - ], + "certificateIds": { "items": { - "description": "Array of UUIDs of the objects", "format": "uuid", "type": "string" }, - "minItems": 1, "type": "array", "uniqueItems": true }, - "entityType": { - "description": "Object type that the tag applies to", - "enum": [ - "CERTIFICATE", - "CERTIFICATE_INSTANCE", - "APPLICATION" - ], - "example": "CERTIFICATE", - "type": "string" - }, - "targetedTags": { - "description": "Array of tags to apply", - "example": [ - "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" - ], + "targetedApplicationIds": { "items": { - "description": "Array of tags to apply", - "example": "[\"265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c\"]", + "format": "uuid", "type": "string" }, "type": "array", @@ -13164,12241 +11967,13416 @@ } }, "required": [ - "entityIds" + "action", + "certificateIds", + "targetedApplicationIds" ], "type": "object" }, - "TagsAssignResponse": { + "ApplicationsAssignResponse": { "properties": { - "tagsAssignInformation": { + "certificates": { "items": { - "$ref": "#/components/schemas/TagsAssignResponseInformation" + "$ref": "#/components/schemas/CertificateInformation" }, "type": "array" } }, "type": "object" }, - "TagsAssignResponseInformation": { + "ApprovalDecisionRequest": { + "properties": { + "reason": { + "description": "Reason for user's decision", + "example": "I reject this request because the certificate won't be needed anymore.", + "maxLength": 1024, + "type": "string" + } + }, + "type": "object" + }, + "ApprovalRequestInformation": { "properties": { + "approvalRule": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + }, + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "type": "array", + "uniqueItems": true + }, + "approversOutcome": { + "description": "A collection of approver outcomes", + "items": { + "$ref": "#/components/schemas/ApproverOutcomeInformation" + }, + "type": "array", + "uniqueItems": true + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, "companyId": { - "description": "UUID specific to your company", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "description": "UUID of a company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", "format": "uuid", "type": "string" }, "creationDate": { - "description": "The date when the assignment is created", - "example": "2023-01-30T16:28:53.166Z", + "description": "The date a approval request was created", + "example": "2023-01-10T09:12:28Z", "format": "date-time", "type": "string" }, "entityId": { - "description": "UUID of the object", - "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "description": "UUID of a certificate request", + "example": "5ece3180-b1e0-11ed-862d-ad36b18e787b", "format": "uuid", "type": "string" }, - "entityType": { - "description": "Object type that the tag applies to", - "example": "CERTIFICATE", - "type": "string" + "finalApprover": { + "$ref": "#/components/schemas/ApproverPropertyOpenApi" }, - "errorInformation": { - "$ref": "#/components/schemas/TagAssignmentErrorInformation" + "id": { + "description": "UUID of a approval request", + "example": "5ece3180-b1e0-11ed-862d-ad36b18e787d", + "format": "uuid", + "type": "string" }, "modificationDate": { - "description": "The date when the assignment is last modified", - "example": "2023-01-30T16:28:53.166Z", + "description": "The date a approval request was modified", + "example": "2023-01-11T09:12:28Z", "format": "date-time", "type": "string" }, + "requestorId": { + "description": "UUID of a requestor", + "example": "8268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "requiredApprovalsCount": { + "description": "Count of a required approvals", + "example": 2, + "format": "int32", + "type": "integer" + }, "status": { - "description": "Status of the assigned entity", - "example": "ASSIGNED", + "description": "Status of an approval request", + "enum": [ + "NOT_REQUIRED", + "PENDING_APPROVAL", + "PENDING_FINAL_APPROVAL", + "APPROVED", + "REJECTED", + "EXPIRED", + "AUTO_APPROVED" + ], + "example": "PENDING_APPROVAL", + "type": "string" + } + }, + "type": "object" + }, + "ApproverOutcomeInformation": { + "properties": { + "companyId": { + "description": "UUID of a company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", "type": "string" }, - "tags": { - "description": "The tags that are assigned", + "creationDate": { + "description": "The date a approver outcome was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "UUID of an approver outcome", + "example": "5ece3180-b1e0-11ed-862d-ad36b18e787c", + "format": "uuid", + "type": "string" + }, + "reason": { + "description": "Reason of an outcome", + "example": "Not needed", + "type": "string" + }, + "status": { + "description": "Status of an approval request", + "enum": [ + "APPROVED", + "REJECTED" + ], + "example": "APPROVED", + "type": "string" + }, + "userId": { + "description": "UUID of a user", + "example": "8268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + } + }, + "type": "object" + }, + "ApproverProperty": { + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "enum": [ + "USER", + "TEAM" + ], + "type": "string" + } + }, + "type": "object" + }, + "ApproverPropertyOpenApi": { + "description": "Approver with id that can be only user type", + "properties": { + "id": { + "description": "UUID specific to the approver user/team", + "example": "8268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "Approver type", + "example": "USER", + "type": "string" + } + }, + "type": "object" + }, + "AuthType": { + "description": "The type of the authentication:\n * `password`\n * `username_password`\n", + "enum": [ + "password", + "username_password" + ], + "type": "string" + }, + "AwsCloudProviderInformation": { + "properties": { + "accountIds": { + "description": "Array of AWS account IDs each of which should be a 12-digit identifier", "example": [ - "Application:TLS" + "123456789012" ], "items": { - "description": "The tags that are assigned", - "example": "[\"Application:TLS\"]", "type": "string" }, - "type": "array", - "uniqueItems": true + "minItems": 1, + "type": "array" + }, + "regions": { + "description": "Array of AWS regions", + "example": [ + "us-west-1" + ], + "items": { + "enum": [ + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2", + "af-south-1", + "ap-east-1", + "ap-south-2", + "ap-southeast-3", + "ap-southeast-4", + "ap-south-1", + "ap-northeast-3", + "ap-northeast-2", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "ca-central-1", + "eu-central-1", + "eu-west-1", + "eu-west-2", + "eu-south-1", + "eu-west-3", + "eu-south-2", + "eu-north-1", + "eu-central-2", + "me-south-1", + "me-central-1", + "sa-east-1", + "us-gov-east-1", + "us-gov-west-1" + ], + "type": "string" + }, + "type": "array" } }, + "required": [ + "accountIds", + "regions" + ], "type": "object" }, - "TagsAssignmentAggregatesRequest": { + "AzureCloudProviderInformation": { "properties": { - "entityType": { - "description": "Object type that the tag applies to. If null, get all object types", - "enum": [ - "CERTIFICATE", - "CERTIFICATE_INSTANCE", - "APPLICATION" - ], - "example": "CERTIFICATE", - "type": "string" - }, - "tags": { - "description": "Array of tags", + "subscriptionIds": { + "description": "Array of Azure subscription IDs each of which should be UUID", "example": [ - "TAG", - "Tag:Value" + "8d10da13-8125-4ba9-a717-bf7490507b3d" ], "items": { - "description": "Array of tags", - "example": "[\"TAG\",\"Tag:Value\"]", + "format": "uuid", "type": "string" }, - "maxItems": 100, - "type": "array", - "uniqueItems": true + "minItems": 1, + "type": "array" } }, "required": [ - "tags" + "subscriptionIds" ], "type": "object" }, - "TagsAssignmentAggregatesResponse": { + "BaseActivityLogFilter": { + "description": "Root expression for filtering", + "oneOf": [ + { + "$ref": "#/components/schemas/ActivityLogFilterOperands" + }, + { + "$ref": "#/components/schemas/ActivityLogFilterOperand" + }, + { + "$ref": "#/components/schemas/ActivityLogCondition" + } + ], + "type": "object" + }, + "BaseActivityLogOrdering": { + "description": "Specify the ordering of a search result", "properties": { - "aggregates": { - "additionalProperties": { - "description": "Represents a mapping of tag name to list of aggregates information", - "example": { - "TagNew": [ - { - "count": 2, - "entityType": "CERTIFICATE" - }, - { - "count": 5, - "entityType": "APPLICATION" - } - ], - "tag:value": [ - { - "count": 6, - "entityType": "CERTIFICATE" - }, - { - "count": 1, - "entityType": "APPLICATION" - } - ] - }, - "items": { - "$ref": "#/components/schemas/TagsAssignmentAggregatesResponseInformation" - }, - "type": "array" - }, - "description": "Represents a mapping of tag name to list of aggregates information", - "example": { - "TagNew": [ - { - "count": 2, - "entityType": "CERTIFICATE" - }, - { - "count": 5, - "entityType": "APPLICATION" - } - ], - "tag:value": [ - { - "count": 6, - "entityType": "CERTIFICATE" - }, - { - "count": 1, - "entityType": "APPLICATION" - } - ] + "orders": { + "items": { + "$ref": "#/components/schemas/ActivityLogOrder" }, - "type": "object" + "type": "array" } }, "type": "object" }, - "TagsAssignmentAggregatesResponseInformation": { - "description": "Represents a mapping of tag name to list of aggregates information", - "example": { - "TagNew": [ - { - "count": 2, - "entityType": "CERTIFICATE" - }, - { - "count": 5, - "entityType": "APPLICATION" - } - ], - "tag:value": [ - { - "count": 6, - "entityType": "CERTIFICATE" - }, - { - "count": 1, - "entityType": "APPLICATION" - } - ] - }, - "properties": { - "count": { - "description": "Number of entities per type", - "example": 2, - "format": "int32", - "type": "integer" + "BaseFilter": { + "description": "Root expression for filtering", + "oneOf": [ + { + "$ref": "#/components/schemas/FilterOperands" }, - "entityType": { - "description": "Object type that the tag applies to", - "example": "CERTIFICATE", - "type": "string" + { + "$ref": "#/components/schemas/FilterOperand" + }, + { + "$ref": "#/components/schemas/Condition" } - }, + ], "type": "object" }, - "TagsBulkRequest": { + "BaseOrdering": { + "description": "Specify the ordering of a search result", "properties": { - "tags": { - "description": "Array of tag and tag-value objects", + "orders": { "items": { - "$ref": "#/components/schemas/TagRequest" + "$ref": "#/components/schemas/Order" }, "type": "array" } }, "type": "object" }, - "Target": { + "BulkApprovalRequest": { "properties": { - "connection": { - "description": "JSON object that configures the webhook connection for this target.\nSupported fields:\n- `url` (string, required): HTTPS endpoint URL for the webhook.\n- `headers` (object, optional): Key/value pairs of HTTP headers. Only the `Authorization` header is honored by the webhook service; all other headers are ignored.\n- `secret` (string, optional): Shared secret used to generate an HMAC signature sent in the `VaaS-Signature` header.\nWebhook deliveries always use `Content-Type: application/json`. Custom `Content-Type` values are not supported.\nExample:\n ```json\n{\n\"url\": \"https://example.com/webhook\",\n\"headers\": {\n\"Authorization\": \"Splunk 12345678-ABCD\"\n},\n\"secret\": \"my-shared-secret\"\n }\n", - "format": "json", + "ids": { + "description": "Set of UUIDs of the certificate requests", + "example": [ + "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" + ], + "items": { + "description": "Set of UUIDs of the certificate requests", + "format": "uuid", + "type": "string" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + }, + "reason": { + "description": "Reason for user's decision", + "example": "I reject this request because the certificate won't be needed anymore.", + "maxLength": 1024, "type": "string" }, - "type": { - "description": "The delivery mechanism for this connector. For webhook-based notifications, use:\n- `generic` for a standard HTTPS webhook endpoint\n- `slack` for a Slack webhook target\n- `teams` for a Microsoft Teams webhook target\n", - "enum": [ - "generic", - "slack", - "teams" - ], + "wsClientId": { + "description": "The ws client id, that will be used when the execution finishes", + "example": "someid", "type": "string" } }, "required": [ - "connection", - "type" + "ids" ], "type": "object" }, - "TargetsInformation": { - "description": "This object contains service type and ports.", - "discriminator": { - "propertyName": "serviceType" - }, + "BulkApprovalResponse": { "properties": { - "serviceType": { + "operationId": { "type": "string" } }, - "required": [ - "serviceType" - ], "type": "object" }, - "TeamId": { - "description": "The ID of a team.", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "CMSAuthenticationType": { + "description": "The authentication type for the privileged access management:\n * `certificate` - For authentication with a Certificate bundle\n * `userPassword` - For authentication with user and password\n", + "enum": [ + "certificate", + "userPassword" + ], + "type": "string" + }, + "CMSConfId": { + "description": "The Credential Manager Service configuration ID.", + "example": "72e4c1f6-d85f-11ed-afa1-0242ac120002", "format": "uuid", "type": "string" }, - "TeamInformation1": { + "CMSConfigurationResponse": { + "description": "The information representing a Credential Manager Service configuration for response.", "properties": { - "companyId": { - "format": "uuid", - "type": "string" + "cmsDetails": { + "$ref": "#/components/schemas/ResponseCMSDetails" }, - "id": { - "format": "uuid", - "type": "string" + "cmsType": { + "$ref": "#/components/schemas/CMSType" }, - "members": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "companyId": { + "$ref": "#/components/schemas/CompanyId" }, - "name": { - "type": "string" + "createdBy": { + "$ref": "#/components/schemas/CreatedBy" }, - "owners": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "createdOn": { + "$ref": "#/components/schemas/CreatedOn" }, - "ownership": { - "additionalProperties": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "type": "object" + "id": { + "$ref": "#/components/schemas/CMSConfId" }, - "productRoles": { - "additionalProperties": { - "items": { - "enum": [ - "SECURITY_ADMIN", - "DEVOPS_LEAD", - "DEVOPS_USER", - "OUTAGEDETECTION_ADMIN", - "RESOURCE_OWNER", - "PKI_ADMIN", - "GUEST", - "PLATFORM_ADMIN" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "type": "object" + "lastModifiedBy": { + "$ref": "#/components/schemas/LastModifiedBy" }, - "systemRoles": { - "items": { - "enum": [ - "SYSTEM_ADMIN", - "CONDOR_METRICS" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "lastModifiedOn": { + "$ref": "#/components/schemas/LastModifiedOn" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "vSatelliteIds": { + "$ref": "#/components/schemas/VSatelliteIds" } }, "type": "object" }, - "TeamInformation2": { + "CMSType": { + "description": "The type of the privileged access management:\n * `cyberark` - For CyberArk privileged access management\n * `hashicorp` - For HashiCorp privileged access management\n", + "enum": [ + "cyberark", + "hashicorp" + ], + "type": "string" + }, + "CMSURL": { + "description": "The baseUrl of the privileged access management provider.", + "format": "uri", + "type": "string" + }, + "CSRAttributesInformation": { + "description": "Represents CSR attributes for certificate requests. Required when isVaaSGenerated is set to true and reuseCSR to false.", + "example": { + "commonName": "localhost", + "country": "MX", + "keyTypeParameters": { + "keyCurve": "P256", + "keyLength": 4096, + "keyType": "RSA" + }, + "locality": "Merida", + "organization": "venafi", + "organizationalUnits": [ + "devops" + ], + "state": "Yucatan", + "subjectAlternativeNamesByType": { + "dnsNames": [ + "localhost" + ] + } + }, "properties": { - "companyId": { - "format": "uuid", + "commonName": { "type": "string" }, - "id": { - "format": "uuid", + "country": { "type": "string" }, - "members": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "keyTypeParameters": { + "$ref": "#/components/schemas/KeyTypeParameters2" }, - "modificationDate": { - "format": "date-time", + "locality": { "type": "string" }, - "name": { + "organization": { "type": "string" }, - "owners": { + "organizationalUnits": { "items": { - "format": "uuid", "type": "string" }, - "type": "array", - "uniqueItems": true - }, - "productRoles": { - "additionalProperties": { - "items": { - "$ref": "#/components/schemas/Role2" - }, - "type": "array", - "uniqueItems": true - }, - "type": "object" - }, - "role": { - "$ref": "#/components/schemas/TeamRole" + "type": "array" }, - "systemRoles": { - "items": { - "$ref": "#/components/schemas/SystemRole" - }, - "type": "array", - "uniqueItems": true + "state": { + "type": "string" }, - "userMatchingRules": { - "items": { - "$ref": "#/components/schemas/UserMatchingRule" - }, - "type": "array" + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/SubjectAlternativeNamesByType" } }, "type": "object" }, - "TeamMembersRequest": { - "properties": { - "members": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "members" + "Capability": { + "enum": [ + "DEFAULT", + "ISSUANCE", + "VALIDATION", + "ENTERPRISE", + "PROVISIONING", + "SINGLE_SIGN_ON", + "DISTRIBUTED_ISSUER", + "CLOUD_PROVIDERS", + "CREDENTIAL_MANAGER", + "KUBERNETES_DISCOVERY", + "KUBERNETES_ENTERPRISE_COMPONENTS", + "KUBERNETES_ENTERPRISE_COMPONENTS_CERT_MANAGER", + "KUBERNETES_ENTERPRISE_COMPONENTS_VEI", + "KUBERNETES_ENTERPRISE_COMPONENTS_APE", + "KUBERNETES_ENTERPRISE_COMPONENTS_OS", + "KUBERNETES_INTEGRATION_TLSPDC" ], - "type": "object" + "type": "string" }, - "TeamOwnersRequest": { + "CapabilityInformation": { "properties": { - "owners": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "isTrial": { + "type": "boolean" + }, + "name": { + "$ref": "#/components/schemas/Capability" + }, + "productExpiryDate": { + "format": "date-time", + "type": "string" + }, + "productGraceExpiryDate": { + "format": "date-time", + "type": "string" } }, "required": [ - "owners" + "isTrial", + "name", + "productExpiryDate" ], "type": "object" }, - "TeamRole": { - "enum": [ - "SYSTEM_ADMIN", - "PKI_ADMIN", - "RESOURCE_OWNER", - "GUEST", - "PLATFORM_ADMIN" - ], - "type": "string" - }, - "TeamsIds": { - "description": "The ID's of teams.", - "items": { - "$ref": "#/components/schemas/TeamId" + "CertificateAuthorityProductInformation1": { + "description": "Product specific for external certificate authority", + "discriminator": { + "propertyName": "certificateAuthority" }, - "type": "array", - "uniqueItems": true - }, - "TeamsResponse": { "properties": { - "teams": { + "certificateAuthority": { + "type": "string" + }, + "certificateType": { + "enum": [ + "OTHER", + "DOMAIN_VALIDATED_SSL" + ], + "type": "string" + }, + "hashAlgorithm": { + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "type": "string" + }, + "productName": { + "type": "string" + }, + "productTypes": { "items": { - "$ref": "#/components/schemas/TeamInformation2" + "enum": [ + "SSL", + "CODESIGN" + ], + "type": "string" }, + "readOnly": true, "type": "array" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" } }, + "required": [ + "certificateAuthority" + ], "type": "object" }, - "TenantExpirationNotificationConfiguration": { + "CertificateAuthorityProductInformation2": { "properties": { - "additionalRecipients": { - "description": "A list of users and/or teams who should be added as recipients.", - "example": [ - { - "id": "22153ae0-4352-11ee-b95c-3531a284802b", - "type": "User" - }, - { - "id": "22153ae0-4352-11ee-b95c-12345abcd123", - "type": "Team" - } + "certificateType": { + "enum": [ + "OTHER", + "DOMAIN_VALIDATED_SSL" ], - "items": { - "$ref": "#/components/schemas/Recipient" - }, - "type": "array", - "uniqueItems": true + "type": "string" }, - "channels": { - "description": "A list of channels that should be used to deliver the notification.", - "example": [ - "email" + "hashAlgorithm": { + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" ], + "type": "string" + }, + "productName": { + "type": "string" + }, + "productTypes": { "items": { - "$ref": "#/components/schemas/Channel" + "enum": [ + "SSL", + "CODESIGN" + ], + "type": "string" }, - "minItems": 1, - "type": "array", - "uniqueItems": true + "type": "array" }, - "enabled": { - "description": "If true, then the system will send notification for certificates which are nearing expiration.", - "example": true, - "type": "boolean" + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" + } + }, + "type": "object" + }, + "CertificateCredentialData": { + "properties": { + "certificateBundle": { + "description": "The Base64 encoding certificate bundle encrypted content.", + "format": "byte", + "type": "string" }, - "fallbackToPKIAdmin": { - "description": "If true, then all users with the PKI admin role will be added as recipients if the persona list does not include any recipients for a specific certificate.", - "example": true, - "type": "boolean" + "certificateId": { + "description": "The Id of the certificate selected from the Certificate Inventory", + "format": "uuid", + "type": "string" }, - "includeCertificateDetails": { - "description": "If true, then the notification may include potentially sensitive details about the certificate that is nearing expiration.", - "example": true, - "type": "boolean" + "certificatePassword": { + "description": "The password to decrypt the certificate bundle.", + "format": "password", + "type": "string" }, - "personas": { - "description": "A list of personas who should be recipients of the notification. If \"Application Owners\" is included then the owners of the Application object to which the certificate is assigned will be added as recipients. If \"All PKI Admins\" or \"All Admins\" are present then all users in the system with that role will be added as recipients.", - "example": [ - "Application Owners", - "All PKI Admins" - ], - "items": { - "$ref": "#/components/schemas/Persona" - }, - "type": "array", - "uniqueItems": true + "fingerprint": { + "description": "The fingerprint of the certificate selected from the Certificate Inventory", + "type": "string" } }, "type": "object" }, - "TenantExpirationReportsConfiguration": { + "CertificateDeletionRequest": { "properties": { - "additionalRecipients": { - "description": "A list of users and/or teams who should be added as recipients.", + "certificateIds": { + "description": "A collection of certificates UUIDs", "example": [ - { - "id": "22153ae0-4352-11ee-b95c-3531a284802b", - "type": "User" - }, - { - "id": "22153ae0-4352-11ee-b95c-12345abcd123", - "type": "Team" - } + "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", + "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" ], "items": { - "$ref": "#/components/schemas/Recipient" + "format": "uuid", + "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" + } + }, + "required": [ + "certificateIds" + ], + "type": "object" + }, + "CertificateExpirationInventoryMonitoringConfig": { + "allOf": [ + { + "$ref": "#/components/schemas/InventoryMonitoringConfig" }, - "channels": { - "description": "A list of channels that should be used to deliver the notification.", - "example": [ - "email" - ], - "items": { - "$ref": "#/components/schemas/Channel" + { + "properties": { + "applicationIds": { + "description": "Application IDs that the webhook applies to", + "items": { + "description": "Application IDs that the webhook applies to", + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "enabled": { + "description": "Enables or disables webhook messages.", + "type": "boolean" + }, + "includeUnassignedCertificates": { + "description": "Enables or disables notifications for unassigned certificates.", + "type": "boolean" + }, + "thresholds": { + "description": "Array of certificate expiration thresholds, in days, for when notifications will be sent. Limit is 3 values.", + "items": { + "description": "Array of certificate expiration thresholds, in days, for when notifications will be sent. Limit is 3 values.", + "format": "int32", + "type": "integer" + }, + "type": "array" + } }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "enabled": { - "description": "If true, then the system will send reports providing details of certificates which are nearing expiration.", - "example": true, - "type": "boolean" - }, - "expiringWithinDays": { - "description": "Any certificates which will expire within the number of days specified here will be included in the report.", - "example": 30, - "type": "integer" - }, - "ignoreAfterDays": { - "description": "Any certificates which have expired for more than the specified days will be excluded in the report.", - "example": 30, - "type": "integer" + "type": "object" + } + ], + "type": "object" + }, + "CertificateImportInfo": { + "description": "Base64 encoding certificate content.", + "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" }, - "roles": { - "description": "All users with the specified VaaS roles will be added as a report recipient.", + "applicationIds": { + "description": "A collection of application IDs", "example": [ - "SYSTEM_ADMIN" + "47c9d920-da21-11ed-a63c-d508f08eeaa0", + "9303e940-df9d-11ed-8850-f18176fc5513" ], "items": { - "$ref": "#/components/schemas/Role1" + "format": "uuid", + "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "schedule": { - "description": "A cron string representing the desired schedule for delivering reports. Note that currently reports may not be sent more than once per day. The `hour` and `minute` fields of the cron schedule will be ignored.", - "example": "0 0 * * Mon", - "type": "string" - } - }, - "type": "object" - }, - "TenantRenewalConfiguration": { - "properties": { - "id": { - "description": "The object ID", - "example": "12a05220-4352-11ee-ac28-c1379e5decf9", - "format": "UUID", + "certificate": { + "description": "Certificate base64 encoded format (PEM without header/footer", "type": "string" }, - "renewalWindow": { - "description": "A set of options to control the time window in which auto-renewal of certificates should be attempted.", - "example": { - "days": 30 - }, - "properties": { - "days": { - "description": "Any certificates associated with this object that are expected to expire within the specified number of days will be acted on.", - "format": "int64", - "minimum": 1, - "type": "integer" + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" }, - "required": [ - "days" + "type": "array" + }, + "issuerCertificates": { + "description": "A collection of issuer certificates", + "example": [ + "Venafi issuer", + "QA Venafi issuer" ], - "type": "object" + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ - "id", - "renewalWindow" + "certificate" ], "type": "object" }, - "TestCMSConfigurationRequest": { - "description": "The information representing a Credential Manager Service configuration for test purposes.", + "CertificateImportInformation": { + "description": "List of the certificates and private key pairs to import", "properties": { - "cmsDetails": { - "$ref": "#/components/schemas/TestCMSDetails" - }, - "cmsType": { - "$ref": "#/components/schemas/CMSType" + "certificate": { + "description": "Certificate to import", + "type": "string" }, - "id": { - "$ref": "#/components/schemas/CMSConfId" + "dekEncryptedPassword": { + "description": "Password to decrypt the certificate", + "type": "string" }, - "name": { - "$ref": "#/components/schemas/Name" + "dekEncryptedPrivateKey": { + "description": "Format of the private key", + "type": "string" }, - "vSatelliteIds": { - "$ref": "#/components/schemas/VSatelliteIds" + "passwordEncryptedPrivateKey": { + "description": "Private key for certificate to import", + "type": "string" }, - "wsClientId": { - "description": "An ID where you can subscribe to receive the response of the workflow.", + "pkcs12Keystore": { + "description": "pkcs12 keystore base64 encoded string", "type": "string" } }, "required": [ - "wsClientId" + "certificate", + "dekEncryptedPrivateKey", + "passwordEncryptedPrivateKey" ], "type": "object" }, - "TestCMSConfigurationResponse": { - "description": "The result of testing the Credential Manager Service configuration.", + "CertificateImportRequest1": { "properties": { - "workflowId": { + "edgeInstanceId": { + "description": "Id for edge instance", "format": "uuid", "type": "string" }, - "workflowName": { + "encryptionKeyId": { + "description": "Id for data encryption key", + "minLength": 1, "type": "string" + }, + "importInformation": { + "description": "List of the certificates and private key pairs to import", + "items": { + "$ref": "#/components/schemas/CertificateImportInformation" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" } }, "required": [ - "workflowId", - "workflowName" + "edgeInstanceId", + "encryptionKeyId", + "importInformation" ], "type": "object" }, - "TestCMSDetails": { - "oneOf": [ - { - "$ref": "#/components/schemas/TestCyberArkDetails" + "CertificateImportRequest2": { + "properties": { + "certificates": { + "description": "Base64 encoding certificate content.", + "items": { + "$ref": "#/components/schemas/CertificateImportInfo" + }, + "type": "array" }, - { - "$ref": "#/components/schemas/TestHashiCorpDetails" + "overrideBlocklist": { + "description": "Imports the certificate even if it's present in the Certificates blocklist.", + "type": "boolean" } - ] + }, + "required": [ + "certificates" + ], + "type": "object" }, - "TestCredentialDetails": { - "oneOf": [ - { - "$ref": "#/components/schemas/TestCyberArkCredDetails" + "CertificateImportResponse1": { + "properties": { + "creationDate": { + "description": "Import creation date of certificates and private keys", + "format": "date-time", + "type": "string" }, - { - "$ref": "#/components/schemas/TestHashiCorpCredDetails" + "id": { + "description": "Import id used to check the status of the bulk operation", + "type": "string" } - ] + }, + "type": "object" }, - "TestCredentialRequest": { - "description": "The properties representing a credential to test.", + "CertificateImportResponse2": { "properties": { - "authType": { - "$ref": "#/components/schemas/AuthType" + "certificateInformations": { + "description": "A collection of information about certificates that were newly imported.", + "items": { + "$ref": "#/components/schemas/ImportedCertificateInformation" + }, + "type": "array" }, - "cmsType": { - "$ref": "#/components/schemas/CMSType" + "statistics": { + "additionalProperties": { + "description": "Certificate import statistics", + "format": "int32", + "type": "integer" + }, + "description": "Certificate import statistics", + "type": "object" + } + }, + "type": "object" + }, + "CertificateImportStatusDetail": { + "description": "Status detail information for each certificate and private key imported related to the import id", + "properties": { + "certificateBytes": { + "description": "Bytes of the imported certificate", + "format": "byte", + "type": "string" }, - "credentialDetails": { - "$ref": "#/components/schemas/TestCredentialDetails" + "fingerprint": { + "description": "Unique identifier for the imported certificate", + "type": "string" }, + "reason": { + "description": "Reason for the status result", + "type": "string" + }, + "status": { + "description": "Result status for the import", + "enum": [ + "IMPORTED", + "FAILED", + "SKIPPED", + "PROCESSING" + ], + "type": "string" + } + }, + "type": "object" + }, + "CertificateImportStatusDetailResponse": { + "properties": { "id": { - "$ref": "#/components/schemas/CredentialId" + "description": "Import id", + "format": "uuid", + "type": "string" }, - "wsClientId": { - "description": "An ID where you can subscribe to receive the response of the workflow.", + "results": { + "description": "Status detail information for each certificate and private key imported related to the import id", + "items": { + "$ref": "#/components/schemas/CertificateImportStatusDetail" + }, + "type": "array" + }, + "status": { + "description": "Status of bulk import", + "enum": [ + "PROCESSING", + "COMPLETED", + "WAITING", + "FAILED" + ], "type": "string" } }, - "required": [ - "wsClientId" - ], "type": "object" }, - "TestCredentialResponse": { - "description": "The result of testing access to the credential.", + "CertificateInformation": { "properties": { - "workflowId": { + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "561baf7c-98b7-49af-ab9c-7b3a9fea3028", + "4adeba6f-0c94-4595-a5b6-babea458249f" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "archivedDate": { + "description": "The date a certificate was archived", + "example": "2022-05-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "authorityKeyIdentifierHash": { + "description": "An authority key identifier hash", + "example": "40572B10F85DDAF18BFF987372178532AB875BCA", + "type": "string" + }, + "certificateAuthorityAccountId": { + "description": "UUID of a certificate authority account", + "format": "uuid", + "type": "string" + }, + "certificateName": { + "description": "A certificate name", + "example": "venafi.com", + "type": "string" + }, + "certificateRequestId": { + "description": "UUID of a certificate request", + "example": "2e8964a0-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "certificateStatus": { + "description": "Certificate's status", + "enum": [ + "ACTIVE", + "RETIRED", + "DELETED" + ], + "example": "ACTIVE", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", "format": "uuid", "type": "string" }, - "workflowName": { + "dekHash": { + "description": "A certificate dek hash", + "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", "type": "string" - } - }, - "required": [ - "workflowId", - "workflowName" - ], - "type": "object" - }, - "TestCyberArkCredDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkDetails" - } - ] - }, - "TestCyberArkDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkConfigurationRequiredProp" - } - ] - }, - "TestHashiCorpCredDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/HashiCorpDetails" - } - ] - }, - "TestHashiCorpDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/HashiCorpConfigurationRequiredProp" - } - ] - }, - "TrackingDataInformation": { - "discriminator": { - "propertyName": "certificateAuthority" - }, - "properties": { - "certificateAuthority": { + }, + "encryptionType": { + "description": "A certificate encryption type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "EC", "type": "string" - } - }, - "required": [ - "certificateAuthority" - ], - "type": "object" - }, - "UnaryOperator": { - "description": "An operator for filtering", - "enum": [ - "NOT" - ], - "example": "NOT", - "type": "string" - }, - "UpdateCMSConfigurationRequest": { - "description": "The information representing a Credential Manager Service configuration for update.", - "properties": { - "cmsDetails": { - "$ref": "#/components/schemas/UpdateCMSDetails" }, - "id": { - "$ref": "#/components/schemas/CMSConfId" + "extendedKeyUsage": { + "description": "A collection of certificate extended key usages", + "example": [ + "1.3.6.1.5.5.7.3.2", + "1.3.6.1.5.5.7.3.1" + ], + "items": { + "type": "string" + }, + "type": "array" }, - "name": { - "$ref": "#/components/schemas/Name" + "fingerprint": { + "description": "A certificate fingerprint", + "example": "6D4C95512C117B004191F1A096ECAD13242FCD9F", + "type": "string" }, - "vSatelliteIds": { - "$ref": "#/components/schemas/VSatelliteIds" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "UpdateCMSDetails": { - "oneOf": [ - { - "$ref": "#/components/schemas/UpdateCyberArkDetails" + "id": { + "description": "UUID of a certificate", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" }, - { - "$ref": "#/components/schemas/UpdateHashiCorpDetails" - } - ] - }, - "UpdateCredentialDetails": { - "oneOf": [ - { - "$ref": "#/components/schemas/UpdateCyberArkCredDetails" + "inhibitAnyPolicy": { + "description": "Inhibit any policy", + "example": 150, + "format": "int32", + "type": "integer" }, - { - "$ref": "#/components/schemas/UpdateHashiCorpCredDetails" - } - ] - }, - "UpdateCredentialRequest": { - "description": "The properties representing a credential to update.", - "properties": { - "cmsConfigId": { - "$ref": "#/components/schemas/CMSConfId" + "inhibitPolicyMapping": { + "description": "Inhibit policy mapping", + "example": 200, + "format": "int32", + "type": "integer" }, - "credentialDetails": { - "$ref": "#/components/schemas/UpdateCredentialDetails" + "instances": { + "description": "A collection of certificate instances information", + "example": [ + { + "certificateId": "7ec12010-9051-11ed-8e50-b994b27d2ece", + "certificateInstanceId": "7ec1bc50-9051-11ed-8e50-b994b27d2ece", + "certificateSource": "USER_SCAN", + "deploymentStatus": "IN_USE", + "hostname": "venafi.com", + "instanceChainValidationStatus": [ + "OK" + ], + "ipAddress": "23.185.0.2", + "lastScanDate": "2023-01-09T19:12:05.314+00:00", + "lastValidatedAttempt": "2023-01-09T19:12:05.446+00:00", + "modificationDate": "2023-01-09T19:12:14.865+00:00", + "port": 443, + "serviceIds": [ + "1d61e9e0-9046-11ed-bf12-53a1b041cf25" + ], + "sslProtocols": [ + "TLSv1.3", + "TLSv1.2" + ], + "sslValidationErrorArguments": [], + "sslValidationStatus": "OK" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateInstanceInformation" + }, + "type": "array" }, - "id": { - "$ref": "#/components/schemas/CredentialId" + "issuerAlternativeNameDns": { + "description": "A collection of certificate issuer alternative names DNs", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { + "type": "string" + }, + "type": "array" }, - "name": { - "$ref": "#/components/schemas/CredentialName" + "issuerAlternativeNameNonDns": { + "description": "A collection of certificate issuer alternative name none DNs", + "example": [ + "venafi issuer doman" + ], + "items": { + "type": "string" + }, + "type": "array" }, - "teamsIds": { - "$ref": "#/components/schemas/TeamsIds" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "UpdateCyberArkCredDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkDetails" - } - ] - }, - "UpdateCyberArkDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/CyberArkConfiguration" - } - ] - }, - "UpdateHashiCorpCredDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/HashiCorpDetails" - } - ] - }, - "UpdateHashiCorpDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/HashiCorpConfiguration" - } - ] - }, - "UpdateTeamRequest": { - "properties": { - "name": { - "maxLength": 100, + "issuerC": { + "description": "A certificate issues Country", + "example": "US", + "type": "string" + }, + "issuerCN": { + "description": "A collection of certificate issuer Common names", + "example": [ + "HydrantID SSL CA G3" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "issuerCertificateIds": { + "description": "A collection of issuer certificate IDs", + "example": [ + "2e8964a0-9046-11ed-8e50-b994b27d2ece", + "d5b418a0-297e-11eb-bc4c-8b24e5a66fb6" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "issuerDN": { + "description": "A certificate issue DN", + "example": "cn=HydrantID SSL CA G3,o=HydrantID (Avalanche Cloud Corporation),c=US", "type": "string" }, - "role": { - "$ref": "#/components/schemas/TeamRole" + "issuerL": { + "description": "A certificate issues Locality", + "example": "Salt Lake City", + "type": "string" }, - "userMatchingRules": { + "issuerOU": { + "description": "A collection of certificate issuer Organization units", + "example": [ + "Issuer CA" + ], "items": { - "$ref": "#/components/schemas/UserMatchingRule" + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "UpdatesConfigRequest": { - "properties": { - "updateConfigSchedulerPattern": { - "oneOf": [ - { - "$ref": "#/components/schemas/DailyPatternInformation" - }, - { - "$ref": "#/components/schemas/WeeklyPatternInformation" - } + }, + "issuerST": { + "description": "A certificate issuer State", + "example": "Utah", + "type": "string" + }, + "keyCurve": { + "description": "A certificate key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" ], - "type": "object" - } - }, - "required": [ - "updateConfigSchedulerPattern" - ], - "type": "object" - }, - "UpdatesConfigResponse": { - "properties": { - "updateConfigSchedulerPattern": { - "oneOf": [ - { - "$ref": "#/components/schemas/DailyPatternInformation" - }, - { - "$ref": "#/components/schemas/WeeklyPatternInformation" - } + "example": "P256", + "type": "string" + }, + "keyStrength": { + "description": "A certificate key strength", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyUsage": { + "description": "A collection of certificate key usages", + "example": [ + "digitalSignature", + "keyEncipherment" ], - "type": "object" - } - }, - "type": "object" - }, - "UpgradeStatus": { - "enum": [ - "LATEST", - "UPGRADE_PENDING", - "UPGRADING", - "FAILED" - ], - "type": "string" - }, - "UriBuilder": { - "type": "object" - }, - "UserAccountResponse": { - "properties": { - "apiKey": { - "$ref": "#/components/schemas/ApiKeyInformation" + "items": { + "type": "string" + }, + "type": "array" }, - "company": { - "$ref": "#/components/schemas/CompanyInformation" + "lastNotification": { + "format": "int32", + "type": "integer" }, - "user": { - "$ref": "#/components/schemas/UserInformation2" - } - }, - "type": "object" - }, - "UserAccountType": { - "enum": [ - "WEB_UI", - "API" - ], - "type": "string" - }, - "UserAccountTypeRequest": { - "properties": { - "accountType": { - "$ref": "#/components/schemas/UserAccountType" - } - }, - "required": [ - "accountType" - ], - "type": "object" - }, - "UserForceLocalPasswordExpirationRequest": { - "properties": { - "forceLocalPasswordExpiration": { + "managedCertificateId": { + "description": "UUID of a managed certificate", + "example": "2f0e7320-9046-11ed-8ab8-19e0a618d9cd", + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "description": "The last date a certificate was modified", + "example": "2022-03-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "ocspNoCheck": { + "description": "If a certificate no ocsp check", + "example": false, "type": "boolean" - } - }, - "required": [ - "forceLocalPasswordExpiration" - ], - "type": "object" - }, - "UserInformation1": { - "properties": { - "admin": { + }, + "ownership": { + "$ref": "#/components/schemas/CertificateOwnership" + }, + "pathLength": { + "description": "A certificate path length", + "example": 3, + "format": "int32", + "type": "integer" + }, + "requireExplicitPolicy": { + "description": "Required explicit policy is required", + "example": 1, + "format": "int32", + "type": "integer" + }, + "selfSigned": { + "description": "If the certificate is self singed", + "example": true, "type": "boolean" }, - "companyId": { - "format": "uuid", + "serialNumber": { + "description": "A certificate serial number", + "example": "0C51A562B02A19A222FFB4730C47A8E2", "type": "string" }, - "creationDate": { - "format": "date-time", + "signatureAlgorithm": { + "description": "A certificate signature algorithm", + "enum": [ + "MD2_WITH_RSA_ENCRYPTION", + "MD5_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION2", + "SHA256_WITH_RSA_ENCRYPTION", + "SHA384_WITH_RSA_ENCRYPTION", + "SHA512_WITH_RSA_ENCRYPTION", + "ID_DSA_WITH_SHA1", + "dsaWithSHA1", + "EC_DSA_WITH_SHA1", + "EC_DSA_WITH_SHA224", + "EC_DSA_WITH_SHA256", + "EC_DSA_WITH_SHA384", + "EC_DSA_WITH_SHA512", + "UNKNOWN", + "SHA1_WITH_RSAandMGF1", + "GOST_R3411_94_WITH_GOST_R3410_2001", + "GOST_R3411_94_WITH_GOST_R3410_94" + ], + "example": "SHA256_WITH_RSA_ENCRYPTION", "type": "string" }, - "firstname": { + "signatureHashAlgorithm": { + "description": "A certificate signature hash algorithm", + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "example": "SHA256", "type": "string" }, - "id": { - "format": "uuid", + "statusModificationDate": { + "description": "The date a certificate's status was modified", + "example": "2022-04-24T09:12:28Z", + "format": "date-time", "type": "string" }, - "lastname": { + "statusModificationUserId": { + "description": "UUID of the user that modified the certificate installation", + "example": "3c9964a0-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", "type": "string" }, - "memberedTeams": { + "subjectAlternativeNameDns": { + "description": "A collection of certificate subject alternative names DNs", + "example": [ + "venafi.com", + "www.venafi.com" + ], "items": { - "format": "uuid", "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "ownedTeams": { + "subjectAlternativeNameNonDns": { + "description": "A collection of certificate subject alternative name none DNs", + "example": [ + "venafi domain" + ], "items": { - "format": "uuid", "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "productRoles": { - "additionalProperties": { - "items": { - "enum": [ - "SECURITY_ADMIN", - "DEVOPS_LEAD", - "DEVOPS_USER", - "OUTAGEDETECTION_ADMIN", - "RESOURCE_OWNER", - "PKI_ADMIN", - "GUEST", - "PLATFORM_ADMIN" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData2" + }, + "subjectC": { + "description": "A certificate subject Country", + "example": "US", + "type": "string" + }, + "subjectCN": { + "description": "A collection of certificate subject CNs", + "example": [ + "venafi.com", + "cloud.venafi" + ], + "items": { + "type": "string" }, - "type": "object" + "type": "array" }, - "resourceOwner": { - "type": "boolean" + "subjectDN": { + "description": "A certificate subject DN", + "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", + "type": "string" }, - "serviceAccount": { - "type": "boolean" + "subjectKeyIdentifierHash": { + "description": "A subject key identifier hash", + "example": "4E0CE93D3240561F468C33A85F08FCD3B04CC9DC", + "type": "string" }, - "systemRoles": { + "subjectL": { + "description": "A certificate subject Locality", + "example": "Salt Lake City", + "type": "string" + }, + "subjectO": { + "description": "A certificate subject Organization", + "example": "Venafi, Inc.", + "type": "string" + }, + "subjectOU": { + "description": "A collection of certificate subject Organization units", + "example": [ + "devops", + "test" + ], "items": { - "enum": [ - "SYSTEM_ADMIN", - "CONDOR_METRICS" - ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "teamsIds": { + "subjectST": { + "description": "A certificate subject State", + "example": "Utah", + "type": "string" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "owner:test.user", + "90-day" + ], "items": { - "format": "uuid", "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, - "userAccountType": { - "type": "string" + "totalActiveInstanceCount": { + "description": "total active instances of a certificate", + "example": 50, + "format": "int32", + "type": "integer" }, - "userStatus": { + "totalInstanceCount": { + "description": "total instances of a certificate", + "example": 100, + "format": "int32", + "type": "integer" + }, + "validityEnd": { + "description": "The date a certificate validity ends", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", "type": "string" }, - "userType": { + "validityStart": { + "description": "The date a certificate validity starts", + "example": "2022-01-24T09:12:28Z", + "format": "date-time", "type": "string" }, - "username": { + "versionType": { + "description": "A certificate version type", + "enum": [ + "OLD", + "CURRENT" + ], + "example": "CURRENT", "type": "string" } }, "type": "object" }, - "UserInformation2": { + "CertificateInstanceInformation": { "properties": { - "companyId": { + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "d3cce873-6957-4071-a65e-7676c0ae1123", + "322bcd99-286a-47ea-8dcd-8291ec5bff14" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "certificateId": { + "description": "UUID of a certificate", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", "format": "uuid", "type": "string" }, - "creationDate": { - "format": "date-time", + "certificateInstanceId": { + "description": "UUID of a certificate instance", + "example": "f68daf30-4690-45bc-85b3-bb327024735e", + "format": "uuid", "type": "string" }, - "deleted": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "emailAddress": { + "certificateSource": { + "description": "Certificate source", + "enum": [ + "UNKNOWN", + "USER_PROVIDED", + "USER_IMPORTED", + "USER_SCAN", + "TRUSTNET_SCAN", + "ON_PREM_CA_IMPORT", + "EXTERNAL_CA_IMPORT", + "FILE_IMPORT", + "EXTERNAL_SCAN", + "DOMAIN_SCAN", + "SMART_SCAN_INTERNAL", + "SMART_SCAN_EXTERNAL", + "SMART_VALIDATION_INTERNAL", + "SMART_VALIDATION_EXTERNAL", + "MACHINE_DISCOVERY", + "KUBERNETES_DISCOVERY", + "AWS_DISCOVERY", + "AZURE_DISCOVERY", + "GCP_DISCOVERY" + ], + "example": "USER_SCAN", "type": "string" }, - "firstLoginDate": { - "format": "date-time", + "deploymentStatus": { + "description": "The deployment status", + "enum": [ + "UNKNOWN", + "IN_USE", + "SUPERSEDED" + ], + "example": "IN_USE", "type": "string" }, - "firstname": { + "hostname": { + "description": "A hostname", + "example": "venafi.com", "type": "string" }, - "forceLocalPasswordExpiration": { - "type": "boolean" + "instanceChainValidationStatus": { + "description": "A collection of the instance chain validation status", + "example": [ + "OK" + ], + "items": { + "enum": [ + "OK", + "CHAIN_BUILDING_FAILED", + "INCOMPLETE_CHAIN", + "CHAIN_EXPIRE_BEFORE_EE", + "DISTRUSTED", + "UNKNOWN_ERROR", + "SELF_SIGNED" + ], + "type": "string" + }, + "type": "array" }, - "hasPassword": { - "type": "boolean" + "ipAddress": { + "description": "An ip address", + "example": "14.183.1.32", + "type": "string" }, - "id": { - "format": "uuid", + "lastScanDate": { + "description": "The last scan date", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", "type": "string" }, - "lastname": { + "lastValidatedAttempt": { + "description": "The last validation attempt date", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", "type": "string" }, - "localLoginDisabled": { - "type": "boolean" + "modificationDate": { + "description": "The last modification date", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" }, - "memberedTeams": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "port": { + "description": "A port number", + "example": 443, + "format": "int32", + "type": "integer" }, - "ownedTeams": { + "serviceIds": { + "description": "A collection of service IDs", "items": { "format": "uuid", "type": "string" }, - "type": "array", - "uniqueItems": true - }, - "productRoles": { - "additionalProperties": { - "items": { - "$ref": "#/components/schemas/Role2" - }, - "type": "array", - "uniqueItems": true - }, - "type": "object" + "type": "array" }, - "signupAttributes": { - "additionalProperties": { + "sslProtocols": { + "description": "A collection of ssl protocols", + "example": [ + "TLSv1.1", + "TLSv1.2" + ], + "items": { "type": "string" }, - "type": "object" - }, - "ssoStatus": { - "$ref": "#/components/schemas/SSOStatus" + "type": "array" }, - "systemRoles": { + "sslValidationErrorArguments": { + "description": "A collection of ssl validation error arguments", + "example": [ + "B69950CC5F51EDDF55F36AD2BC898767BC43CC2A", + "24E5796GA7298E78EDE47D6FAED0790E8F464G54" + ], "items": { - "$ref": "#/components/schemas/SystemRole" + "type": "string" }, - "type": "array", - "uniqueItems": true - }, - "userAccountType": { - "$ref": "#/components/schemas/UserAccountType" - }, - "userStatus": { - "$ref": "#/components/schemas/UserStatus" - }, - "userType": { - "$ref": "#/components/schemas/UserType" - }, - "username": { - "type": "string" - } - }, - "type": "object" - }, - "UserMatchingRule": { - "properties": { - "claimName": { - "minLength": 1, - "type": "string" - }, - "operator": { - "$ref": "#/components/schemas/Operator" + "type": "array" }, - "value": { - "minLength": 1, - "type": "string" - } - }, - "required": [ - "claimName", - "operator", - "value" - ], - "type": "object" - }, - "UserPasswordAuthenticationData": { - "properties": { - "password": { - "description": "The user's password of the underlying credentials provider.", - "format": "password", + "sslValidationStatus": { + "description": "SSL validation status", + "enum": [ + "HOSTNAME_NOT_RESOLVABLE", + "NO_CERTIFICATE_PRESENTED", + "INVALID_CERTIFICATE_FOUND", + "UNEXPECTED_CERTIFICATE_FOUND", + "OLD_VERSION_CERTIFICATE_FOUND", + "TARGET_UNREACHABLE", + "UNKNOWN_ERROR", + "OK" + ], + "example": "OK", "type": "string" }, - "userName": { - "description": "The user's name of the underlying credentials provider.", + "sslValidationStatusMessage": { + "description": "SSL validation status message", + "example": "Certificate installation is using older versions of certificate", "type": "string" } }, "type": "object" }, - "UserResponse": { + "CertificateInstanceValidationRequest": { "properties": { - "users": { + "instanceIds": { + "description": "Unique certificate instance id(s) containing numbers, letters and dashes.", + "example": [ + "7860eedb-c140-4354-b0ad-991cc7a7b4d1", + "0b0f6424-30bc-4ed8-ae83-cdeca3eaf60e" + ], "items": { - "$ref": "#/components/schemas/UserInformation2" - }, - "type": "array" - } - }, - "type": "object" - }, - "UserStatus": { - "enum": [ - "PENDING_ACTIVATION", - "ACTIVE", - "INACTIVE" - ], - "type": "string" - }, - "UserType": { - "enum": [ - "EXTERNAL", - "INTERNAL" - ], - "type": "string" - }, - "VSatelliteId": { - "description": "The VSatellite ID", - "format": "uuid", - "type": "string" - }, - "VSatelliteIds": { - "description": "An array of the VSatellite Ids which are connected to the CMS provider.", - "items": { - "$ref": "#/components/schemas/VSatelliteId" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "VisibilityConstraintsInformation": { - "properties": { - "fullAccessDurationDays": { - "format": "int32", - "minimum": 0, - "type": "integer" - }, - "limitedAccessNotificationDays": { - "format": "int32", - "minimum": 0, - "type": "integer" - }, - "limitedVisibilityCertCount": { - "format": "int32", - "minimum": 0, - "type": "integer" - }, - "limitedVisibilityCertInstallPerCertCount": { - "format": "int32", - "minimum": 0, - "type": "integer" - } - }, - "type": "object" - }, - "WebhookProperties": { - "description": "Connector properties for webhook-based notifications.\nWebhook notifications are delivered as HTTP POST requests with a JSON body structured as:\n```json\n{\n \"events\": [\n {\n \"eventName\": \"string\",\n \"eventType\": \"string\",\n \"message\": \"string\",\n \"criticality\": 0,\n \"createdAt\": \"2025-01-15T12:45:00Z\"\n }\n ]\n}\n```\nOnly one event is included per request. The webhook service sets `Content-Type: application/json`, `VaaS-Timestamp`, and, when a `secret` is configured in the connection, `VaaS-Signature`.\n", - "properties": { - "filter": { - "$ref": "#/components/schemas/Filter1" - }, - "target": { - "$ref": "#/components/schemas/Target" - } - }, - "required": [ - "filter", - "target" - ], - "type": "object" - }, - "WeeklyPatternInformation": { - "allOf": [ - { - "$ref": "#/components/schemas/SchedulerPatternInformation2" - }, - { - "properties": { - "daysOfWeek": { - "description": "Days of the week", - "enum": [ - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ], - "items": { - "description": "Days of the week", - "enum": [ - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "duration": { - "description": "Duration in ISO-8601 format", - "enum": [ - "PT8H", - "PT12H", - "PT24H" - ], - "example": "PT24H", - "type": "string" - }, - "startTime": { - "description": "Start time in HH:mm:ss format", - "pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "daysOfWeek", - "duration", - "startTime" - ], - "type": "object" - }, - "WorkType": { - "description": "Defines the type of supported workflow for the plugin.", - "enum": [ - "DISCOVERY", - "CREDENTIAL", - "PROVISIONING", - "ISSUANCE", - "CERTIFICATE_IMPORT" + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "instanceIds" ], - "title": "WorkType", - "type": "string" + "type": "object" }, - "WorkerServiceStatusDetails": { + "CertificateIssuingTemplateInformation1": { "properties": { - "name": { + "certificateAuthority": { + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP", + "CONNECTOR" + ], "type": "string" }, - "status": { + "certificateAuthorityAccountId": { + "format": "uuid", "type": "string" - } - }, - "type": "object" - }, - "WorkerStatus": { - "enum": [ - "DRAFT", - "PAIRED", - "ACTIVE", - "FAILED", - "INACTIVE" - ], - "type": "string" - } - }, - "securitySchemes": { - "tppl-api-key": { - "in": "header", - "name": "tppl-api-key", - "type": "apiKey" - } - } - }, - "info": { - "title": "TLS Protect Cloud API for Strata Cloud Manager", - "description": "Use the TLS Protect Cloud APIs to manage certificates, certificate requests, applications, machine identities, users, teams, event logs, and more.\nThis Open API spec was created for the Strata Cloud Manager platform. \u00a9 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.", - "version": "1.0.0", - "license": { - "name": "MIT", - "url": "https://opensource.org/license/mit" - } - }, - "openapi": "3.0.1", - "paths": { - "/outagedetection/v1/certificates": { - "get": { - "description": "This endpoint allows you to retrieve all your certificates according to a specified criteria. This API provides a quick way to gather certificate details in order to install the certificates where they are needed.\n\nUse the `subject` query parameter to limit the search based on the certificate subject common name.", - "operationId": "certificates_getAll", - "parameters": [ - { - "in": "query", - "name": "ownershipTree", - "schema": { - "default": false, - "type": "boolean" - } }, - { - "in": "query", - "name": "excludeSupersededInstances", - "schema": { - "default": false, - "type": "boolean" - } + "certificateAuthorityProductOptionId": { + "format": "uuid", + "type": "string" }, - { - "description": "Ability to enter regular expression to match specific criteria.", - "in": "query", - "name": "subject", - "schema": { - "type": "string" - } + "companyId": { + "format": "uuid", + "type": "string" }, - { - "description": "Indicates the maximum integer number of certificates returned.", - "in": "query", - "name": "limit", - "schema": { - "default": 1000, - "maximum": 10000, - "minimum": 1, - "type": "number" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } + "creationDate": { + "format": "date-time", + "type": "string" + }, + "csrUploadAllowed": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "driverGeneratedCsr": { + "type": "boolean" + }, + "driverId": { + "format": "uuid", + "type": "string" + }, + "everyoneIsConsumer": { + "type": "boolean" + }, + "extendedKeyUsageValues": { + "items": { + "enum": [ + "SERVER", + "CLIENT" + ], + "type": "string" }, - "description": "Certificate(s) response." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "id": { + "format": "uuid", + "type": "string" + }, + "keyGeneratedByVenafiAllowed": { + "type": "boolean" + }, + "keyPairId": { + "format": "uuid", + "type": "string" + }, + "keyReuse": { + "type": "boolean" + }, + "keyTypes": { + "items": { + "$ref": "#/components/schemas/KeyTypeInformation1" }, - "description": "Request conditions failed." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "locationId": { + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "priority": { + "format": "int32", + "type": "integer" + }, + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation1" + }, + "reason": { + "type": "string" + }, + "recommendedSettings": { + "$ref": "#/components/schemas/RecommendedSettingsInformation1" + }, + "referencingApplicationIds": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve all certificate data", - "tags": [ - "Certificates" - ] - }, - "post": { - "description": "This endpoint allows you to import CA-issued certificates, and optionally include their intermediate and root certificates.", - "operationId": "certificateimports_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateImportRequest1" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateImportResponse1" - } - } + "type": "array" + }, + "resourceConsumerTeamIds": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Certificate imported." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "resourceConsumerUserIds": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed." + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "sanDnsNameRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Import certificates", - "tags": [ - "Certificate Import" - ] - } - }, - "/outagedetection/v1/certificates/{id}": { - "get": { - "description": "This endpoint retrieves certificate data using the **id** parameter to match a specified value.", - "operationId": "certificates_getById", - "parameters": [ - { - "description": "Displays list of **owningUsers**.", - "in": "query", - "name": "ownershipTree", - "schema": { - "default": false, - "type": "boolean" - } + "type": "array" }, - { - "in": "query", - "name": "excludeSupersededInstances", - "schema": { - "default": false, - "type": "boolean" - } + "sanIpAddressRegexes": { + "items": { + "type": "string" + }, + "type": "array" }, - { - "description": "A unique certificate id containing numbers, letters and dashes.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "format": "uuid", + "sanRegexes": { + "items": { "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedCertificateInformation" - } - } }, - "description": "Certificate details matching specified **id**." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "sanRfc822NameRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "sanUniformResourceIdentifierRegexes": { + "items": { + "type": "string" }, - "description": "Certificate was not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "status": { + "enum": [ + "AVAILABLE", + "UNAVAILABLE" + ], + "type": "string" + }, + "subjectCNRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." + "type": "array" + }, + "subjectCValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectLRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectORegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectOURegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectSTRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "systemGenerated": { + "type": "boolean" + }, + "trackingData": { + "$ref": "#/components/schemas/TrackingDataInformation" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve certificate data via id", - "tags": [ - "Certificates" - ] - } - }, - "/outagedetection/v1/certificates/{id}/contents": { - "get": { - "description": "This endpoint downloads a certificate or a certificate chain in a specified format and chain order. This can be useful for troubleshoot purposes for a certificate or certificate chain. This endpoint does not download private key material.", - "operationId": "certificates_getContentsById", - "parameters": [ - { - "description": "Specify an 'accept' header parameter's value", - "in": "header", - "name": "Accept", - "schema": { - "enum": [ - "text/plain", - "application/octet-stream" - ], - "type": "string" - } + "type": "object" + }, + "CertificateIssuingTemplateInformation2": { + "properties": { + "certificateAuthority": { + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP", + "CONNECTOR" + ], + "type": "string" + }, + "certificateAuthorityAccountId": { + "format": "uuid", + "type": "string" + }, + "certificateAuthorityProductOptionId": { + "format": "uuid", + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "csrUploadAllowed": { + "type": "boolean" + }, + "everyoneIsConsumer": { + "type": "boolean" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "keyGeneratedByVenafiAllowed": { + "type": "boolean" + }, + "keyReuse": { + "type": "boolean" + }, + "keyTypes": { + "items": { + "$ref": "#/components/schemas/KeyTypeInformation2" + }, + "type": "array" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "priority": { + "format": "int32", + "type": "integer" }, - { - "description": "A unique certificate id containing numbers, letters and dashes.", - "in": "path", - "name": "id", - "required": true, - "schema": { + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" + }, + "productEntitlement": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + }, + "productEntitlements": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string", + "writeOnly": true + }, + "reason": { + "type": "string" + }, + "recommendedSettings": { + "$ref": "#/components/schemas/RecommendedSettingsInformation2" + }, + "resourceConsumerTeamIds": { + "items": { "format": "uuid", "type": "string" - } + }, + "type": "array", + "uniqueItems": true }, - { - "description": "Indicates the export format. Default is `PEM`.", - "in": "query", - "name": "format", - "schema": { - "enum": [ - "PEM", - "DER" - ], + "resourceConsumerUserIds": { + "items": { + "format": "uuid", "type": "string" - } + }, + "type": "array", + "uniqueItems": true }, - { - "description": "Determines order of certificate chain. Default is End Entity Only (`EE_ONLY`).", - "in": "query", - "name": "chainOrder", - "schema": { - "enum": [ - "EE_ONLY", - "EE_FIRST", - "ROOT_FIRST" - ], + "sanDnsNameRegexes": { + "items": { "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "string" - } - }, - "application/octet-stream": { - "schema": { - "type": "string" - } - }, - "text/plain": { - "schema": { - "type": "string" - } - } }, - "description": "Certificate details matching specified **id**." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "application/octet-stream": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "sanIpAddressRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "application/octet-stream": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "sanRegexes": { + "items": { + "type": "string" }, - "description": "Certificate was not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "application/octet-stream": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Download certificate or certificate chain via", - "tags": [ - "Certificates" - ] - } - }, - "/outagedetection/v1/certificates/validation": { - "post": { - "description": "This endpoint allows you to submit one or more certificates for validation using the **certificateIds** parameter. After the validation completes, you can view the validation results in the web UI. See the [validation documentation](https://docs.venafi.cloud/CSH_validation_overview) for more information.", - "operationId": "certificates_validation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateValidationRequest" - } - } - } - }, - "responses": { - "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateValidationResponse" - } - } + "sanRfc822NameRegexes": { + "items": { + "type": "string" }, - "description": "Certificates submitted for validation response." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "sanUniformResourceIdentifierRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "status": { + "enum": [ + "AVAILABLE", + "UNAVAILABLE" + ], + "type": "string" + }, + "subjectCNRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Submit certificates for validation", - "tags": [ - "Certificates" - ] - } - }, - "/outagedetection/v1/certificates/retirement": { - "post": { - "description": "This endpoint retires one or more certificates using the **certificateIds** parameter to match a specified value.", - "operationId": "certificateretirement_retireCertificates", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRetirementRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } + "type": "array" + }, + "subjectCValues": { + "items": { + "type": "string" }, - "description": "Certificate retirement response" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "subjectLRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retire certificates", - "tags": [ - "Certificates" - ] - } - }, - "/outagedetection/v1/certificates/recovery": { - "post": { - "description": "This endpoint recovers previously retired certificates and assigns them to a specified application.", - "operationId": "certificateretirement_recoverCertificates", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRecoveryRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } + "subjectORegexes": { + "items": { + "type": "string" }, - "description": "Certificate recovery response." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "subjectOURegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "subjectSTRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." + "type": "array" + }, + "systemGenerated": { + "type": "boolean" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Recover retired certificates", - "tags": [ - "Certificates" - ] - } - }, - "/outagedetection/v1/certificates/deletion": { - "post": { - "description": "This endpoint deletes retired certificates using the **certificateIds** parameter to match a specific value.", - "operationId": "certificateretirement_deleteCertificates", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateDeletionRequest" - } - } + "type": "object" + }, + "CertificateIssuingTemplateRequest": { + "properties": { + "certificateAuthority": { + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP", + "CONNECTOR" + ], + "type": "string" }, - "required": true - }, - "responses": { - "204": { - "description": "Response of \"No Content\" is a successful deletion of the certificate." + "certificateAuthorityProductOptionId": { + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "csrUploadAllowed": { + "type": "boolean" + }, + "description": { + "maxLength": 1024, + "type": "string" + }, + "driverGeneratedCsr": { + "type": "boolean" + }, + "driverId": { + "format": "uuid", + "type": "string" + }, + "everyoneIsConsumer": { + "type": "boolean" + }, + "extendedKeyUsageValues": { + "items": { + "enum": [ + "SERVER", + "CLIENT" + ], + "type": "string" }, - "description": "Request conditions failed." + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "keyGeneratedByVenafiAllowed": { + "type": "boolean" + }, + "keyPairId": { + "format": "uuid", + "type": "string" + }, + "keyReuse": { + "type": "boolean" + }, + "keyTypes": { + "items": { + "$ref": "#/components/schemas/KeyTypeParameters1" }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Delete retired certificates", - "tags": [ - "Certificates" - ] - } - }, - "/outagedetection/v1/certificatesearch": { - "post": { - "description": "This endpoint retrieves certificate data according to specified search criteria based on commonly used field search parameters. Some examples are `signatureHashAlgorithm`, `validityEnd`, and `issuerCN`. For more information, see [common search parameters](https://docs.venafi.cloud/api/about-api-search-fields/).\n", - "operationId": "certificates_search_getByExpression", - "parameters": [ - { - "in": "query", - "name": "ownershipTree", - "schema": { - "default": false, - "type": "boolean" - } + "type": "array" + }, + "locationId": { + "format": "uuid", + "type": "string" + }, + "name": { + "maxLength": 64, + "type": "string" + }, + "priority": { + "format": "int32", + "type": "integer" + }, + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation1" + }, + "recommendedSettings": { + "$ref": "#/components/schemas/RecommendedSettingsRequest" + }, + "resourceConsumerTeamIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "resourceConsumerUserIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "sanIpAddressRegexes": { + "items": { + "type": "string" + }, + "type": "array" }, - { - "in": "query", - "name": "excludeSupersededInstances", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter2" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/CertificateResponse" - } - } + "sanRegexes": { + "items": { + "type": "string" }, - "description": "Certificate response." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "sanRfc822NameRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "sanUniformResourceIdentifierRegexes": { + "items": { + "type": "string" }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve certificate data matching search criteria", - "tags": [ - "Certificates" - ] - } - }, - "/outagedetection/v1/certificateinstances": { - "get": { - "description": "Use this endpoint allows you to retrieve certificate instances according to specified criteria. Total certificate instances are the sum of the number of certificate installations, plus the total number of certificates that have no installations. Trusted CA certificates are not counted. For more information, see [certificate instances](https://docs.venafi.cloud/CSH_view_instances).\n\nUse query parameters to limit your search based on certificate criteria.", - "operationId": "certificateinstances_getAll", - "parameters": [ - { - "in": "query", - "name": "source", - "schema": { - "enum": [ - "UNKNOWN", - "USER_PROVIDED", - "USER_IMPORTED", - "USER_SCAN", - "TRUSTNET_SCAN", - "ON_PREM_CA_IMPORT", - "EXTERNAL_CA_IMPORT", - "FILE_IMPORT", - "EXTERNAL_SCAN", - "DOMAIN_SCAN", - "SMART_SCAN_INTERNAL", - "SMART_SCAN_EXTERNAL", - "SMART_VALIDATION_INTERNAL", - "SMART_VALIDATION_EXTERNAL", - "MACHINE_DISCOVERY", - "KUBERNETES_DISCOVERY", - "AWS_DISCOVERY", - "AZURE_DISCOVERY", - "GCP_DISCOVERY" - ], + "type": "array" + }, + "subjectCNRegexes": { + "items": { "type": "string" - } + }, + "type": "array" }, - { - "in": "query", - "name": "ipAddress", - "schema": { + "subjectCValues": { + "items": { "type": "string" - } + }, + "type": "array" }, - { - "in": "query", - "name": "hostname", - "schema": { + "subjectLRegexes": { + "items": { "type": "string" - } + }, + "type": "array" }, - { - "in": "query", - "name": "limit", - "schema": { - "format": "int32", - "type": "integer" - } + "subjectORegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectOURegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "subjectSTRegexes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "trackingData": { + "$ref": "#/components/schemas/TrackingDataInformation" } + }, + "required": [ + "certificateAuthority", + "certificateAuthorityProductOptionId", + "keyReuse", + "keyTypes", + "name", + "product" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" - } - } + "type": "object" + }, + "CertificateIssuingTemplateResponse": { + "properties": { + "certificateIssuingTemplates": { + "items": { + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" }, - "description": "Certificate response." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "type": "array" + } + }, + "type": "object" + }, + "CertificateOwnership": { + "properties": { + "owningContainers": { + "items": { + "$ref": "#/components/schemas/ExtendedApplicationOwnership" }, - "description": "Request conditions failed." + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "CertificateRecoveryRequest": { + "properties": { + "applicationIds": { + "description": "A collection of applications UUIDs", + "example": [ + "47c9d920-da21-11ed-a63c-d508f08eeaa0", + "9303e940-df9d-11ed-8850-f18176fc5513" + ], + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "certificateIds": { + "description": "A collection of certificates UUIDs", + "example": [ + "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", + "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" + ], + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "certificateIds" ], - "summary": "Retrieve Certificate Instances", - "tags": [ - "Certificate Installations" - ] - } - }, - "/outagedetection/v1/certificateinstances/{id}": { - "get": { - "description": "This endpoint retrieves a certificate instance using the **id** parameter to match a specified value.\n", - "operationId": "certificateinstances_getById", - "parameters": [ - { - "description": "A unique id containing numbers, letters and dashes. This parameter is listed as **certificateInstanceId** in the request and response.", - "in": "path", - "name": "id", - "required": true, - "schema": { + "type": "object" + }, + "CertificateRequestApprovalConditionsFilterRuleInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application ids the rule will be applicable to", + "format": "uuid", + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedCertificateInstanceInformation" - } - } }, - "description": "Certificate instances response." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "certificateAuthorityAccountIds": { + "description": "A collection of certificate authority account ids the rule will be applicable to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "certificateIssuingTemplateIds": { + "description": "A collection of certificate issuing template ids the rule will be applicable to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Certificate installation not found." + "type": "array" + } + }, + "type": "object" + }, + "CertificateRequestApprovalExceptionsFilterRuleInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application ids the rule won't be applied to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "requestors": { + "description": "A collection of approvers, specified by type and id, for which the rule won't be applied", + "items": { + "$ref": "#/components/schemas/ApproverProperty" }, - "description": "Request conditions failed." + "type": "array", + "uniqueItems": true } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "CertificateRequestApprovalRuleDeleteResponseOpenApi": { + "properties": { + "id": { + "description": "Approval rule `id`", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "type": "string" } - ], - "summary": "Retrieve certificate instance via id", - "tags": [ - "Certificate Installations" - ] - } - }, - "/outagedetection/v1/certificateinstances/validation": { - "post": { - "description": "This endpoint allows you to submit one or more certificate instances for validation using the **instanceIds** parameter. Why is certificate validation important? Because security, compliance, and technological innovations introduce new criteria for the validation of certificates and the servers that host them, Certificate Manager - SaaS uses validation techniques to ensure that your certificates remain valid and are being used properly.", - "operationId": "certificateinstances_validation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateInstanceValidationRequest" - } - } + }, + "type": "object" + }, + "CertificateRequestApprovalRuleOpenApi": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "type": "array", + "uniqueItems": true }, - "required": true + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "format": "int32", + "type": "integer" + }, + "autoApproveOnRenew": { + "default": false, + "description": "Automatically approve when renew a certificate", + "type": "boolean" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" + }, + "creationDate": { + "description": "The date a approval rule was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "$ref": "#/components/schemas/ApproverPropertyOpenApi" + }, + "id": { + "description": "Approval rule `id`", + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "description": "The date a approval rule was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "type": "string" + }, + "priority": { + "description": "Priority of the rule", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of the approval rule", + "type": "string" + } }, - "responses": { - "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Response" - } - } + "type": "object" + }, + "CertificateRequestApprovalRulesRequest": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" }, - "description": "Response of \"Accepted\" is a successful submission of the certificate(s)." + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "example": 2, + "format": "int32", + "minimum": 1, + "type": "integer" + }, + "autoApproveOnRenew": { + "default": false, + "description": "Automatically approve when renew a certificate", + "type": "boolean" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" + }, + "continueProcessingOnException": { + "default": false, + "description": "Continue with next approval rules when match an approval rule exception condition", + "type": "boolean" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "description": "UUID of the final approver", + "example": "8268d820-a08d-11ed-bbc0-252385d6d390", + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request conditions failed." + "name": { + "description": "Approval rule name", + "example": "Approval rule for built in CA", + "maxLength": 64, + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request conditions failed." + "type": { + "description": "The type of the approval rule", + "enum": [ + "ALL", + "AT_LEAST" + ], + "example": "AT_LEAST", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "approvers", + "conditions", + "name", + "type" ], - "summary": "Submit certificates for validation", - "tags": [ - "Certificate Installations" - ] - } - }, - "/outagedetection/v1/certificateinstancesearch": { - "post": { - "description": "Use this endpoint to retrieve certificate instance data according to specified search criteria based on commonly used field search parameters. Some examples are `signatureHashAlgorithm`, `validityEnd`, and `issuerCN`. For more information, see [common search parameters](https://docs.venafi.cloud/api/about-api-search-fields/#common-search-parameters)", - "operationId": "certificateinstances_search_getByExpression", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter2" - } - } + "type": "object" + }, + "CertificateRequestApprovalRulesResponseOpenApi": { + "properties": { + "approvalRules": { + "items": { + "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" + }, + "type": "array" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ExtendedCertificateInstanceResponse" - } - } + "type": "object" + }, + "CertificateRequestApprovalRulesUpdateRequest": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" }, - "description": "Certificate Instances Response" + "minItems": 1, + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request Conditions Failed" + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "example": 2, + "format": "int32", + "minimum": 1, + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request Conditions Failed" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve certificate instance data matching search", - "tags": [ - "Certificate Installations" - ] - } - }, - "/v1/integrationservices": { - "get": { - "description": "This endpoint retrieves a list of all integration services, including certificate discovery services.", - "operationId": "integrationsservices_getAll", - "parameters": [ - { - "description": "This shows the total number of services.", - "in": "query", - "name": "totalCount", - "schema": { - "default": false, - "type": "boolean" - } + "autoApproveOnRenew": { + "default": false, + "description": "Automatically approve when renew a certificate", + "type": "boolean" }, - { - "description": "A unique id of a vSatellite in UUID format. Passing this id returns the services running on a given vSatellite.", - "in": "query", - "name": "edgeInstanceId", - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntegrationServiceDetailsResponse" - } - } - }, - "description": "Integration Services matching the specified id." + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } - }, - "description": "Request conditions failed." + "conditions": { + "$ref": "#/components/schemas/CertificateRequestApprovalConditionsFilterRuleInformation" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } - }, - "description": "Request conditions failed." + "continueProcessingOnException": { + "default": false, + "description": "Continue with next approval rules when match an approval rule exception condition", + "type": "boolean" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRequestApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "description": "UUID of the final approver", + "example": "8268d820-a08d-11ed-bbc0-252385d6d390", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "example": "Approval rule for built in CA", + "maxLength": 64, + "type": "string" + }, + "priority": { + "description": "Rule priority. The order in which the rules will be executed. Starts from 1 (highest priority).", + "example": 5, + "minimum": 1, + "type": "number" + }, + "type": { + "description": "The type of the approval rule", + "enum": [ + "ALL", + "AT_LEAST" + ], + "example": "AT_LEAST", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "approvers", + "conditions", + "name", + "type" ], - "summary": "Retrieve all integration services", - "tags": [ - "Certificate Discovery" - ] + "type": "object" }, - "post": { - "description": "This endpoint creates a new integration service. Use this API to add services such as basic, enhanced, or internet discovery.", - "operationId": "integrationsservices_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntegrationServiceCreationRequest" - } - } + "CertificateRequestDocumentInformation": { + "properties": { + "applicationId": { + "description": "UUID of an application ID", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" }, - "description": "Details of the service to be created", - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntegrationServiceInformation" - } - } + "approvedIds": { + "description": "A collection of IDs of all users that have already approved", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Integration service created." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } + "approverTeamIds": { + "description": "A collection of all team IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Create an integration service", - "tags": [ - "Certificate Discovery" - ] - } - }, - "/v1/integrationservices/{id}": { - "get": { - "description": "This endpoint retrieves an integration service using the id parameter to match a specified value. Use `/v1/integrationservices` to get the ids for integration services.", - "operationId": "integrationsservices_getById", - "parameters": [ - { - "description": "A unique integration service id in UUID format.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a service", + "type": "array" + }, + "approverUserIds": { + "description": "A collection of all user IDs that are configured as approvers", + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntegrationServiceInformation" - } - } }, - "description": "Integration Services matching the specified id." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } + "caOrderId": { + "description": "A CA order ID", + "example": "63364861", + "type": "string" + }, + "certificateIds": { + "description": "A collection of certificate ids", + "example": [ + "1441c6f0-9136-11ed-bd65-ed926a033704", + "12257370-9132-11ed-bd65-ed926a033704" + ], + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } + "certificateIssuingTemplateId": { + "description": "UUID of certificate issuing template", + "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "UUID of the certificate request's owner", + "example": "88932c30-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date a certificate request was created", + "example": "2022-01-20T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "customAttributes": { + "$ref": "#/components/schemas/CustomAttributes2" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation7" + }, + "finalApproverId": { + "description": "UUID of the final approver if configured", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "UUID of a certificate request", + "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "keyCurve": { + "description": "Certificate request key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P521", + "type": "string" + }, + "keyLength": { + "description": "Certificate request key length", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyType": { + "description": "Certificate request key type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "RSA", + "type": "string" + }, + "modificationDate": { + "description": "The date a certificate request was modified", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The status of the certificate request", + "enum": [ + "NEW", + "PENDING", + "PENDING_APPROVAL", + "PENDING_FINAL_APPROVAL", + "REJECTED_APPROVAL", + "REQUESTED", + "ISSUED", + "REJECTED", + "CANCELLED", + "REVOKED", + "FAILED", + "DELETED" + ], + "example": "ISSUED", + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData2" + }, + "subjectCN": { + "description": "Certificate request subject CN", + "example": "venafi.com", + "type": "string" + }, + "subjectDN": { + "description": "Certificate request subject DN", + "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "test", + "category:security" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRequestDocumentResponse": { + "properties": { + "certificateRequests": { + "description": "A collection of certificate request information", + "example": [ + { + "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", + "caOrderId": "3a:5f:7e:9f:8c:e4:b6:f7:25:a7:81:0d:f0:ac:28:ec:fe:05:9b:30", + "certificateIds": [ + "a27dfc10-c357-11ed-946f-7db55f9ae03e", + "a275beb0-c357-11ed-946f-7db55f9ae03e", + "a24c16a0-c357-11ed-946f-7db55f9ae03e" + ], + "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", + "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", + "companyId": "98996d90-b797-11ed-a508-c13aa0641666", + "creationDate": "2023-03-15T17:34:26.466+00:00", + "id": "a1c0c690-c357-11ed-a00c-e3953fcf04eb", + "keyLength": 4096, + "keyType": "RSA", + "modificationDate": "2023-03-15T17:34:27.479+00:00", + "status": "ISSUED", + "subjectAlternativeNamesByType": { + "dNSName": [ + "localhost" + ] + }, + "subjectCN": "localhost", + "subjectDN": "cn=localhost,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", + "validityPeriod": "P10D" } + ], + "items": { + "$ref": "#/components/schemas/CertificateRequestDocumentInformation" }, - "description": "Integration service not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } - }, - "description": "Request conditions failed." + "numFound": { + "description": "The number of certificate requests that were found", + "example": 10, + "format": "int64", + "type": "integer" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve an integration service via id", - "tags": [ - "Certificate Discovery" - ] + "type": "object" }, - "delete": { - "description": "This endpoint deletes an integration service using the id parameter to match a specified value.", - "operationId": "integrationsservices_delete", - "parameters": [ - { - "description": "A unique integration service id containing numbers, letters and dashes.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a service", + "CertificateRequestInformation1": { + "properties": { + "caOrderId": { + "description": "A CA order ID", + "example": "63364861", + "type": "string" + }, + "certificateIds": { + "description": "A collection of certificate IDs", + "example": [ + "1441c6f0-9136-11ed-bd65-ed926a033704", + "12257370-9132-11ed-bd65-ed926a033704" + ], + "items": { "format": "uuid", "type": "string" - } + }, + "type": "array" }, - { - "description": "Option to chose to retire the certificates discovered by this service. Default is **false**.", - "in": "query", - "name": "retireCertificates", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "204": { - "description": "Integration Service Deleted" + "certificateIssuingTemplateId": { + "description": "UUID of a certificate issuing template", + "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } - }, - "description": "Request conditions failed." + "certificateName": { + "description": "A certificate name", + "example": "venafi.com", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } - }, - "description": "Integration service not found." + "certificateOwnerUserId": { + "description": "UUID of the certificate request's owner", + "example": "88932c30-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } - }, - "description": "Request conditions failed." + "certificateSigningRequest": { + "description": "A certificate signing request (CSR) in PEM format", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date a certificate request was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "customAttributes": { + "$ref": "#/components/schemas/CustomAttributes1" + }, + "dekHash": { + "description": "A certificate dek hash", + "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", + "type": "string" + }, + "encryptedPrivateKey": { + "format": "byte", + "type": "string" + }, + "encryptionDetails": { + "$ref": "#/components/schemas/EncryptionDetails" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation9" + }, + "id": { + "description": "UUID of a certificate request", + "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "keyCurve": { + "description": "Certificate request key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P521", + "type": "string" + }, + "keyLength": { + "description": "Certificate request key length", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyType": { + "description": "Certificate request key type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "RSA", + "type": "string" + }, + "modificationDate": { + "description": "The date a certificate request was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation1" + }, + "productEntitlement": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + }, + "status": { + "description": "The status of a certificate request", + "enum": [ + "NEW", + "PENDING", + "PENDING_APPROVAL", + "PENDING_FINAL_APPROVAL", + "REJECTED_APPROVAL", + "REQUESTED", + "ISSUED", + "REJECTED", + "CANCELLED", + "REVOKED", + "FAILED", + "DELETED" + ], + "example": "ISSUED", + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData1" + }, + "subjectDN": { + "description": "Certificate request subject DN", + "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Delete an integration service", - "tags": [ - "Certificate Discovery" - ] + "type": "object" }, - "patch": { - "description": "This endpoint is used to update specific fields in an integration service. Only the fields that are specified in the request will be updated. Leaving the **edgeInstancesIds** parameter value empty will dissociate the vSatellites from the integration service.", - "operationId": "integrationsservices_update", - "parameters": [ - { - "description": "A unique integration service id containing in UUID format.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "Integration Service ID", + "CertificateRequestInformation2": { + "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" + }, + "applicationId": { + "description": "UUID of an application ID", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" + }, + "approvedIds": { + "description": "A collection of IDs of all users that have already approved", + "items": { "format": "uuid", "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntegrationServiceUpdateRequest" - } - } - }, - "description": "Details of the service to be updated", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntegrationServiceInformation" - } - } }, - "description": "Updated integration service(s) matching the specified id." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } + "approverTeamIds": { + "description": "A collection of all team IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed." + "type": "array", + "uniqueItems": true }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } + "approverUserIds": { + "description": "A collection of all user IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Integration service not found." + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse1" - } - } + "caOrderId": { + "description": "A CA order ID", + "example": "63364861", + "type": "string" + }, + "certificateIds": { + "description": "A collection of certificate IDs", + "example": [ + "1441c6f0-9136-11ed-bd65-ed926a033704", + "12257370-9132-11ed-bd65-ed926a033704" + ], + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update integration service properties", - "tags": [ - "Certificate Discovery" - ] - } - }, - "/v1/certificates/imports": { - "post": { - "description": "Import a list of certificates and their associated private key pairs", - "operationId": "certificates_import", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateImportRequest2" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateImportResponse2" - } + "type": "array" + }, + "certificateIssuingTemplateId": { + "description": "UUID of a certificate issuing template", + "example": "ce9c2cc0-9131-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "UUID of the certificate request's owner", + "example": "88932c30-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "certificateSigningRequest": { + "description": "A certificate signing request (CSR) in PEM format", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" }, - "description": "Certificates and private keys imported" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse7" - } - } + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "creationDate": { + "description": "The date a certificate request was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "customAttributesInformation": { + "$ref": "#/components/schemas/CustomAttributesInformation" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation7" + }, + "finalApproverId": { + "description": "UUID of the final approver if configured", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "UUID of a certificate request", + "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", + "format": "uuid", + "type": "string" + }, + "keyCurve": { + "description": "Certificate request key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P521", + "type": "string" + }, + "keyLength": { + "description": "Certificate request key length", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyType": { + "description": "Certificate request key type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "RSA", + "type": "string" + }, + "modificationDate": { + "description": "The date a certificate request was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The status of a certificate request", + "enum": [ + "NEW", + "PENDING", + "PENDING_APPROVAL", + "PENDING_FINAL_APPROVAL", + "REJECTED_APPROVAL", + "REQUESTED", + "ISSUED", + "REJECTED", + "CANCELLED", + "REVOKED", + "FAILED", + "DELETED" + ], + "example": "ISSUED", + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData2" + }, + "subjectDN": { + "description": "Certificate request subject DN", + "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "test", + "category:security" + ], + "items": { + "type": "string" }, - "description": "Request Conditions Failed" + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse7" - } - } - }, - "description": "Request Conditions Failed" + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Import a list of certificates and", - "tags": [ - "Private Key Import" - ] - } - }, - "/v1/certificates/imports/{id}": { - "get": { - "description": "Retrieve import details", - "operationId": "certificatesImport_getByImportId", - "parameters": [ - { - "description": "Import id associated with the result of importing a list of certificates and private keys", - "in": "path", - "name": "id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateImportStatusDetailResponse" - } - } - }, - "description": "Import details matching the specified import id" + "type": "object" + }, + "CertificateRequestRequest": { + "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse7" - } - } - }, - "description": "Request Conditions Failed" + "applicationId": { + "description": "Application UUID", + "example": "b00701b0-886f-11ed-9f39-3d586ab80cf2", + "format": "uuid", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse7" - } + "certificateIssuingTemplateId": { + "description": "Certificate issuing template UUID", + "example": "a305d810-886f-11ed-9ccf-0dbf748eb1ae", + "format": "uuid", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "Certificate owner UUID", + "example": "a305d810-886f-11ed-9ccf-0dbf748eb1ae", + "format": "uuid", + "type": "string" + }, + "certificateSigningRequest": { + "description": "A certificate signing request(CSR) in PEM format. Required when reuseCSR and isVaaSGenerated are set to false.", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" }, - "description": "Import details not found" + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse7" - } - } + "csrAttributes": { + "$ref": "#/components/schemas/CSRAttributesInformation" + }, + "customAttributes": { + "$ref": "#/components/schemas/CustomAttributesInformation" + }, + "existingCertificateId": { + "description": "Existing certificate UUID. Required when reuseCSR is set to true.", + "example": "b505d810-886f-11ed-9ccf-0dbf748eb1ae", + "format": "uuid", + "type": "string" + }, + "isVaaSGenerated": { + "description": "Specify whether VaaS should generate the request.", + "example": true, + "type": "boolean" + }, + "reuseCSR": { + "description": "Specifies whether an existing CSR is reused", + "example": true, + "type": "boolean" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "test", + "category:security" + ], + "items": { + "type": "string" }, - "description": "Request Conditions Failed" + "type": "array", + "uniqueItems": true + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "applicationId", + "certificateIssuingTemplateId", + "isVaaSGenerated" ], - "summary": "Retrieve import details", - "tags": [ - "Private Key Import" - ] - } - }, - "/outagedetection/v1/certificaterequests": { - "get": { - "description": "Retrieves the details of all certificate requests.", - "operationId": "certificaterequests_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestResponse" - } - } - }, - "description": "The response body contains the details of the certificate requests" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." - }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } + "type": "object" + }, + "CertificateRequestResponse": { + "properties": { + "certificateRequests": { + "description": "A collection of certificate information", + "example": [ + { + "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", + "caOrderId": "3a:5f:7e:9f:8c:e4:b6:f7:25:a7:81:0d:f0:ac:28:ec:fe:05:9b:30", + "certificateIds": [ + "a27dfc10-c357-11ed-946f-7db55f9ae03e", + "a275beb0-c357-11ed-946f-7db55f9ae03e", + "a24c16a0-c357-11ed-946f-7db55f9ae03e" + ], + "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", + "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", + "companyId": "98996d90-b797-11ed-a508-c13aa0641666", + "creationDate": "2023-03-15T17:34:26.466+00:00", + "id": "a1c0c690-c357-11ed-a00c-e3953fcf04eb", + "keyLength": 4096, + "keyType": "RSA", + "modificationDate": "2023-03-15T17:34:27.479+00:00", + "status": "ISSUED", + "subjectAlternativeNamesByType": { + "dNSName": [ + "localhost" + ] + }, + "subjectCN": "localhost", + "subjectDN": "cn=localhost,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", + "validityPeriod": "P10D" + }, + { + "applicationId": "813700b0-c357-11ed-aea1-99c5a9067cde", + "caOrderId": "6f:b7:27:c8:2c:bd:1a:b0:6f:43:fb:8a:6b:5b:a3:a6:c2:52:38:85", + "certificateIds": [ + "b767aef0-c357-11ed-946f-7db55f9ae03e", + "a275beb0-c357-11ed-946f-7db55f9ae03e", + "a24c16a0-c357-11ed-946f-7db55f9ae03e" + ], + "certificateIssuingTemplateId": "73a22290-c357-11ed-a00c-e3953fcf04eb", + "certificateOwnerUserId": "9bf1e760-b797-11ed-a508-c13aa0641666", + "companyId": "98996d90-b797-11ed-a508-c13aa0641666", + "creationDate": "2023-03-15T17:35:02.384+00:00", + "id": "b7502f50-c357-11ed-a00c-e3953fcf04eb", + "keyLength": 4096, + "keyType": "RSA", + "modificationDate": "2023-03-15T17:35:02.544+00:00", + "status": "ISSUED", + "subjectAlternativeNamesByType": { + "dNSName": [ + "venafi.com" + ] + }, + "subjectCN": "venafi.com", + "subjectDN": "cn=venafi.com,ou=devops,o=venafi,c=MX,st=Yucatan,l=Merida", + "validityPeriod": "P12D" } + ], + "items": { + "$ref": "#/components/schemas/CertificateRequestInformation2" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get the details of all certificate", - "tags": [ - "Certificate Request" - ] + "type": "object" }, - "post": { - "description": "Creates a certificate request for the specified `applicationId` and using the specified `certificateIssuingTemplateId`. Indicate a renewal by specifying `existingCertificateId`. Set `isVaaSGenerated` to true, specify `csrAttributes` to request a certificate using *Automated Secure Keypair*. The `validityPeriod` value must be in the ISO8601 format for time duration. Examples of ISO8601 format time duration include _P1Y_ for one year, _P10D_ for ten days, and _PT12H_ for twelve hours.", - "operationId": "certificaterequests_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestRequest" + "CertificateRequestResubmissionRequest": { + "properties": { + "certificateIssuingTemplateId": { + "description": "Certificate issuing template UUID", + "example": "a305d810-886f-11ed-9ccf-dbf748eb1ae0", + "format": "uuid", + "type": "string" + }, + "certificateOwnerUserId": { + "description": "Certificate owner UUID", + "example": "a305d810-886f-11ed-4bbe-dbf748eb1ae0", + "format": "uuid", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" } - } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" + }, + "type": "array" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P10M", + "type": "string" } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestResponse" - } - } + "type": "object" + }, + "CertificateResponse": { + "properties": { + "certificates": { + "description": "A collection of certificates", + "items": { + "$ref": "#/components/schemas/CertificateInformation" }, - "description": "A certificate request has been created, and its details can be found in the response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "The request is either incomplete or malformed." + "count": { + "description": "The number of certificates.", + "example": 2, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CertificateRetirementRequest": { + "properties": { + "addToBlocklist": { + "description": "This parameter ensures the deleted certificate will not be discovered again.", + "example": true, + "type": "boolean" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "certificateIds": { + "description": "A collection of certificates UUIDs", + "example": [ + "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", + "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" + ], + "items": { + "format": "uuid", + "type": "string" }, - "description": "The request is either incomplete or malformed." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "certificateIds" ], - "summary": "Create a certificate request", - "tags": [ - "Certificate Request" - ] - } - }, - "/outagedetection/v1/certificaterequests/{id}": { - "get": { - "description": "Retrieves the details of the certificate request with the specified `id`.", - "operationId": "certificaterequests_getById", - "parameters": [ - { - "description": "UUID of a Certificate Request", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Certificate Request", + "type": "object" + }, + "CertificateRevocationApprovalConditionsFilterRuleInformation": { + "properties": { + "certificateAuthorityAccountIds": { + "description": "A collection of certificate authority account ids the rule will be applicable to", + "format": "uuid", + "items": { "format": "uuid", "type": "string" - } + }, + "minItems": 1, + "type": "array" } + }, + "required": [ + "certificateAuthorityAccountIds" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestInformation1" - } - } + "type": "object" + }, + "CertificateRevocationApprovalExceptionsFilterRuleInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application ids the rule won't be applied to", + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "A certificate request has been found, and its details are in the response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "requestors": { + "description": "A collection of approvers, specified by type and id, for which the rule won't be applied", + "items": { + "$ref": "#/components/schemas/ApproverProperty" }, - "description": "The request is either incomplete or malformed." + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "CertificateRevocationApprovalRuleDeleteResponseOpenApi": { + "properties": { + "id": { + "description": "Approval rule `id`", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRevocationApprovalRuleOpenApi": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" + }, + "type": "array", + "uniqueItems": true + }, + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "format": "int32", + "type": "integer" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since revoke request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" + }, + "creationDate": { + "description": "The date a approval rule was created", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "$ref": "#/components/schemas/ApproverPropertyOpenApi" + }, + "id": { + "description": "Approval rule `id`", + "format": "uuid", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "The certificate request was not found." + "modificationDate": { + "description": "The date a approval rule was modified", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "The request is either incomplete or malformed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get a certificate request details", - "tags": [ - "Certificate Request" - ] - } - }, - "/outagedetection/v1/certificaterequests/{id}/resubmission": { - "post": { - "description": "Resubmits the certificate request that has the specified `id`.", - "operationId": "certificaterequests_resubmitById", - "parameters": [ - { - "description": "UUID of a Certificate Request", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Certificate Request", - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestResubmissionRequest" - } - } + "name": { + "description": "Approval rule name", + "type": "string" + }, + "priority": { + "description": "Priority of the rule", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of the approval rule", + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestResponse" - } - } + "type": "object" + }, + "CertificateRevocationApprovalRulesRequest": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" }, - "description": "Certificate Request was resubmitted; details in response body." + "minItems": 1, + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "example": 2, + "format": "int32", + "minimum": 1, + "type": "integer" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Certificate Request not found." + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since revocation request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "conditions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" + }, + "continueProcessingOnException": { + "default": false, + "description": "Continue with next approval rules when match an approval rule exception condition", + "type": "boolean" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "description": "UUID of the final approver", + "example": "8268d820-a08d-11ed-bbc0-252385d6d390", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Approval rule name", + "example": "Approval rule for built in CA", + "maxLength": 64, + "type": "string" + }, + "type": { + "description": "The type of the approval rule", + "enum": [ + "ALL", + "AT_LEAST" + ], + "example": "AT_LEAST", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "approvers", + "conditions", + "name", + "type" ], - "summary": "Resubmit a certificate request", - "tags": [ - "Certificate Request" - ] - } - }, - "/outagedetection/v1/certificaterequests/validation": { - "post": { - "description": "This operation validates a proposed certificate request without actually submitting it.Checks for compliance with the specified issuing template and verifies all other references are valid (e.g., `existingCertificateId` is the UUID of an inventory certificate).", - "operationId": "certificaterequests_validation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestRequest" - } - } + "type": "object" + }, + "CertificateRevocationApprovalRulesResponseOpenApi": { + "properties": { + "approvalRules": { + "items": { + "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" + }, + "type": "array" } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificationRequestInformation" - } - } + "type": "object" + }, + "CertificateRevocationApprovalRulesUpdateRequest": { + "properties": { + "approvers": { + "description": "A collection of approvers specified by type and id", + "items": { + "$ref": "#/components/schemas/ApproverProperty" }, - "description": "Certificate Request was validated." + "minItems": 1, + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "atLeast": { + "description": "If the type of the approval is AT_LEAST then specify how many people have to approve", + "example": 2, + "format": "int32", + "minimum": 1, + "type": "integer" + }, + "autoRejectionThreshold": { + "description": "Auto rejection threshold. After the defined number of days since revocation request creation, the request is automatically rejected, if it is not approved", + "example": 5, + "maximum": 99, + "minimum": 1, + "type": "number" + }, + "conditions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalConditionsFilterRuleInformation" + }, + "continueProcessingOnException": { + "default": false, + "description": "Continue with next approval rules when match an approval rule exception condition", + "type": "boolean" + }, + "exceptions": { + "$ref": "#/components/schemas/CertificateRevocationApprovalExceptionsFilterRuleInformation" + }, + "finalApprover": { + "description": "UUID of the final approver", + "example": "8268d820-a08d-11ed-bbc0-252385d6d390", + "format": "uuid", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "name": { + "description": "Approval rule name", + "example": "Approval rule for built in CA", + "maxLength": 64, + "type": "string" + }, + "priority": { + "description": "Rule priority. The order in which the rules will be executed. Starts from 1 (highest priority).", + "example": 5, + "minimum": 1, + "type": "number" + }, + "type": { + "description": "The type of the approval rule", + "enum": [ + "ALL", + "AT_LEAST" + ], + "example": "AT_LEAST", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "approvers", + "conditions", + "name", + "type" ], - "summary": "Validate a certificate request", - "tags": [ - "Certificate Request" - ] - } - }, - "/outagedetection/v1/certificaterequestssearch": { - "post": { - "description": "Retrieves the details of certificate requests that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", - "operationId": "getCertificateRequestsByExpression", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Filter2" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestDocumentResponse" - } - } - }, - "description": "The response body contains the details of the certificate requests." + "type": "object" + }, + "CertificateUsageMetadata": { + "properties": { + "appName": { + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "The request is either incomplete or malformed." + "automationMetadata": { + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "The request is either incomplete or malformed." + "nodeName": { + "type": "string" } }, - "summary": "Get the details of certificate requests", - "tags": [ - "Certificate Request" - ] - } - }, - "/v1/certificateissuingtemplates": { - "get": { - "description": "Retrieves the details of issuing templates ordered by `priority` and `certificateAuthority`.", - "operationId": "certificateissuingtemplate_getAll", - "parameters": [ - { - "description": "UUID of a Certificate Authority Account.", - "in": "query", - "name": "certificateAuthorityAccountId", - "schema": { + "type": "object" + }, + "CertificateValidationRequest": { + "properties": { + "certificateIds": { + "description": "A collection of certificates UUIDs ", + "example": [ + "f2b42d60-df9c-11ed-b8ab-4788d83ace9f", + "f2c173d0-df9c-11ed-b8ab-4788d83ace9f" + ], + "items": { "format": "uuid", "type": "string" - } + }, + "type": "array" } + }, + "required": [ + "certificateIds" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateResponse" - } - } + "type": "object" + }, + "CertificateValidationResponse": { + "properties": { + "fingerprints": { + "description": "A collection of certificate's fingerprints", + "example": [ + "2C85B0AD64F55AA70BAC75F69711578DC505C3F9", + "051ECFBD202B0383A7745F479F978C8E9FA9ADE1" + ], + "items": { + "type": "string" }, - "description": "Details of Issuing Templates in response body." + "type": "array" + } + }, + "type": "object" + }, + "CertificationRequestInformation": { + "properties": { + "hashAlgorithm": { + "description": "A certificate request signature hash algorithm", + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "example": "SHA256", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "keyCurve": { + "description": "Certificate request key length", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P256", + "type": "string" + }, + "keyLength": { + "description": "Certificate request key length", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyType": { + "description": "Certificate request key type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "RSA", + "type": "string" + }, + "publicKeyHash": { + "description": "A certificate request public hash key", + "example": "0048AA1D7E2F0017F9CA2E687D8776A1A340553D", + "type": "string" + }, + "signatureAlgorithm": { + "description": "A certificate request signature algorithm", + "enum": [ + "MD2_WITH_RSA_ENCRYPTION", + "MD5_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION2", + "SHA256_WITH_RSA_ENCRYPTION", + "SHA384_WITH_RSA_ENCRYPTION", + "SHA512_WITH_RSA_ENCRYPTION", + "ID_DSA_WITH_SHA1", + "dsaWithSHA1", + "EC_DSA_WITH_SHA1", + "EC_DSA_WITH_SHA224", + "EC_DSA_WITH_SHA256", + "EC_DSA_WITH_SHA384", + "EC_DSA_WITH_SHA512", + "UNKNOWN", + "SHA1_WITH_RSAandMGF1", + "GOST_R3411_94_WITH_GOST_R3410_2001", + "GOST_R3411_94_WITH_GOST_R3410_94" + ], + "example": "SHA256_WITH_RSA_ENCRYPTION", + "type": "string" + }, + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData2" + }, + "subjectDN": { + "description": "A certificate request subject DN", + "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", + "type": "string" + } + }, + "type": "object" + }, + "Channel": { + "enum": [ + "email" + ], + "type": "string" + }, + "ChartDetails": { + "properties": { + "name": { + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "version": { + "type": "string" } }, - "security": [ + "type": "object" + }, + "ClientAuthenticationInformation": { + "discriminator": { + "propertyName": "type" + }, + "oneOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/JwtStandardClaimsAuthenticationInformation" + }, + { + "$ref": "#/components/schemas/JwtJwksAuthenticationInformation" + }, + { + "$ref": "#/components/schemas/JwtOidcAuthenticationInformation" } ], - "summary": "Get the details of issuing templates", - "tags": [ - "Certificate Policy" - ] + "properties": { + "type": { + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" }, - "post": { - "description": "Creates an issuing template.", - "operationId": "certificateissuingtemplate_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateRequest" - } - } + "ClientAuthenticationOpenApi": { + "discriminator": { + "mapping": { + "JWT_JWKS": "#/components/schemas/JwtJwksAuthenticationOpenApi", + "JWT_OIDC": "#/components/schemas/JwtOidcAuthenticationOpenApi", + "JWT_STANDARD_CLAIMS": "#/components/schemas/JwtStandardClaimsAuthenticationOpenApi" + }, + "propertyName": "type" + }, + "properties": { + "type": { + "type": "string" } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateResponse" - } + "type": "object" + }, + "ClientAuthenticationRequestOpenApi": { + "properties": { + "clientAuthentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/JwtStandardClaimsAuthenticationOpenApi" + }, + { + "$ref": "#/components/schemas/JwtJwksAuthenticationOpenApi" + }, + { + "$ref": "#/components/schemas/JwtOidcAuthenticationOpenApi" } - }, - "description": "Issuing Template was created; details in response body." + ], + "type": "object" + } + }, + "type": "object" + }, + "ClientAuthorizationInformation": { + "properties": { + "customClaimsAliases": { + "$ref": "#/components/schemas/CustomClaimsAliasesInformation" + } + }, + "type": "object" + }, + "CloudProvidersInformation": { + "properties": { + "aws": { + "$ref": "#/components/schemas/AwsCloudProviderInformation" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "azure": { + "$ref": "#/components/schemas/AzureCloudProviderInformation" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Issuing Template not found." + "google": { + "$ref": "#/components/schemas/GoogleCloudProviderInformation" + } + }, + "type": "object" + }, + "CompanyId": { + "description": "The company ID", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "CompanyInformation": { + "properties": { + "active": { + "type": "boolean" }, - "409": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "companyType": { + "$ref": "#/components/schemas/CompanyType" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "domains": { + "items": { + "type": "string" }, - "description": "Issuing Template already exists." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "id": { + "format": "uuid", + "type": "string" + }, + "instanceId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "productEntitlements": { + "items": { + "$ref": "#/components/schemas/ProductEntitlementInformation" }, - "description": "Incomplete or malformed request." + "type": "array" + }, + "tsgId": { + "type": "string" + }, + "urlPrefix": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "id", + "productEntitlements" ], - "summary": "Add an issuing template", - "tags": [ - "Certificate Policy" - ] - } - }, - "/v1/certificateissuingtemplates/{id}": { - "get": { - "description": "Retrieve the details of the issuing template that has the specified `id`.", - "operationId": "certificateissuingtemplate_getById", - "parameters": [ - { - "description": "UUID of an Issuing Template.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an Issuing Template.", - "format": "uuid", + "type": "object" + }, + "CompanyType": { + "enum": [ + "INTERNAL", + "CA", + "TPP_CUSTOMER", + "REGULAR", + "OTHER" + ], + "type": "string" + }, + "Condition": { + "description": "A Condition for filtering", + "properties": { + "field": { + "description": "Represents a field for filtering", + "example": "certificateName", + "type": "string" + }, + "operator": { + "description": "An operator for filtering", + "enum": [ + "EQ", + "LT", + "LTE", + "GT", + "GTE", + "MATCH", + "FIND", + "IN" + ], + "example": "EQ", + "type": "string" + }, + "value": { + "description": "represents a field's value", + "example": "venafi.com", + "type": "string" + }, + "values": { + "description": "represents a field's values", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" - } - } }, - "description": "Issuing Template was found; details in response body." + "type": "array" + } + }, + "type": "object" + }, + "ConfigurationCreateRequest": { + "properties": { + "advancedSettings": { + "$ref": "#/components/schemas/AdvancedSettingsInformation" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "clientAuthentication": { + "$ref": "#/components/schemas/ClientAuthenticationInformation" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "clientAuthorization": { + "$ref": "#/components/schemas/ClientAuthorizationInformation" + }, + "cloudProviders": { + "$ref": "#/components/schemas/CloudProvidersInformation" + }, + "minTlsVersion": { + "description": "Minimum required TLS protocol version", + "enum": [ + "TLS12", + "TLS13" + ], + "type": "string" + }, + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "maxLength": 64, + "type": "string" + }, + "policyIds": { + "description": "Array of UUIDs of policies to associate with the new configuration", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Issuing Template not found." + "minItems": 1, + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "serviceAccountIds": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" + }, + "subCaProviderId": { + "description": "UUID of Sub CA provider to associate with the new configuration", + "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "format": "uuid", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "name", + "policyIds", + "subCaProviderId" ], - "summary": "Get an issuing template details", - "tags": [ - "Certificate Policy" - ] + "type": "object" }, - "put": { - "description": "Updates all the details of the issuing template that has the specified `id`.", - "operationId": "certificateissuingtemplate_update", - "parameters": [ - { - "description": "UUID of an Issuing Template.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an Issuing Template.", - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateRequest" - } - } + "ConfigurationDeleteResponse": { + "properties": { + "id": { + "description": "UUID of the configuration", + "example": "7268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" - } - } - }, - "description": "Issuing Template was updated; details in response body." + "type": "object" + }, + "ConfigurationInformation": { + "properties": { + "advancedSettings": { + "$ref": "#/components/schemas/AdvancedSettingsInformation" }, - "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" - } - } - }, - "description": "Issuing Template exists." + "clientAuthentication": { + "$ref": "#/components/schemas/ClientAuthenticationInformation" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "clientAuthorization": { + "$ref": "#/components/schemas/ClientAuthorizationInformation" + }, + "cloudProviders": { + "$ref": "#/components/schemas/CloudProvidersInformation" + }, + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "controllerAllowedPolicyIds": { + "description": "Array of UUIDs of policies that the kubernetes controller is permitted to use", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request Conditions Failed" + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "creationDate": { + "description": "When the configuration was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "id": { + "description": "UUID of the configuration", + "example": "7268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" + }, + "longLivedCertCount": { + "description": "Number of long lived certificates", + "example": 2, + "format": "int64", + "type": "integer" + }, + "minTlsVersion": { + "description": "Minimum required TLS protocol version", + "enum": [ + "TLS12", + "TLS13" + ], + "type": "string" + }, + "modificationDate": { + "description": "When the configuration was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" + }, + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "type": "string" + }, + "policyIds": { + "description": "Array of UUIDs of policies to associate with the configuration", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Issuing Template not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Overwrite an issuing template details", - "tags": [ - "Certificate Policy" - ] - }, - "delete": { - "description": "Deletes the issuing template that has the specified `id`.", - "operationId": "certificateissuingtemplate_delete", - "parameters": [ - { - "description": "UUID of an Issuing Template.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an Issuing Template.", + "serviceAccountIds": { + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Issuing Template was deleted" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Issuing Template not found." + "shortLivedCertCount": { + "description": "Number of short lived certificates", + "example": 20, + "format": "int64", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "ultraShortLivedCertCount": { + "description": "Number of ultra short lived certificates", + "example": 200, + "format": "int64", + "type": "integer" + }, + "unixSocketAllowedPolicyIds": { + "description": "Array of UUIDs of policies that are permitted to be used when using the unix socket", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Remove an issuing template", - "tags": [ - "Certificate Policy" - ] - } - }, - "/v1/certificateissuingtemplates/domainssynchronization": { - "post": { - "description": "Loads domain list from CA and updates the issuing templates with it", - "operationId": "domainssynchronization", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IssuingTemplatesDomainsSyncRequest" - } - } + "type": "array" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IssuingTemplateDomainsSyncResponse" - } - } + "type": "object" + }, + "ConfigurationResponse": { + "properties": { + "configurations": { + "items": { + "$ref": "#/components/schemas/ExtendedConfigurationInformation" }, - "description": "List with the information about the status of the sync of every issuing template" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Synchronize issuing templates domains with CA", - "tags": [ - "Certificate Policy" - ] - } - }, - "/outagedetection/v1/applications": { - "get": { - "description": "Returns the details of applications matching the below provided criteria.", - "operationId": "applications_getAll", - "parameters": [ - { - "description": "Indicates whether or not the response should include the `owningUsers` and `owningTeams` details.", - "in": "query", - "name": "ownerDetails", - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Indicates whether or not the response should exclude applications that are not editable by the current user.", - "in": "query", - "name": "ownershipCheck", - "schema": { - "default": false, - "type": "boolean" - } + "type": "object" + }, + "ConfigurationUpdateRequest": { + "properties": { + "advancedSettings": { + "$ref": "#/components/schemas/AdvancedSettingsInformation" }, - { - "description": "Indicates whether or not the response should exclude applications with no issuing templates assigned to them.", - "in": "query", - "name": "issuingTemplateAssigned", - "schema": { - "default": false, - "type": "boolean" - } + "clientAuthentication": { + "$ref": "#/components/schemas/ClientAuthenticationRequestOpenApi" }, - { - "description": "This parameter is deprecated for Application endpoints.", - "in": "query", - "name": "ownershipTree", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationResponse" - } - } - }, - "description": "Details of applications in response body." + "clientAuthorization": { + "$ref": "#/components/schemas/ClientAuthorizationInformation" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "cloudProviders": { + "$ref": "#/components/schemas/CloudProvidersInformation" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get the details of applications", - "tags": [ - "Application" - ] - }, - "post": { - "description": "Creates an application.", - "operationId": "applications_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationRequest" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationResponse" - } - } - }, - "description": "Application was created; details in response body." + "minTlsVersion": { + "description": "Minimum required TLS protocol version", + "enum": [ + "TLS12", + "TLS13" + ], + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "maxLength": 64, + "type": "string" }, - "409": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "policyIds": { + "description": "Array of UUIDs of policies to associate with the configuration", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Application already exists." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "serviceAccountIds": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" + }, + "subCaProviderId": { + "description": "UUID of Sub CA provider to associate with the configuration", + "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "format": "uuid", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Add an application", - "tags": [ - "Application" - ] - } - }, - "/outagedetection/v1/applications/{id}": { - "get": { - "description": "Retrieves the details of the application that has the specified `id`.", - "operationId": "applications_getById", - "parameters": [ - { - "description": "UUID of an Application.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an Application.", - "format": "uuid", - "type": "string" - } + "type": "object" + }, + "ConnectorsCreationRequest": { + "properties": { + "name": { + "type": "string" }, - { - "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`).", - "in": "query", - "name": "ownershipTree", - "schema": { - "default": false, - "type": "boolean" - } + "properties": { + "$ref": "#/components/schemas/WebhookProperties" } + }, + "required": [ + "name", + "properties" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationInformation" - } - } - }, - "description": "Application Information" + "type": "object" + }, + "ConnectorsInformation": { + "properties": { + "id": { + "description": "Unique identifier of the connector.", + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request Conditions Failed." + "name": { + "description": "Human-readable name of the connector.", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Application not found." + "properties": { + "$ref": "#/components/schemas/WebhookProperties" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request Conditions Failed." + "status": { + "description": "Current status of the connector (for example, enabled or disabled).", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "id", + "name", + "status", + "properties" ], - "summary": "Get an application details", - "tags": [ - "Application" - ] + "type": "object" }, - "put": { - "description": "Updates (replaces) all details of the application that has the specified `id`.", - "operationId": "applications_update", - "parameters": [ - { - "description": "UUID of an Application.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an Application.", - "format": "uuid", - "type": "string" - } + "ConnectorsResponse": { + "properties": { + "connectors": { + "items": { + "$ref": "#/components/schemas/ConnectorsInformation" + }, + "type": "array" } + }, + "required": [ + "connectors" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationRequest" - } - } + "type": "object" + }, + "ConnectorsUpdateRequest": { + "properties": { + "properties": { + "$ref": "#/components/schemas/WebhookProperties" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationInformation" - } - } - }, - "description": " Application was updated; details in response body" + "required": [ + "properties" + ], + "type": "object" + }, + "CreateCMSConfigurationRequest": { + "description": "The information representing a Credential Manager Service configuration for creation purpose.", + "properties": { + "cmsDetails": { + "$ref": "#/components/schemas/CreateCMSDetails" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "name": { + "$ref": "#/components/schemas/Name" + }, + "vSatelliteIds": { + "$ref": "#/components/schemas/VSatelliteIds" + } + }, + "required": [ + "cmsType", + "vSatelliteIds", + "cmsDetails" + ], + "type": "object" + }, + "CreateCMSConfigurationsRequest": { + "description": "The array of Credential Manager Service configurations to create.", + "properties": { + "cmsConfigurations": { + "items": { + "$ref": "#/components/schemas/CreateCMSConfigurationRequest" }, - "description": "Incomplete or malformed request." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "minItems": 1, + "type": "array" + } + }, + "required": [ + "cmsConfigurations" + ], + "type": "object" + }, + "CreateCMSConfigurationsResponse": { + "description": "The array of Credential Manager Service configurations created.", + "properties": { + "cmsConfigurationsCreated": { + "items": { + "$ref": "#/components/schemas/CMSConfigurationResponse" }, - "description": "Application not found." + "minItems": 1, + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "count": { + "type": "integer" } }, - "security": [ + "required": [ + "cmsConfigurationsCreated", + "count" + ], + "type": "object" + }, + "CreateCMSDetails": { + "oneOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/CreateCyberArkDetails" + }, + { + "$ref": "#/components/schemas/CreateHashiCorpDetails" } - ], - "summary": "Update an application details", - "tags": [ - "Application" ] }, - "delete": { - "description": "Deletes the application that has the specified `id`.", - "operationId": "applications_delete", - "parameters": [ + "CreateCredentialDetails": { + "oneOf": [ { - "description": "UUID of an Application.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an Application.", - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Application was deleted." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Application not found." + "$ref": "#/components/schemas/CreateCyberArkCredDetails" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/CreateHashiCorpCredDetails" } - ], - "summary": "Remove an application", - "tags": [ - "Application" ] - } - }, - "/outagedetection/v1/applications/{id}/invitations": { - "post": { - "description": "Activates a URL that invites new users to become owners of the application with the specified `id`. The invitation link remains valid for 10 minutes.", - "operationId": "applications_invitations_create", - "parameters": [ + }, + "CreateCyberArkCredDetails": { + "allOf": [ { - "description": "UUID of an Application.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an Application.", - "format": "uuid", - "type": "string" - } + "$ref": "#/components/schemas/CyberArkDetailsRequiredProp" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InvitationRequest" - } - } + ] + }, + "CreateCyberArkDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkConfigurationRequiredProp" } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InvitationResponse" - } - } - }, - "description": "If successful, this operation returns a User Invitation link in the response body." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." - }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + ] + }, + "CreateHashiCorpCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpDetailsRequiredProp" } - }, - "security": [ + ] + }, + "CreateHashiCorpDetails": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/HashiCorpConfigurationRequiredProp" } - ], - "summary": "Creates an invitation link for an", - "tags": [ - "Application" ] - } - }, - "/outagedetection/v1/applications/{id}/scanaficonfiguration": { - "get": { - "description": "Retrieves the *Basic Discovery* (Scanafi) configuration for the application that has the specified `id`.", - "operationId": "applications_getScanafiConfigById", - "parameters": [ + }, + "CreateServiceAccountRequestBody": { + "allOf": [ { - "description": "UUID of an Application.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an Application.", - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/ServiceAccountBaseObject" + }, + { + "required": [ + "name", + "scopes" + ], + "type": "object" + } + ], + "example": { + "applications": [ + "dc96438b-7a80-464b-a09b-9e5ec746c3e3", + "5bce5ff4-a69b-4e78-9b7e-6d4029995000" + ], + "authenticationType": "rsaKey", + "credentialLifetime": 30, + "name": "Firefly SA", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "publicKey": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEAzRCyRWzXlyhFp3RcUrum1Q6j7YR8jyL0L1fWnh7zgt4=\\n-----END PUBLIC KEY-----", + "scopes": [ + "distributed-issuance" + ] + } + }, + "CreateServiceAccountResponseBody": { + "example": { + "id": "933507dd-0286-11ef-bc25-8a00a468403f", + "privateKey": "-----BEGIN PRIVATE KEY-----\n⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆⋆\n-----END PRIVATE KEY-----\n", + "publicKey": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEAzRCyRWzXlyhFp3RcUrum1Q6j7YR8jyL0L1fWnh7zgt4=\\n-----END PUBLIC KEY-----" + }, + "properties": { + "id": { + "description": "The ID for this service account", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" } + }, + "ociAccountName": { + "description": "The OCI account name generated for a robot in case of the registry scope", + "type": "string" + }, + "ociRegistryToken": { + "description": "The OCI registry token generated for a robot in case of the registry scope", + "type": "string" + }, + "privateKey": { + "description": "The generated private key for the service account when not providing a public key on the create payload", + "type": "string" + }, + "publicKey": { + "description": "The generated public key for the service account when not providing a public key on the create payload", + "type": "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScanafiConfigResponseV1" - } - } + }, + "type": "object" + }, + "CreateTeamRequest": { + "properties": { + "members": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Basic Discovery configuration in response body." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "name": { + "maxLength": 100, + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "owners": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Application not found." + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "role": { + "$ref": "#/components/schemas/TeamRole" + }, + "userMatchingRules": { + "items": { + "$ref": "#/components/schemas/UserMatchingRule" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "required": [ + "name", + "owners", + "role" + ], + "type": "object" + }, + "CreatedBy": { + "description": "The ID of the user whom created the credential.", + "type": "string" + }, + "CreatedOn": { + "description": "The date in ISO 8601 full-date format when the credential was created.", + "format": "date", + "type": "string" + }, + "CredentialId": { + "description": "The ID of the Credential in our System.", + "example": "94e86140-d85f-11ed-afa1-0242ac120002", + "format": "uuid", + "type": "string" + }, + "CredentialName": { + "description": "The name of the Credential in our System.", + "type": "string" + }, + "CredentialResponse": { + "description": "The properties representing a Credential for response purposes.", + "properties": { + "authType": { + "$ref": "#/components/schemas/AuthType" + }, + "cmsConfigId": { + "$ref": "#/components/schemas/CMSConfId" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "createdBy": { + "$ref": "#/components/schemas/CreatedBy" + }, + "createdOn": { + "$ref": "#/components/schemas/CreatedOn" + }, + "credentialDetails": { + "$ref": "#/components/schemas/ResponseCredentialDetails" + }, + "id": { + "$ref": "#/components/schemas/CredentialId" + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/LastModifiedBy" + }, + "lastModifiedOn": { + "$ref": "#/components/schemas/LastModifiedOn" + }, + "name": { + "$ref": "#/components/schemas/CredentialName" + }, + "references": { + "$ref": "#/components/schemas/References" + }, + "teamsIds": { + "$ref": "#/components/schemas/TeamsIds" } + }, + "required": [ + "id", + "name", + "cmsConfigId", + "authType", + "cmsType" ], - "summary": "Get the Basic Discovery configuration for", - "tags": [ - "Application" - ] - } - }, - "/outagedetection/v1/applications/{name}/certificateissuingtemplates/{alias}": { - "get": { - "description": "Retrieves the details of the certificate issuing template identified by the specified `alias` assigned to the application that has the specified `name`.", - "operationId": "certificateissuingtemplates_getByAlias", - "parameters": [ - { - "description": "Name of an Application.", - "in": "path", - "name": "name", - "required": true, - "schema": { + "type": "object" + }, + "CustomAttributes1": { + "description": "A certificate request custom attributes", + "example": { + "dnsNames": [ + "www.venafi.com", + "venafi.com" + ] + }, + "properties": { + "dnsNames": { + "items": { "type": "string" - } + }, + "type": "array", + "uniqueItems": true }, - { - "description": "Alias of an Issuing Template for the specified Application.", - "in": "path", - "name": "alias", - "required": true, - "schema": { - "type": "string" - } + "overwriteSans": { + "type": "boolean" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" - } - } + }, + "type": "object" + }, + "CustomAttributes2": { + "description": "Certificate request custom attributes", + "example": { + "dnsNames": [ + "www.venafi.com", + "venafi.com" + ] + }, + "properties": { + "dnsNames": { + "items": { + "type": "string" }, - "description": "Issuing Template was found; details in response body." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "overwriteSans": { + "type": "boolean" + } + }, + "type": "object" + }, + "CustomAttributesInformation": { + "description": "Represents custom attributes for certificate requests", + "properties": { + "dnsNames": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array", + "uniqueItems": true + }, + "overwriteSans": { + "description": "Defines if the csr sans should be overwritten by the custom attributes dns sans", + "type": "boolean" + } + }, + "required": [ + "dnsNames" + ], + "type": "object" + }, + "CustomClaimsAliasesInformation": { + "properties": { + "allowAllPolicies": { + "maxLength": 128, + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Issuing Template not found." + "allowedPolicies": { + "maxLength": 128, + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } + "configuration": { + "maxLength": 128, + "type": "string" + } + }, + "type": "object" + }, + "CyberArkConfiguration": { + "allOf": [ + { + "properties": { + "appID": { + "$ref": "#/components/schemas/AppId" + }, + "baseUrl": { + "$ref": "#/components/schemas/CMSURL" } }, - "description": "Incomplete or malformed request." + "type": "object" + }, + { + "$ref": "#/components/schemas/CertificateCredentialData" } - }, - "security": [ + ], + "description": "The configuration for the CyberArk app. It's required to set the value for the `cmsType` property to `cyberark`." + }, + "CyberArkConfigurationRequiredProp": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/CyberArkConfiguration" } ], - "summary": "Get the details of an issuing", - "tags": [ - "Application" + "description": "The configuration for the CyberArk app. It's required to set the value for the `cmsType` property to `cyberark`.", + "required": [ + "appID", + "baseUrl" ] - } - }, - "/outagedetection/v1/applications/certificates": { - "patch": { - "description": "Update one or more application assignments for one or more certificates. Valid actions are ADD, REPLACE and DELETE.", - "operationId": "applications_assignToCertificates", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationsAssignRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationsAssignResponse" - } - } - }, - "description": "Certificate application assignments were updated; details in response body." + }, + "CyberArkDetails": { + "description": "The CyberArk Credential information.", + "properties": { + "folder": { + "description": "The folder property into the CyberArk Safe.", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "objectName": { + "description": "The account's name which represents the credential in the CyberArk instance.", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "safe": { + "description": "The CyberArk Safe property.", + "type": "string" } }, - "security": [ + "type": "object" + }, + "CyberArkDetailsRequiredProp": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/CyberArkDetails" } ], - "summary": "Manage application assignments for a set", - "tags": [ - "Application" + "required": [ + "objectName", + "safe" ] - } - }, - "/outagedetection/v1/applications/name/{name}": { - "get": { - "description": "Retrieves the details of the application that has the specified `name`.", - "operationId": "applications_getByName", - "parameters": [ + }, + "DailyPatternInformation": { + "allOf": [ { - "description": "Name of an Application.", - "in": "path", - "name": "name", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/SchedulerPatternInformation3" }, { - "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`).", - "in": "query", - "name": "ownershipTree", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationInformation" - } - } - }, - "description": "Application was found; details in response body." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } + "properties": { + "duration": { + "description": "Duration in ISO-8601 format", + "enum": [ + "PT8H", + "PT12H", + "PT24H" + ], + "example": "PT24H", + "type": "string" + }, + "startTime": { + "description": "Start time in HH:mm:ss format", + "pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", + "type": "string" } }, - "description": "Application not found." + "type": "object" + } + ], + "required": [ + "duration", + "startTime" + ], + "type": "object" + }, + "DeleteCredentialsResponse": { + "description": "The response for the delete credentials action.", + "properties": { + "count": { + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "idsCredentialsDeleted": { + "items": { + "$ref": "#/components/schemas/CredentialId" }, - "description": "Incomplete or malformed request." + "minItems": 1, + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "idsCredentialsDeleted", + "count" ], - "summary": "Get an application details by its", - "tags": [ - "Application" - ] - } - }, - "/v1/credentialmanagerconfigurations": { - "get": { - "description": "Retrieves a set of stored Credential Manager Service configurations.", - "operationId": "get-public-cms-conf", - "parameters": [ - { - "$ref": "#/components/parameters/CMSTypesParam" + "type": "object" + }, + "Deployment": { + "properties": { + "executionTarget": { + "default": "vsat", + "description": "HELP", + "type": "string" + }, + "image": { + "description": "URL for where the plugin image resides.", + "type": "string" } + }, + "required": [ + "image", + "executionTarget" ], - "responses": { - "200": { - "$ref": "#/components/responses/200GetCMSConfigurations" + "title": "Deployment", + "type": "object", + "x-examples": { + "Example 1": { + "deployment": { + "executionTarget": "vsat", + "image": "public.ecr.aws/docker/library/nginx:mainline-alpine3.18-slim" + } + } + } + }, + "Details": { + "properties": { + "credentialsExpiringOn": { + "description": "The exact date on which the credentials will expire", + "format": "date-time", + "type": "string" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "enabled": { + "description": "Indicates if the given service account must be enabled or disabled where disable means that the credentials cannot be used for", + "type": "boolean" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "id": { + "description": "The ID for this service account", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "lastUsedOn": { + "description": "The last time the account credentials were used to authenticate a machine", + "format": "date-time", + "type": "string" }, - "404": { - "$ref": "#/components/responses/404NotFound" + "updatedBy": { + "description": "The UUID of the latest user that modified the account", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "updatedOn": { + "description": "The last time the account details were updated", + "format": "date-time", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "type": "object" + }, + "Direction": { + "description": "An ordering direction", + "enum": [ + "ASC", + "DESC" ], - "summary": "Retrieves a set of Credential Manager", - "tags": [ - "Credential Management" - ] + "example": "DESC", + "type": "string" }, - "post": { - "description": "Adds a set of new Credential Manager Service configurations. Only one Credential Manager Service configuration per `cmsType` per company can exist.", - "operationId": "post-public-cms-conf", - "requestBody": { - "$ref": "#/components/requestBodies/CreateCMSConfigurationsBodyRequest" - }, - "responses": { - "201": { - "$ref": "#/components/responses/201CreateCMSConfigurations" + "EdgeInstanceConnectionDetails": { + "properties": { + "activeMessageCount": { + "format": "int32", + "type": "integer" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "companyId": { + "format": "uuid", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "edgeInstanceId": { + "format": "uuid", + "type": "string" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "expiredMessageCount": { + "format": "int32", + "type": "integer" }, - "404": { - "$ref": "#/components/responses/404NotFound" + "failedMessageCount": { + "format": "int32", + "type": "integer" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "lastConnectedDate": { + "format": "date-time", + "type": "string" + }, + "lastDisconnectedDate": { + "format": "date-time", + "type": "string" + }, + "timestamp": { + "format": "date-time", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Add a set of Credential Manager", - "tags": [ - "Credential Management" - ] + "type": "object" }, - "put": { - "description": "Updates the information of an existing Credential Manager Service configuration.", - "operationId": "put-public-cms-conf", - "requestBody": { - "$ref": "#/components/requestBodies/UpdateCMSConfigurationsBodyRequest" - }, - "responses": { - "200": { - "$ref": "#/components/responses/200UpdateCMSConfiguration" + "EdgeInstanceHealthDetails": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "edgeInstanceId": { + "format": "uuid", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "hsmStatus": { + "$ref": "#/components/schemas/HSMEdgeStatus" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "installedCharts": { + "items": { + "$ref": "#/components/schemas/NamespaceChartDetails" + }, + "type": "array" }, - "404": { - "$ref": "#/components/responses/404NotFound" + "nodeStatus": { + "items": { + "$ref": "#/components/schemas/NodeStatusDetails" + }, + "type": "array" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "systemstatus": { + "items": { + "$ref": "#/components/schemas/NamespaceStatusDetails" + }, + "type": "array" + }, + "timestamp": { + "format": "date-time", + "type": "string" + }, + "version": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update a Credential Manager Service configuration", - "tags": [ - "Credential Management" - ] - } - }, - "/v1/credentialmanagerconfigurations/{id}": { - "get": { - "description": "Retrieves a Credential Manager Service configuration by the specified `id`.", - "operationId": "get-public-cms-conf-id", - "responses": { - "200": { - "$ref": "#/components/responses/200GetCMSConfiguration" + "type": "object" + }, + "EdgeInstanceInformation": { + "properties": { + "address": { + "type": "string" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "canRestore": { + "type": "boolean" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "clientId": { + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "deploymentDate": { + "format": "date-time", + "type": "string" + }, + "edgeStatus": { + "$ref": "#/components/schemas/EdgeStatus" + }, + "edgeType": { + "$ref": "#/components/schemas/EdgeType" + }, + "encryptionKeyDeploymentDate": { + "format": "date-time", + "type": "string" + }, + "encryptionKeyId": { + "type": "string" + }, + "environmentId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "integrationServicesCount": { + "format": "int64", + "type": "integer" + }, + "kubernetesVersion": { + "type": "string" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "lastSeenOnDate": { + "format": "date-time", + "type": "string" }, - "404": { - "$ref": "#/components/responses/404NotFound" + "modificationDate": { + "format": "date-time", + "type": "string" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieves a Credential Manager Service configurati", - "tags": [ - "Credential Management" - ], - "parameters": [ - { - "$ref": "#/components/parameters/CMSConfigIdParam" - } - ] - }, - "delete": { - "description": "Deletes a Credential Manager Service configuration by the specified `id`.", - "operationId": "delete-public-cms-conf-id", - "responses": { - "204": { - "description": "The returned HTTP code if the Credential Manager Service configuration was deleted successfully." + "name": { + "type": "string" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "pairingCodeId": { + "format": "uuid", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "primaryInstanceId": { + "format": "uuid", + "type": "string" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "productEntitlements": { + "items": { + "$ref": "#/components/schemas/ProductEntitlement2" + }, + "type": "array" }, - "404": { - "$ref": "#/components/responses/404NotFound" + "reconciliationFailed": { + "type": "boolean" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Delete a Credential Manager Service configuration", - "tags": [ - "Credential Management" - ], - "parameters": [ - { - "$ref": "#/components/parameters/CMSConfigIdParam" - } - ] - } - }, - "/v1/credentialmanagerconfigurations/test": { - "post": { - "description": "Tests the connection to a configured privileged access management through selected VSatellites.", - "operationId": "post-public-cms-conf-test", - "requestBody": { - "$ref": "#/components/requestBodies/TestCMSConfigurationBodyRequest" - }, - "responses": { - "200": { - "$ref": "#/components/responses/200TestCMSConfiguration" + "satelliteVersion": { + "type": "string" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "serviceAccountId": { + "format": "uuid", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "statusDetails": { + "$ref": "#/components/schemas/EdgeInstanceStatusDetailsInformation" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "upgradeOrderPriority": { + "format": "int32", + "type": "integer" }, - "404": { - "$ref": "#/components/responses/404NotFound" + "upgradeStatus": { + "$ref": "#/components/schemas/UpgradeStatus" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "version": { + "format": "int32", + "type": "integer" + }, + "workerStatusDetails": { + "items": { + "$ref": "#/components/schemas/EdgeWorkerStatusDetailsInformation" + }, + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "EdgeInstanceRequest": { + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "upgradeOrderPriority": { + "format": "int32", + "maximum": 100, + "minimum": 1, + "type": "integer" } + }, + "required": [ + "name" ], - "summary": "Test the connection to a privileged", - "tags": [ - "Credential Management" - ] - } - }, - "/v1/credentialmanagerconfigurations/{id}/test": { - "post": { - "description": "Tests the connection to a configured privileged access management through selected VSatellites using a specified `id`.", - "operationId": "post-public-cms-conf-test-id", - "responses": { - "200": { - "$ref": "#/components/responses/200TestCMSConfiguration" - }, - "400": { - "$ref": "#/components/responses/400BadRequest" - }, - "401": { - "$ref": "#/components/responses/401Unauthorized" - }, - "403": { - "$ref": "#/components/responses/403Forbidden" - }, - "404": { - "$ref": "#/components/responses/404NotFound" - }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "type": "object" + }, + "EdgeInstanceResponse": { + "properties": { + "edgeInstances": { + "items": { + "$ref": "#/components/schemas/EdgeInstanceInformation" + }, + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "EdgeInstanceStatusDetailsInformation": { + "properties": { + "connectionDetails": { + "items": { + "$ref": "#/components/schemas/EdgeInstanceConnectionDetails" + }, + "type": "array" + }, + "healthDetails": { + "items": { + "$ref": "#/components/schemas/EdgeInstanceHealthDetails" + }, + "type": "array" } + }, + "type": "object" + }, + "EdgeStatus": { + "enum": [ + "ACTIVE", + "LOST_CONNECTION", + "REGISTERED", + "PAIRED", + "LOST_CONNECTION_DURING_INSTALL", + "INSTALLED", + "INSTALL_FAILED", + "UNHEALTHY", + "ERROR", + "INSTALLING" ], - "summary": "Test the connection to an external", - "tags": [ - "Credential Management" + "type": "string" + }, + "EdgeType": { + "enum": [ + "ALL", + "HUB", + "SATELLITE" ], - "parameters": [ - { - "$ref": "#/components/parameters/CMSConfigIdParam" + "type": "string" + }, + "EdgeWorkerDeleteResponse": { + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "pairingCode": { + "type": "string" } - ] - } - }, - "/v1/credentials": { - "get": { - "description": "Retrieves a list of shared credentials for a company.", - "operationId": "get-public-cms-credential", - "parameters": [ - { - "$ref": "#/components/parameters/CMSCredentialDetailsParam" + }, + "type": "object" + }, + "EdgeWorkerHealthDetails": { + "properties": { + "age": { + "format": "int64", + "type": "integer" }, - { - "$ref": "#/components/parameters/CMSTypesParam" + "companyId": { + "format": "uuid", + "type": "string" + }, + "cpuUsage": { + "format": "int32", + "type": "integer" }, - { - "$ref": "#/components/parameters/CredentialIdsParam" + "edgeInstanceId": { + "format": "uuid", + "type": "string" }, - { - "$ref": "#/components/parameters/TeamIdsParam" + "edgeWorkerId": { + "format": "uuid", + "type": "string" }, - { - "$ref": "#/components/parameters/AuthTypesParam" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/200GetCredentials" + "host": { + "type": "string" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "memoryUsage": { + "format": "int64", + "type": "integer" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "port": { + "format": "int32", + "type": "integer" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "services": { + "items": { + "$ref": "#/components/schemas/WorkerServiceStatusDetails" + }, + "type": "array" }, - "422": { - "$ref": "#/components/responses/404NotFound" + "status": { + "type": "string" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "timestamp": { + "format": "date-time", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieves credentials for a company", - "tags": [ - "Credential Management" - ] + "type": "object" }, - "post": { - "description": "Adds a set of new shared credentials. The `name` for each credential must be unique.", - "operationId": "post-public-cms-credential", - "requestBody": { - "$ref": "#/components/requestBodies/AddCredentialsBodyRequest" - }, - "responses": { - "201": { - "$ref": "#/components/responses/201AddCredentials" + "EdgeWorkerInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "edgeInstanceId": { + "format": "uuid", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "environmentId": { + "format": "uuid", + "type": "string" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "hiddenPairingCode": { + "type": "string" }, - "422": { - "$ref": "#/components/responses/404NotFound" + "host": { + "type": "string" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Add a set of new shared", - "tags": [ - "Credential Management" - ] - }, - "put": { - "description": "Updates the information of an existing shared credential.", - "operationId": "put-public-cms-credential", - "requestBody": { - "$ref": "#/components/requestBodies/UpdateCredentialBodyRequest" - }, - "responses": { - "200": { - "$ref": "#/components/responses/200UpdateCredential" + "id": { + "format": "uuid", + "type": "string" }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "lastSeenOnDate": { + "format": "date-time", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "pairingCode": { + "type": "string" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "pairingPublicKey": { + "type": "string" }, - "422": { - "$ref": "#/components/responses/404NotFound" + "port": { + "format": "int32", + "type": "integer" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "status": { + "$ref": "#/components/schemas/WorkerStatus" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update a shared credential", - "tags": [ - "Credential Management" - ] + "type": "object" }, - "delete": { - "description": "Deletes existing shared credentials specified in the query parameter list of `ids`.", - "operationId": "delete-public-cms-credential", - "parameters": [ - { - "$ref": "#/components/parameters/CredentialIdsParam" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/200DeleteCredentials" - }, - "400": { - "$ref": "#/components/responses/400BadRequest" - }, - "401": { - "$ref": "#/components/responses/401Unauthorized" - }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "EdgeWorkerRequest": { + "properties": { + "edgeInstanceId": { + "format": "uuid", + "type": "string" }, - "422": { - "$ref": "#/components/responses/404NotFound" + "host": { + "type": "string" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "port": { + "format": "int32", + "type": "integer" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "EdgeWorkerStatusDetailsInformation": { + "properties": { + "edgeWorkerId": { + "format": "uuid", + "type": "string" + }, + "healthDetails": { + "items": { + "$ref": "#/components/schemas/EdgeWorkerHealthDetails" + }, + "type": "array" } - ], - "summary": "Delete shared credentials", - "tags": [ - "Credential Management" - ] - } - }, - "/v1/credentials/{id}": { - "get": { - "description": "Retrieves the credential matching with provided `id`.", - "operationId": "get-public-cms-credential-id", - "parameters": [ - { - "$ref": "#/components/parameters/CMSCredentialDetailsParam" + }, + "type": "object" + }, + "EdgeWorkersResponse": { + "properties": { + "edgeWorkers": { + "items": { + "$ref": "#/components/schemas/EdgeWorkerInformation" + }, + "type": "array" } - ], - "responses": { - "200": { - "$ref": "#/components/responses/200GetCredential" - }, - "400": { - "$ref": "#/components/responses/400BadRequest" - }, - "401": { - "$ref": "#/components/responses/401Unauthorized" - }, - "403": { - "$ref": "#/components/responses/403Forbidden" - }, - "422": { - "$ref": "#/components/responses/404NotFound" - }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + }, + "type": "object" + }, + "EncryptionDetails": { + "properties": { + "encryptionType": { + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/AnyValue9" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieves shared credential by ID", - "tags": [ - "Credential Management" - ] + "type": "object" }, - "delete": { - "description": "Deletes the shared credential by the specified `id`.", - "operationId": "delete-public-cms-credential-id", - "responses": { - "204": { - "description": "The returned http code if the credential was deleted successfully." - }, - "400": { - "$ref": "#/components/responses/400BadRequest" + "EncryptionKeyInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401Unauthorized" + "id": { + "type": "string" }, - "403": { - "$ref": "#/components/responses/403Forbidden" + "key": { + "type": "string" }, - "422": { - "$ref": "#/components/responses/404NotFound" + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithm" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "lastBackupDate": { + "format": "date-time", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Delete shared credential by ID", - "tags": [ - "Credential Management" - ], - "parameters": [ - { - "$ref": "#/components/parameters/CredentialIdParam" + "type": "object" + }, + "EncryptionKeysResponse": { + "properties": { + "encryptionKeys": { + "items": { + "$ref": "#/components/schemas/EncryptionKeyInformation" + }, + "type": "array" } - ] - } - }, - "/v1/credentials/test": { - "post": { - "description": "Tests the access to a shared credential using a specified `id` or by providing credential values. If both an `id` and parameters are provided, parameters override existing credential values.", - "operationId": "post-public-cms-credential-test-id", - "requestBody": { - "$ref": "#/components/requestBodies/TestCredentialBodyRequest" }, - "responses": { - "200": { - "$ref": "#/components/responses/200TestCredential" - }, - "400": { - "$ref": "#/components/responses/400BadRequest" - }, - "401": { - "$ref": "#/components/responses/401Unauthorized" - }, - "403": { - "$ref": "#/components/responses/403Forbidden" - }, - "404": { - "$ref": "#/components/responses/404NotFound" + "type": "object" + }, + "EntityTag": { + "properties": { + "value": { + "type": "string" }, - "500": { - "$ref": "#/components/responses/500InternalServerErrorContent" + "weak": { + "type": "boolean" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Test the access to shared credential", - "tags": [ - "Credential Management" - ] - } - }, - "/v1/machineidentities": { - "get": { - "description": "Retrieves the details of all machine identities..", - "operationId": "machineidentities_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityResponse" - } - } + "type": "object" + }, + "Error": { + "description": "Hold the error details.", + "properties": { + "args": { + "description": "List of arguments used to generate the error message.", + "items": { + "type": "object" }, - "description": "All Machine Identities for the company." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Incomplete or malformed request." + "code": { + "description": "The error code.", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Incomplete or malformed request." + "message": { + "description": "The error message.", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "code", + "message" ], - "summary": "Get the details of all machine", - "tags": [ - "Machine Identities" - ] + "type": "object" }, - "post": { - "description": "Creates a machine identity for a machine.", - "operationId": "machineidentities_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityCreationRequest" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityInformation" - } - } + "ErrorInformation1": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue1" }, - "description": "Machine Identity was created; details in response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Incomplete or malformed request." + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Add a machine identity to a", - "tags": [ - "Machine Identities" - ] - } - }, - "/v1/machineidentities/{id}": { - "get": { - "description": "Retrieves the machine identity that has the specified `id`.", - "operationId": "machineidentities_getById", - "parameters": [ - { - "description": "UUID of a Machine Identity.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine Identity.", - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityInformation" - } - } - }, - "description": "Machine Identity matching specified id" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "type": "object" + }, + "ErrorInformation10": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue10" }, - "description": "Request Conditions Failed" + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Machine Identity not found" + "code": { + "format": "int32", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Request Conditions Failed" + "message": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get a machine identity details", - "tags": [ - "Machine Identities" - ] + "type": "object" }, - "delete": { - "description": "Deletes the machine identity that has the specified `id`.", - "operationId": "machineidentities_delete", - "parameters": [ - { - "description": "UUID of a Machine Identity.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine Identity.", - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Machine Identity was deleted." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "ErrorInformation2": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue2" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Machine Identity not found." + "code": { + "format": "int32", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation3": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue3" }, - "description": "Incomplete or malformed request." + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "ErrorInformation4": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue4" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" } - ], - "summary": "Remove a machine identity", - "tags": [ - "Machine Identities" - ] + }, + "type": "object" }, - "patch": { - "description": "CUpdates specific details of the machine identity that has the specified `id`.", - "operationId": "machineidentities_update", - "parameters": [ - { - "description": "UUID of a Machine Identity.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine Identity.", - "format": "uuid", - "type": "string" - } + "ErrorInformation5": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue5" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityUpdateRequest" - } - } + }, + "type": "object" + }, + "ErrorInformation6": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue6" + }, + "type": "array" + }, + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityInformation" - } - } + "type": "object" + }, + "ErrorInformation7": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue7" }, - "description": "Machine Identity was updated; details in response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation8": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue8" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorInformation9": { + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue9" }, - "description": "Machine Identity not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "type": "object" + }, + "ErrorResponse1": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation1" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "ErrorResponse10": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation10" + }, + "type": "array" } - ], - "summary": "Update a machine identity details", - "tags": [ - "Machine Identities" - ] - } - }, - "/v1/machineidentities/{id}/workflows": { - "post": { - "description": "Used to initiate a workflow like 'testConnection' for the machine that has the specified `id`.", - "operationId": "machineidentities_initiateWorkflow", - "parameters": [ - { - "description": "UUID of a Machine Identity.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine Identity.", - "format": "uuid", - "type": "string" - } + }, + "type": "object" + }, + "ErrorResponse11": { + "description": "Holds the response body returned for errors.", + "properties": { + "errors": { + "description": "List of encountered errors.", + "items": { + "$ref": "#/components/schemas/Error" + }, + "type": "array" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityWorkflowRequest" - } - } + }, + "type": "object" + }, + "ErrorResponse2": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation2" + }, + "type": "array" } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityWorkflowInformation" - } - } + "type": "object" + }, + "ErrorResponse3": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation3" }, - "description": "Workflow was initiated; details in response body." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse4": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation4" }, - "description": "Incomplete or malformed request." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse5": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation5" }, - "description": "Machine identity not found." - }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "type": "array" + } + }, + "type": "object" + }, + "ErrorResponse6": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation6" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "ErrorResponse7": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation7" + }, + "type": "array" } - ], - "summary": "Initiate a machine workflow", - "tags": [ - "Machine Identities" - ] - } - }, - "/v1/machineidentitysearch": { - "post": { - "description": "Retrieves the details of machine identities that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", - "operationId": "getMachineIdentitiesByExpression", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentitySearchRequest" - } - } + }, + "type": "object" + }, + "ErrorResponse8": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation8" + }, + "type": "array" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineIdentityDocumentResponse" - } - } + "type": "object" + }, + "ErrorResponse9": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorInformation9" }, - "description": "Details of Machine Identities in response body." + "type": "array" + } + }, + "type": "object" + }, + "ExportedActivityLogEntryInformation": { + "properties": { + "activityDate": { + "description": "The date when a log entry was produced", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Incomplete or malformed request." + "activityName": { + "description": "An activity name", + "example": "Login Succeeded", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "activityType": { + "description": "An activity type", + "example": "Authentication", + "type": "string" + }, + "criticality": { + "description": "An activity criticality", + "example": 0, + "format": "int32", + "type": "integer" + }, + "id": { + "description": "UUID of a log entry", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "message": { + "description": "An activity log message", + "example": "user logged in", + "type": "string" + }, + "payload": { + "additionalProperties": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "object" } }, - "summary": "Get the details of machine identities", - "tags": [ - "Machine Identities" - ] - } - }, - "/v1/machinetypes": { - "get": { - "deprecated": true, - "description": "Deprecated. This functionality is no longer supported. Use the Plugins API set instead.", - "operationId": "machineTypes_getAll", - "responses": { - "default": { - "content": { - "application/json": {} + "type": "object" + }, + "Expression": { + "type": "object" + }, + "ExtendedApplicationOwnership": { + "properties": { + "id": { + "format": "uuid", + "type": "string" + }, + "owningTeams": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "default response" + "type": "array", + "uniqueItems": true + }, + "owningUsers": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Deprecated. This functionality is no longer", - "tags": [ - "Machine Types" - ] - } - }, - "/v1/machines": { - "get": { - "description": "Retrieves the details of all machines.", - "operationId": "machines_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachinesResponse" - } - } + "type": "object" + }, + "ExtendedCertificateInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "561baf7c-98b7-49af-ab9c-7b3a9fea3028", + "4adeba6f-0c94-4595-a5b6-babea458249f" + ], + "items": { + "format": "uuid", + "type": "string" }, - "description": "Details of Machines in response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "archivedDate": { + "description": "The date a certificate was archived", + "example": "2022-05-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "authorityKeyIdentifierHash": { + "description": "An authority key identifier hash", + "example": "40572B10F85DDAF18BFF987372178532AB875BCA", + "type": "string" + }, + "certificateAuthorityAccountId": { + "description": "UUID of a certificate authority account", + "format": "uuid", + "type": "string" + }, + "certificateName": { + "description": "A certificate name", + "example": "venafi.com", + "type": "string" + }, + "certificateRequestId": { + "description": "UUID of a certificate request", + "example": "2e8964a0-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "certificateStatus": { + "description": "Certificate's status", + "enum": [ + "ACTIVE", + "RETIRED", + "DELETED" + ], + "example": "ACTIVE", + "type": "string" + }, + "companyId": { + "description": "UUID of a company", + "example": "85595df0-8e14-11ed-87e3-755db050f29d", + "format": "uuid", + "type": "string" + }, + "dekHash": { + "description": "A certificate dek hash", + "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", + "type": "string" + }, + "encryptionType": { + "description": "A certificate encryption type", + "enum": [ + "RSA", + "DSA", + "EC", + "GOST3410", + "ECGOST3410", + "RESERVED3", + "UNKNOWN" + ], + "example": "EC", + "type": "string" + }, + "extendedKeyUsage": { + "description": "A collection of certificate extended key usages", + "example": [ + "1.3.6.1.5.5.7.3.2", + "1.3.6.1.5.5.7.3.1" + ], + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } + "fingerprint": { + "description": "A certificate fingerprint", + "example": "6D4C95512C117B004191F1A096ECAD13242FCD9F", + "type": "string" + }, + "id": { + "description": "UUID of a certificate", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "inhibitAnyPolicy": { + "description": "Inhibit any policy", + "example": 150, + "format": "int32", + "type": "integer" + }, + "inhibitPolicyMapping": { + "description": "Inhibit policy mapping", + "example": 200, + "format": "int32", + "type": "integer" + }, + "instances": { + "description": "A collection of certificate instances information", + "example": [ + { + "certificateId": "7ec12010-9051-11ed-8e50-b994b27d2ece", + "certificateInstanceId": "7ec1bc50-9051-11ed-8e50-b994b27d2ece", + "certificateSource": "USER_SCAN", + "deploymentStatus": "IN_USE", + "hostname": "venafi.com", + "instanceChainValidationStatus": [ + "OK" + ], + "ipAddress": "23.185.0.2", + "lastScanDate": "2023-01-09T19:12:05.314+00:00", + "lastValidatedAttempt": "2023-01-09T19:12:05.446+00:00", + "modificationDate": "2023-01-09T19:12:14.865+00:00", + "port": 443, + "serviceIds": [ + "1d61e9e0-9046-11ed-bf12-53a1b041cf25" + ], + "sslProtocols": [ + "TLSv1.3", + "TLSv1.2" + ], + "sslValidationErrorArguments": [], + "sslValidationStatus": "OK" } + ], + "items": { + "$ref": "#/components/schemas/CertificateInstanceInformation" }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get the details of all machines", - "tags": [ - "Machines" - ] - }, - "post": { - "description": "Creates a machine corresponding to the specified `pluginId`.", - "operationId": "machines_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineCreationRequest" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineInformation" - } - } + "type": "array" + }, + "issuerAlternativeNameDns": { + "description": "A collection of certificate issuer alternative names DNs", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { + "type": "string" }, - "description": "Machine was created; details in response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "issuerAlternativeNameNonDns": { + "description": "A collection of certificate issuer alternative name none DNs", + "example": [ + "venafi issuer doman" + ], + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Add a machine", - "tags": [ - "Machines" - ] - } - }, - "/v1/machines/{id}": { - "get": { - "description": "Retrieves the details of the machine that matches the specified `id`.", - "operationId": "machines_getById", - "parameters": [ - { - "description": "UUID of a Machine", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine", - "format": "uuid", + "type": "array" + }, + "issuerC": { + "description": "A certificate issues Country", + "example": "US", + "type": "string" + }, + "issuerCN": { + "description": "A collection of certificate issuer Common names", + "example": [ + "HydrantID SSL CA G3" + ], + "items": { "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineInformation" - } - } }, - "description": "Machine was found; details in the response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "issuerCertificateIds": { + "description": "A collection of issuer certificate IDs", + "example": [ + "2e8964a0-9046-11ed-8e50-b994b27d2ece", + "d5b418a0-297e-11eb-bc4c-8b24e5a66fb6" + ], + "items": { + "format": "uuid", + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "issuerCertificates": { + "description": "A collection of certificate information", + "items": { + "$ref": "#/components/schemas/CertificateInformation" }, - "description": "Machine not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "issuerDN": { + "description": "A certificate issue DN", + "example": "cn=HydrantID SSL CA G3,o=HydrantID (Avalanche Cloud Corporation),c=US", + "type": "string" + }, + "issuerL": { + "description": "A certificate issues Locality", + "example": "Salt Lake City", + "type": "string" + }, + "issuerOU": { + "description": "A collection of certificate issuer Organization units", + "example": [ + "Issuer CA" + ], + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get a machine details", - "tags": [ - "Machines" - ] - }, - "delete": { - "description": "Deletes a machine that has the specified `id`.", - "operationId": "machines_delete", - "parameters": [ - { - "description": "UUID of a Machine.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine.", - "format": "uuid", + "type": "array" + }, + "issuerST": { + "description": "A certificate issuer State", + "example": "Utah", + "type": "string" + }, + "keyCurve": { + "description": "A certificate key curve", + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "example": "P256", + "type": "string" + }, + "keyStrength": { + "description": "A certificate key strength", + "example": 2048, + "format": "int32", + "type": "integer" + }, + "keyUsage": { + "description": "A collection of certificate key usages", + "example": [ + "digitalSignature", + "keyEncipherment" + ], + "items": { "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Machine deleted." + }, + "type": "array" + }, + "lastNotification": { + "format": "int32", + "type": "integer" + }, + "managedCertificateId": { + "description": "UUID of a managed certificate", + "example": "2f0e7320-9046-11ed-8ab8-19e0a618d9cd", + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "description": "The last date a certificate was modified", + "example": "2022-03-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "ocspNoCheck": { + "description": "If a certificate no ocsp check", + "example": false, + "type": "boolean" + }, + "ownership": { + "$ref": "#/components/schemas/CertificateOwnership" + }, + "pathLength": { + "description": "A certificate path length", + "example": 3, + "format": "int32", + "type": "integer" + }, + "requireExplicitPolicy": { + "description": "Required explicit policy is required", + "example": 1, + "format": "int32", + "type": "integer" + }, + "selfSigned": { + "description": "If the certificate is self singed", + "example": true, + "type": "boolean" + }, + "serialNumber": { + "description": "A certificate serial number", + "example": "0C51A562B02A19A222FFB4730C47A8E2", + "type": "string" + }, + "signatureAlgorithm": { + "description": "A certificate signature algorithm", + "enum": [ + "MD2_WITH_RSA_ENCRYPTION", + "MD5_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION", + "SHA1_WITH_RSA_ENCRYPTION2", + "SHA256_WITH_RSA_ENCRYPTION", + "SHA384_WITH_RSA_ENCRYPTION", + "SHA512_WITH_RSA_ENCRYPTION", + "ID_DSA_WITH_SHA1", + "dsaWithSHA1", + "EC_DSA_WITH_SHA1", + "EC_DSA_WITH_SHA224", + "EC_DSA_WITH_SHA256", + "EC_DSA_WITH_SHA384", + "EC_DSA_WITH_SHA512", + "UNKNOWN", + "SHA1_WITH_RSAandMGF1", + "GOST_R3411_94_WITH_GOST_R3410_2001", + "GOST_R3411_94_WITH_GOST_R3410_94" + ], + "example": "SHA256_WITH_RSA_ENCRYPTION", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Request conditions failed." + "signatureHashAlgorithm": { + "description": "A certificate signature hash algorithm", + "enum": [ + "MD5", + "SHA1", + "MD2", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "UNKNOWN", + "GOSTR3411_94" + ], + "example": "SHA256", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Certificate installation not found." + "statusModificationDate": { + "description": "The date a certificate's status was modified", + "example": "2022-04-24T09:12:28Z", + "format": "date-time", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Delete a machine", - "tags": [ - "Machines" - ] - }, - "patch": { - "description": "Updates specific details of the machine that matches the specified `id`.", - "operationId": "machines_update", - "parameters": [ - { - "description": "UUID of a Machine.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine.", - "format": "uuid", + "statusModificationUserId": { + "description": "UUID of the user that modified the certificate installation", + "example": "3c9964a0-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "subjectAlternativeNameDns": { + "description": "A collection of certificate subject alternative names DNs", + "example": [ + "venafi.com", + "www.venafi.com" + ], + "items": { "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineUpdateRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineInformation" - } - } }, - "description": "Machine was updated; details in the response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "subjectAlternativeNameNonDns": { + "description": "A collection of certificate subject alternative name none DNs", + "example": [ + "venafi domain" + ], + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Machine not found." + "subjectAlternativeNamesByType": { + "$ref": "#/components/schemas/GeneralNamesData2" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update a machine details", - "tags": [ - "Machines" - ] - } - }, - "/v1/machines/{id}/workflows": { - "post": { - "description": "Triggers the beginning of the workflow.", - "operationId": "machines_initiateWorkflow", - "parameters": [ - { - "description": "UUID of a Machine.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine.", - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineWorkflowRequest" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineInformation" - } - } - }, - "description": "Workflow initiated successfully." + "subjectC": { + "description": "A certificate subject Country", + "example": "US", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Request conditions failed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Initiate the workflow", - "tags": [ - "Machines" - ] - } - }, - "/v1/machinesearch": { - "post": { - "description": "Retrieves the details of machines that match the specified [search expression](https://docs.venafi.cloud/CSH_api_search).", - "operationId": "getMachinesByExpression", - "parameters": [ - { - "description": "Indicates whether response should include nested ownership data (e.g., `owningContainers`)", - "in": "query", - "name": "ownershipTree", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachinesSearchRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineDocumentResponse" - } - } + "subjectCN": { + "description": "A collection of certificate subject CNs", + "example": [ + "venafi.com", + "cloud.venafi" + ], + "items": { + "type": "string" }, - "description": "Details of Machines in response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "subjectDN": { + "description": "A certificate subject DN", + "example": "cn=www.venafi.com,o=Venafi, Inc.,c=US,st=Utah,l=Salt Lake City", + "type": "string" + }, + "subjectKeyIdentifierHash": { + "description": "A subject key identifier hash", + "example": "4E0CE93D3240561F468C33A85F08FCD3B04CC9DC", + "type": "string" + }, + "subjectL": { + "description": "A certificate subject Locality", + "example": "Salt Lake City", + "type": "string" + }, + "subjectO": { + "description": "A certificate subject Organization", + "example": "Venafi, Inc.", + "type": "string" + }, + "subjectOU": { + "description": "A collection of certificate subject Organization units", + "example": [ + "devops", + "test" + ], + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "subjectST": { + "description": "A certificate subject State", + "example": "Utah", + "type": "string" + }, + "tags": { + "description": "A collection of tags", + "example": [ + "owner:test.user", + "90-day" + ], + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" + }, + "totalActiveInstanceCount": { + "description": "total active instances of a certificate", + "example": 50, + "format": "int32", + "type": "integer" + }, + "totalInstanceCount": { + "description": "total instances of a certificate", + "example": 100, + "format": "int32", + "type": "integer" + }, + "validityEnd": { + "description": "The date a certificate validity ends", + "example": "2023-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "validityStart": { + "description": "The date a certificate validity starts", + "example": "2022-01-24T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "versionType": { + "description": "A certificate version type", + "enum": [ + "OLD", + "CURRENT" + ], + "example": "CURRENT", + "type": "string" } }, - "summary": "Get the details of machines matching", - "tags": [ - "Machines" - ] - } - }, - "/v1/machines/{id}/batchprovisionings/abort": { - "post": { - "description": "Triggers the abort operation on the current batch provisioning process for the machine with the specified `id`.", - "operationId": "abort-v1-batchprovisionings-forMachineId", - "parameters": [ - { - "description": "UUID of a Machine.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine.", + "type": "object" + }, + "ExtendedCertificateInstanceInformation": { + "properties": { + "applicationIds": { + "description": "A collection of application IDs", + "example": [ + "d3cce873-6957-4071-a65e-7676c0ae1123", + "322bcd99-286a-47ea-8dcd-8291ec5bff14" + ], + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "202": { - "description": "Batch provisioning abort success." - }, - "403": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } }, - "description": "Operation forbidden." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Active batch provisioning not found." + "certificate": { + "$ref": "#/components/schemas/CertificateInformation" }, - "405": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "certificateId": { + "description": "UUID of a certificate", + "example": "2eb29780-9046-11ed-8e50-b994b27d2ece", + "format": "uuid", + "type": "string" + }, + "certificateInstanceId": { + "description": "UUID of a certificate instance", + "example": "f68daf30-4690-45bc-85b3-bb327024735e", + "format": "uuid", + "type": "string" + }, + "certificateSource": { + "description": "Certificate source", + "enum": [ + "UNKNOWN", + "USER_PROVIDED", + "USER_IMPORTED", + "USER_SCAN", + "TRUSTNET_SCAN", + "ON_PREM_CA_IMPORT", + "EXTERNAL_CA_IMPORT", + "FILE_IMPORT", + "EXTERNAL_SCAN", + "DOMAIN_SCAN", + "SMART_SCAN_INTERNAL", + "SMART_SCAN_EXTERNAL", + "SMART_VALIDATION_INTERNAL", + "SMART_VALIDATION_EXTERNAL", + "MACHINE_DISCOVERY", + "KUBERNETES_DISCOVERY", + "AWS_DISCOVERY", + "AZURE_DISCOVERY", + "GCP_DISCOVERY" + ], + "example": "USER_SCAN", + "type": "string" + }, + "deploymentStatus": { + "description": "The deployment status", + "enum": [ + "UNKNOWN", + "IN_USE", + "SUPERSEDED" + ], + "example": "IN_USE", + "type": "string" + }, + "hostname": { + "description": "A hostname", + "example": "venafi.com", + "type": "string" + }, + "instanceChainValidationStatus": { + "description": "A collection of the instance chain validation status", + "example": [ + "OK" + ], + "items": { + "enum": [ + "OK", + "CHAIN_BUILDING_FAILED", + "INCOMPLETE_CHAIN", + "CHAIN_EXPIRE_BEFORE_EE", + "DISTRUSTED", + "UNKNOWN_ERROR", + "SELF_SIGNED" + ], + "type": "string" }, - "description": "Abort batch provisioning not allowed." + "type": "array" + }, + "ipAddress": { + "description": "An ip address", + "example": "14.183.1.32", + "type": "string" + }, + "lastScanDate": { + "description": "The last scan date", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "lastValidatedAttempt": { + "description": "The last validation attempt date", + "example": "2023-01-11T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "modificationDate": { + "description": "The last modification date", + "example": "2023-01-10T09:12:28Z", + "format": "date-time", + "type": "string" + }, + "port": { + "description": "A port number", + "example": 443, + "format": "int32", + "type": "integer" }, - "500": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Internal server error." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Abort active batch provisioning for a", - "tags": [ - "Machines" - ] - } - }, - "/v1/machines/{id}/discovery": { - "get": { - "description": "Retrieves the details of the machine's discovery.", - "operationId": "machineDiscoveryResults_getByMachineId", - "parameters": [ - { - "description": "UUID of a Machine.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine.", + "serviceIds": { + "description": "A collection of service IDs", + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineDiscoveryResultInformation" - } - } }, - "description": "Discovery result for machine was found; details in response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "sslProtocols": { + "description": "A collection of ssl protocols", + "example": [ + "TLSv1.1", + "TLSv1.2" + ], + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } + "sslValidationErrorArguments": { + "description": "A collection of ssl validation error arguments", + "example": [ + "B69950CC5F51EDDF55F36AD2BC898767BC43CC2A", + "24E5796GA7298E78EDE47D6FAED0790E8F464G54" + ], + "items": { + "type": "string" }, - "description": "The discovery result for the machine was not found. It is possible that discovery was never initiated. Run discovery and try again." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Incomplete or malformed request." + "sslValidationStatus": { + "description": "SSL validation status", + "enum": [ + "HOSTNAME_NOT_RESOLVABLE", + "NO_CERTIFICATE_PRESENTED", + "INVALID_CERTIFICATE_FOUND", + "UNEXPECTED_CERTIFICATE_FOUND", + "OLD_VERSION_CERTIFICATE_FOUND", + "TARGET_UNREACHABLE", + "UNKNOWN_ERROR", + "OK" + ], + "example": "OK", + "type": "string" + }, + "sslValidationStatusMessage": { + "description": "SSL validation status message", + "example": "Certificate installation is using older versions of certificate", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "ExtendedCertificateInstanceResponse": { + "properties": { + "count": { + "format": "int32", + "type": "integer" + }, + "instances": { + "items": { + "$ref": "#/components/schemas/ExtendedCertificateInstanceInformation" + }, + "type": "array" } - ], - "summary": "Get the discovery results for a", - "tags": [ - "Machines" - ] - } - }, - "/v1/machines/{id}/discovery/abort": { - "post": { - "description": "Aborts an active discovery.", - "operationId": "machineDiscoveryResults_abortdiscovery", - "parameters": [ - { - "description": "UUID of a Machine.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a Machine.", + }, + "type": "object" + }, + "ExtendedConfigurationInformation": { + "properties": { + "advancedSettings": { + "$ref": "#/components/schemas/AdvancedSettingsInformation" + }, + "clientAuthentication": { + "$ref": "#/components/schemas/ClientAuthenticationInformation" + }, + "clientAuthorization": { + "$ref": "#/components/schemas/ClientAuthorizationInformation" + }, + "cloudProviders": { + "$ref": "#/components/schemas/CloudProvidersInformation" + }, + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "controllerAllowedPolicyIds": { + "description": "Array of UUIDs of policies that the kubernetes controller is permitted to use", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MachineInformation" - } - } }, - "description": "Abort discovery success." + "type": "array" }, - "403": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Operation forbidden." + "creationDate": { + "description": "When the configuration was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Active discovery not found." + "id": { + "description": "UUID of the configuration", + "example": "7268d820-a08d-11ed-bbc0-252385d6d389", + "format": "uuid", + "type": "string" }, - "405": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse11" - } - } - }, - "description": "Abort discovery not allowed." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Abort machine discovery", - "tags": [ - "Machines" - ] - } - }, - "/v1/users": { - "get": { - "description": "Retrieve list of users matching the criteria. Note that this operation might result in a larger-than-expected dataset.operation can potentially be expensive as resulting dataset may be large", - "operationId": "get-v1-users", - "parameters": [ - { - "description": "Current user status.", - "in": "query", - "name": "userStatus", - "schema": { - "items": { - "$ref": "#/components/schemas/UserStatus" - }, - "type": "array" - } + "longLivedCertCount": { + "description": "Number of long lived certificates", + "example": 2, + "format": "int64", + "type": "integer" + }, + "minTlsVersion": { + "description": "Minimum required TLS protocol version", + "enum": [ + "TLS12", + "TLS13" + ], + "type": "string" }, - { - "description": "Username string; Accepts regex", - "in": "query", - "name": "username", - "schema": { - "type": "string" - } + "modificationDate": { + "description": "When the configuration was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" }, - { - "description": "Optional disabled user filter flag; true will return disabled users; false will return non-disabled users; default will return all users", - "in": "query", - "name": "disabled", - "schema": { - "type": "boolean" - } + "name": { + "description": "Name of the configuration", + "example": "Some configuration", + "type": "string" }, - { - "description": "Optional soft-deleted user filter flag; true will return soft-deleted users; false will return non-soft-deleted users; default will return all users", - "in": "query", - "name": "deleted", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserResponse" - } - } + "policies": { + "items": { + "$ref": "#/components/schemas/PolicyInformation" }, - "description": "All users" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve users matching specified criteria", - "tags": [ - "Users" - ] - } - }, - "/v1/users/{id}": { - "get": { - "description": "Retrieve user with 'id' attribute matching specified value.", - "operationId": "get-v1-users-byId", - "parameters": [ - { - "description": "UUID of a user", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a user", + "type": "array" + }, + "policyDefinitions": { + "items": { + "$ref": "#/components/schemas/PolicyInformation" + }, + "type": "array" + }, + "policyIds": { + "description": "Array of UUIDs of policies to associate with the configuration", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInformation2" - } - } }, - "description": "User matching specified userId" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "serviceAccountIds": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed" + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "User not found" + "shortLivedCertCount": { + "description": "Number of short lived certificates", + "example": 20, + "format": "int64", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "subCaProvider": { + "$ref": "#/components/schemas/SubCaProviderInformation" + }, + "ultraShortLivedCertCount": { + "description": "Number of ultra short lived certificates", + "example": 200, + "format": "int64", + "type": "integer" + }, + "unixSocketAllowedPolicyIds": { + "description": "Array of UUIDs of policies that are permitted to be used when using the unix socket", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request conditions failed" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve user details by user ID", - "tags": [ - "Users" - ] - } - }, - "/v1/users/{id}/accounttype": { - "put": { - "description": "Update account type for user with 'id' attribute matching specified value.", - "operationId": "put-v1-users-byId-accounttype", - "parameters": [ - { - "description": "UUID of a user", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a user", - "format": "uuid", + "type": "object" + }, + "ExtendedPolicyInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "configurations": { + "items": { + "$ref": "#/components/schemas/ConfigurationInformation" + }, + "type": "array" + }, + "creationDate": { + "description": "When the policy was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "extendedKeyUsages": { + "description": "Extended key usages", + "example": [ + "CLIENT_AUTH", + "SERVER_AUTH" + ], + "items": { + "enum": [ + "ANY", + "SERVER_AUTH", + "CLIENT_AUTH", + "CODE_SIGNING", + "EMAIL_PROTECTION", + "IPSEC_ENDSYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "TIME_STAMPING", + "OCSP_SIGNING", + "DVCS", + "SBGP_CERT_AA_SERVER_AUTH", + "SCVP_RESPONDER", + "EAP_OVER_PPP", + "EAP_OVER_LAN", + "SCVP_SERVER", + "SCVP_CLIENT", + "IPSEC_IKE", + "CAPWAP_AC", + "CAPWAP_WTP", + "IPSEC_IKE_INTERMEDIATE", + "SMARTCARD_LOGON" + ], + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "UUID of the policy", + "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", + "format": "uuid", + "type": "string" + }, + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithmInformation" + }, + "keyUsages": { + "description": "Key usages", + "example": [ + "keyEncipherment", + "digitalSignature" + ], + "items": { + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountTypeRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInformation2" - } - } }, - "description": "User account type was updated. Updated user details in response." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "modificationDate": { + "description": "When the policy was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "User was not found." + "name": { + "description": "Name of the policy", + "example": "Some policy", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update user account type", - "tags": [ - "Users" - ] - } - }, - "/v1/users/{id}/locallogin": { - "put": { - "description": "Enable/disable local login for specified user.", - "operationId": "put-v1-users-byId-locallogin", - "parameters": [ - { - "description": "UUID of a user.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a user.", - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LocalLoginRequest" - } - } + "sans": { + "$ref": "#/components/schemas/SansInformation" + }, + "subject": { + "$ref": "#/components/schemas/SubjectAttributesInformation" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInformation2" - } - } - }, - "description": "Local login property for the user was updated. Updated user details in response." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "type": "object" + }, + "Facet": { + "properties": { + "domain": { + "additionalProperties": { + "$ref": "#/components/schemas/AnyValue7" }, - "description": "Incomplete or malformed request." + "type": "object" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "facets": { + "items": { + "$ref": "#/components/schemas/Facet" }, - "description": "User not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "name": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "Filter1": { + "format": "json", + "type": "string" + }, + "Filter2": { + "properties": { + "expression": { + "$ref": "#/components/schemas/BaseFilter" + }, + "ordering": { + "$ref": "#/components/schemas/BaseOrdering" + }, + "paging": { + "$ref": "#/components/schemas/Page2" } - ], - "summary": "Enable disable local login for user", - "tags": [ - "Users" - ] - } - }, - "/v1/users/{id}/roles": { - "put": { - "description": "Update a user's currently assigned user role to limit or expand permissions. Learn more about [user roles](https://docs.venafi.cloud/CSH_user_roles_defined)", - "operationId": "put-v1-users-byId-roles", - "parameters": [ - { - "description": "UUID of a user.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a user.", - "format": "uuid", - "type": "string" - } + }, + "type": "object" + }, + "FilterOperand": { + "properties": { + "operand": { + "$ref": "#/components/schemas/Condition" + }, + "operator": { + "description": "An operator for filtering", + "enum": [ + "NOT" + ], + "example": "NOT", + "type": "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RolesRequest" + }, + "type": "object" + }, + "FilterOperands": { + "properties": { + "operands": { + "description": "A list of conditions that will be used for filtering", + "example": [ + { + "field": "certificateStatus", + "operator": "EQ", + "value": "ACTIVE" + }, + { + "field": "certificateName", + "operator": "EQ", + "value": "venafi.com" } - } + ], + "items": { + "$ref": "#/components/schemas/BaseFilter" + }, + "type": "array" + }, + "operator": { + "description": "An operator for filtering", + "enum": [ + "AND", + "OR" + ], + "example": "OR", + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInformation2" - } - } + "type": "object" + }, + "GeneralNamesData1": { + "description": "A certificate request subject alternative name (SAN) type", + "example": { + "dNSName": [ + "www.venafi.com", + "venafi.com" + ] + }, + "properties": { + "dNSName": { + "items": { + "type": "string" }, - "description": "User roles were updated. The newly assigned user role is given in the response." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "directoryName": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "ediPartyName": { + "items": { + "type": "string" }, - "description": "User not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "iPAddress": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update user roles", - "tags": [ - "Users" - ] - } - }, - "/v1/users/username/{username}": { - "get": { - "description": "Lets you use the 'username' attribute to get the details of the associated user; specified value should be an email address.", - "operationId": "get-v1-users-username-byUsername", - "parameters": [ - { - "in": "path", - "name": "username", - "required": true, - "schema": { + "type": "array" + }, + "otherName": { + "items": { "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserResponse" - } - } }, - "description": "Details of the user matching specified username." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "registeredID": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "rfc822Name": { + "items": { + "type": "string" }, - "description": "User not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "uniformResourceIdentifier": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve user details by username", - "tags": [ - "Users" - ] - } - }, - "/v1/users/{id}/passwordexpiration": { - "put": { - "description": "Update if a user's password should be forced into an expired state for user with 'id' attribute matching specified value.", - "operationId": "put-v1-users-byId-passwordexpiration", - "parameters": [ - { - "description": "UUID of a user", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a user", - "format": "uuid", + "type": "array" + }, + "x400Address": { + "items": { "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserForceLocalPasswordExpirationRequest" - } - } + }, + "type": "array" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInformation2" - } - } + "type": "object" + }, + "GeneralNamesData2": { + "description": "A certificate subject alternative name by type", + "example": { + "dNSName": [ + "www.venafi.com", + "venafi.com" + ] + }, + "properties": { + "dNSName": { + "items": { + "type": "string" }, - "description": "User forceLocalPasswordExpiration value was updated. Updated user details in response." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "directoryName": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "ediPartyName": { + "items": { + "type": "string" }, - "description": "User was not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "iPAddress": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update if a user must change", - "tags": [ - "Users" - ] - } - }, - "/v1/useraccounts": { - "get": { - "description": "Retrieve user account information for API key specified in header: User details, User's API key details and Associated company details.", - "operationId": "useraccounts_getByAuth", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccountResponse" - } - } + "type": "array" + }, + "otherName": { + "items": { + "type": "string" }, - "description": "Authenticated user's account information: user details, user's API key details, and associated company details." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "registeredID": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "rfc822Name": { + "items": { + "type": "string" }, - "description": "User account was not found for the specified API Key." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "uniformResourceIdentifier": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" + }, + "x400Address": { + "items": { + "type": "string" + }, + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve an authenticated user account details", - "tags": [ - "User Accounts" - ] - } - }, - "/v1/teams": { - "get": { - "description": "Retrieve teams for the current company", - "operationId": "teams_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamsResponse" - } - } + "type": "object" + }, + "GetCMSConfigurationsResponse": { + "description": "The array of Credential Manager Service configurations received.", + "properties": { + "cmsConfigurations": { + "items": { + "$ref": "#/components/schemas/CMSConfigurationResponse" }, - "description": "List of teams." + "minItems": 1, + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "count": { + "type": "integer" + } + }, + "required": [ + "cmsConfigurations", + "count" + ], + "type": "object" + }, + "GetCredentialsResponse": { + "description": "Array of credentials received.", + "properties": { + "count": { + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "credentials": { + "items": { + "$ref": "#/components/schemas/CredentialResponse" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ + "required": [ + "credentials", + "count" + ], + "type": "object" + }, + "GetServiceAccountScopesResponseBody": { + "example": [ { - "tppl-api-key": [] + "authenticationType": "rsaKey", + "id": "distributed-issuance", + "readableName": "Distributed Issuance" } ], - "summary": "Retrieve teams for the current company", - "tags": [ - "Teams" - ] + "items": { + "$ref": "#/components/schemas/ScopeDetails" + }, + "type": "array" }, - "post": { - "description": "Creates a team for the company with which the authenticated user is associated.", - "operationId": "teams_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateTeamRequest" - } - } + "GetServiceAccountsByClientIDResponseBody": { + "$ref": "#/components/schemas/ServiceAccountDetails" + }, + "GetServiceAccountsResponseBody": { + "example": [ + { + "authenticationType": "rsaKey", + "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", + "credentialLifetime": 365, + "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", + "enabled": true, + "id": "933507dd-0286-11ef-bc25-8a00a468403f", + "name": "Service Account I", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "scopes": [ + "distributed-issuance" + ], + "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", + "updatedOn": "2024-01-01T00:00:00.000000Z" + }, + { + "authenticationType": "rsaKey", + "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", + "credentialLifetime": 365, + "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", + "enabled": true, + "id": "933507dd-0286-11ef-bc25-8a00a468403a", + "name": "Service Account II", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "scopes": [ + "distributed-issuance" + ], + "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", + "updatedOn": "2024-01-01T00:00:00.000000Z" } + ], + "items": { + "$ref": "#/components/schemas/ServiceAccountDetailsNoKey" }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamInformation2" - } - } - }, - "description": "Team created" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "type": "array" + }, + "GoogleCloudProviderInformation": { + "properties": { + "projectIdentifiers": { + "description": "Array of Google project identifiers each of which should be a string with int64 number or 6 to 30 lowercase letters, digits, or hyphens, should start with a letter and not contain trailing hyphens", + "example": [ + "415104041262", + "tokyo-rain-123" + ], + "items": { + "type": "string" }, - "description": "Incomplete or malformed request." + "minItems": 1, + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "regions": { + "description": "Array of Google regions", + "example": [ + "us-west1" + ], + "items": { + "enum": [ + "asia-east1", + "asia-east2", + "asia-northeast1", + "asia-northeast2", + "asia-northeast3", + "asia-south1", + "asia-south2", + "asia-southeast1", + "asia-southeast2", + "australia-southeast1", + "australia-southeast2", + "europe-central2", + "europe-north1", + "europe-southwest1", + "europe-west1", + "europe-west12", + "europe-west2", + "europe-west3", + "europe-west4", + "europe-west6", + "europe-west8", + "europe-west9", + "me-central1", + "me-west1", + "northamerica-northeast1", + "northamerica-northeast2", + "southamerica-east1", + "southamerica-west1", + "us-central1", + "us-east1", + "us-east4", + "us-east5", + "us-south1", + "us-west1", + "us-west2", + "us-west3", + "us-west4" + ], + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "projectIdentifiers", + "regions" ], - "summary": "Add a team", - "tags": [ - "Teams" - ] - } - }, - "/v1/teams/{id}": { - "get": { - "description": "Retrieve the details of a team that has the specified `id`.", - "operationId": "teams_getById", - "parameters": [ - { - "description": " UUID of a team.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": " UUID of a team.", - "format": "uuid", - "type": "string" - } - } + "type": "object" + }, + "HSMEdgeStatus": { + "enum": [ + "HSM_ERROR", + "HSM_NOT_CONFIGURED", + "HSM_LOST_CONNECTION", + "HSM_HEALTHY" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamInformation2" - } - } - }, - "description": "Team's details." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } + "type": "string" + }, + "HashiCorpConfiguration": { + "allOf": [ + { + "properties": { + "authType": { + "$ref": "#/components/schemas/CMSAuthenticationType" + }, + "url": { + "$ref": "#/components/schemas/CMSURL" } }, - "description": "Incomplete or malformed request." + "required": [ + "authType" + ], + "type": "object" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ { - "tppl-api-key": [] + "oneOf": [ + { + "$ref": "#/components/schemas/CertificateCredentialData" + }, + { + "$ref": "#/components/schemas/UserPasswordAuthenticationData" + } + ] } ], - "summary": "Get a team details", - "tags": [ - "Teams" - ] + "description": "The configuration for the HashiCorp app. It's required to set the value for the `cmsType` property to `hashicorp`." }, - "delete": { - "description": "Deletes the team with specified `id`.", - "operationId": "teams_delete", - "parameters": [ + "HashiCorpConfigurationRequiredProp": { + "allOf": [ { - "description": "UUID of a team.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a team.", - "format": "uuid", - "type": "string" - } + "$ref": "#/components/schemas/HashiCorpConfiguration" } ], - "responses": { - "204": { - "description": "Team was deleted." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "description": "The configuration for the HashiCorp app. It's required to set the value for the `cmsType` property to `hashicorp`.", + "required": [ + "url" + ] + }, + "HashiCorpDetails": { + "description": "The HashiCorp Credential information.", + "properties": { + "secretKeyName": { + "description": "The HashiCorp secret key name property.", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "secretPath": { + "description": "The HashiCorp secret path property.", + "type": "string" } }, - "security": [ + "type": "object" + }, + "HashiCorpDetailsRequiredProp": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/HashiCorpDetails" } ], - "summary": "delete a team", - "tags": [ - "Teams" + "required": [ + "secretPath", + "secretKeyName" ] }, - "patch": { - "description": "Updates the details of a team that matches the specified team `id`.", - "operationId": "teams_update", - "parameters": [ - { - "description": "UUID of a team.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a team.", + "ImportedCertificateInformation": { + "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" + }, + "base64Certificate": { + "description": "Certificate base64 encoded format (PEM without header/footer", + "type": "string" + }, + "certificateSource": { + "description": "A certificate source", + "enum": [ + "UNKNOWN", + "USER_PROVIDED", + "USER_IMPORTED", + "USER_SCAN", + "TRUSTNET_SCAN", + "ON_PREM_CA_IMPORT", + "EXTERNAL_CA_IMPORT", + "FILE_IMPORT", + "EXTERNAL_SCAN", + "DOMAIN_SCAN", + "SMART_SCAN_INTERNAL", + "SMART_SCAN_EXTERNAL", + "SMART_VALIDATION_INTERNAL", + "SMART_VALIDATION_EXTERNAL", + "MACHINE_DISCOVERY", + "KUBERNETES_DISCOVERY", + "AWS_DISCOVERY", + "AZURE_DISCOVERY", + "GCP_DISCOVERY" + ], + "example": "USER_PROVIDED", + "type": "string" + }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" + }, + "type": "array" + }, + "companyId": { + "description": "UUID of a company", + "example": "2d558b30-da16-11ed-8e4f-8339a1bc8d58", + "format": "uuid", + "type": "string" + }, + "fingerprint": { + "description": "A certificate fingerprint", + "example": "2C85B0AD64F55AA70BAC75F69711578DC505C3F9", + "type": "string" + }, + "id": { + "description": "UUID of a Certificate", + "example": "16cb6940-e2de-11ed-a644-4fab0ea00b60", + "format": "uuid", + "type": "string" + }, + "issuerCertificateIds": { + "description": "A collection of issuer certificates", + "items": { "format": "uuid", "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateTeamRequest" - } - } + }, + "type": "array" + }, + "managedCertificateId": { + "description": "UUID of a managed certificate", + "example": "17488880-e2de-11ed-aed6-79d407efea73", + "format": "uuid", + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamInformation2" - } - } + "type": "object" + }, + "IntegrationServiceCreationRequest": { + "properties": { + "edgeInstancesIds": { + "description": "A collection of Vsatellite instance IDs", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Successfully updated team properties." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "environmentId": { + "description": "UUID of an environment", + "example": "2e8cfc70-74ce-11ed-9051-cfa579eae364", + "format": "uuid", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "name": { + "description": "Integration service name", + "example": "Internet discovery", + "minLength": 1, + "type": "string" + }, + "scheduleEnabled": { + "description": "If a integration service is scheduled for execution", + "example": true, + "type": "boolean" + }, + "schedulePattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation2" + }, + "serviceType": { + "description": "The type of an integration service", + "enum": [ + "BASIC_DISCOVERY", + "ENHANCED_DISCOVERY", + "EXTERNAL_SCAN", + "INTERNET_DISCOVERY", + "SMART_DISCOVERY_EXTERNAL", + "KEY_GENERATION", + "MSCA", + "ACME" + ], + "example": "ENHANCED_DISCOVERY", + "type": "string" + }, + "targets": { + "$ref": "#/components/schemas/TargetsInformation" + }, + "workTypes": { + "description": "A collection of work types", + "items": { + "enum": [ + "DISCOVER", + "MANAGE" + ], + "type": "string" }, - "description": "Incomplete or malformed request." + "minItems": 1, + "type": "array", + "uniqueItems": true } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update team details", - "tags": [ - "Teams" - ] - } - }, - "/v1/teams/{id}/members": { - "post": { - "description": "Adds members to the team with specified team's`id`.", - "operationId": "teams_members_add", - "parameters": [ - { - "description": "UUID of a team.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a team.", - "format": "uuid", - "type": "string" - } - } + "required": [ + "environmentId", + "name", + "serviceType", + "workTypes" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamMembersRequest" - } - } + "type": "object" + }, + "IntegrationServiceDetailsResponse": { + "properties": { + "integrationsServices": { + "items": { + "$ref": "#/components/schemas/IntegrationServiceInformation" + }, + "type": "array" + }, + "totalCount": { + "description": "The total number of integration services returned", + "example": 10, + "format": "int64", + "type": "integer" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamInformation2" - } - } - }, - "description": "Successfully added team members. Updated team details in the response." + "type": "object" + }, + "IntegrationServiceInformation": { + "properties": { + "companyId": { + "description": "UUID of a company", + "example": "2b391680-74ce-11ed-bf7a-a3d5ccdf275c", + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "edgeInstancesIds": { + "description": "A collection of Vsatellite instance IDs", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "encryptionKeyId": { + "description": "Encryption key UUID", + "example": "41bb5280-7193-11ed-a059-a7f274bd0b5b", + "format": "uuid", + "type": "string" + }, + "environmentId": { + "description": "UUID of an environment", + "example": "2e8cfc70-74ce-11ed-9051-cfa579eae364", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "UUID of an integration service", + "example": "2e8d71a0-74ce-11ed-9051-cfa579eae364", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Integration service name", + "example": "Internet discovery", + "type": "string" + }, + "schedulePattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation2" + }, + "schedulerEnabled": { + "description": "If a integration service is scheduled for execution", + "example": true, + "type": "boolean" + }, + "serviceType": { + "description": "The type of an integration service", + "enum": [ + "BASIC_DISCOVERY", + "ENHANCED_DISCOVERY", + "EXTERNAL_SCAN", + "INTERNET_DISCOVERY", + "SMART_DISCOVERY_EXTERNAL", + "KEY_GENERATION", + "MSCA", + "ACME" + ], + "example": "ENHANCED_DISCOVERY", + "type": "string" + }, + "status": { + "description": "Integration service status", + "enum": [ + "ACTIVE", + "DISABLED", + "RUNNING", + "WARNING", + "DRAFT", + "ERROR" + ], + "example": "DISABLED", + "type": "string" + }, + "statusMessage": { + "description": "Integration service status message", + "example": "Integration service is disable", + "type": "string" + }, + "systemGenerated": { + "description": "If an integration service was generated automatically", + "example": true, + "type": "boolean" + }, + "targets": { + "$ref": "#/components/schemas/TargetsInformation" + }, + "workTypes": { + "description": "A collection of work types", + "items": { + "enum": [ + "DISCOVER", + "MANAGE" + ], + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array", + "uniqueItems": true } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Add team members", - "tags": [ - "Teams" - ] + "type": "object" }, - "delete": { - "description": "Removes team members with the specified team's `id`.", - "operationId": "teams_members_delete", - "parameters": [ - { - "description": "UUID of a team.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a team.", + "IntegrationServiceUpdateRequest": { + "properties": { + "edgeInstancesIds": { + "description": "A collection of Vsatellite instance IDs", + "items": { "format": "uuid", "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamMembersRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamInformation2" - } - } }, - "description": "Members were removed. Updated team details in response." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "name": { + "description": "Integration service name", + "example": "Internet discovery", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Remove team members", - "tags": [ - "Teams" - ] - } - }, - "/v1/teams/{id}/owners": { - "post": { - "description": "Adds owners to the team with the specified team's `id`.", - "operationId": "teams_members_owners_add", - "parameters": [ - { - "description": "UUID of a team.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a team.", - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamOwnersRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamInformation2" - } - } - }, - "description": "Successfully added Team owners." + "scheduleEnabled": { + "description": "If a integration service is scheduled for execution", + "example": true, + "type": "boolean" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "schedulePattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation2" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "targets": { + "$ref": "#/components/schemas/TargetsInformation" + }, + "workTypes": { + "description": "A collection of work types", + "items": { + "enum": [ + "DISCOVER", + "MANAGE" + ], + "type": "string" }, - "description": "Incomplete or malformed request." + "maxItems": 2147483647, + "minItems": 1, + "type": "array", + "uniqueItems": true } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Add team owners", - "tags": [ - "Teams" - ] + "type": "object" }, - "delete": { - "description": "Removes owners from the team with the specified team's `id`.", - "operationId": "teams_members_owners_remove", - "parameters": [ - { - "description": "UUID of a team.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of a team.", - "format": "uuid", + "IntermediateCertificateInformation": { + "properties": { + "certificate": { + "description": "Intermediate certificate bytes in PEM format", + "format": "PEM", + "type": "string" + }, + "commonName": { + "description": "Common name of the Intermediate certificate", + "example": "example.com", + "type": "string" + }, + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" + }, + "configuration": { + "$ref": "#/components/schemas/ConfigurationInformation" + }, + "creationDate": { + "description": "When the intermediate certificate was created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation3" + }, + "fingerprint": { + "description": "Intermediate certificate fingerprint", + "type": "string" + }, + "id": { + "description": "UUID of the intermediate certificate", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "issuerCertificates": { + "description": "Intermediate certificate chain bytes in PEM format", + "items": { + "description": "Intermediate certificate chain bytes in PEM format", "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamOwnersRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TeamInformation2" - } - } }, - "description": "Owners were removed. Updated team details in response." + "type": "array" + }, + "longLivedCertCount": { + "description": "Number of long lived certificates", + "example": 1, + "format": "int64", + "type": "integer" + }, + "modificationDate": { + "description": "When the intermediate certificate was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } - }, - "description": "Incomplete or malformed request." + "shortLivedCertCount": { + "description": "Number of short lived certificates", + "example": 10, + "format": "int64", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse6" - } - } + "status": { + "description": "Status of the Intermediate certificate request", + "example": "ISSUED", + "type": "string" + }, + "ultraShortLivedCertCount": { + "description": "Number of ultra short lived certificates", + "example": 100, + "format": "int64", + "type": "integer" + }, + "validityEnd": { + "description": "Intermediate certificate validity end date", + "type": "string" + }, + "validityStart": { + "description": "Intermediate certificate validity start date", + "type": "string" + }, + "workflowId": { + "description": "Intermediate certificate workflow id", + "type": "string" + } + }, + "type": "object" + }, + "IntermediateCertificateResponse": { + "properties": { + "intermediateCertificates": { + "items": { + "$ref": "#/components/schemas/IntermediateCertificateInformation" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "InventoryMonitoringConfig": { + "discriminator": { + "mapping": { + "CERTIFICATE_EXPIRATION": "#/components/schemas/CertificateExpirationInventoryMonitoringConfig" + }, + "propertyName": "inventoryMonitoringConfigurationType" + }, + "properties": { + "inventoryMonitoringConfigurationType": { + "type": "string" } - ], - "summary": "Remove team owners", - "tags": [ - "Teams" - ] - } - }, - "/v1/activitylogsearch": { - "post": { - "description": "Request specific event log data that matches your filter criteria and include a total count of entries in the response.", - "operationId": "activitylogs_getByExpression", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityLogFilter" + }, + "type": "object" + }, + "InventoryMonitoringConfigRequest": { + "properties": { + "inventoryMonitoringConfiguration": { + "oneOf": [ + { + "$ref": "#/components/schemas/CertificateExpirationInventoryMonitoringConfig" } - } + ], + "type": "object" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityLogEntriesResponse" - } - } - }, - "description": "Total count and list of matching log entries." + "type": "object" + }, + "InventoryMonitoringConfiguration": { + "discriminator": { + "propertyName": "inventoryMonitoringConfigurationType" + }, + "properties": { + "inventoryMonitoringConfigurationType": { + "type": "string" + } + }, + "required": [ + "inventoryMonitoringConfigurationType" + ], + "type": "object" + }, + "InventoryMonitoringConfigurationResponse": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "2b391680-74ce-11ed-bf7a-a3d5ccdf275c", + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse3" - } - } - }, - "description": "Incomplete or malformed request." + "configuration": { + "$ref": "#/components/schemas/InventoryMonitoringConfiguration" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse3" - } - } - }, - "description": "Incomplete or malformed request." + "id": { + "description": "UUID of the configuration", + "example": "2e8d71a0-74ce-11ed-9051-cfa579eae364", + "format": "uuid", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve count and activity log entries", - "tags": [ - "Event Logs" - ] - } - }, - "/v1/activitylogsearch/export": { - "post": { - "description": "Request specific event log data that matches your filter criteria. You can even specify the format in the header as either JSON or CSV.", - "operationId": "activitylogs_getAllByExpression", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActivityLogFilter" - } - } + "type": "object" + }, + "InventoryMonitoringSchedulerInformation": { + "properties": { + "name": { + "description": "Name of the configuration", + "type": "string" + }, + "status": { + "description": "Status of the configuration", + "enum": [ + "PENDING", + "RUNNING", + "DONE", + "FAILED" + ], + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ExportedActivityLogEntryInformation" - }, - "type": "array" - } - }, - "text/csv": { - "schema": { - "type": "string" - } - } - }, - "description": "List of matching log entries." + "type": "object" + }, + "InvitationInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse3" - } - }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse3" - } - } - }, - "description": "Incomplete or malformed request." + "id": { + "format": "uuid", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse3" - } + "productRoles": { + "additionalProperties": { + "items": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" }, - "text/csv": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse3" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Export filtered event log data to", - "tags": [ - "Event Logs" - ] - } - }, - "/v1/activitytypes": { - "get": { - "description": "Retrieve types of activities used for event logging, such as failed login attempts or events that are critical. Learn more about [event logging](https://docs.venafi.cloud/vaas/logging/c-about-activity-logging/).", - "operationId": "activitylogtypes_get", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ActivityLogType" - }, - "type": "array" - } - } + "type": "array", + "uniqueItems": true }, - "description": "Types of activities in event logging; details in response body" + "type": "object" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse3" - } - } + "properties": { + "additionalProperties": { + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "object" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse3" - } - } - }, - "description": "Incomplete or malformed request." + "userId": { + "format": "uuid", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve types of activities used for", - "tags": [ - "Event Logs" - ] - } - }, - "/v1/edgeinstances/{id}/update": { - "post": { - "description": "Triggering an update for a satellite instance (manual)", - "operationId": "create-edgeinstances-update", - "parameters": [ - { - "description": "Satellite Instance ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "Satellite Instance ID", - "format": "uuid", - "type": "string" - } + "type": "object" + }, + "InvitationRequest": { + "properties": { + "role": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" } + }, + "required": [ + "role" ], - "responses": { - "202": { - "description": "Satellite Start Manual Update" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } + "type": "object" + }, + "InvitationResponse": { + "properties": { + "invitations": { + "items": { + "$ref": "#/components/schemas/InvitationInformation" }, - "description": "Request Conditions Failed" + "type": "array" + } + }, + "type": "object" + }, + "IssuingTemplateDomainsSyncInformation": { + "properties": { + "error": { + "$ref": "#/components/schemas/ErrorInformation9" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Satellite Instance Not Found" + "issuingTemplateId": { + "format": "uuid", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Request Conditions Failed" + "status": { + "enum": [ + "COMPLETED", + "FAILED" + ], + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Trigger manual update of Satellite Instance", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/edgeencryptionkeys": { - "get": { - "description": "Retrieve the list of satellite encryption keys based on query parameters", - "operationId": "edgeencryptionkeys_getAll", - "parameters": [ - { - "in": "query", - "name": "edgeInstanceId", - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EncryptionKeysResponse" - } - } + "type": "object" + }, + "IssuingTemplateDomainsSyncResponse": { + "properties": { + "issuingTemplatesInformationList": { + "items": { + "$ref": "#/components/schemas/IssuingTemplateDomainsSyncInformation" }, - "description": "List of SatelliteEncryption keys" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve Satellite Encryption Keys", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/edgeencryptionkeys/{id}": { - "get": { - "description": "Retrieve satellite encryption key with 'id' attribute matching specified value; specified value should be string not numeric", - "operationId": "edgeencryptionkeys_getById", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { + "type": "object" + }, + "IssuingTemplatesDomainsSyncRequest": { + "properties": { + "action": { + "enum": [ + "REPLACE" + ], + "type": "string" + }, + "certificateAuthorityAccountId": { + "format": "uuid", + "type": "string" + }, + "issuingTemplatesIds": { + "description": "Set of UUIDs of the issuing templates", + "example": [ + "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" + ], + "items": { + "description": "Set of UUIDs of the issuing templates", + "format": "uuid", "type": "string" - } + }, + "minItems": 1, + "type": "array", + "uniqueItems": true } + }, + "required": [ + "action", + "certificateAuthorityAccountId", + "issuingTemplatesIds" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EncryptionKeyInformation" - } - } + "type": "object" + }, + "JwtClient": { + "properties": { + "allowedPolicyIds": { + "description": "Array of UUIDs of policies that the client is permitted to use", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { + "format": "uuid", + "type": "string" }, - "description": "Encryption key information" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Request Conditions Failed" + "issuer": { + "description": "Issuer of the JWT", + "example": "https://kubernetes.default.svc", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Encryption key not found" + "jwksUri": { + "description": "URL used to pull the trusted singing keys used for validation", + "example": "https://www.example.com:6443/jwks", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } + "name": { + "description": "Name of the client", + "example": "Some client", + "type": "string" + }, + "subjects": { + "description": "Array of subjects of the JWT", + "example": [ + "system:serviceaccount:venafi:application-team-1" + ], + "items": { + "type": "string" }, - "description": "Request Conditions Failed" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve SatelliteEncryption Key By Id", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/edgeinstances": { - "get": { - "description": "Retrieve list of all satellite instances for company", - "operationId": "edgeinstances_getAll", - "parameters": [ - { - "in": "query", - "name": "environmentId", - "schema": { + "type": "object" + }, + "JwtClientInformation": { + "properties": { + "allowedPolicyIds": { + "description": "Array of UUIDs of policies that the client is permitted to use", + "example": [ + "8ae92800-b1e0-11ed-859d-b39255f965ee" + ], + "format": "uuid", + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeInstanceResponse" - } - } }, - "description": "Satelliteinstances matching specified id" + "minItems": 1, + "type": "array" + }, + "issuer": { + "description": "Issuer of the JWT", + "example": "https://kubernetes.default.svc", + "maxLength": 2048, + "type": "string" + }, + "jwksUri": { + "description": "URL used to pull the trusted singing keys used for validation", + "example": "https://www.example.com:6443/jwks", + "maxLength": 2048, + "type": "string" + }, + "name": { + "description": "Name of the client", + "example": "Some client", + "maxLength": 64, + "type": "string" + }, + "subjects": { + "description": "Array of subjects of the JWT", + "example": [ + "system:serviceaccount:venafi:application-team-1" + ], + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "allowedPolicyIds", + "issuer", + "name", + "subjects" ], - "summary": "Retrieve Satellite Instances", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/edgeinstances/{id}": { - "get": { - "description": "Retrieve satellite instance with 'id' attribute matching specified value; specified value should be uuid not numeric", - "operationId": "edgeinstances_getById", - "parameters": [ + "type": "object" + }, + "JwtJwksAuthenticationInformation": { + "allOf": [ { - "description": "Satellite Instance ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "Satellite Instance ID", - "format": "uuid", - "type": "string" - } + "$ref": "#/components/schemas/ClientAuthenticationInformation" }, { - "in": "query", - "name": "statusDetails", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeInstanceInformation" - } - } - }, - "description": "Satellite instance matching specified id" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Request Conditions Failed" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } + "properties": { + "urls": { + "description": "Array of JWT JWKS urls", + "example": [ + "https://jwks.example.com" + ], + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" } }, - "description": "Satellite instance not found" + "type": "object" + } + ], + "required": [ + "urls" + ], + "type": "object" + }, + "JwtJwksAuthenticationOpenApi": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationOpenApi" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } + { + "properties": { + "urls": { + "description": "Array of JWT JWKS urls", + "example": [ + "https://jwks.example.com" + ], + "items": { + "type": "string" + }, + "type": "array" } }, - "description": "Request Conditions Failed" - } - }, - "security": [ - { - "tppl-api-key": [] + "type": "object" } ], - "summary": "Retrieve Satellite Instance By Id", - "tags": [ - "VSatellite" - ] + "type": "object" }, - "put": { - "description": "Update satellite instance with specified new value", - "operationId": "edgeinstances_update", - "parameters": [ + "JwtOidcAuthenticationInformation": { + "allOf": [ { - "description": "Satellite Instance ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "Satellite Instance ID", - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeInstanceRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeInstanceInformation" - } - } - }, - "description": "Satellite Instance Updated" + "$ref": "#/components/schemas/ClientAuthenticationInformation" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } + { + "properties": { + "audience": { + "description": "OpenId audience", + "example": "Client1", + "maxLength": 256, + "type": "string" + }, + "baseUrl": { + "description": "JWT OpenId base URL", + "example": "https://openid.example.com", + "maxLength": 2048, + "type": "string" } }, - "description": "Request Conditions Failed" + "type": "object" + } + ], + "required": [ + "audience", + "baseUrl" + ], + "type": "object" + }, + "JwtOidcAuthenticationOpenApi": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationOpenApi" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } + { + "properties": { + "audience": { + "description": "OpenId audience", + "example": "Alpha testers", + "type": "string" + }, + "baseUrl": { + "description": "JWT OpenId base URL", + "example": "https://oidc.example.com/", + "type": "string" } }, - "description": "Satellite Instance Not Found" + "type": "object" + } + ], + "type": "object" + }, + "JwtStandardClaimsAuthenticationInformation": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationInformation" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } + { + "properties": { + "audience": { + "description": "Recipients that the JWT is intended for", + "example": "Client1", + "maxLength": 256, + "type": "string" + }, + "clients": { + "description": "List with clients, identified by processing JWTs that include standard/registered claims", + "items": { + "$ref": "#/components/schemas/JwtClientInformation" + }, + "minItems": 1, + "type": "array" } }, - "description": "Request Conditions Failed" - } - }, - "security": [ - { - "tppl-api-key": [] + "type": "object" } ], - "summary": "Update Satellite Instance", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/pairingcodes/satellite": { - "post": { - "description": "Generate new pairing code for satellite instance registration", - "operationId": "pairingcodes_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PairingCodeRequest" + "required": [ + "audience", + "clients" + ], + "type": "object" + }, + "JwtStandardClaimsAuthenticationOpenApi": { + "allOf": [ + { + "$ref": "#/components/schemas/ClientAuthenticationOpenApi" + }, + { + "properties": { + "audience": { + "description": "Recipients that the JWT is intended for", + "example": "Client1", + "type": "string" + }, + "clients": { + "description": "List with clients, identified by processing JWTs that include standard/registered claims", + "items": { + "$ref": "#/components/schemas/JwtClient" + }, + "type": "array" } - } + }, + "type": "object" } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PairingCodeInformation" - } - } + ], + "type": "object" + }, + "KeyAlgorithm": { + "enum": [ + "RSA", + "ED25519", + "VSAT_HPKE" + ], + "type": "string" + }, + "KeyAlgorithmInformation": { + "description": "Key algorithm", + "properties": { + "allowedValues": { + "description": "Key algorithm allowed values", + "items": { + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "type": "string" }, - "description": "Pairing Code Created" + "minItems": 1, + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Request Conditions Failed" + "defaultValue": { + "description": "Key algorithm default value", + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "example": "RSA_4096", + "type": "string" + } + }, + "required": [ + "allowedValues", + "defaultValue" + ], + "type": "object" + }, + "KeyTypeInformation1": { + "discriminator": { + "propertyName": "keyType" + }, + "properties": { + "keyType": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Create Pairing Code for Satellite Instance", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/recoverycodes/satellite": { - "post": { - "description": "Generate new recovery code for satellite instance restoration", - "operationId": "recoverycodes_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecoveryCodeRequest" - } - } + "type": "object" + }, + "KeyTypeInformation2": { + "discriminator": { + "propertyName": "keyType" + }, + "properties": { + "keyType": { + "type": "string" } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RecoveryCodeInformation" - } - } + "type": "object" + }, + "KeyTypeParameters1": { + "properties": { + "keyCurves": { + "items": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" }, - "description": "Recovery Code Created" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } + "keyLengths": { + "items": { + "format": "int32", + "type": "integer" }, - "description": "Request Conditions Failed" + "type": "array" + }, + "keyType": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "keyType" ], - "summary": "Create Recovery Code for Satellite Instance", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/edgeworkers": { - "get": { - "description": "Retrieve list of all satellite workers for company", - "operationId": "edgeworkers_getAll", - "parameters": [ - { - "in": "query", - "name": "edgeInstanceId", - "schema": { - "format": "uuid", - "type": "string" - } + "type": "object" + }, + "KeyTypeParameters2": { + "properties": { + "keyCurve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" + }, + "keyLength": { + "format": "int32", + "type": "integer" + }, + "keyType": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" } + }, + "required": [ + "keyCurve", + "keyLength", + "keyType" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeWorkersResponse" - } - } + "type": "object" + }, + "LastModifiedBy": { + "description": "The ID of the user whom modified the credential.", + "type": "string" + }, + "LastModifiedOn": { + "description": "The date in ISO 8601 full-date format when the credential was modified.", + "format": "date", + "type": "string" + }, + "Link": { + "properties": { + "params": { + "additionalProperties": { + "type": "string" }, - "description": "List of Satellite workers" + "type": "object" + }, + "rel": { + "type": "string" + }, + "rels": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "type": "string" + }, + "type": { + "type": "string" + }, + "uri": { + "format": "uri", + "type": "string" + }, + "uriBuilder": { + "$ref": "#/components/schemas/UriBuilder" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "LocalLoginRequest": { + "properties": { + "localLoginDisabled": { + "type": "boolean" } - ], - "summary": "Retrieve Satellite Workers", - "tags": [ - "VSatellite" - ] + }, + "type": "object" }, - "post": { - "description": "Create satellite worker and generate the pairing information", - "operationId": "edgeworkers_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeWorkerRequest" + "LocalizationResource": { + "description": "Translation map for the UI being rendered. This map is used with the manifest schema. The keys represent the values provided for the \"x-localizationKey\" property in the domain entity definition, and each key's value is used to represent field labels, enum values, or error messages.", + "nullable": true, + "properties": { + "en": { + "type": "object" + } + }, + "title": "LocalizationResources", + "type": "object", + "x-examples": { + "Example 1": { + "en": { + "address": { + "label": "Server Hostname" + }, + "binding": { + "label": "Server Store Details" + }, + "certificateName": { + "description": "How the certificate should appear on the server.", + "label": "Certificate Name" + }, + "chainName": { + "label": "Chain Bundle Name" + }, + "discovery": { + "expiredCertificatesLabel": "Exclude expired certificates", + "inactiveProfilesLabel": "Exclude certificates that are not in use by either a virtual server or a monitor.", + "partitionDescription": "A comma separated list of partition names.", + "partitionLabel": "Partition(s)" + }, + "discoveryType": { + "all": "Both Monitors and Virtual Servers", + "label": "Resource Types to Discover", + "monitor": "Monitors", + "virtualServer": "Virtual Servers" + }, + "keystore": { + "label": "Certificate Information" + }, + "parentProfile": { + "description": "No value is interpreted as \"clientssl\" or \"serverssl\" depending on the Profile Type selected.", + "label": "Parent Profile" + }, + "partition": { + "description": "No value is interpreted as the \"Common\" partition.", + "label": "Partition" + }, + "password": { + "hidePassword": "Hide Password", + "label": "Password", + "showPassword": "Show Password" + }, + "port": { + "description": "No value is interpreted as 443.", + "label": "Port" + }, + "serverName": { + "description": "An alternative DNS name used for Server Name Indication.", + "label": "SNI" + }, + "sslProfile": { + "label": "SSL Profile" + }, + "sslProfileType": { + "client": "Client SSL Profile", + "label": "Profile Type", + "server": "Server SSL Profile" + }, + "username": { + "label": "Username" } } } + } + }, + "MachineBatchProvisioningResultInformation": { + "properties": { + "endDate": { + "format": "date-time", + "type": "string" + }, + "errorMessage": { + "type": "string" + }, + "machineIdentitiesCount": { + "format": "int64", + "type": "integer" + }, + "machineIdentitiesFailedCount": { + "format": "int64", + "type": "integer" + }, + "machineIdentitiesSucceedCount": { + "format": "int64", + "type": "integer" + }, + "startDate": { + "format": "date-time", + "type": "string" + }, + "type": { + "enum": [ + "MANUAL", + "SCHEDULED" + ], + "type": "string" + } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeWorkerInformation" - } - } - }, - "description": "Satellite worker information" + "type": "object" + }, + "MachineCreationRequest": { + "properties": { + "connectionDetails": { + "$ref": "#/components/schemas/AnyValue5" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Request conditions failed" + "dekId": { + "minLength": 1, + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "machineTypeId": { + "deprecated": true, + "format": "uuid", + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + }, + "owningTeamId": { + "format": "uuid", + "type": "string" + }, + "pluginId": { + "format": "uuid", + "type": "string" + }, + "status": { + "enum": [ + "DRAFT", + "VERIFIED", + "UNVERIFIED", + "DELETING" + ], + "type": "string" + }, + "tags": { + "items": { + "type": "string" }, - "description": "Request conditions failed" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "connectionDetails", + "dekId", + "edgeInstanceId", + "name", + "pluginId" ], - "summary": "Create Satellite Worker", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/edgeworkers/{id}/pair": { - "post": { - "operationId": "edgeworkers_pair", - "parameters": [ - { - "description": "EdgeWorker ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "EdgeWorker ID", - "format": "uuid", - "type": "string" - } + "type": "object" + }, + "MachineDiscoveryResultInformation": { + "properties": { + "certificatesCountCurrent": { + "format": "int64", + "type": "integer" + }, + "certificatesCountTotal": { + "format": "int64", + "type": "integer" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "discoveryStatus": { + "enum": [ + "NEVER INITIATED", + "INITIATED", + "RUNNING", + "COMPLETED", + "ABORTED", + "ABORTING", + "FAILED" + ], + "type": "string" + }, + "endDate": { + "format": "date-time", + "type": "string" + }, + "errorCount": { + "format": "int32", + "type": "integer" + }, + "machineIdentitiesCount": { + "format": "int64", + "type": "integer" + }, + "machineIdentitiesDeletedCount": { + "format": "int64", + "type": "integer" + }, + "machineIdentitiesMissingCount": { + "format": "int64", + "type": "integer" + }, + "startDate": { + "format": "date-time", + "type": "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeWorkerRequest" - } - } + }, + "type": "object" + }, + "MachineDocumentInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "integrationId": { + "format": "uuid", + "type": "string" + }, + "machineIdentitiesCount": { + "format": "int32", + "type": "integer" + }, + "machineName": { + "type": "string" + }, + "machineType": { + "deprecated": true, + "type": "string" + }, + "machineTypeId": { + "deprecated": true, + "format": "uuid", + "type": "string" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "ownership": { + "$ref": "#/components/schemas/MachineOwnership" + }, + "owningTeam": { + "format": "uuid", + "type": "string" + }, + "pluginId": { + "format": "uuid", + "type": "string" + }, + "pluginName": { + "type": "string" + }, + "status": { + "enum": [ + "DRAFT", + "VERIFIED", + "UNVERIFIED", + "DELETING" + ], + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeWorkerInformation" - } - } - }, - "description": "Satellite worker paired with Satellitehub" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } + "type": "object" + }, + "MachineDocumentResponse": { + "properties": { + "machines": { + "items": { + "$ref": "#/components/schemas/MachineDocumentInformation" }, - "description": "Request conditions failed" + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Request conditions failed" + "totalCount": { + "format": "int64", + "type": "integer" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "MachineIdentityCreationRequest": { + "properties": { + "binding": { + "$ref": "#/components/schemas/AnyValue5" + }, + "certificateId": { + "format": "uuid", + "type": "string" + }, + "keystore": { + "$ref": "#/components/schemas/AnyValue5" + }, + "machineId": { + "format": "uuid", + "type": "string" } + }, + "required": [ + "certificateId", + "machineId" ], - "summary": "Pair Satellite Worker with Satellite Instance", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/edgeworkers/{id}": { - "delete": { - "description": "Delete satellite worker", - "operationId": "edgeworker_delete", - "parameters": [ - { - "description": "EdgeWorker ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "EdgeWorker ID", + "type": "object" + }, + "MachineIdentityDocumentInformation": { + "properties": { + "applicationIds": { + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdgeWorkerDeleteResponse" - } - } }, - "description": "Satellite worker deleted" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Request Conditions Failed" + "binding": { + "$ref": "#/components/schemas/AnyValue5" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } - }, - "description": "Satellite worker not found" + "certificateFingerprint": { + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse8" - } - } + "certificateId": { + "format": "uuid", + "type": "string" + }, + "certificateName": { + "type": "string" + }, + "certificateValidityEnd": { + "format": "date-time", + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "keystore": { + "$ref": "#/components/schemas/AnyValue5" + }, + "lastSeenOn": { + "format": "date-time", + "type": "string" + }, + "machineId": { + "format": "uuid", + "type": "string" + }, + "machineName": { + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/AnyValue5" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "NEW", + "PENDING", + "INSTALLED", + "DISCOVERED", + "VALIDATED", + "MISSING", + "FAILED" + ], + "type": "string" + } + }, + "type": "object" + }, + "MachineIdentityDocumentResponse": { + "properties": { + "machineIdentities": { + "items": { + "$ref": "#/components/schemas/MachineIdentityDocumentInformation" }, - "description": "Request Conditions Failed" + "type": "array" + } + }, + "type": "object" + }, + "MachineIdentityInformation": { + "properties": { + "binding": { + "$ref": "#/components/schemas/AnyValue5" + }, + "certificateId": { + "format": "uuid", + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "keystore": { + "$ref": "#/components/schemas/AnyValue5" + }, + "lastSeenOn": { + "format": "date-time", + "type": "string" + }, + "machineId": { + "format": "uuid", + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/AnyValue5" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "NEW", + "PENDING", + "INSTALLED", + "DISCOVERED", + "VALIDATED", + "MISSING", + "FAILED" + ], + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Delete Satellite Worker", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/updatesconfig": { - "get": { - "description": "Retrieve updates configuration for tenant", - "operationId": "updatesconfig_get", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdatesConfigResponse" - } - } + "type": "object" + }, + "MachineIdentityResponse": { + "properties": { + "machineIdentities": { + "items": { + "$ref": "#/components/schemas/MachineIdentityInformation" }, - "description": "Tenant updates configuration" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "MachineIdentitySearchRequest": { + "properties": { + "expression": { + "$ref": "#/components/schemas/Expression" + }, + "ordering": { + "$ref": "#/components/schemas/Ordering" + }, + "paging": { + "$ref": "#/components/schemas/Paging" } - ], - "summary": "Retrieve Updates configuration", - "tags": [ - "VSatellite" - ] + }, + "type": "object" }, - "patch": { - "description": "Create or update updates configuration. The default update window is set to daily, with a start time at 12:00 AM and duration of 24 hours. This schedule allows updates to be performed on demand as soon as they become available.\n **Example Default Request Body:**\n\n ```json\n {\n \"updateConfigSchedulerPattern\": {\n \"recurrenceType\": \"DAY\",\n \"startTime\": \"00:00:00\",\n \"duration\": \"PT24H\"\n }\n }\n ```\n", - "operationId": "updatesconfig_patch", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdatesConfigRequest" - } - } + "MachineIdentityUpdateRequest": { + "properties": { + "binding": { + "$ref": "#/components/schemas/AnyValue5" }, - "description": "Modify updates configuration using patch behavior. All top level properties are optional", - "required": true + "certificateId": { + "format": "uuid", + "type": "string" + }, + "keystore": { + "$ref": "#/components/schemas/AnyValue5" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdatesConfigResponse" - } - } - }, - "description": "Updates configuration created/updated" + "type": "object" + }, + "MachineIdentityWorkflowInformation": { + "properties": { + "workflowId": { + "type": "string" + }, + "workflowName": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "MachineIdentityWorkflowRequest": { + "properties": { + "workflowInput": { + "$ref": "#/components/schemas/ProvisionCertificateWorkflowInputInformation" + }, + "workflowName": { + "type": "string" } + }, + "required": [ + "workflowName" ], - "summary": "Create or Update Configuration", - "tags": [ - "VSatellite" - ] - } - }, - "/v1/connectors/{id}": { - "put": { - "description": "Can be used to update specific fields. Only fields specified in the request will be updated.\nWhen the connector\u2019s target is a webhook (`generic`, `slack`, or `teams`), updating the connector triggers the same outbound connectivity check as creation. The service performs a live POST request Certificate Manager - SaaS to the configured `connection.url`. If the endpoint is unreachable (for example, due to DNS failure, TLS handshake issues, or network/firewall restrictions), the update request fails with a descriptive error.\n", - "operationId": "connectors_update", - "parameters": [ - { - "description": "Connector ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "Connector ID", + "type": "object" + }, + "MachineInformation": { + "properties": { + "batchProvisioningResult": { + "$ref": "#/components/schemas/MachineBatchProvisioningResultInformation" + }, + "batchProvisioningSchedulerEnabled": { + "type": "boolean" + }, + "batchProvisioningSchedulerPattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation1" + }, + "batchProvisioningStatus": { + "enum": [ + "NEVER_INITIATED", + "INITIATED", + "RUNNING", + "COMPLETED", + "ABORTED", + "ABORTING", + "FAILED" + ], + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "discoveryJson": { + "$ref": "#/components/schemas/AnyValue5" + }, + "discoverySchedulerEnabled": { + "type": "boolean" + }, + "discoverySchedulerPattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation1" + }, + "discoveryStatus": { + "enum": [ + "NEVER INITIATED", + "INITIATED", + "RUNNING", + "COMPLETED", + "ABORTED", + "ABORTING", + "FAILED" + ], + "type": "string" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "integrationId": { + "format": "uuid", + "type": "string" + }, + "machineType": { + "deprecated": true, + "type": "string" + }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "owningTeamId": { + "format": "uuid", + "type": "string" + }, + "pluginId": { + "format": "uuid", + "type": "string" + }, + "status": { + "enum": [ + "DRAFT", + "VERIFIED", + "UNVERIFIED", + "DELETING" + ], + "type": "string" + } + }, + "type": "object" + }, + "MachineOwnership": { + "properties": { + "owningTeams": { + "items": { "format": "uuid", "type": "string" - } + }, + "type": "array", + "uniqueItems": true } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorsUpdateRequest" - } - } + }, + "type": "object" + }, + "MachineUpdateRequest": { + "properties": { + "batchProvisioningSchedulerEnabled": { + "type": "boolean" + }, + "batchProvisioningSchedulerPattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation1" + }, + "connectionDetails": { + "$ref": "#/components/schemas/AnyValue5" + }, + "discoveryJson": { + "$ref": "#/components/schemas/AnyValue5" + }, + "discoverySchedulerEnabled": { + "type": "boolean" + }, + "discoverySchedulerPattern": { + "$ref": "#/components/schemas/SchedulerPatternInformation1" + }, + "edgeInstanceId": { + "format": "uuid", + "type": "string" + }, + "name": { + "type": "string" + }, + "owningTeamId": { + "format": "uuid", + "type": "string" + }, + "status": { + "enum": [ + "DRAFT", + "VERIFIED", + "UNVERIFIED", + "DELETING" + ], + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorsInformation" - } - } - }, - "description": "Connector Updated" + "type": "object" + }, + "MachineWorkflowRequest": { + "properties": { + "workflowInput": { + "$ref": "#/components/schemas/AnyValue5" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "workflowName": { + "type": "string" + } + }, + "type": "object" + }, + "MachinesResponse": { + "properties": { + "machines": { + "items": { + "$ref": "#/components/schemas/MachineInformation" }, - "description": "Request Conditions Failed" + "type": "array" + } + }, + "type": "object" + }, + "MachinesSearchRequest": { + "properties": { + "expression": { + "$ref": "#/components/schemas/Expression" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Connector Not Found" + "ordering": { + "$ref": "#/components/schemas/Ordering" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request Conditions Failed" + "paging": { + "$ref": "#/components/schemas/Paging" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update Connector properties", - "tags": [ - "Webhooks" - ] + "type": "object" }, - "delete": { - "description": "Delete a Connector.\nDeleting a connector removes its configuration for delivering events to the target endpoint, but it does not modify any customer firewall allowlisting or network settings. If your webhook endpoint requires allowlisting Venafi Cloud NAT IP addresses, that configuration must be managed separately.\n", - "operationId": "connectors_delete", - "parameters": [ - { - "description": "Connector ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "Connector ID", - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Connector Deleted" + "Manifest": { + "properties": { + "deployment": { + "$ref": "#/components/schemas/Deployment" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request Conditions Failed" + "description": { + "description": "Description text for the plugin.", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } + "domainSchema": { + "type": "object" + }, + "hooks": { + "properties": { + "mapping": { + "type": "object" + }, + "requestConverters": { + "items": {}, + "nullable": true, + "type": "array" } }, - "description": "Connector Not Found" + "required": [ + "mapping" + ], + "type": "object" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "localizationResources": { + "$ref": "#/components/schemas/LocalizationResource" + }, + "name": { + "description": "Name of the plugin.", + "type": "string" + }, + "pluginType": { + "$ref": "#/components/schemas/PluginType" + }, + "workTypes": { + "description": "Defines the type of workflows supported for the plugin.", + "items": { + "$ref": "#/components/schemas/WorkType" }, - "description": "Request Conditions Failed" + "minItems": 1, + "type": "array", + "uniqueItems": true } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "name", + "workTypes", + "deployment", + "domainSchema", + "hooks" ], - "summary": "Delete a Connector", - "tags": [ - "Webhooks" - ] - } - }, - "/v1/connectors": { - "get": { - "description": "Retrieve a list of all Connectors for a company", - "operationId": "connectors_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorsResponse" - } + "title": "Manifest", + "type": "object", + "x-examples": { + "Example 1": { + "deployment": { + "executionTarget": "vsat", + "image": "public.ecr.aws/docker/library/nginx:mainline-alpine3.18-slim" + }, + "description": "Description text.", + "domainSchema": { + "binding": { + "properties": { + "parentProfile": { + "description": "parentProfile.description", + "type": "string", + "x-labelLocalizationKey": "parentProfile.label", + "x-rank": 1 + }, + "serverName": { + "description": "serverName.description", + "format": "hostname", + "type": "string", + "x-labelLocalizationKey": "serverName.label", + "x-rank": 3, + "x-rule": { + "condition": { + "type": "#/properties/sslProfileType" + }, + "effect": "SHOW" + } + }, + "sslProfile": { + "type": "string", + "x-labelLocalizationKey": "sslProfile.label", + "x-rank": 2 + }, + "sslProfileType": { + "oneOf": [ + { + "const": "client", + "x-labelLocalizationKey": "sslProfileType.client" + }, + { + "const": "server", + "x-labelLocalizationKey": "sslProfileType.server" + } + ], + "x-labelLocalizationKey": "sslProfileType.label", + "x-rank": 0 + } + }, + "required": [ + "sslProfile", + "sslProfileType" + ], + "type": "object", + "x-labelLocalizationKey": "binding.label", + "x-primaryKey": [ + "#/sslProfileType", + "#/sslProfile" + ] + }, + "certificateBundle": { + "properties": { + "certificate": { + "contentEncoding": "base64", + "type": "string" + }, + "certificateChain": { + "contentEncoding": "base64", + "type": "string" + }, + "privateKey": { + "contentEncoding": "base64", + "type": "string", + "x-encrypted-base64": true + } + }, + "required": [ + "certificate", + "privateKey", + "certificateChain" + ], + "type": "object" + }, + "connection": { + "properties": { + "hostnameOrAddress": { + "type": "string", + "x-labelLocalizationKey": "address.label", + "x-rank": 0 + }, + "password": { + "type": "string", + "x-controlOptions": { + "hidePasswordLabel": "password.hidePassword", + "password": true, + "showPasswordLabel": "password.showPassword" + }, + "x-encrypted": true, + "x-labelLocalizationKey": "password.label", + "x-rank": 3 + }, + "port": { + "description": "port.description", + "maximum": 65535, + "minimum": 1, + "type": "integer", + "x-labelLocalizationKey": "port.label", + "x-rank": 1 + }, + "username": { + "type": "string", + "x-encrypted": true, + "x-labelLocalizationKey": "username.label", + "x-rank": 2 + } + }, + "required": [ + "hostnameOrAddress", + "username", + "password" + ], + "type": "object" + }, + "discovery": { + "properties": { + "discoveryType": { + "oneOf": [ + { + "const": "all", + "x-labelLocalizationKey": "discoveryType.all" + }, + { + "const": "monitor", + "x-labelLocalizationKey": "discoveryType.monitor" + }, + { + "const": "virtualServer", + "x-labelLocalizationKey": "discoveryType.virtualServer" + } + ], + "x-labelLocalizationKey": "discoveryType.label", + "x-rank": 0 + }, + "excludeExpiredCertificates": { + "type": "boolean", + "x-labelLocalizationKey": "discovery.expiredCertificatesLabel", + "x-rank": 2 + }, + "excludeInactiveProfiles": { + "type": "boolean", + "x-labelLocalizationKey": "discovery.inactiveProfilesLabel", + "x-rank": 3 + }, + "partition": { + "default": "Common", + "description": "discovery.partitionDescription", + "maxLength": 64, + "type": "string", + "x-labelLocalizationKey": "discovery.partitionLabel", + "x-rank": 1 + } + }, + "type": "object" + }, + "discoveryControl": { + "properties": { + "maxResults": { + "type": "int" + } + }, + "required": [ + "maxResults" + ], + "type": "object" + }, + "discoveryPage": { + "properties": { + "discoveryType": { + "type": "string" + }, + "paginator": { + "type": "string" + } + }, + "type": "object" + }, + "keystore": { + "properties": { + "certificateName": { + "description": "certificateName.description", + "type": "string", + "x-labelLocalizationKey": "certificateName.label", + "x-rank": 0 + }, + "chainName": { + "type": "string", + "x-labelLocalizationKey": "chainName.label", + "x-rank": 1 + }, + "partition": { + "description": "partition.description", + "maxLength": 64, + "type": "string", + "x-labelLocalizationKey": "partition.label", + "x-rank": 2, + "x-targetConfigurationRef": "/partitions" + } + }, + "required": [ + "certificateName", + "chainName" + ], + "type": "object", + "x-labelLocalizationKey": "keystore.label", + "x-primaryKey": [ + "#/certificateName", + "#/partition" + ] } }, - "description": "Success" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "hooks": { + "mapping": { + "configureInstallationEndpoint": "/v1/configureinstallationendpoint", + "discoverCertificates": "/v1/discovercertificates", + "installCertificateBundle": "/v1/installcertificatebundle", + "testConnection": "/v1/testconnection" + }, + "requestConverters": [ + "arguments-decrypter" + ] }, - "description": "Request Conditions Failed" - }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "localizationResources": { + "en": { + "address": { + "label": "Server Hostname" + }, + "binding": { + "label": "Server Store Details" + }, + "certificateName": { + "description": "How the certificate should appear on the server.", + "label": "Certificate Name" + }, + "chainName": { + "label": "Chain Bundle Name" + }, + "discovery": { + "expiredCertificatesLabel": "Exclude expired certificates.", + "inactiveProfilesLabel": "Exclude certificates that are not in use by either a virtual server or a monitor.", + "partitionDescription": "A comma separated list of partition names.", + "partitionLabel": "Partition(s)" + }, + "discoveryType": { + "all": "Both Monitors and Virtual Servers", + "label": "Resource Types to Discover", + "monitor": "Monitors", + "virtualServer": "Virtual Servers" + }, + "keystore": { + "label": "Certificate Information" + }, + "parentProfile": { + "description": "No value is interpreted as \"clientssl\" or \"serverssl\" depending on the Profile Type selected.", + "label": "Parent Profile" + }, + "partition": { + "description": "No value is interpreted as the \"Common\" partition.", + "label": "Partition" + }, + "password": { + "hidePassword": "Hide Password", + "label": "Password", + "showPassword": "Show Password" + }, + "port": { + "description": "No value is interpreted as 443.", + "label": "Port" + }, + "serverName": { + "description": "An alternative DNS name used for Server Name Indication.", + "label": "SNI" + }, + "sslProfile": { + "label": "SSL Profile" + }, + "sslProfileType": { + "client": "Client SSL Profile", + "label": "Profile Type", + "server": "Server SSL Profile" + }, + "username": { + "label": "Username" } } }, - "description": "Request Conditions Failed" - } - }, - "security": [ - { - "tppl-api-key": [] + "name": "Sample Manifest" } - ], - "summary": "Retrieve all Connectors for a company", - "tags": [ - "Webhooks" - ] + } }, - "post": { - "description": "Create a Connector for your company. When the connector\u2019s target is a webhook (`generic`, `slack`, or `teams`), the service performs a live outbound POST request from Certificate Manager - SaaS to the specified `connection.url` during creation. This validates DNS resolution, TLS handshake, and network reachability. If the URL is unreachable (for example, blocked by firewall rules or incorrect DNS), the connector creation request fails with a timeout or connection error. This behavior is expected and prevents creating connectors that cannot receive webhook notifications.", - "operationId": "connectors_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorsCreationRequest" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorsInformation" - } - } + "MediaType": { + "properties": { + "parameters": { + "additionalProperties": { + "type": "string" }, - "description": "Connector Created" + "type": "object" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Request Conditions Failed" + "subtype": { + "type": "string" + }, + "type": { + "type": "string" + }, + "wildcardSubtype": { + "type": "boolean" + }, + "wildcardType": { + "type": "boolean" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Create a Connector", - "tags": [ - "Webhooks" - ] - } - }, - "/outagedetection/v1/inventorymonitoringconfig/{type}": { - "get": { - "description": "Retrieves the details of the inventory monitoring configuration by configuration type", - "operationId": "inventorymonitoringconfiguration_getByType", - "parameters": [ - { - "description": "Configuration type", - "in": "path", - "name": "type", - "required": true, - "schema": { - "description": "Configuration type", - "enum": [ - "CERTIFICATE_EXPIRATION" - ], - "type": "string" - } + "type": "object" + }, + "MetadataInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "productEntitlement": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InventoryMonitoringConfigurationResponse" - } - } + }, + "type": "object" + }, + "Name": { + "description": "The Name of CMS configuration", + "type": "string" + }, + "NamespaceChartDetails": { + "properties": { + "charts": { + "items": { + "$ref": "#/components/schemas/ChartDetails" }, - "description": "Details of inventory monitoring configuration in response body." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "name": { + "type": "string" + } + }, + "type": "object" + }, + "NamespaceStatusDetails": { + "properties": { + "name": { + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "pods": { + "items": { + "$ref": "#/components/schemas/PodStatusDetails" }, - "description": "Inventory monitoring configuration not found." + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "timestamp": { + "format": "date-time", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get the details of the current", - "tags": [ - "Certificate Inventory Monitoring" - ] + "type": "object" }, - "put": { - "description": "Updates existing inventory monitoring configuration", - "operationId": "inventorymonitoringconfiguration_update", - "parameters": [ - { - "description": "Configuration type", - "in": "path", - "name": "type", - "required": true, - "schema": { - "description": "Type of the configuration", - "enum": [ - "CERTIFICATE_EXPIRATION" - ], - "type": "string" - } - } + "NaryOperator": { + "description": "An operator for filtering", + "enum": [ + "AND", + "OR" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InventoryMonitoringConfigRequest" - } - } + "example": "OR", + "type": "string" + }, + "NewCookie": { + "properties": { + "comment": { + "type": "string" }, - "description": "Updates properties of the inventory monitoring configuration.", - "required": true + "domain": { + "type": "string" + }, + "expiry": { + "format": "date-time", + "type": "string" + }, + "httpOnly": { + "type": "boolean" + }, + "maxAge": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sameSite": { + "enum": [ + "NONE", + "LAX", + "STRICT" + ], + "type": "string" + }, + "secure": { + "type": "boolean" + }, + "value": { + "type": "string" + }, + "version": { + "format": "int32", + "type": "integer" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InventoryMonitoringConfigurationResponse" - } - } - }, - "description": "Inventory monitoring configuration was updated." + "type": "object" + }, + "NodeCondition": { + "properties": { + "Status": { + "type": "string", + "writeOnly": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "Type": { + "type": "string", + "writeOnly": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "status": { + "type": "string" + }, + "type": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "NodeInfo": { + "properties": { + "kubelet_version": { + "type": "string" } - ], - "summary": "Updates existing inventory monitoring configuratio", - "tags": [ - "Certificate Inventory Monitoring" - ] - } - }, - "/outagedetection/v1/inventorymonitoringconfig/{type}/scheduler": { - "put": { - "description": "Update inventory monitoring scheduler by type", - "operationId": "inventorymonitoringconfigurationscheduler_update", - "parameters": [ - { - "description": "Configuration type", - "in": "path", - "name": "type", - "required": true, - "schema": { - "description": "Configuration type", - "enum": [ - "CERTIFICATE_EXPIRATION" - ], - "type": "string" - } + }, + "type": "object" + }, + "NodeStatusDetails": { + "properties": { + "conditions": { + "items": { + "$ref": "#/components/schemas/NodeCondition" + }, + "type": "array" }, - { - "description": "Start the scheduler now", - "in": "query", - "name": "runNow", - "schema": { - "default": true, - "description": "Start the scheduler now", - "type": "boolean" - } + "info": { + "$ref": "#/components/schemas/NodeInfo" } + }, + "type": "object" + }, + "Operator": { + "enum": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "ENDS_WITH" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InventoryMonitoringSchedulerInformation" - } - } - }, - "description": "Inventory monitoring scheduler was updated." + "type": "string" + }, + "Order": { + "properties": { + "direction": { + "description": "An ordering direction", + "enum": [ + "ASC", + "DESC" + ], + "example": "DESC", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } - }, - "description": "Incomplete or malformed request." + "field": { + "description": "A field, that will be used for ordering", + "example": "modificationDate", + "type": "string" + } + }, + "type": "object" + }, + "OrderObject": { + "properties": { + "direction": { + "enum": [ + "ASC", + "DESC" + ], + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse4" - } - } + "field": { + "type": "string" + } + }, + "type": "object" + }, + "Ordering": { + "properties": { + "orders": { + "items": { + "$ref": "#/components/schemas/OrderObject" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "OwnerIdAndType": { + "properties": { + "ownerId": { + "format": "uuid", + "type": "string" + }, + "ownerType": { + "enum": [ + "USER", + "TEAM", + "SERVICE_ACCOUNT" + ], + "type": "string" } + }, + "required": [ + "ownerId", + "ownerType" ], - "summary": "Update inventory monitoring scheduler by type", - "tags": [ - "Certificate Inventory Monitoring" - ] - } - }, - "/v1/expirationnotifications/tenantconfiguration": { - "get": { - "description": "Retrieve the certificate expiration notification configuration for the current tenant", - "operationId": "get-v1-tenant-expiration-notification-configuration", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" - } - } - }, - "description": "Success" - }, - "400": { - "description": "BadRequest" + "type": "object" + }, + "Page1": { + "description": "Specify pagination on the search request", + "properties": { + "pageNumber": { + "description": "page number", + "example": 0, + "format": "int32", + "type": "integer" }, - "401": { - "description": "Unauthorized" + "pageSize": { + "description": "page size", + "example": 10, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Page2": { + "description": "Specify pagination on the search request", + "properties": { + "pageNumber": { + "description": "page number", + "example": 0, + "format": "int32", + "type": "integer" }, - "500": { - "description": "InternalServerError" + "pageSize": { + "description": "page size", + "example": 10, + "format": "int32", + "type": "integer" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve the certificate expiration notification c", - "tags": [ - "Certificate Inventory Monitoring" - ] + "type": "object" }, - "put": { - "description": "Update the certificate expiration notification configuration for the current tenant", - "operationId": "put-v1-tenant-expiration-notification-configuration", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" - } - } + "Paging": { + "properties": { + "pageNumber": { + "format": "int32", + "type": "integer" }, - "description": "The options to apply", - "required": true + "pageSize": { + "format": "int32", + "type": "integer" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantExpirationNotificationConfiguration" - } - } - }, - "description": "Success. The tenant configuration was successfully updated." + "type": "object" + }, + "PairingCodeInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" }, - "400": { - "description": "BadRequest" + "environmentId": { + "format": "uuid", + "type": "string" }, - "401": { - "description": "Unauthorized" + "expirationDate": { + "format": "date-time", + "type": "string" }, - "500": { - "description": "InternalServerError" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update the certificate expiration notification con", - "tags": [ - "Certificate Inventory Monitoring" - ] - } - }, - "/v1/autorenewal/tenantconfiguration": { - "get": { - "description": "Retrieve the certificate expiration monitoring configuration for the current tenant", - "operationId": "get-v1-tenant-renewal-configuration", - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "id": "12a05220-4352-11ee-ac28-c1379e5decf9", - "renewalWindow": { - "days": 30 - } - }, - "schema": { - "$ref": "#/components/schemas/TenantRenewalConfiguration" - } - } + "id": { + "format": "uuid", + "type": "string" + }, + "pairingCode": { + "type": "string" + }, + "productEntitlements": { + "items": { + "$ref": "#/components/schemas/ProductEntitlement2" }, - "description": "Success" + "type": "array" }, - "400": { - "description": "BadRequest" + "reuseCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PairingCodeRequest": { + "properties": { + "environmentId": { + "format": "uuid", + "type": "string" }, - "401": { - "description": "Unauthorized" + "primaryInstanceId": { + "format": "uuid", + "type": "string" }, - "500": { - "description": "InternalServerError" + "reuseCount": { + "format": "int32", + "type": "integer" } }, - "security": [ + "type": "object" + }, + "PatchServiceAccountByClientIDRequestBody": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/ServiceAccountPatchBaseObject" + }, + { + "properties": { + "enabled": { + "description": "Indicates if the given service account must be enabled or disabled where disable means that the credentials cannot be used for authentication", + "type": "boolean" + } + }, + "type": "object" } ], - "summary": "Retrieve the monitoring configuration", - "tags": [ - "Certificate Auto-renewal Monitoring" - ] + "example": { + "credentialLifetime": 365, + "enabled": true, + "name": "New name", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAor3JRni8bObnKbmWzRubiNyKMoCXLVrswqiMm2h8zl8=\n-----END PUBLIC KEY-----\n", + "scopes": [ + "distributed-issuance" + ] + } }, - "put": { - "description": "Update the certificate expiration monitoring configuration for the current tenant", - "operationId": "put-v1-tenant-renewal-configuration", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantRenewalConfiguration" - } - } + "Persona": { + "enum": [ + "Application Owners", + "All PKI Admins", + "All Admins" + ], + "type": "string" + }, + "Plugin": { + "properties": { + "creationTime": { + "description": "Represents the date when the plugin was created.", + "format": "date-time", + "type": "string" }, - "description": "The options to apply", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantRenewalConfiguration" - } - } - }, - "description": "Success. The tenant configuration was successfully updated." + "disabled": { + "description": "Indicates whether the tenant has disabled the plugin from its list of plugins.", + "type": "boolean" }, - "400": { - "description": "BadRequest" + "id": { + "description": "Represents the plugin ID.", + "type": "string" }, - "401": { - "description": "Unauthorized" + "lastModifiedOn": { + "description": "Date the plugin was last modified.", + "format": "date-time", + "type": "string" }, - "500": { - "description": "InternalServerError" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update the monitoring configuration", - "tags": [ - "Certificate Auto-renewal Monitoring" - ] - } - }, - "/v1/autorenewal/trigger": { - "post": { - "description": "The certificate renewal check is normally scheduled to run daily. This operation attempts to start the process for the current tenant now.", - "operationId": "post-v1-run-autorenewal", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StatusResponse" - } - } + "maintainer": { + "description": "Refers to the organization, individual, email, location, or website responsible for maintaining the plugin.", + "nullable": true, + "type": "string" + }, + "manifest": { + "$ref": "#/components/schemas/Manifest" + }, + "name": { + "description": "Represents the name of the plugin. This must be unique.", + "type": "string" + }, + "pluginType": { + "$ref": "#/components/schemas/PluginType" + }, + "revision": { + "description": "Represents the number of times the plugins has been updated.", + "type": "integer" + }, + "workTypes": { + "description": "Represents the type of workflow the plugin supports.", + "items": { + "$ref": "#/components/schemas/WorkType" }, - "description": "Success. The auto-renewal check process was triggered." + "minItems": 1, + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "id", + "name", + "revision", + "pluginType", + "workTypes", + "manifest", + "lastModifiedOn", + "creationTime" ], - "summary": "Attempt to initiate the certificate renewal", - "tags": [ - "Certificate Auto-renewal Monitoring" - ] - } - }, - "/v1/autorenewal/status": { - "get": { - "description": "Get details about the status of the certificate auto-renewal monitoring process.", - "operationId": "get-v1-status", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StatusResponse" - } - } + "title": "Plugin", + "type": "object" + }, + "PluginResponse": { + "properties": { + "plugins": { + "items": { + "$ref": "#/components/schemas/Plugin" }, - "description": "Success" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "InternalServerError" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "plugins" ], - "summary": "Get the current certificate auto-renewal monitorin", - "tags": [ - "Certificate Auto-renewal Monitoring" - ] - } - }, - "/v1/autorenewal/{application_id}/configuration": { - "get": { - "description": "Retrieve the certificate expiration monitoring configuration for the specified application", - "operationId": "get-v1-application-renewal-configuration", - "parameters": [ - { - "description": "The ID of the application that you would like to retrieve configuration for", - "example": "22153ae0-4352-11ee-b95c-3531a284802b", - "in": "path", - "name": "application_id", - "required": true, - "schema": { - "format": "UUID", - "type": "string" - } - } + "title": "PluginResponse", + "type": "object" + }, + "PluginType": { + "description": "Used for differentiation between different types of plugins.", + "enum": [ + "MACHINE", + "CA", + "TPP", + "CREDENTIAL_MANAGER" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationRenewalConfiguration" - } - } - }, - "description": "Success" + "title": "PluginType", + "type": "string" + }, + "PodStatusDetails": { + "properties": { + "age": { + "format": "int64", + "type": "integer" }, - "401": { - "description": "Unauthorized" + "cpuUsage": { + "format": "int32", + "type": "integer" }, - "500": { - "description": "InternalServerError" + "image": { + "type": "string" + }, + "memoryUsage": { + "format": "int64", + "type": "integer" + }, + "name": { + "type": "string" + }, + "restartCount": { + "format": "int32", + "type": "integer" + }, + "status": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve the monitoring configuration", - "tags": [ - "Certificate Auto-renewal Monitoring" - ] + "type": "object" }, - "put": { - "description": "Update the certificate expiration monitoring configuration for the specified application", - "operationId": "put-v1-application-renewal-configuration", - "parameters": [ - { - "description": "The ID of the application you want to update", - "example": "22153ae0-4352-11ee-b95c-3531a284802b", - "in": "path", - "name": "application_id", - "required": true, - "schema": { - "format": "UUID", + "PolicyCreateRequest": { + "properties": { + "extendedKeyUsages": { + "description": "Extended key usages", + "example": [ + "CLIENT_AUTH", + "SERVER_AUTH" + ], + "items": { + "enum": [ + "ANY", + "SERVER_AUTH", + "CLIENT_AUTH", + "CODE_SIGNING", + "EMAIL_PROTECTION", + "IPSEC_ENDSYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "TIME_STAMPING", + "OCSP_SIGNING", + "DVCS", + "SBGP_CERT_AA_SERVER_AUTH", + "SCVP_RESPONDER", + "EAP_OVER_PPP", + "EAP_OVER_LAN", + "SCVP_SERVER", + "SCVP_CLIENT", + "IPSEC_IKE", + "CAPWAP_AC", + "CAPWAP_WTP", + "IPSEC_IKE_INTERMEDIATE", + "SMARTCARD_LOGON" + ], "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationRenewalConfiguration" - } - } - }, - "description": "The options to apply", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationRenewalConfiguration" - } - } }, - "description": "Success. The application configuration was successfully updated." - }, - "400": { - "description": "BadRequest" + "minItems": 1, + "type": "array" }, - "401": { - "description": "Unauthorized" + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithmInformation" }, - "500": { - "description": "InternalServerError" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update the monitoring configuration", - "tags": [ - "Certificate Auto-renewal Monitoring" - ] - } - }, - "/v1/expirationreports/tenantconfiguration": { - "get": { - "description": "Retrieve the certificate expiration reports configuration for the current tenant", - "operationId": "get-v1-tenant-expiration-reports-configuration", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" - } - } + "keyUsages": { + "description": "Key usages", + "example": [ + "keyEncipherment", + "digitalSignature" + ], + "items": { + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], + "type": "string" }, - "description": "Success" + "minItems": 1, + "type": "array" }, - "400": { - "description": "BadRequest" + "name": { + "description": "Name of the policy", + "example": "Some policy", + "maxLength": 64, + "type": "string" }, - "401": { - "description": "Unauthorized" + "sans": { + "$ref": "#/components/schemas/SansInformation" }, - "500": { - "description": "InternalServerError" + "subject": { + "$ref": "#/components/schemas/SubjectAttributesInformation" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "extendedKeyUsages", + "keyAlgorithm", + "keyUsages", + "name", + "sans", + "subject", + "validityPeriod" ], - "summary": "Retrieve the certificate expiration reports config", - "tags": [ - "Certificate Expiration Reports" - ] + "type": "object" }, - "put": { - "description": "Update the certificate expiration reports configuration for the current tenant", - "operationId": "put-v1-tenant-expiration-reports-configuration", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" - } - } + "PolicyDeleteResponse": { + "properties": { + "id": { + "description": "UUID of the policy", + "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", + "format": "uuid", + "type": "string" }, - "description": "The options to apply", - "required": true + "name": { + "description": "Name of the policy", + "example": "Some policy", + "type": "string" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantExpirationReportsConfiguration" - } - } - }, - "description": "Success. The tenant configuration was successfully updated." - }, - "400": { - "description": "BadRequest" + "type": "object" + }, + "PolicyInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" }, - "401": { - "description": "Unauthorized" + "creationDate": { + "description": "When the policy was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" }, - "500": { - "description": "InternalServerError" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update the certificate expiration reports configur", - "tags": [ - "Certificate Expiration Reports" - ] - } - }, - "/v1/expirationreports/trigger": { - "post": { - "description": "The certificate reports job is normally scheduled per the tenant configuration. This operation attempts to start the process for the current tenant now.", - "operationId": "post-v1-run-reports", - "responses": { - "204": { - "description": "Success. The reports check process was triggered." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Attempt to initiate the certificate reports", - "tags": [ - "Certificate Expiration Reports" - ] - } - }, - "/v1/tags": { - "get": { - "description": "Retrieve details of all available tags", - "operationId": "tags_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagResponse" - } - } + "extendedKeyUsages": { + "description": "Extended key usages", + "example": [ + "CLIENT_AUTH", + "SERVER_AUTH" + ], + "items": { + "enum": [ + "ANY", + "SERVER_AUTH", + "CLIENT_AUTH", + "CODE_SIGNING", + "EMAIL_PROTECTION", + "IPSEC_ENDSYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "TIME_STAMPING", + "OCSP_SIGNING", + "DVCS", + "SBGP_CERT_AA_SERVER_AUTH", + "SCVP_RESPONDER", + "EAP_OVER_PPP", + "EAP_OVER_LAN", + "SCVP_SERVER", + "SCVP_CLIENT", + "IPSEC_IKE", + "CAPWAP_AC", + "CAPWAP_WTP", + "IPSEC_IKE_INTERMEDIATE", + "SMARTCARD_LOGON" + ], + "type": "string" }, - "description": "Details of tags in response body" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "id": { + "description": "UUID of the policy", + "example": "8ae92800-b1e0-11ed-859d-b39255f965ee", + "format": "uuid", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve all tags", - "tags": [ - "Tags" - ] - }, - "post": { - "description": "Create tag with optional values", - "operationId": "tags_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagRequest" - } - } + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithmInformation" }, - "description": "Properties of the new tag.", - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagInformation" - } - } + "keyUsages": { + "description": "Key usages", + "example": [ + "keyEncipherment", + "digitalSignature" + ], + "items": { + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], + "type": "string" }, - "description": "Tag is created. Details in response body" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "modificationDate": { + "description": "When the policy was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "name": { + "description": "Name of the policy", + "example": "Some policy", + "type": "string" + }, + "sans": { + "$ref": "#/components/schemas/SansInformation" + }, + "subject": { + "$ref": "#/components/schemas/SubjectAttributesInformation" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "PolicyResponse": { + "properties": { + "policies": { + "items": { + "$ref": "#/components/schemas/ExtendedPolicyInformation" + }, + "type": "array" } - ], - "summary": "Create a tag", - "tags": [ - "Tags" - ] - } - }, - "/v1/tags/{name}": { - "get": { - "description": "Retrieve a tag with 'name' attribute matching a specified value", - "operationId": "tags_getByName", - "parameters": [ - { - "description": "Name of the tag.", - "in": "path", - "name": "name", - "required": true, - "schema": { - "description": "Name of the tag.", + }, + "type": "object" + }, + "PolicyUpdateRequest": { + "properties": { + "extendedKeyUsages": { + "description": "Extended key usages", + "example": [ + "CLIENT_AUTH", + "SERVER_AUTH" + ], + "items": { + "enum": [ + "ANY", + "SERVER_AUTH", + "CLIENT_AUTH", + "CODE_SIGNING", + "EMAIL_PROTECTION", + "IPSEC_ENDSYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "TIME_STAMPING", + "OCSP_SIGNING", + "DVCS", + "SBGP_CERT_AA_SERVER_AUTH", + "SCVP_RESPONDER", + "EAP_OVER_PPP", + "EAP_OVER_LAN", + "SCVP_SERVER", + "SCVP_CLIENT", + "IPSEC_IKE", + "CAPWAP_AC", + "CAPWAP_WTP", + "IPSEC_IKE_INTERMEDIATE", + "SMARTCARD_LOGON" + ], "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagInformation" - } - } }, - "description": "Details of tag in response body" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "keyAlgorithm": { + "$ref": "#/components/schemas/KeyAlgorithmInformation" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "keyUsages": { + "description": "Key usages", + "example": [ + "keyEncipherment", + "digitalSignature" + ], + "items": { + "enum": [ + "digitalSignature", + "nonRepudiation", + "keyEncipherment", + "dataEncipherment", + "keyAgreement", + "keyCertSign", + "cRLSign", + "encipherOnly", + "decipherOnly" + ], + "type": "string" }, - "description": "Tag not found" + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "name": { + "description": "Name of the policy", + "example": "Some policy", + "maxLength": 64, + "type": "string" + }, + "sans": { + "$ref": "#/components/schemas/SansInformation" + }, + "subject": { + "$ref": "#/components/schemas/SubjectAttributesInformation" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "type": "object" + }, + "ProductEntitlement1": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" ], - "summary": "Retrieve tag by name", - "tags": [ - "Tags" - ] + "type": "string" }, - "delete": { - "description": "Delete a tag with 'name' attribute matching a specified value", - "operationId": "tags_deleteByName", - "parameters": [ - { - "description": "Name of the tag.", - "in": "path", - "name": "name", - "required": true, - "schema": { - "description": "Name of the tag.", - "type": "string" - } - } + "ProductEntitlement2": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" ], - "responses": { - "202": { - "description": "Tag is deleted" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Tag not found" - }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "type": "string" + }, + "ProductEntitlementInformation": { + "properties": { + "capabilities": { + "items": { + "$ref": "#/components/schemas/CapabilityInformation" }, - "description": "Incomplete or malformed request" + "type": "array" + }, + "label": { + "$ref": "#/components/schemas/ProductEntitlement1" + }, + "visibilityConstraintsInformation": { + "$ref": "#/components/schemas/VisibilityConstraintsInformation" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "capabilities", + "label", + "visibilityConstraintsInformation" ], - "summary": "Delete tag by name", - "tags": [ - "Tags" - ] - } - }, - "/v1/tags/{name}/values": { - "get": { - "description": "Retrieve tag values for a tag with 'name' attribute matching specified value", - "operationId": "tags_get_values", - "parameters": [ - { - "description": "Name of the tag.", - "in": "path", - "name": "name", - "required": true, - "schema": { - "description": "Name of the tag.", + "type": "object" + }, + "PropertyInformation": { + "properties": { + "allowedValues": { + "items": { "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagValuesResponse" - } - } }, - "description": "Tag values in response body" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "defaultValues": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Tag not found" + "maxOccurrences": { + "format": "int32", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "minOccurrences": { + "format": "int32", + "type": "integer" + }, + "type": { + "enum": [ + "IGNORED", + "FORBIDDEN", + "OPTIONAL", + "REQUIRED", + "LOCKED" + ], + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve values for a tag", - "tags": [ - "Tags" - ] + "type": "object" }, - "post": { - "description": "Create tag values for a tag with 'name' attribute matching specified value", - "operationId": "tag_values_create", - "parameters": [ - { - "description": "Name of the tag.", - "in": "path", - "name": "name", - "required": true, - "schema": { - "description": "Name of the tag.", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagValuesRequest" - } - } + "ProviderConfigInformation": { + "properties": { + "api_key": { + "type": "string" }, - "description": "The values of the tag.", - "required": true + "endpoint": { + "type": "string" + } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagValuesResponse" - } - } + "type": "object" + }, + "ProviderInformation": { + "properties": { + "config": { + "$ref": "#/components/schemas/ProviderConfigInformation" + }, + "inputs": { + "items": { + "$ref": "#/components/schemas/ProviderInputInformation" }, - "description": "Tag values created" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ProviderInputInformation": { + "properties": { + "hosts": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "ports": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" + }, + "subnet": { + "type": "string" + }, + "type": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "ProvisionCertificateWorkflowInputInformation": { + "properties": { + "wsClientId": { + "minLength": 1, + "type": "string" } + }, + "required": [ + "wsClientId" ], - "summary": "Create tag values", - "tags": [ - "Tags" - ] - } - }, - "/v1/tags/{name}/values/{value}": { - "delete": { - "description": "Delete a value associated with a tag", - "operationId": "tags_deleteValueByName", - "parameters": [ - { - "description": "Name of the tag", - "in": "path", - "name": "name", - "required": true, - "schema": { - "description": "Name of the tag", - "type": "string" - } + "type": "object" + }, + "PublicPluginCreationRequest": { + "properties": { + "maintainer": { + "description": "Refers to the organization, individual, email, location, or website responsible for maintaining the plugin.", + "nullable": true, + "type": "string" }, - { - "description": "Name of the value to delete", - "in": "path", - "name": "value", - "required": true, - "schema": { - "description": "Name of the value to delete", - "type": "string" - } + "manifest": { + "$ref": "#/components/schemas/Manifest" + }, + "pluginType": { + "$ref": "#/components/schemas/PluginType" } + }, + "required": [ + "manifest", + "pluginType" ], - "responses": { - "202": { - "description": "Tag value deleted" + "title": "PublicPluginCreationRequest", + "type": "object", + "x-stoplight": { + "id": "sto5fs3n5bxmf" + } + }, + "PublicPluginUpdateRequest": { + "properties": { + "image": { + "nullable": true, + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Tag not found" + "maintainer": { + "nullable": true, + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "manifest": { + "$ref": "#/components/schemas/Manifest" } }, - "security": [ - { - "tppl-api-key": [] + "title": "PublicPluginUpdateRequest", + "type": "object", + "x-stoplight": { + "id": "8ypau6to0udah" + } + }, + "PutServiceAccountByClientIDCredentialsRequestBody": { + "example": { + "extendCredentialLifetime": true + }, + "properties": { + "extendCredentialLifetime": { + "description": "Extend the credential lifetime", + "type": "boolean" } + }, + "required": [ + "extendCredentialLifetime" ], - "summary": "Delete a tag value", - "tags": [ - "Tags" - ] - } - }, - "/v1/tags/values": { - "get": { - "description": "Retrieve tag values for all tags", - "operationId": "tags_getAllValues", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagValuesResponse" - } - } - }, - "description": "Tag values in response body" + "type": "object" + }, + "PutServiceAccountByClientIDCredentialsResponseBody": { + "properties": { + "credentialExpiresIn": { + "description": "Expiration in hours for service account credentials", + "format": "float", + "type": "number", + "x-go-type": "float64" + } + }, + "type": "object" + }, + "PutServiceAccountByClientIDOCITokenResponseBody": { + "properties": { + "ociRegistryToken": { + "description": "The OCI registry token generated for a robot in case of the registry scope", + "type": "string" + } + }, + "type": "object" + }, + "Recipient": { + "properties": { + "id": { + "description": "The ID of a user or team who should be included as a recipient.", + "format": "UUID", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "type": { + "description": "The type of the recipient.", + "enum": [ + "User", + "Team" + ], + "type": "string" + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "RecommendedSettingsInformation1": { + "properties": { + "key": { + "$ref": "#/components/schemas/RecommendedSettingsKeyTypeInformation1" + }, + "keyGeneratedBy": { + "type": "string" + }, + "sanRegexes": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "subjectCNRegexes": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" + }, + "subjectCValue": { + "type": "string" + }, + "subjectLValue": { + "type": "string" + }, + "subjectOUValue": { + "type": "string" + }, + "subjectOValue": { + "type": "string" + }, + "subjectSTValue": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve values for all tags", - "tags": [ - "Tags" - ] - } - }, - "/v1/tags/creation": { - "post": { - "description": "Create tags in bulk with optional values", - "operationId": "tags_bulk_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagsBulkRequest" - } - } + "type": "object" + }, + "RecommendedSettingsInformation2": { + "properties": { + "key": { + "$ref": "#/components/schemas/RecommendedSettingsKeyTypeInformation2" }, - "description": "Properties of the new tags.", - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagsAndValuesResponse" - } - } + "sanRegexes": { + "items": { + "type": "string" }, - "description": "Tags are created. Details in response body" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "subjectCNRegexes": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" + }, + "subjectCValue": { + "type": "string" + }, + "subjectLValue": { + "type": "string" + }, + "subjectOUValue": { + "type": "string" + }, + "subjectOValue": { + "type": "string" + }, + "subjectSTValue": { + "type": "string" + } + }, + "type": "object" + }, + "RecommendedSettingsKeyTypeInformation1": { + "properties": { + "curve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "length": { + "format": "int32", + "type": "integer" + }, + "type": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Create tags in bulk", - "tags": [ - "Tags" - ] - } - }, - "/v1/tags/deletion": { - "post": { - "description": "Delete tags in bulk by specified keys and values", - "operationId": "tags_bulk_delete", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagsBulkRequest" - } - } + "type": "object" + }, + "RecommendedSettingsKeyTypeInformation2": { + "properties": { + "curve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" }, - "description": "Properties of the tags to delete.", - "required": true + "length": { + "format": "int32", + "type": "integer" + }, + "type": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" + } }, - "responses": { - "202": { - "description": "Tags are deleted" + "type": "object" + }, + "RecommendedSettingsKeyTypeParameter": { + "properties": { + "curve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Tags not found" + "length": { + "format": "int32", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "type": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Delete tags in bulk", - "tags": [ - "Tags" - ] - } - }, - "/v1/tagsassignment": { - "patch": { - "description": "Replace, add, or delete one or more tags or tag values to/from one or more entities", - "operationId": "tags_assignToEntities", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagsAssignRequest" - } - } + "type": "object" + }, + "RecommendedSettingsRequest": { + "properties": { + "key": { + "$ref": "#/components/schemas/RecommendedSettingsKeyTypeParameter" }, - "description": "Properties of the assignments.", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagsAssignResponse" - } - } - }, - "description": "Tag assign response" + "keyGeneratedBy": { + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "sanRegexes": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "subjectCNRegexes": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" + }, + "subjectCValue": { + "pattern": "^(([A-Z]{2})|(\\.\\*))$", + "type": "string" + }, + "subjectLValue": { + "pattern": "[^\\*]*", + "type": "string" + }, + "subjectOUValue": { + "pattern": "[^\\*]*", + "type": "string" + }, + "subjectOValue": { + "pattern": "[^\\*]*", + "type": "string" + }, + "subjectSTValue": { + "pattern": "[^\\*]*", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Replace, add, or delete tags or", - "tags": [ - "Tags" - ] - } - }, - "/v1/tagsassignment/aggregates": { - "post": { - "description": "Bulk operation to retrieve number of entities per tag", - "operationId": "tags_assignmentAggregates", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagsAssignmentAggregatesRequest" - } - } + "type": "object" + }, + "RecoveryCodeInformation": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" }, - "description": "Entity Type and list of tags and/or tag:value pairs.", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TagsAssignmentAggregatesResponse" - } - } - }, - "description": "Entity type and total count per tag in response body" + "dataPlaneDomain": { + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } - }, - "description": "Incomplete or malformed request" + "expirationDate": { + "format": "date-time", + "type": "string" + }, + "hiddenRecoveryCode": { + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse9" - } - } + "id": { + "format": "uuid", + "type": "string" + }, + "productEntitlements": { + "items": { + "$ref": "#/components/schemas/ProductEntitlement2" }, - "description": "Incomplete or malformed request" + "type": "array" + }, + "recoveryCode": { + "type": "string" + }, + "tsgId": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Bulk operation to retrieve number of", - "tags": [ - "Tags" - ] - } - }, - "/v1/distributedissuers/configurations": { - "post": { - "description": "Adds a new Issuer Configuration, which links the following together - Sub CA Provider, Policies used to determine which certificates can be issued, and the IdP (Identity Provider) the Issuer should trust when receiving signed JWTs from its clients.", - "operationId": "configurations_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConfigurationCreateRequest" - } - } + "type": "object" + }, + "RecoveryCodeRequest": { + "properties": { + "edgeInstanceId": { + "format": "uuid", + "type": "string" } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedConfigurationInformation" - } - } - }, - "description": "Issuer configuration successfully created; details in response body." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "required": [ + "edgeInstanceId" + ], + "type": "object" + }, + "Reference": { + "description": "The machine referenced.", + "properties": { + "id": { + "format": "uuid", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "type": { + "$ref": "#/components/schemas/ReferenceType" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "id", + "type" ], - "summary": "Create a new Issuer configuration", - "tags": [ - "Workload Identity Manager Configurations" - ] + "type": "object" }, - "get": { - "description": "Retrieves a list of all Issuer Configurations. Configurations link together Sub CA Providers, Workload Issuance Policies and Identity Provider information. Together these allow an instance of an Issuer to obtain a Sub CA certificate and use it to issue certificates.", - "operationId": "configurations_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConfigurationResponse" - } - } + "ReferenceType": { + "description": "The type of the reference:\n * `machine`\n", + "enum": [ + "machine" + ], + "type": "string" + }, + "References": { + "description": "The machines referenced.", + "items": { + "$ref": "#/components/schemas/Reference" + }, + "type": "array", + "uniqueItems": true + }, + "Response": { + "properties": { + "allowedMethods": { + "items": { + "type": "string" }, - "description": "All Issuer configurations." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } + "closed": { + "type": "boolean" + }, + "cookies": { + "additionalProperties": { + "$ref": "#/components/schemas/NewCookie" }, - "description": "Incomplete or malformed request." + "type": "object" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } + "date": { + "format": "date-time", + "type": "string" + }, + "entity": { + "$ref": "#/components/schemas/AnyValue7" + }, + "entityTag": { + "$ref": "#/components/schemas/EntityTag" + }, + "headers": { + "additionalProperties": { + "items": { + "$ref": "#/components/schemas/AnyValue7" + }, + "type": "array" + }, + "properties": { + "empty": { + "type": "boolean" } }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get the details of all Issuer", - "tags": [ - "Workload Identity Manager Configurations" - ] - } - }, - "/v1/distributedissuers/configurations/{id}": { - "get": { - "description": "Retrieves the details of the existing Issuer configuration for the specified `id`.", - "operationId": "configurations_getById", - "parameters": [ - { - "description": "Issuer configuration UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedConfigurationInformation" - } + "type": "object" + }, + "language": { + "properties": { + "country": { + "type": "string" + }, + "displayCountry": { + "type": "string" + }, + "displayLanguage": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "displayScript": { + "type": "string" + }, + "displayVariant": { + "type": "string" + }, + "extensionKeys": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "iso3Country": { + "type": "string" + }, + "iso3Language": { + "type": "string" + }, + "language": { + "type": "string" + }, + "script": { + "type": "string" + }, + "unicodeLocaleAttributes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "unicodeLocaleKeys": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "variant": { + "type": "string" } }, - "description": "Specified Issuer configuration found; details in response body." + "type": "object" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } + "lastModified": { + "format": "date-time", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "links": { + "items": { + "$ref": "#/components/schemas/Link" }, - "description": "Incomplete or malformed request." + "type": "array", + "uniqueItems": true }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } + "location": { + "format": "uri", + "type": "string" + }, + "mediaType": { + "$ref": "#/components/schemas/MediaType" + }, + "metadata": { + "additionalProperties": { + "items": { + "$ref": "#/components/schemas/AnyValue7" + }, + "type": "array" + }, + "properties": { + "empty": { + "type": "boolean" } }, - "description": "Specified Issuer configuration was not found." + "type": "object" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } + "status": { + "format": "int32", + "type": "integer" + }, + "statusInfo": { + "$ref": "#/components/schemas/StatusType" + }, + "stringHeaders": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "properties": { + "empty": { + "type": "boolean" } }, - "description": "Incomplete or malformed request." + "type": "object" } }, - "security": [ + "type": "object" + }, + "ResponseCMSDetails": { + "description": "An string containing the JSON content representing the details of the specific privileged access management.", + "oneOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/ResponseCyberArkDetails" + }, + { + "$ref": "#/components/schemas/ResponseHashiCorpDetails" } - ], - "summary": "Get configurations details for a specific", - "tags": [ - "Workload Identity Manager Configurations" ] }, - "patch": { - "description": "Updates (replaces) fields on an Issuer configuration that has the specified `id`. Only fields specified in the request will be updated. Fields not specified in the request are not modified.", - "operationId": "configurations_update", - "parameters": [ + "ResponseCredentialDetails": { + "oneOf": [ { - "description": "Issuer configuration UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConfigurationUpdateRequest" - } - } - }, - "description": "Issuer configuration's details to update.", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedConfigurationInformation" - } - } - }, - "description": "Specified Issuer configuration updated; details in response body." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Specified Issuer configuration was not found." + "$ref": "#/components/schemas/ResponseCyberArkCredDetails" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + { + "$ref": "#/components/schemas/ResponseHashiCorpCredDetails" } - }, - "security": [ + ] + }, + "ResponseCyberArkCredDetails": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/CyberArkDetailsRequiredProp" } - ], - "summary": "Update an Issuer configuration details", - "tags": [ - "Workload Identity Manager Configurations" ] }, - "delete": { - "description": "Deletes the Issuer configuration for the specified `id`. Before deleting a configuration, be sure no Issuer instances use that configuration, or they will no longer function.", - "operationId": "configurations_delete", - "parameters": [ + "ResponseCyberArkDetails": { + "allOf": [ { - "description": "Issuer configuration UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/CyberArkConfiguration" + } + ] + }, + "ResponseHashiCorpCredDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpDetailsRequiredProp" + } + ] + }, + "ResponseHashiCorpDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/HashiCorpConfiguration" } + ] + }, + "Role1": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConfigurationDeleteResponse" - } - } - }, - "description": "Specified Issuer configuration was deleted." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } + "type": "string" + }, + "Role2": { + "enum": [ + "SYSTEM_ADMIN", + "OUTAGE_DETECTION_PLATFORM_ADMIN", + "OUTAGE_DETECTION_PKI_ADMIN", + "OUTAGE_DETECTION_RESOURCE_OWNER", + "OUTAGE_DETECTION_GUEST" + ], + "type": "string" + }, + "RolesRequest": { + "properties": { + "roles": { + "additionalProperties": { + "$ref": "#/components/schemas/Role1" }, - "description": "Issuer configuration was not found." + "type": "object" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "systemAdmin": { + "type": "boolean" } }, - "security": [ - { - "tppl-api-key": [] - } + "type": "object" + }, + "SSOStatus": { + "enum": [ + "ACTIVE", + "INACTIVE" ], - "summary": "Remove an Issuer configuration", - "tags": [ - "Workload Identity Manager Configurations" - ] - } - }, - "/v1/distributedissuers/subcaproviders": { - "post": { - "description": "Creates a sub ca provider", - "operationId": "subcaproviders_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubCaProviderCreateRequest" - } - } + "type": "string" + }, + "SansInformation": { + "description": "Subject alternative names", + "properties": { + "dnsNames": { + "$ref": "#/components/schemas/PropertyInformation" }, - "description": "Details of the new sub CA provider.", - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubCaProviderInformation" - } - } - }, - "description": "Sub CA Provider was created; details in response body;" + "ipAddresses": { + "$ref": "#/components/schemas/PropertyInformation" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "rfc822Names": { + "$ref": "#/components/schemas/PropertyInformation" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "uniformResourceIdentifiers": { + "$ref": "#/components/schemas/PropertyInformation" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Create a new Sub CA provider", - "tags": [ - "Workload Identity Manager Sub CA Providers" - ] + "type": "object" }, - "get": { - "description": "Returns a list of all the subordinate CA providers along with their details.", - "operationId": "subcaprovider_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubCaProviderResponse" - } - } - }, - "description": "All Sub CA providers with details." + "ScanafiConfigResponseV1": { + "properties": { + "id": { + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "metadata": { + "$ref": "#/components/schemas/MetadataInformation" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "provider": { + "$ref": "#/components/schemas/ProviderInformation" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "SchedulerPatternInformation1": { + "discriminator": { + "propertyName": "recurrenceType" + }, + "properties": { + "recurrenceType": { + "type": "string" } + }, + "required": [ + "recurrenceType" ], - "summary": "Get the details of all Sub", - "tags": [ - "Workload Identity Manager Sub CA Providers" - ] - } - }, - "/v1/distributedissuers/subcaproviders/{id}": { - "get": { - "description": "Retrieves the details of the subordinate CA provider that has the specified `id`.", - "operationId": "subcaproviders_getById", - "parameters": [ - { - "description": "Sub CA provider UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "type": "object" + }, + "SchedulerPatternInformation2": { + "discriminator": { + "propertyName": "recurrenceType" + }, + "properties": { + "recurrenceType": { + "type": "string" } + }, + "required": [ + "recurrenceType" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubCaProviderInformation" - } - } - }, - "description": "Specified sub CA provider found; details in response body." + "type": "object" + }, + "SchedulerPatternInformation3": { + "discriminator": { + "mapping": { + "DAY": "#/components/schemas/DailyPatternInformation", + "WEEK": "#/components/schemas/WeeklyPatternInformation" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "propertyName": "recurrenceType" + }, + "properties": { + "recurrenceType": { + "type": "string" + } + }, + "required": [ + "recurrenceType" + ], + "type": "object" + }, + "Scope": { + "description": "The service account authorization scopes", + "example": "distributed-issuance", + "type": "string" + }, + "ScopeDetails": { + "description": "The service account authorization scopes detailed", + "example": { + "authenticationType": "rsaKey", + "id": "distributed-issuance", + "readableName": "Distributed Issuance" + }, + "properties": { + "authenticationType": { + "description": "Type of authentication used in the scope", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Specified sub CA provider was not found." + "id": { + "description": "ID for the given scope", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "readableName": { + "description": "User friendly name for the scope", + "type": "string" } }, - "security": [ + "required": [ + "id", + "readableName" + ], + "type": "object" + }, + "ServiceAccountBaseObject": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/ServiceAccountBaseObjectNoKey" + }, + { + "properties": { + "publicKey": { + "description": "The client generated public key", + "maxLength": 2000, + "type": "string" + } + }, + "type": "object" } - ], - "summary": "Get a Sub CA provider details", - "tags": [ - "Workload Identity Manager Sub CA Providers" ] }, - "patch": { - "description": "Updates (replaces) details of the subordinate CA provider that has the specified `id`. Only fields specified in the request will be updated.", - "operationId": "subcaproviders_update", - "parameters": [ - { - "description": "Sub CA provider UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" + "ServiceAccountBaseObjectNoKey": { + "properties": { + "applications": { + "description": "The list of applications for which the account is authorized", + "example": [ + "dc96438b-7a80-464b-a09b-9e5ec746c3e3", + "5bce5ff4-a69b-4e78-9b7e-6d4029995000" + ], + "items": { + "$ref": "#/components/schemas/Application" + }, + "type": "array", + "uniqueItems": true + }, + "audience": { + "description": "The intended audience or recipients of the entity", + "example": "Audience", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "authenticationType": { + "description": "Type of authentication used in the scope. Currently supporting two types rsaKey and ociToken", + "example": "rsaKey", + "type": "string" + }, + "companyId": { + "description": "The UUID of the company/tenant", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubCaProviderUpdateRequest" - } + }, + "credentialLifetime": { + "description": "The number of days for which the credentials will be valid before expiring and requiring renewal", + "example": 365, + "maximum": 365, + "minimum": 1, + "type": "integer" + }, + "issuerURL": { + "description": "The URL of the entity issuer, providing the source or origin", + "example": "https://accounts.google.com/", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "jwksURI": { + "description": "The URI pointing to the JSON Web Key Set (JWKS) for the entity, facilitating secure authentication", + "example": "https://www.googleapis.com/oauth2/v3/certs", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "User friendly name for the given account", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "owner": { + "description": "The UUID of the owning team", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" } }, - "description": "Sub CA provider's details to update.", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubCaProviderInformation" - } - } + "scopes": { + "description": "The list of scopes for which the account is authorized", + "example": [ + "distributed-issuance" + ], + "items": { + "$ref": "#/components/schemas/Scope" }, - "description": "Sub CA provider updated; details in response body." + "minItems": 1, + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } + "subject": { + "description": "The subject of the entity, representing the main topic or title.", + "example": "Subject", + "maxLength": 250, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "ServiceAccountBasePatchObjectNoKey": { + "properties": { + "applications": { + "description": "The list of applications for which the account is authorized", + "example": [ + "dc96438b-7a80-464b-a09b-9e5ec746c3e3", + "5bce5ff4-a69b-4e78-9b7e-6d4029995000" + ], + "items": { + "$ref": "#/components/schemas/Application" }, - "description": "Incomplete or malformed request." + "type": "array", + "uniqueItems": true }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Specified Sub CA provider was not found." + "audience": { + "description": "The intended audience or recipients of the entity", + "example": "Audience", + "maxLength": 250, + "minLength": 1, + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } + "credentialLifetime": { + "description": "The number of days for which the credentials will be valid before expiring and requiring renewal", + "maximum": 365, + "minimum": 1, + "type": "integer" + }, + "issuerURL": { + "description": "The URL of the entity issuer, providing the source or origin", + "example": "https://accounts.google.com/", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "jwksURI": { + "description": "The URI pointing to the JSON Web Key Set (JWKS) for the entity, facilitating secure authentication", + "example": "https://www.googleapis.com/oauth2/v3/certs", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "User friendly name for the given account", + "maxLength": 250, + "minLength": 1, + "type": "string" + }, + "owner": { + "description": "The UUID of the owning team", + "format": "UUID", + "type": "string", + "x-go-type": "uuid.UUID", + "x-go-type-import": { + "path": "github.com/google/uuid" + } + }, + "scopes": { + "description": "The list of scopes for which the account is authorized", + "items": { + "$ref": "#/components/schemas/Scope" }, - "description": "Incomplete or malformed request." + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "subject": { + "description": "The subject of the entity, representing the main topic or title.", + "example": "Subject", + "maxLength": 250, + "minLength": 1, + "type": "string" } }, - "security": [ + "type": "object" + }, + "ServiceAccountDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/ServiceAccountBaseObject" + }, { - "tppl-api-key": [] + "$ref": "#/components/schemas/Details" } - ], - "summary": "Update a Sub CA provider details", - "tags": [ - "Workload Identity Manager Sub CA Providers" ] }, - "delete": { - "description": "Deletes the subordinate CA provider that has the specified `id`.", - "operationId": "subcaproviders_delete", - "parameters": [ + "ServiceAccountDetailsNoKey": { + "allOf": [ { - "description": "Sub CA provider UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/ServiceAccountBaseObjectNoKey" + }, + { + "$ref": "#/components/schemas/Details" } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubCaProviderDeleteResponse" - } - } + "example": { + "authenticationType": "rsaKey", + "companyId": "145f12e0-fdbf-11ee-b275-2754a4f7e272", + "credentialLifetime": 365, + "credentialsExpiringOn": "2025-01-01T00:00:00.000000Z", + "enabled": true, + "id": "933507dd-0286-11ef-bc25-8a00a468403f", + "name": "Service Account I", + "owner": "2620f8e0-fdbf-11ee-b275-2754a4f7e272", + "scopes": [ + "distributed-issuance" + ], + "updatedBy": "150760d0-fdbf-11ee-b275-2754a4f7e272", + "updatedOn": "2024-01-01T00:00:00.000000Z" + } + }, + "ServiceAccountInformation": { + "properties": { + "applications": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Specified Sub CA provider was deleted." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } + "applicationsAdded": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array", + "uniqueItems": true }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } + "applicationsRemoved": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Specified sub CA provider was not found." + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } + "authType": { + "type": "string" + }, + "authenticationType": { + "type": "string" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "name": { + "type": "string" + }, + "owner": { + "format": "uuid", + "type": "string" + }, + "ownership": { + "additionalProperties": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true }, - "description": "Incomplete or malformed request." + "type": "object" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "scopes": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "serviceAccount": { + "type": "boolean" + }, + "tenantId": { + "format": "uuid", + "type": "string" + }, + "userAccount": { + "type": "boolean" } }, - "security": [ + "type": "object" + }, + "ServiceAccountPatchBaseObject": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/ServiceAccountBasePatchObjectNoKey" + }, + { + "properties": { + "publicKey": { + "description": "The client generated public key", + "maxLength": 2000, + "type": "string" + } + }, + "type": "object" } - ], - "summary": "Remove a Sub CA provider", - "tags": [ - "Workload Identity Manager Sub CA Providers" ] - } - }, - "/v1/distributedissuers/policies": { - "post": { - "description": "Add a new a Workload Issuance Policy for an Issuer to use to ensure compliance with company restrictions for creating certificates.", - "operationId": "policies_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyCreateRequest" - } - } + }, + "StatusResponse": { + "description": "Details about the current in-progress certificate auto-renewal process, and the most recently completed process.", + "properties": { + "current": { + "$ref": "#/components/schemas/StatusResponseItem" + }, + "previous": { + "$ref": "#/components/schemas/StatusResponseItem" } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedPolicyInformation" - } + "required": [ + "current" + ], + "type": "object" + }, + "StatusResponseItem": { + "description": "Details about the upcoming certificate auto-renewal run.", + "example": { + "applications": 13, + "certificates": { + "eligible": 47, + "renewal": { + "failed": 1, + "successful": 9, + "triggered": 3 + } + }, + "state": "running", + "timestamp": "2023-08-25T20:59:36.688019837Z" + }, + "properties": { + "applications": { + "description": "The number of applications that have auto-renewal enabled.", + "example": 13, + "format": "int64", + "type": "integer" + }, + "certificates": { + "description": "A set of statistics related to the certificates that were included in the auto-renewal process.", + "example": { + "eligible": 47, + "renewal": { + "failed": 1, + "successful": 9, + "triggered": 3 + } + }, + "properties": { + "eligible": { + "description": "The number of certificates that belong to an application that has auto-renewal enabled.", + "format": "int64", + "type": "integer" + }, + "renewal": { + "properties": { + "failed": { + "description": "The number of certificates for which renewal failed", + "format": "int64", + "type": "integer" + }, + "successful": { + "description": "The number of certificates for which renewal completed successfully", + "format": "int64", + "type": "integer" + }, + "triggered": { + "description": "The number of certificates for which the renewal has been started", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "triggered", + "successful", + "failed" + ], + "type": "object" } }, - "description": "Workload Issuance policy was created; details in response body." + "required": [ + "eligible", + "renewal" + ], + "type": "object" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "state": { + "description": "A string representing the status of a specific run of the auto-renewal process.", + "enum": [ + "pending", + "triggered", + "running", + "complete", + "awaiting results", + "no enabled apps", + "no automated keypair service active", + "failure" + ], + "example": "running", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "timestamp": { + "description": "The date and time when certificate auto-renewal is estimated to begin.", + "example": "2023-08-25T20:59:36.688019837Z", + "format": "date-time", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "timestamp", + "state", + "applications", + "certificates" ], - "summary": "Create a new Workload Issuance policy", - "tags": [ - "Workload Identity Manager Policies" - ] + "type": "object" }, - "get": { - "description": "Retrieves all policy details for all Workload Issuance policies. Policies are sets of rules that constrain how certificates can be issued, as well as set default values for some fields.", - "operationId": "policies_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyResponse" - } - } - }, - "description": "All Workload Issuance policies; details in response body." + "StatusType": { + "properties": { + "family": { + "enum": [ + "INFORMATIONAL", + "SUCCESSFUL", + "REDIRECTION", + "CLIENT_ERROR", + "SERVER_ERROR", + "OTHER" + ], + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "reasonPhrase": { + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "statusCode": { + "format": "int32", + "type": "integer" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get the details of all Workload", - "tags": [ - "Workload Identity Manager Policies" - ] - } - }, - "/v1/distributedissuers/policies/{id}": { - "get": { - "description": "Retrieves the details of the Workload Issuance policy with the specified `id`.", - "operationId": "policies_getById", - "parameters": [ - { - "description": "Workload Issuance policy UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedPolicyInformation" - } - } - }, - "description": "Specified Workload Issuance policy found; details in response body." + "type": "object" + }, + "SubCaProviderCreateRequest": { + "properties": { + "caAccountId": { + "description": "UUID of the CA account used by this Sub CA provider", + "example": "4ece3180-b1e0-11ed-862d-ad36b18e787a", + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "caProductOptionId": { + "description": "UUID of the CA product option used by this Sub CA provider", + "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", + "format": "uuid", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Specified Workload Issuance policy was not found." + "caType": { + "description": "Type of CA this Sub CA provider works with", + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP" + ], + "example": "BUILTIN", + "type": "string" + }, + "commonName": { + "description": "Common name", + "example": "example.com", + "maxLength": 64, + "type": "string" + }, + "country": { + "description": "Country", + "example": "US", + "maxLength": 64, + "type": "string" + }, + "keyAlgorithm": { + "description": "Key algorithm type", + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "example": "EC_P256", + "type": "string" + }, + "locality": { + "description": "Locality", + "example": "San Antonio", + "maxLength": 64, + "type": "string" + }, + "name": { + "description": "Name of the Sub CA provider", + "example": "Some Sub CA provider", + "maxLength": 64, + "type": "string" + }, + "organization": { + "description": "Organization", + "example": "Some organization", + "maxLength": 64, + "type": "string" + }, + "organizationalUnit": { + "description": "Organizational unit", + "example": "Some organizational unit", + "maxLength": 64, + "type": "string" + }, + "pkcs11": { + "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" + }, + "stateOrProvince": { + "description": "State or province", + "example": "Texas", + "maxLength": 64, + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "caAccountId", + "caProductOptionId", + "caType", + "commonName", + "keyAlgorithm", + "name", + "validityPeriod" ], - "summary": "Get a Workload Issuance policy details", - "tags": [ - "Workload Identity Manager Policies" - ] + "type": "object" }, - "patch": { - "description": "Updates (replaces) details of the Workload Issuance policy that has the specified `id`. Only fields specified in the request will be updated. Fields not included in the request will be ignored.", - "operationId": "policies_update", - "parameters": [ - { - "description": "Workload Issuance policy UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyUpdateRequest" - } - } + "SubCaProviderDeleteResponse": { + "properties": { + "id": { + "description": "UUID of the Sub CA provider", + "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the Sub CA provider", + "example": "Some Sub CA", + "type": "string" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedPolicyInformation" - } - } - }, - "description": "Workload Issuance policy updated." + "type": "object" + }, + "SubCaProviderInformation": { + "properties": { + "caAccountId": { + "description": "UUID of the CA account used by this Sub CA provider", + "example": "4ece3180-b1e0-11ed-862d-ad36b18e787a", + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "caProductOptionId": { + "description": "UUID of the CA product option used by this Sub CA provider", + "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", + "format": "uuid", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Workload Issuance policy was not found." + "caType": { + "description": "Type of CA this Sub CA provider works with", + "enum": [ + "MOCKCA", + "DIGICERT", + "GLOBALSIGN", + "BUILTIN", + "ENTRUST", + "MICROSOFT", + "ACME", + "ZTPKI", + "GLOBALSIGNMSSL", + "TPP" + ], + "example": "BUILTIN", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update a Workload Issuance policy details", - "tags": [ - "Workload Identity Manager Policies" - ] - }, - "delete": { - "description": "Deletes the Workload Issuance policy that has the specified `id`.", - "operationId": "policies_delete", - "parameters": [ - { - "description": "Workload Issuance policy UUID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PolicyDeleteResponse" - } - } - }, - "description": "Specified Workload Issuance policy was deleted" + "commonName": { + "description": "Common name", + "example": "example.com", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "companyId": { + "description": "UUID specific to your company", + "example": "03eb6e61-9806-11ed-84f2-c747fb71e467", + "format": "uuid", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Specified Workload Issuance policy was not found." + "country": { + "description": "Country", + "example": "US", + "type": "string" + }, + "creationDate": { + "description": "When the Sub CA provider was initially created", + "example": "2022-10-10T14:50:41.710+00:00", + "type": "string" + }, + "id": { + "description": "UUID of the Sub CA provider", + "example": "2f3c6030-b1e0-11ed-a3ed-e3dbaf56a746", + "format": "uuid", + "type": "string" + }, + "keyAlgorithm": { + "description": "Key algorithm type", + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "example": "EC_P256", + "type": "string" + }, + "locality": { + "description": "Locality", + "example": "San Antonio", + "type": "string" + }, + "modificationDate": { + "description": "When the Sub CA provider was last modified", + "example": "2023-12-12T20:00:10.500+00:00", + "type": "string" + }, + "name": { + "description": "Name of the Sub CA provider", + "example": "Some Sub CA provider", + "type": "string" + }, + "organization": { + "description": "Organization", + "example": "Some organization", + "type": "string" + }, + "organizationalUnit": { + "description": "Organizational unit", + "example": "Some organizational unit", + "type": "string" + }, + "pkcs11": { + "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" + }, + "stateOrProvince": { + "description": "State or province", + "example": "Texas", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "P30D", + "format": "PnYnMnDTnHnMnS", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Remove a Workload Issuance policy", - "tags": [ - "Workload Identity Manager Policies" - ] - } - }, - "/v1/distributedissuers/intermediatecertificates": { - "get": { - "description": "Retrieves the details of all Issuer intermediate certificates. These are the CA certificates issued to the Issuer instances that allow them to issue short-lived certificates.", - "operationId": "intermediatecertificates_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IntermediateCertificateResponse" - } - } + "type": "object" + }, + "SubCaProviderPkcs11ConfigurationInformation": { + "properties": { + "allowedClientLibraries": { + "description": "A collection of strings each of which represents SHA256 hash of an allowed HSM client library", + "example": [ + "c34d199f2e30bb679cd9b8533b99975465aefe8b023be1b37972f1ab43ab7b2d" + ], + "items": { + "type": "string" }, - "description": "All Issuer intermediate certificates and details." + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "partitionLabel": { + "description": "HSM Partition Label", + "example": "workload-identity-manager-hsm-partition", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse2" - } - } - }, - "description": "Incomplete or malformed request." + "partitionSerialNumber": { + "description": "HSM Partition Serial Number", + "example": "1444210958933", + "pattern": "^[A-Fa-fx0-9]{0,18}$", + "type": "string" + }, + "pin": { + "description": "HSM PIN", + "example": "1234", + "type": "string", + "writeOnly": true + }, + "signingEnabled": { + "description": "Indicates whether HSM signing is enabled or not", + "example": true, + "type": "boolean" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "SubCaProviderResponse": { + "properties": { + "subCaProviders": { + "items": { + "$ref": "#/components/schemas/SubCaProviderInformation" + }, + "type": "array" } - ], - "summary": "Get the details of all Issuer", - "tags": [ - "Workload Identity Manager Intermediate Certificates" - ] - } - }, - "/v1/certificaterequests/{id}/approval/{decision}": { - "post": { - "description": "Approve or reject certificate request that is waiting for user action", - "operationId": "certificaterequests_approve", - "parameters": [ - { - "description": "UUID of a Certificate Request", - "in": "path", - "name": "id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + }, + "type": "object" + }, + "SubCaProviderUpdateRequest": { + "properties": { + "caProductOptionId": { + "description": "UUID of the CA product option used by this Sub CA provider", + "example": "6b3d8d20-b1e0-11ed-9c2f-953e35982bbd", + "format": "uuid", + "type": "string" }, - { - "description": "User's decision - either approve or reject", - "in": "path", - "name": "decision", - "required": true, - "schema": { - "enum": [ - "APPROVE", - "REJECT" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApprovalDecisionRequest" - } - } + "commonName": { + "description": "Common name", + "example": "example.com", + "maxLength": 64, + "type": "string" }, - "description": "In case of rejection contains the reason for that" - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestInformation2" - } - } - }, - "description": "Certificate Request approved/rejected" + "country": { + "description": "Country", + "example": "US", + "maxLength": 64, + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request" + "keyAlgorithm": { + "description": "Key algorithm type", + "enum": [ + "RSA_2048", + "RSA_3072", + "RSA_4096", + "EC_P256", + "EC_P384", + "EC_P521", + "EC_ED25519" + ], + "example": "EC_P256", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Certificate Request not found" + "locality": { + "description": "Locality", + "example": "San Antonio", + "maxLength": 64, + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request" - } - }, - "security": [ - { - "tppl-api-key": [] + "name": { + "description": "Name of the Sub CA provider", + "example": "Some Sub CA", + "maxLength": 64, + "type": "string" + }, + "organization": { + "description": "Organization", + "example": "Some organization", + "maxLength": 64, + "type": "string" + }, + "organizationalUnit": { + "description": "Organizational unit", + "example": "Some organizational unit", + "maxLength": 64, + "type": "string" + }, + "pkcs11": { + "$ref": "#/components/schemas/SubCaProviderPkcs11ConfigurationInformation" + }, + "stateOrProvince": { + "description": "State or province", + "example": "Texas", + "maxLength": 64, + "type": "string" + }, + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" } - ], - "summary": "Approve or reject pending certificate request", - "tags": [ - "Certificate Approvals" - ] - } - }, - "/v1/certificaterequests/approval/bulk/{decision}": { - "post": { - "description": "Initiate approval or rejection of multiple certificate requests that are waiting for user action", - "operationId": "certificaterequests_bulk_approve", - "parameters": [ - { - "description": "User's decision - either approve or reject", - "in": "path", - "name": "decision", - "required": true, - "schema": { - "enum": [ - "APPROVE", - "REJECT" - ], + }, + "type": "object" + }, + "SubjectAlternativeNamesByType": { + "properties": { + "dnsNames": { + "items": { "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BulkApprovalRequest" - } - } + }, + "type": "array" }, - "description": "In case of rejection contains the reason for that." - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BulkApprovalResponse" - } - } + "ipAddresses": { + "items": { + "type": "string" }, - "description": "Bulk Approval of Certificate Request is accepted and processing" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "rfc822Names": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "uniformResourceIdentifiers": { + "items": { + "type": "string" }, - "description": "Incomplete or malformed request" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "SubjectAttributesInformation": { + "description": "Subject attributes", + "properties": { + "commonName": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "country": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "locality": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "organization": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "organizationalUnit": { + "$ref": "#/components/schemas/PropertyInformation" + }, + "stateOrProvince": { + "$ref": "#/components/schemas/PropertyInformation" } + }, + "type": "object" + }, + "SystemRole": { + "enum": [ + "SYSTEM_ADMIN", + "CONDOR_METRICS" ], - "summary": "Approve or reject multiple pending approval", - "tags": [ - "Certificate Approvals" - ] - } - }, - "/v1/certificaterequests/approvalrules": { - "post": { - "description": "Create certificate request workflow approval rule", - "operationId": "certificaterequests_approval_rule_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestApprovalRulesRequest" - } - } - }, - "description": "Properties of the new approval rule.", - "required": true + "type": "string" + }, + "TagAssignmentErrorInformation": { + "description": "Error information for tags not assigned", + "example": { + "errorInformation": { + "message": "not assigned", + "statusCode": 1111 + } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" - } - } + "properties": { + "args": { + "items": { + "$ref": "#/components/schemas/AnyValue2" }, - "description": "Approval rule is created. Details in response body" + "type": "array" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "message": { + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "statusCode": { + "format": "int32", + "type": "integer" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "TagInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "UUID of the tag", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "isReserved": { + "description": "Used by Venafi to reserve system tags", + "example": false, + "type": "boolean" + }, + "key": { + "description": "Same as tag name, though all lowercase", + "example": "application", + "type": "string" + }, + "name": { + "description": "Name of the tag", + "example": "Application", + "type": "string" } - ], - "summary": "Create an approval rule for certificate", - "tags": [ - "Certificate Approvals" - ] + }, + "type": "object" }, - "get": { - "description": "Retrieve all certificate request workflow approval rules for the current company.", - "operationId": "certificaterequests_approval_rules_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestApprovalRulesResponseOpenApi" - } - } - }, - "description": "All approval rules for the current company; details in response body." + "TagRequest": { + "description": "Array of tag and tag-value objects", + "properties": { + "name": { + "description": "Name of the tag", + "example": "Application", + "minLength": 1, + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "values": { + "description": "Array of values associated with the tag", + "example": [ + "TLS Protect", + "Jetstack" + ], + "items": { + "description": "Array of values associated with the tag", + "example": "[\"TLS Protect\",\"Jetstack\"]", + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "TagResponse": { + "properties": { + "count": { + "description": "Number of tags returned", + "example": 7, + "format": "int32", + "type": "integer" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "tags": { + "items": { + "$ref": "#/components/schemas/TagInformation" }, - "description": "Incomplete or malformed request." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "TagValueInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "id": { + "description": "The ID of the value", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "tagId": { + "description": "The ID of the tag the value applies to", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" + }, + "value": { + "description": "Name of the value", + "example": "TLS Protect", + "type": "string" } - ], - "summary": "Get all approval rules", - "tags": [ - "Certificate Approvals" - ] - } - }, - "/v1/certificaterequests/approvalrules/{id}": { - "get": { - "description": "Retrieve certificate request workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", - "operationId": "certificaterequests_approval_rule_getById", - "parameters": [ - { - "description": "UUID of an approval rule.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an approval rule.", - "format": "uuid", + }, + "type": "object" + }, + "TagValuesRequest": { + "properties": { + "values": { + "description": "Array of value names to associate with the tag", + "items": { + "description": "Array of value names to associate with the tag", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", "type": "string" - } + }, + "minItems": 1, + "type": "array" } + }, + "required": [ + "values" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" - } - } - }, - "description": "Approval rule matching specified id" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Request Conditions Failed" + "type": "object" + }, + "TagValuesResponse": { + "properties": { + "count": { + "description": "Number of values returned", + "example": 7, + "format": "int32", + "type": "integer" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "values": { + "items": { + "$ref": "#/components/schemas/TagValueInformation" }, - "description": "Approval rule not found" + "type": "array" + } + }, + "type": "object" + }, + "TagsAndValuesInformation": { + "properties": { + "tag": { + "$ref": "#/components/schemas/TagInformation" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "values": { + "items": { + "$ref": "#/components/schemas/TagValueInformation" }, - "description": "Request Conditions Failed" + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve approval rule by id", - "tags": [ - "Certificate Approvals" - ] + "type": "object" }, - "put": { - "description": "Can be used to update specific fields of the approval rule that has the specified `id`", - "operationId": "certificaterequests_approval_rule_update", - "parameters": [ - { - "description": "UUID of an approval rule.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an approval rule.", - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestApprovalRulesUpdateRequest" - } - } + "TagsAndValuesResponse": { + "properties": { + "tagsAndValues": { + "items": { + "$ref": "#/components/schemas/TagsAndValuesInformation" + }, + "type": "array" } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestApprovalRuleOpenApi" - } - } - }, - "description": "Approval rule updated" + "type": "object" + }, + "TagsAssignRequest": { + "properties": { + "action": { + "description": "Action to perform", + "enum": [ + "REPLACE", + "ADD", + "DELETE", + "DELETE_ALL" + ], + "example": "REPLACE", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "entityIds": { + "description": "Array of UUIDs of the objects", + "example": [ + "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" + ], + "items": { + "description": "Array of UUIDs of the objects", + "format": "uuid", + "type": "string" }, - "description": "Request Conditions Failed" + "minItems": 1, + "type": "array", + "uniqueItems": true }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Approval rule Not Found" + "entityType": { + "description": "Object type that the tag applies to", + "enum": [ + "CERTIFICATE", + "CERTIFICATE_INSTANCE", + "APPLICATION" + ], + "example": "CERTIFICATE", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "targetedTags": { + "description": "Array of tags to apply", + "example": [ + "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c" + ], + "items": { + "description": "Array of tags to apply", + "example": "[\"265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c\"]", + "type": "string" }, - "description": "Request Conditions Failed" + "type": "array", + "uniqueItems": true } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "entityIds" ], - "summary": "Update certificate request workflow approval rule", - "tags": [ - "Certificate Approvals" - ] + "type": "object" }, - "delete": { - "description": "Delete certificate request workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", - "operationId": "certificaterequests_approval_rule_delete", - "parameters": [ - { - "description": "UUID of an approval rule.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRequestApprovalRuleDeleteResponseOpenApi" - } - } + "TagsAssignResponse": { + "properties": { + "tagsAssignInformation": { + "items": { + "$ref": "#/components/schemas/TagsAssignResponseInformation" }, - "description": "Specified approval rule was deleted" + "type": "array" + } + }, + "type": "object" + }, + "TagsAssignResponseInformation": { + "properties": { + "companyId": { + "description": "UUID specific to your company", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "creationDate": { + "description": "The date when the assignment is created", + "example": "2023-01-30T16:28:53.166Z", + "format": "date-time", + "type": "string" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Specified approval rule was not found." + "entityId": { + "description": "UUID of the object", + "example": "265f6d30-a0bb-11ed-aee0-89fe7e5f5d0c", + "format": "uuid", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "entityType": { + "description": "Object type that the tag applies to", + "example": "CERTIFICATE", + "type": "string" + }, + "errorInformation": { + "$ref": "#/components/schemas/TagAssignmentErrorInformation" + }, + "modificationDate": { + "description": "The date when the assignment is last modified", + "example": "2023-01-30T16:28:53.166Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "Status of the assigned entity", + "example": "ASSIGNED", + "type": "string" + }, + "tags": { + "description": "The tags that are assigned", + "example": [ + "Application:TLS" + ], + "items": { + "description": "The tags that are assigned", + "example": "[\"Application:TLS\"]", + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array", + "uniqueItems": true } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Delete certificate request workflow approval rule", - "tags": [ - "Certificate Approvals" - ] - } - }, - "/v1/certificaterequests/approvalrequests/{entityId}": { - "get": { - "description": "Retrieve approval request by specified certificate request id", - "operationId": "certificaterequests_approvalrequest", - "parameters": [ - { - "description": "Entity UUID of the approval request", - "in": "path", - "name": "entityId", - "required": true, - "schema": { - "format": "uuid", + "type": "object" + }, + "TagsAssignmentAggregatesRequest": { + "properties": { + "entityType": { + "description": "Object type that the tag applies to. If null, get all object types", + "enum": [ + "CERTIFICATE", + "CERTIFICATE_INSTANCE", + "APPLICATION" + ], + "example": "CERTIFICATE", + "type": "string" + }, + "tags": { + "description": "Array of tags", + "example": [ + "TAG", + "Tag:Value" + ], + "items": { + "description": "Array of tags", + "example": "[\"TAG\",\"Tag:Value\"]", "type": "string" - } + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true } + }, + "required": [ + "tags" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApprovalRequestInformation" - } - } - }, - "description": "Approval Request information" - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "type": "object" + }, + "TagsAssignmentAggregatesResponse": { + "properties": { + "aggregates": { + "additionalProperties": { + "description": "Represents a mapping of tag name to list of aggregates information", + "items": { + "$ref": "#/components/schemas/TagsAssignmentAggregatesResponseInformation" + }, + "type": "array" }, - "description": "Incomplete or malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "description": "Represents a mapping of tag name to list of aggregates information", + "example": { + "TagNew": [ + { + "count": 2, + "entityType": "CERTIFICATE" + }, + { + "count": 5, + "entityType": "APPLICATION" } - } - }, - "description": "Approval Request not found" - }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + ], + "tag:value": [ + { + "count": 6, + "entityType": "CERTIFICATE" + }, + { + "count": 1, + "entityType": "APPLICATION" } - } + ] }, - "description": "Incomplete or malformed request" + "type": "object" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieve approval request for specific certificate", - "tags": [ - "Certificate Approvals" - ] - } - }, - "/v1/certificates/revocations/approvalrules": { - "post": { - "description": "Create certificate revocation workflow approval rule", - "operationId": "certificaterevocations_approval_rule_create", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRevocationApprovalRulesRequest" - } + "type": "object" + }, + "TagsAssignmentAggregatesResponseInformation": { + "description": "Represents a mapping of tag name to list of aggregates information", + "example": { + "TagNew": [ + { + "count": 2, + "entityType": "CERTIFICATE" + }, + { + "count": 5, + "entityType": "APPLICATION" } - }, - "description": "Properties of the new approval rule.", - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" - } - } + ], + "tag:value": [ + { + "count": 6, + "entityType": "CERTIFICATE" }, - "description": "Approval rule is created. Details in response body" + { + "count": 1, + "entityType": "APPLICATION" + } + ] + }, + "properties": { + "count": { + "description": "Number of entities per type", + "example": 2, + "format": "int32", + "type": "integer" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "entityType": { + "description": "Object type that the tag applies to", + "example": "CERTIFICATE", + "type": "string" + } + }, + "type": "object" + }, + "TagsBulkRequest": { + "properties": { + "tags": { + "description": "Array of tag and tag-value objects", + "items": { + "$ref": "#/components/schemas/TagRequest" }, - "description": "Incomplete or malformed request." + "type": "array" + } + }, + "type": "object" + }, + "Target": { + "properties": { + "connection": { + "description": "JSON object that configures the webhook connection for this target.\nSupported fields:\n- `url` (string, required): HTTPS endpoint URL for the webhook.\n- `headers` (object, optional): Key/value pairs of HTTP headers. Only the `Authorization` header is honored by the webhook service; all other headers are ignored.\n- `secret` (string, optional): Shared secret used to generate an HMAC signature sent in the `VaaS-Signature` header.\nWebhook deliveries always use `Content-Type: application/json`. Custom `Content-Type` values are not supported.\nExample:\n ```json\n{\n\"url\": \"https://example.com/webhook\",\n\"headers\": {\n\"Authorization\": \"Splunk 12345678-ABCD\"\n},\n\"secret\": \"my-shared-secret\"\n }\n", + "format": "json", + "type": "string" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "type": { + "description": "The delivery mechanism for this connector. For webhook-based notifications, use:\n- `generic` for a standard HTTPS webhook endpoint\n- `slack` for a Slack webhook target\n- `teams` for a Microsoft Teams webhook target\n", + "enum": [ + "generic", + "slack", + "teams" + ], + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "required": [ + "connection", + "type" + ], + "type": "object" + }, + "TargetsInformation": { + "discriminator": { + "propertyName": "serviceType" + }, + "properties": { + "serviceType": { + "type": "string" } + }, + "required": [ + "serviceType" ], - "summary": "Create an approval rule for certificate", - "tags": [ - "Certificate Revocation Approvals" - ] + "type": "object" }, - "get": { - "description": "Retrieve all certificate revocation workflow approval rules for the current company.", - "operationId": "certificaterevocations_approval_rules_getAll", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRevocationApprovalRulesResponseOpenApi" - } - } + "TeamId": { + "description": "The ID of a team.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "TeamInformation1": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "members": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "All approval rules for the current company; details in response body." + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "modificationDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "owners": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Incomplete or malformed request." + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "productRoles": { + "additionalProperties": { + "items": { + "$ref": "#/components/schemas/Role1" + }, + "type": "array", + "uniqueItems": true }, - "description": "Incomplete or malformed request." + "type": "object" + }, + "role": { + "$ref": "#/components/schemas/TeamRole" + }, + "systemRoles": { + "items": { + "$ref": "#/components/schemas/SystemRole" + }, + "type": "array", + "uniqueItems": true + }, + "userMatchingRules": { + "items": { + "$ref": "#/components/schemas/UserMatchingRule" + }, + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Get all certificate revocation approval rules", - "tags": [ - "Certificate Revocation Approvals" - ] - } - }, - "/v1/certificates/revocations/approvalrules/{id}": { - "get": { - "description": "Retrieve certificate revocation workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", - "operationId": "certificaterevocations_approval_rule_getById", - "parameters": [ - { - "description": "UUID of an approval rule.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an approval rule.", + "type": "object" + }, + "TeamInformation2": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "members": { + "items": { "format": "uuid", "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" - } - } }, - "description": "Approval rule matching specified id" + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "name": { + "type": "string" + }, + "owners": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "Request Conditions Failed" + "type": "array", + "uniqueItems": true }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "ownership": { + "additionalProperties": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true }, - "description": "Approval rule not found" + "type": "object" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "productRoles": { + "additionalProperties": { + "items": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true }, - "description": "Request Conditions Failed" + "type": "object" + }, + "systemRoles": { + "items": { + "enum": [ + "SYSTEM_ADMIN", + "CONDOR_METRICS" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "TeamMembersRequest": { + "properties": { + "members": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true } + }, + "required": [ + "members" ], - "summary": "Retrieve certificate revocation approval rule by", - "tags": [ - "Certificate Revocation Approvals" - ] + "type": "object" }, - "put": { - "description": "Can be used to update specific fields of the approval rule that has the specified `id`", - "operationId": "certificaterevocations_approval_rule_update", - "parameters": [ - { - "description": "UUID of an approval rule.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "description": "UUID of an approval rule.", + "TeamOwnersRequest": { + "properties": { + "owners": { + "items": { "format": "uuid", "type": "string" - } + }, + "type": "array", + "uniqueItems": true } + }, + "required": [ + "owners" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRevocationApprovalRulesUpdateRequest" + "type": "object" + }, + "TeamRole": { + "enum": [ + "SYSTEM_ADMIN", + "PKI_ADMIN", + "RESOURCE_OWNER", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "TeamsIds": { + "description": "The ID's of teams.", + "items": { + "$ref": "#/components/schemas/TeamId" + }, + "type": "array", + "uniqueItems": true + }, + "TeamsResponse": { + "properties": { + "teams": { + "items": { + "$ref": "#/components/schemas/TeamInformation1" + }, + "type": "array" + } + }, + "type": "object" + }, + "TenantExpirationNotificationConfiguration": { + "properties": { + "additionalRecipients": { + "description": "A list of users and/or teams who should be added as recipients.", + "example": [ + { + "id": "22153ae0-4352-11ee-b95c-3531a284802b", + "type": "User" + }, + { + "id": "22153ae0-4352-11ee-b95c-12345abcd123", + "type": "Team" } - } + ], + "items": { + "$ref": "#/components/schemas/Recipient" + }, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "A list of channels that should be used to deliver the notification.", + "example": [ + "email" + ], + "items": { + "$ref": "#/components/schemas/Channel" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "enabled": { + "description": "If true, then the system will send notification for certificates which are nearing expiration.", + "example": true, + "type": "boolean" + }, + "fallbackToPKIAdmin": { + "description": "If true, then all users with the PKI admin role will be added as recipients if the persona list does not include any recipients for a specific certificate.", + "example": true, + "type": "boolean" + }, + "includeCertificateDetails": { + "description": "If true, then the notification may include potentially sensitive details about the certificate that is nearing expiration.", + "example": true, + "type": "boolean" + }, + "personas": { + "description": "A list of personas who should be recipients of the notification. If \"Application Owners\" is included then the owners of the Application object to which the certificate is assigned will be added as recipients. If \"All PKI Admins\" or \"All Admins\" are present then all users in the system with that role will be added as recipients.", + "example": [ + "Application Owners", + "All PKI Admins" + ], + "items": { + "$ref": "#/components/schemas/Persona" + }, + "type": "array", + "uniqueItems": true } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRevocationApprovalRuleOpenApi" - } + "type": "object" + }, + "TenantExpirationReportsConfiguration": { + "properties": { + "additionalRecipients": { + "description": "A list of users and/or teams who should be added as recipients.", + "example": [ + { + "id": "22153ae0-4352-11ee-b95c-3531a284802b", + "type": "User" + }, + { + "id": "22153ae0-4352-11ee-b95c-12345abcd123", + "type": "Team" } + ], + "items": { + "$ref": "#/components/schemas/Recipient" }, - "description": "Approval rule updated" + "type": "array", + "uniqueItems": true }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "channels": { + "description": "A list of channels that should be used to deliver the notification.", + "example": [ + "email" + ], + "items": { + "$ref": "#/components/schemas/Channel" }, - "description": "Request Conditions Failed" + "minItems": 1, + "type": "array", + "uniqueItems": true }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } + "enabled": { + "description": "If true, then the system will send reports providing details of certificates which are nearing expiration.", + "example": true, + "type": "boolean" + }, + "expiringWithinDays": { + "description": "Any certificates which will expire within the number of days specified here will be included in the report.", + "example": 30, + "type": "integer" + }, + "ignoreAfterDays": { + "description": "Any certificates which have expired for more than the specified days will be excluded in the report.", + "example": 30, + "type": "integer" + }, + "roles": { + "description": "All users with the specified VaaS roles will be added as a report recipient.", + "example": [ + "SYSTEM_ADMIN" + ], + "items": { + "$ref": "#/components/schemas/Role2" }, - "description": "Approval rule Not Found" + "type": "array", + "uniqueItems": true }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } + "schedule": { + "description": "A cron string representing the desired schedule for delivering reports. Note that currently reports may not be sent more than once per day. The `hour` and `minute` fields of the cron schedule will be ignored.", + "example": "0 0 * * Mon", + "type": "string" + } + }, + "type": "object" + }, + "TenantRenewalConfiguration": { + "properties": { + "id": { + "description": "The object ID", + "example": "12a05220-4352-11ee-ac28-c1379e5decf9", + "format": "UUID", + "type": "string" + }, + "renewalWindow": { + "description": "A set of options to control the time window in which auto-renewal of certificates should be attempted.", + "example": { + "days": 30 + }, + "properties": { + "days": { + "description": "Any certificates associated with this object that are expected to expire within the specified number of days will be acted on.", + "format": "int64", + "minimum": 1, + "type": "integer" } }, - "description": "Request Conditions Failed" + "required": [ + "days" + ], + "type": "object" } }, - "security": [ - { - "tppl-api-key": [] - } + "required": [ + "id", + "renewalWindow" ], - "summary": "Update certificate revocation workflow approval ru", - "tags": [ - "Certificate Revocation Approvals" - ] + "type": "object" }, - "delete": { - "description": "Delete certificate revocation workflow approval rule with 'id' attribute matching specified value; specified value should be uuid not numeric", - "operationId": "certificaterevocations_approval_rule_delete", - "parameters": [ - { - "description": "UUID of an approval rule.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CertificateRevocationApprovalRuleDeleteResponseOpenApi" - } - } - }, - "description": "Specified approval rule was deleted" + "TestCMSConfigurationRequest": { + "description": "The information representing a Credential Manager Service configuration for test purposes.", + "properties": { + "cmsDetails": { + "$ref": "#/components/schemas/TestCMSDetails" }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "cmsType": { + "$ref": "#/components/schemas/CMSType" }, - "404": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Specified approval rule was not found." + "id": { + "$ref": "#/components/schemas/CMSConfId" }, - "412": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse10" - } - } - }, - "description": "Incomplete or malformed request." + "name": { + "$ref": "#/components/schemas/Name" + }, + "vSatelliteIds": { + "$ref": "#/components/schemas/VSatelliteIds" + }, + "wsClientId": { + "description": "An ID where you can subscribe to receive the response of the workflow.", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "required": [ + "wsClientId" + ], + "type": "object" + }, + "TestCMSConfigurationResponse": { + "description": "The result of testing the Credential Manager Service configuration.", + "properties": { + "workflowId": { + "format": "uuid", + "type": "string" + }, + "workflowName": { + "type": "string" } + }, + "required": [ + "workflowId", + "workflowName" ], - "summary": "Delete certificate revocation workflow approval ru", - "tags": [ - "Certificate Revocation Approvals" - ] - } - }, - "/v1/plugins": { - "get": { - "description": "Retrieve all the plugins for the tenant.", - "operationId": "get-v1-plugins", - "parameters": [ + "type": "object" + }, + "TestCMSDetails": { + "oneOf": [ { - "description": "Filter by provided plugin type.", - "in": "query", - "name": "pluginTypes", - "schema": { - "items": { - "$ref": "#/components/schemas/PluginType" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } + "$ref": "#/components/schemas/TestCyberArkDetails" }, { - "description": "Include disabled plugins if set to true.", - "in": "query", - "name": "includeDisabled", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "plugins": { - "items": { - "$ref": "#/components/schemas/Plugin" - }, - "type": "array" - } - }, - "required": [ - "plugins" - ], - "type": "object" - } - } - }, - "description": "Success. All plugins retrieved." - } - }, - "security": [ + "$ref": "#/components/schemas/TestHashiCorpDetails" + } + ] + }, + "TestCredentialDetails": { + "oneOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/TestCyberArkCredDetails" + }, + { + "$ref": "#/components/schemas/TestHashiCorpCredDetails" } - ], - "summary": "Retrieve all plugins", - "tags": [ - "Plugins" ] }, - "post": { - "description": "Create a custom plugin for your tenant's exclusive use. The user must be a SYSTEM_ADMIN or a PKI_ADMIN.", - "operationId": "post-v1-plugins", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublicPluginCreationRequest" - } - } + "TestCredentialRequest": { + "description": "The properties representing a credential to test.", + "properties": { + "authType": { + "$ref": "#/components/schemas/AuthType" + }, + "cmsType": { + "$ref": "#/components/schemas/CMSType" + }, + "credentialDetails": { + "$ref": "#/components/schemas/TestCredentialDetails" + }, + "id": { + "$ref": "#/components/schemas/CredentialId" + }, + "wsClientId": { + "description": "An ID where you can subscribe to receive the response of the workflow.", + "type": "string" } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginResponse" - } - } - }, - "description": "Success. Plugin created." + "required": [ + "wsClientId" + ], + "type": "object" + }, + "TestCredentialResponse": { + "description": "The result of testing access to the credential.", + "properties": { + "workflowId": { + "format": "uuid", + "type": "string" + }, + "workflowName": { + "type": "string" } }, - "security": [ + "required": [ + "workflowId", + "workflowName" + ], + "type": "object" + }, + "TestCyberArkCredDetails": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/CyberArkDetails" } - ], - "summary": "Create a local plugin", - "tags": [ - "Plugins" ] - } - }, - "/v1/plugins/{id}": { - "get": { - "description": "Retrieve a plugin with the specified ID.", - "operationId": "get-v1-plugins-id", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - }, - "description": "Success. Plugin retrieved." + }, + "TestCyberArkDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkConfigurationRequiredProp" } - }, - "security": [ + ] + }, + "TestHashiCorpCredDetails": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/HashiCorpDetails" } - ], - "summary": "Retrieve plugin by ID", - "tags": [ - "Plugins" - ], - "parameters": [ + ] + }, + "TestHashiCorpDetails": { + "allOf": [ { - "description": "Plugin ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/HashiCorpConfigurationRequiredProp" } ] }, - "patch": { - "description": "Update a plugin with specified ID. Plugin must be owned by the tenant and the user must be a SYSTEM_ADMIN or a PKI_ADMIN.", - "operationId": "patch-v1-plugins-id", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PublicPluginUpdateRequest" - } - } + "TrackingDataInformation": { + "discriminator": { + "propertyName": "certificateAuthority" + }, + "properties": { + "certificateAuthority": { + "type": "string" } }, - "responses": { - "200": { - "description": "Success. Plugin updated." + "required": [ + "certificateAuthority" + ], + "type": "object" + }, + "UnaryOperator": { + "description": "An operator for filtering", + "enum": [ + "NOT" + ], + "example": "NOT", + "type": "string" + }, + "UpdateCMSConfigurationRequest": { + "description": "The information representing a Credential Manager Service configuration for update.", + "properties": { + "cmsDetails": { + "$ref": "#/components/schemas/UpdateCMSDetails" }, - "401": { - "description": "Unauthorized" + "id": { + "$ref": "#/components/schemas/CMSConfId" }, - "403": { - "description": "Forbidden" + "name": { + "$ref": "#/components/schemas/Name" + }, + "vSatelliteIds": { + "$ref": "#/components/schemas/VSatelliteIds" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Update a local plugin", - "tags": [ - "Plugins" + "required": [ + "id" ], - "parameters": [ + "type": "object" + }, + "UpdateCMSDetails": { + "oneOf": [ { - "description": "Plugin ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/UpdateCyberArkDetails" + }, + { + "$ref": "#/components/schemas/UpdateHashiCorpDetails" } ] }, - "delete": { - "description": "Delete a plugin with the specified ID. Plugin must be owned by the tenant and the user must be a SYSTEM_ADMIN or a PKI_ADMIN.", - "operationId": "delete-v1-plugins-id", - "responses": { - "204": { - "description": "No Content." - } - }, - "security": [ + "UpdateCredentialDetails": { + "oneOf": [ { - "tppl-api-key": [] - } - ], - "summary": "Delete a local plugin", - "tags": [ - "Plugins" - ], - "parameters": [ + "$ref": "#/components/schemas/UpdateCyberArkCredDetails" + }, { - "description": "Plugin ID", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/UpdateHashiCorpCredDetails" } ] - } - }, - "/v1/plugins/{id}/disablements": { - "post": { - "description": "Set a plugin to be disabled for your tenant.", - "operationId": "post-v1-plugins-id-exclusions", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginResponse" - } - } - }, - "description": "Successfully disabled the plugin for the current tenant." + }, + "UpdateCredentialRequest": { + "description": "The properties representing a credential to update.", + "properties": { + "cmsConfigId": { + "$ref": "#/components/schemas/CMSConfId" + }, + "credentialDetails": { + "$ref": "#/components/schemas/UpdateCredentialDetails" + }, + "id": { + "$ref": "#/components/schemas/CredentialId" + }, + "name": { + "$ref": "#/components/schemas/CredentialName" + }, + "teamsIds": { + "$ref": "#/components/schemas/TeamsIds" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Disable a plugin", - "tags": [ - "Plugins" + "required": [ + "id" ], - "parameters": [ + "type": "object" + }, + "UpdateCyberArkCredDetails": { + "allOf": [ { - "description": "Plugin ID that is currently marked as disabled.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/CyberArkDetails" } ] }, - "delete": { - "description": "Remove a plugin exclusion from your tenant.", - "operationId": "delete-v1-plugins-id-exclusions", - "responses": { - "204": { - "description": "No Content. Successfully deleted the plugin disablement." + "UpdateCyberArkDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/CyberArkConfiguration" } - }, - "security": [ + ] + }, + "UpdateHashiCorpCredDetails": { + "allOf": [ { - "tppl-api-key": [] + "$ref": "#/components/schemas/HashiCorpDetails" } - ], - "summary": "Remove plugin disablement", - "tags": [ - "Plugins" - ], - "parameters": [ + ] + }, + "UpdateHashiCorpDetails": { + "allOf": [ { - "description": "Plugin ID that is currently marked as disabled.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/HashiCorpConfiguration" } ] - } - }, - "/v1/plugins/disablements": { - "get": { - "description": "Retrieve all the disabled plugins for the current tenant.", - "operationId": "get-v1-plugins-exclusions", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PluginResponse" - } - } + }, + "UpdateTeamRequest": { + "properties": { + "name": { + "maxLength": 100, + "type": "string" + }, + "role": { + "$ref": "#/components/schemas/TeamRole" + }, + "userMatchingRules": { + "items": { + "$ref": "#/components/schemas/UserMatchingRule" }, - "description": "Successfully retrieved all the disabled plugins for the current tenant." + "type": "array" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "UpdatesConfigRequest": { + "properties": { + "updateConfigSchedulerPattern": { + "oneOf": [ + { + "$ref": "#/components/schemas/DailyPatternInformation" + }, + { + "$ref": "#/components/schemas/WeeklyPatternInformation" + } + ], + "type": "object" } + }, + "required": [ + "updateConfigSchedulerPattern" ], - "summary": "Retrieve all disabled plugins", - "tags": [ - "Plugins" - ] - } - }, - "/v1/serviceaccounts": { - "get": { - "description": "Retrieves all the Service Accounts the user has access to", - "operationId": "get-v1-serviceaccounts", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetServiceAccountsResponseBody" - } + "type": "object" + }, + "UpdatesConfigResponse": { + "properties": { + "updateConfigSchedulerPattern": { + "oneOf": [ + { + "$ref": "#/components/schemas/DailyPatternInformation" + }, + { + "$ref": "#/components/schemas/WeeklyPatternInformation" } + ], + "type": "object" + } + }, + "type": "object" + }, + "UpgradeStatus": { + "enum": [ + "LATEST", + "UPGRADE_PENDING", + "UPGRADING", + "FAILED" + ], + "type": "string" + }, + "UriBuilder": { + "type": "object" + }, + "UserAccountResponse": { + "properties": { + "apiKey": { + "$ref": "#/components/schemas/ApiKeyInformation" + }, + "company": { + "$ref": "#/components/schemas/CompanyInformation" + }, + "user": { + "$ref": "#/components/schemas/UserInformation1" + } + }, + "type": "object" + }, + "UserAccountType": { + "enum": [ + "WEB_UI", + "API" + ], + "type": "string" + }, + "UserAccountTypeRequest": { + "properties": { + "accountType": { + "$ref": "#/components/schemas/UserAccountType" + } + }, + "required": [ + "accountType" + ], + "type": "object" + }, + "UserForceLocalPasswordExpirationRequest": { + "properties": { + "forceLocalPasswordExpiration": { + "type": "boolean" + } + }, + "required": [ + "forceLocalPasswordExpiration" + ], + "type": "object" + }, + "UserInformation1": { + "properties": { + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "emailAddress": { + "type": "string" + }, + "firstLoginDate": { + "format": "date-time", + "type": "string" + }, + "firstname": { + "type": "string" + }, + "forceLocalPasswordExpiration": { + "type": "boolean" + }, + "hasPassword": { + "type": "boolean" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "lastname": { + "type": "string" + }, + "localLoginDisabled": { + "type": "boolean" + }, + "memberedTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ownedTeams": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "The list of all Service Account details the user has access to" + "type": "array", + "uniqueItems": true }, - "400": { - "description": "BadRequest" + "productRoles": { + "additionalProperties": { + "items": { + "$ref": "#/components/schemas/Role1" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" }, - "401": { - "description": "Unauthorized" + "signupAttributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" }, - "500": { - "description": "InternalServerError" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Retrieves all the Service Accounts the", - "tags": [ - "Service Accounts" - ] - }, - "post": { - "description": "Creates a Service Account with the information provided. The service account is later used for machine to machine authentication. For rsaKey authentication service accounts publicKey key is required. Provide authenticationType field for creating other service accounts with another type of authentication.", - "operationId": "create-v1-serviceaccounts", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateServiceAccountRequestBody" - } - } + "ssoStatus": { + "$ref": "#/components/schemas/SSOStatus" }, - "description": "The Service Account data", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateServiceAccountResponseBody" - } - } + "systemRoles": { + "items": { + "$ref": "#/components/schemas/SystemRole" }, - "description": "The id assigned to the created Service Account. If the Service Account has CyberArk registry purpose and is created with ociToken authentication type, the ociRegistryToken and ociAccountName are returned in the response." + "type": "array", + "uniqueItems": true }, - "400": { - "description": "BadRequest. Return ErrInvalidPayload when creating rsaKey authentication service accounts and publicKey not provided." + "userAccountType": { + "$ref": "#/components/schemas/UserAccountType" }, - "401": { - "description": "Unauthorized" + "userStatus": { + "$ref": "#/components/schemas/UserStatus" }, - "500": { - "description": "InternalServerError" + "userType": { + "$ref": "#/components/schemas/UserType" + }, + "username": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Creates a Service Account", - "tags": [ - "Service Accounts" - ] - } - }, - "/v1/serviceaccounts/{id}": { - "get": { - "description": "Retrieves the information of an Service Account associated to the given id", - "operationId": "get-v1-serviceaccounts-byId", - "parameters": [ - { - "description": "The ID corresponding to the Service Account you want to retrieve", - "in": "path", - "name": "id", - "required": true, - "schema": { - "example": "933507dd-0286-11ef-bc25-8a00a468403f", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetServiceAccountsByClientIDResponseBody" - } - } + "type": "object" + }, + "UserInformation2": { + "properties": { + "admin": { + "type": "boolean" + }, + "companyId": { + "format": "uuid", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "firstname": { + "type": "string" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "lastname": { + "type": "string" + }, + "memberedTeams": { + "items": { + "format": "uuid", + "type": "string" }, - "description": "The Service Account details for the given id" + "type": "array", + "uniqueItems": true }, - "400": { - "description": "BadRequest" + "ownedTeams": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true }, - "401": { - "description": "Unauthorized" + "productRoles": { + "additionalProperties": { + "items": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" }, - "500": { - "description": "InternalServerError" - } - }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Gets a Service Account", - "tags": [ - "Service Accounts" - ] - }, - "patch": { - "description": "Updates the specified fields for a given service account matching the provided id. Providing either a new credentialLifetime or a new publicKey will result of the corresponding credentials associated to this Service Account", - "operationId": "patch-v1-serviceaccounts-byId", - "parameters": [ - { - "description": "The ID corresponding to the Service Account you want to update", - "in": "path", - "name": "id", - "required": true, - "schema": { - "example": "933507dd-0286-11ef-bc25-8a00a468403f", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchServiceAccountByClientIDRequestBody" - } - } + "resourceOwner": { + "type": "boolean" }, - "description": "The data to update", - "required": true - }, - "responses": { - "204": { - "description": "The Service Account was updated successfully" + "serviceAccount": { + "type": "boolean" + }, + "systemRoles": { + "items": { + "enum": [ + "SYSTEM_ADMIN", + "CONDOR_METRICS" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "teamsIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "userAccountType": { + "type": "string" }, - "400": { - "description": "BadRequest" + "userStatus": { + "type": "string" }, - "401": { - "description": "Unauthorized" + "userType": { + "type": "string" }, - "500": { - "description": "InternalServerError" + "username": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } - ], - "summary": "Updates a Service Account", - "tags": [ - "Service Accounts" - ] + "type": "object" }, - "delete": { - "description": "Deletes the Service Account corresponding to the provided id. Deleting a Service Account also invalidates its associated credentials.", - "operationId": "delete-v1-serviceaccounts-byId", - "parameters": [ - { - "description": "The ID corresponding to the Service Account you want to delete", - "in": "path", - "name": "id", - "required": true, - "schema": { - "example": "933507dd-0286-11ef-bc25-8a00a468403f", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - } - } - ], - "responses": { - "204": { - "description": "The Service Account was deleted successfully" + "UserMatchingRule": { + "properties": { + "claimName": { + "minLength": 1, + "type": "string" }, - "400": { - "description": "BadRequest" + "operator": { + "$ref": "#/components/schemas/Operator" }, - "401": { - "description": "Unauthorized" + "value": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "claimName", + "operator", + "value" + ], + "type": "object" + }, + "UserPasswordAuthenticationData": { + "properties": { + "password": { + "description": "The user's password of the underlying credentials provider.", + "format": "password", + "type": "string" }, - "500": { - "description": "InternalServerError" + "userName": { + "description": "The user's name of the underlying credentials provider.", + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "UserResponse": { + "properties": { + "users": { + "items": { + "$ref": "#/components/schemas/UserInformation1" + }, + "type": "array" } + }, + "type": "object" + }, + "UserStatus": { + "enum": [ + "PENDING_ACTIVATION", + "ACTIVE", + "INACTIVE" ], - "summary": "Deletes a Service Account", - "tags": [ - "Service Accounts" - ] - } - }, - "/v1/serviceaccounts/scopes": { - "get": { - "description": "Retrieves all the Service Accounts Scopes available for the user", - "operationId": "get-v1-serviceaccountscopes", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetServiceAccountScopesResponseBody" - } - } - }, - "description": "The list of all Service Account Scopes available for the user" + "type": "string" + }, + "UserType": { + "enum": [ + "EXTERNAL", + "INTERNAL" + ], + "type": "string" + }, + "VSatelliteId": { + "description": "The VSatellite ID", + "format": "uuid", + "type": "string" + }, + "VSatelliteIds": { + "description": "An array of the VSatellite Ids which are connected to the CMS provider.", + "items": { + "$ref": "#/components/schemas/VSatelliteId" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "VisibilityConstraintsInformation": { + "properties": { + "fullAccessDurationDays": { + "format": "int32", + "minimum": 0, + "type": "integer" }, - "400": { - "description": "BadRequest" + "limitedAccessNotificationDays": { + "format": "int32", + "minimum": 0, + "type": "integer" }, - "401": { - "description": "Unauthorized" + "limitedVisibilityCertCount": { + "format": "int32", + "minimum": 0, + "type": "integer" }, - "500": { - "description": "InternalServerError" + "limitedVisibilityCertInstallPerCertCount": { + "format": "int32", + "minimum": 0, + "type": "integer" } }, - "security": [ - { - "tppl-api-key": [] + "type": "object" + }, + "WebhookProperties": { + "description": "Connector properties for webhook-based notifications.\nWebhook notifications are delivered as HTTP POST requests with a JSON body structured as:\n```json\n{\n \"events\": [\n {\n \"eventName\": \"string\",\n \"eventType\": \"string\",\n \"message\": \"string\",\n \"criticality\": 0,\n \"createdAt\": \"2025-01-15T12:45:00Z\"\n }\n ]\n}\n```\nOnly one event is included per request. The webhook service sets `Content-Type: application/json`, `VaaS-Timestamp`, and, when a `secret` is configured in the connection, `VaaS-Signature`.\n", + "properties": { + "filter": { + "$ref": "#/components/schemas/Filter1" + }, + "target": { + "$ref": "#/components/schemas/Target" } + }, + "required": [ + "filter", + "target" ], - "summary": "Retrieves all the Service Accounts Scopes", - "tags": [ - "Service Accounts" - ] - } - }, - "/v1/serviceaccounts/{id}/ocitoken": { - "put": { - "description": "Regenerate the OCI registry token for a given service account matching the provided id. Providing a new OCI registry token to this Service Account and sending it back to the client back. Calling this endpoint will remove the current token for the service account and create a new one. Old token can not be used.", - "operationId": "put-v1-serviceaccounts-byId-ocitoken", - "parameters": [ + "type": "object" + }, + "WeeklyPatternInformation": { + "allOf": [ { - "description": "The ID corresponding to the Service Account you want to regenerate the OCI registry token", - "in": "path", - "name": "id", - "required": true, - "schema": { - "example": "933507dd-0286-11ef-bc25-8a00a468403f", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutServiceAccountByClientIDOCITokenResponseBody" - } + "$ref": "#/components/schemas/SchedulerPatternInformation3" + }, + { + "properties": { + "daysOfWeek": { + "description": "Days of the week", + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "items": { + "description": "Days of the week", + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "duration": { + "description": "Duration in ISO-8601 format", + "enum": [ + "PT8H", + "PT12H", + "PT24H" + ], + "example": "PT24H", + "type": "string" + }, + "startTime": { + "description": "Start time in HH:mm:ss format", + "pattern": "^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$", + "type": "string" } }, - "description": "The Service Account OCI registry token has been regenerated" - }, - "400": { - "description": "BadRequest. This also happens when trying to regenerate token for account without token based authentication" - }, - "401": { - "description": "Unauthorized" - }, - "500": { - "description": "InternalServerError" - } - }, - "security": [ - { - "tppl-api-key": [] + "type": "object" } ], - "summary": "Regenerate the OCI registry token for", - "tags": [ - "Service Accounts" - ] - } - }, - "/v1/serviceaccounts/{id}/credentials": { - "put": { - "description": "Updates the specified credentials for a given service account matching the provided id. Providing either a new credentialLifetime or a new publicKey will result of the corresponding credentials associated to this Service Account", - "operationId": "put-v1-serviceaccounts-byId-credentials", - "parameters": [ - { - "description": "The ID corresponding to the Service Account you want to update", - "in": "path", - "name": "id", - "required": true, - "schema": { - "example": "933507dd-0286-11ef-bc25-8a00a468403f", - "format": "UUID", - "type": "string", - "x-go-type": "uuid.UUID", - "x-go-type-import": { - "path": "github.com/google/uuid" - } - } - } + "required": [ + "daysOfWeek", + "duration", + "startTime" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutServiceAccountByClientIDCredentialsRequestBody" - } - } - }, - "description": "The data to update", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutServiceAccountByClientIDCredentialsResponseBody" - } - } - }, - "description": "The Service Account Credentials were updated successfully" - }, - "400": { - "description": "BadRequest" - }, - "401": { - "description": "Unauthorized" + "type": "object" + }, + "WorkType": { + "description": "Defines the type of supported workflow for the plugin.", + "enum": [ + "DISCOVERY", + "CREDENTIAL", + "PROVISIONING", + "ISSUANCE", + "CERTIFICATE_IMPORT" + ], + "title": "WorkType", + "type": "string" + }, + "WorkerServiceStatusDetails": { + "properties": { + "name": { + "type": "string" }, - "500": { - "description": "InternalServerError" + "status": { + "type": "string" } }, - "security": [ - { - "tppl-api-key": [] - } + "type": "object" + }, + "WorkerStatus": { + "enum": [ + "DRAFT", + "PAIRED", + "ACTIVE", + "FAILED", + "INACTIVE" ], - "summary": "Updates a Service Account credentials", - "tags": [ - "Service Accounts" - ] + "type": "string" } - } - }, - "servers": [ - { - "url": "https://api.strata.paloaltonetworks.com", - "description": "Strata Cloud Manager API" - } - ], - "tags": [ - { - "name": "Certificates", - "description": "APIs for Certificates." - }, - { - "name": "Certificate Installations", - "description": "APIs for Certificate Installations." - }, - { - "name": "Certificate Discovery", - "description": "APIs for Certificate Discovery." - }, - { - "name": "Certificate Import", - "description": "APIs for Certificate Import." - }, - { - "name": "Private Key Import", - "description": "APIs for Private Key Import." - }, - { - "name": "Certificate Request", - "description": "APIs for Certificate Request." - }, - { - "name": "Certificate Policy", - "description": "APIs for Certificate Policy." - }, - { - "name": "Application", - "description": "APIs for Application." - }, - { - "name": "Credential Management", - "description": "APIs for Credential Management." - }, - { - "name": "Machine Identities", - "description": "APIs for Machine Identities." - }, - { - "name": "Machine Types", - "description": "APIs for Machine Types." - }, - { - "name": "Machines", - "description": "APIs for Machines." - }, - { - "name": "Users", - "description": "APIs for Users." - }, - { - "name": "User Accounts", - "description": "APIs for User Accounts." - }, - { - "name": "Teams", - "description": "APIs for Teams." - }, - { - "name": "Event Logs", - "description": "APIs for Event Logs." - }, - { - "name": "VSatellite", - "description": "APIs for VSatellite." - }, - { - "name": "Webhooks", - "description": "APIs for Webhooks." - }, - { - "name": "Certificate Inventory Monitoring", - "description": "APIs for Certificate Inventory Monitoring." - }, - { - "name": "Certificate Auto-renewal Monitoring", - "description": "APIs for Certificate Auto-renewal Monitoring." - }, - { - "name": "Certificate Expiration Reports", - "description": "APIs for Certificate Expiration Reports." - }, - { - "name": "Tags", - "description": "APIs for Tags." - }, - { - "name": "Workload Identity Manager Configurations", - "description": "APIs for Workload Identity Manager Configurations." - }, - { - "name": "Workload Identity Manager Sub CA Providers", - "description": "APIs for Workload Identity Manager Sub CA Providers." - }, - { - "name": "Workload Identity Manager Policies", - "description": "APIs for Workload Identity Manager Policies." - }, - { - "name": "Workload Identity Manager Intermediate Certificates", - "description": "APIs for Workload Identity Manager Intermediate Certificates." - }, - { - "name": "Certificate Approvals", - "description": "APIs for Certificate Approvals." - }, - { - "name": "Certificate Revocation Approvals", - "description": "APIs for Certificate Revocation Approvals." - }, - { - "name": "Plugins", - "description": "APIs for Plugins." }, - { - "name": "Service Accounts", - "description": "APIs for Service Accounts." + "securitySchemes": { + "tppl-api-key": { + "in": "header", + "name": "tppl-api-key", + "type": "apiKey" + } } - ] + } } \ No newline at end of file From 0a1da520b37a315ce2ee66f2dea31c65b18f26b9 Mon Sep 17 00:00:00 2001 From: sra Date: Wed, 1 Apr 2026 21:17:57 +0530 Subject: [PATCH 3/5] Fixed syntax error in index.js at line 250 --- src/pages/strata-cloud-manager/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/strata-cloud-manager/index.js b/src/pages/strata-cloud-manager/index.js index 23d37a328..ae4ee6c89 100644 --- a/src/pages/strata-cloud-manager/index.js +++ b/src/pages/strata-cloud-manager/index.js @@ -254,7 +254,7 @@ export default function SCMLandingPage() { }, { label: "Monitoring", - description: "", + description: "Monitoring", docs: [ { to: "sase/api/mt-monitor", From 8574b8c3e2877882c951636c043b4541cb06051b Mon Sep 17 00:00:00 2001 From: sra Date: Wed, 1 Apr 2026 22:28:12 +0530 Subject: [PATCH 4/5] Restored to the previous state --- src/pages/strata-cloud-manager/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/strata-cloud-manager/index.js b/src/pages/strata-cloud-manager/index.js index ae4ee6c89..23d37a328 100644 --- a/src/pages/strata-cloud-manager/index.js +++ b/src/pages/strata-cloud-manager/index.js @@ -254,7 +254,7 @@ export default function SCMLandingPage() { }, { label: "Monitoring", - description: "Monitoring", + description: "", docs: [ { to: "sase/api/mt-monitor", From bae47f24c50ff0198065042bc8a5b2ac24b6b863 Mon Sep 17 00:00:00 2001 From: Rajit Shah Date: Thu, 2 Apr 2026 15:48:33 -0500 Subject: [PATCH 5/5] Replace tppl-api-key with SCM OAuth2 auth scheme Update spec to use scmOAuth + scmToken (Bearer JWT) matching other SCM APIs. Rewrite intro page auth section to describe OAuth2 client credentials flow instead of API key. Co-Authored-By: Claude Sonnet 4.6 --- .../scm/config/ngts/tlsprotect-cloud.json | 2480 ++++++----------- products/scm/api/config/ngts/ngts-api.md | 10 +- 2 files changed, 823 insertions(+), 1667 deletions(-) diff --git a/openapi-specs/scm/config/ngts/tlsprotect-cloud.json b/openapi-specs/scm/config/ngts/tlsprotect-cloud.json index e85632bea..473245e73 100644 --- a/openapi-specs/scm/config/ngts/tlsprotect-cloud.json +++ b/openapi-specs/scm/config/ngts/tlsprotect-cloud.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "TLS Protect Cloud API for Strata Cloud Manager", - "description": "Use the TLS Protect Cloud APIs to manage certificates, certificate requests, applications, machine identities, users, teams, event logs, and more. This Open API spec file was created on March 26, 2026. © 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.", + "description": "Use the TLS Protect Cloud APIs to manage certificates, certificate requests, applications, machine identities, users, teams, event logs, and more. This Open API spec file was created on April 02, 2026. © 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.", "version": "1.0.0", "license": { "name": "MIT", @@ -199,12 +199,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -214,23 +214,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request conditions failed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve all certificate data", "tags": [ "Certificates" @@ -263,7 +258,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -273,18 +268,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Import a set of raw certificates", "tags": [ "Certificate Import" @@ -339,7 +329,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -349,7 +339,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -359,18 +349,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a certificate details", "tags": [ "Certificates" @@ -455,17 +440,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/plain": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -475,17 +460,17 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/plain": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -495,28 +480,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/plain": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Download a certificate", "tags": [ "Certificates" @@ -551,7 +531,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -561,18 +541,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Request validation for a set of", "tags": [ "Certificates" @@ -607,7 +582,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -617,18 +592,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request conditions failed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retire certificates", "tags": [ "Certificates" @@ -663,7 +633,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -673,18 +643,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Recover a set of certificates", "tags": [ "Certificates" @@ -713,7 +678,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -723,18 +688,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete a set of retired certificates", "tags": [ "Certificates" @@ -767,7 +727,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Filter2" + "$ref": "#/components/schemas/Filter1" } } } @@ -792,12 +752,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -807,23 +767,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request conditions failed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve certificate data matching search criteria", "tags": [ "Certificates" @@ -906,12 +861,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -921,23 +876,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request conditions failed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve Certificate Instances", "tags": [ "Certificate Installations" @@ -975,7 +925,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -985,7 +935,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -995,18 +945,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a certificate installation details", "tags": [ "Certificate Installations" @@ -1042,7 +987,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1052,18 +997,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Request validation for a set of", "tags": [ "Certificate Installations" @@ -1078,7 +1018,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Filter2" + "$ref": "#/components/schemas/Filter1" } } } @@ -1103,12 +1043,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1118,23 +1058,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve certificate instance data matching search", "tags": [ "Certificate Installations" @@ -1180,7 +1115,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, @@ -1190,18 +1125,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a list of services", "tags": [ "Certificate Discovery" @@ -1236,18 +1166,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add a service", "tags": [ "Certificate Discovery" @@ -1286,7 +1211,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, @@ -1296,7 +1221,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, @@ -1306,18 +1231,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get service details", "tags": [ "Certificate Discovery" @@ -1356,7 +1276,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, @@ -1366,7 +1286,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, @@ -1376,18 +1296,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove a service", "tags": [ "Certificate Discovery" @@ -1435,7 +1350,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, @@ -1445,7 +1360,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, @@ -1455,18 +1370,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse8" + "$ref": "#/components/schemas/ErrorResponse2" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update Service properties", "tags": [ "Certificate Discovery" @@ -1518,11 +1428,6 @@ "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Import a list of certificates and", "tags": [ "Private Key Import" @@ -1587,11 +1492,6 @@ "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve import details", "tags": [ "Private Key Import" @@ -1617,7 +1517,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1627,18 +1527,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of all certificate", "tags": [ "Certificate Request" @@ -1671,7 +1566,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1681,18 +1576,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "The request is either incomplete or malformed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create a certificate request", "tags": [ "Certificate Request" @@ -1721,7 +1611,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificateRequestInformation2" + "$ref": "#/components/schemas/CertificateRequestInformation1" } } }, @@ -1731,7 +1621,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1741,7 +1631,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1751,18 +1641,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "The request is either incomplete or malformed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a certificate request details", "tags": [ "Certificate Request" @@ -1810,7 +1695,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1820,7 +1705,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1830,18 +1715,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Resubmit a certificate request", "tags": [ "Certificate Request" @@ -1876,7 +1756,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1886,18 +1766,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Validate a certificate request", "tags": [ "Certificate Request" @@ -1912,7 +1787,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Filter2" + "$ref": "#/components/schemas/Filter1" } } } @@ -1932,7 +1807,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1942,7 +1817,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -1985,7 +1860,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -1995,18 +1870,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of issuing templates", "tags": [ "Certificate Policy" @@ -2039,7 +1909,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2049,7 +1919,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2059,7 +1929,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2069,18 +1939,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add an issuing template", "tags": [ "Certificate Policy" @@ -2109,7 +1974,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" } } }, @@ -2119,7 +1984,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2129,7 +1994,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2139,18 +2004,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get an issuing template details", "tags": [ "Certificate Policy" @@ -2186,7 +2046,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" } } }, @@ -2196,7 +2056,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" } } }, @@ -2206,7 +2066,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2216,7 +2076,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2226,18 +2086,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Overwrite an issuing template details", "tags": [ "Certificate Policy" @@ -2267,7 +2122,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2277,7 +2132,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -2287,18 +2142,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove an issuing template", "tags": [ "Certificate Policy" @@ -2330,11 +2180,6 @@ "description": "List with the information about the status of the sync of every issuing template" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Synchronize issuing templates domains with CA", "tags": [ "Certificate Policy" @@ -2398,7 +2243,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2408,18 +2253,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of applications", "tags": [ "Application" @@ -2452,7 +2292,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2462,7 +2302,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2472,18 +2312,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add an application", "tags": [ "Application" @@ -2531,7 +2366,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2541,7 +2376,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2551,18 +2386,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request Conditions Failed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get an application details", "tags": [ "Application" @@ -2608,7 +2438,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2618,7 +2448,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2628,18 +2458,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update an application details", "tags": [ "Application" @@ -2669,7 +2494,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2679,7 +2504,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2689,18 +2514,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove an application", "tags": [ "Application" @@ -2748,7 +2568,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2758,18 +2578,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Creates an invitation link for an", "tags": [ "Application" @@ -2808,7 +2623,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2818,7 +2633,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2828,18 +2643,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the Basic Discovery configuration for", "tags": [ "Application" @@ -2875,7 +2685,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" } } }, @@ -2885,7 +2695,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2895,7 +2705,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2905,18 +2715,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of an issuing", "tags": [ "Application" @@ -2951,7 +2756,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -2961,18 +2766,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Manage application assignments for a set", "tags": [ "Application" @@ -3018,7 +2818,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -3028,7 +2828,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -3038,18 +2838,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get an application details by its", "tags": [ "Application" @@ -3085,11 +2880,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieves a set of Credential Manager", "tags": [ "Credential Management" @@ -3121,11 +2911,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add a set of Credential Manager", "tags": [ "Credential Management" @@ -3157,11 +2942,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update a Credential Manager Service configuration", "tags": [ "Credential Management" @@ -3192,11 +2972,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieves a Credential Manager Service configurati", "tags": [ "Credential Management" @@ -3230,11 +3005,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete a Credential Manager Service configuration", "tags": [ "Credential Management" @@ -3273,11 +3043,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Test the connection to a privileged", "tags": [ "Credential Management" @@ -3308,11 +3073,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Test the connection to an external", "tags": [ "Credential Management" @@ -3365,11 +3125,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieves credentials for a company", "tags": [ "Credential Management" @@ -3401,11 +3156,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add a set of new shared", "tags": [ "Credential Management" @@ -3437,11 +3187,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update a shared credential", "tags": [ "Credential Management" @@ -3475,11 +3220,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete shared credentials", "tags": [ "Credential Management" @@ -3525,11 +3265,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieves shared credential by ID", "tags": [ "Credential Management" @@ -3558,11 +3293,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete shared credential by ID", "tags": [ "Credential Management" @@ -3601,11 +3331,6 @@ "$ref": "#/components/responses/500InternalServerErrorContent" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Test the access to shared credential", "tags": [ "Credential Management" @@ -3631,7 +3356,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3641,18 +3366,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of all machine", "tags": [ "Machine Identities" @@ -3685,18 +3405,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add a machine identity to a", "tags": [ "Machine Identities" @@ -3735,7 +3450,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3745,7 +3460,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3755,18 +3470,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a machine identity details", "tags": [ "Machine Identities" @@ -3796,7 +3506,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3806,7 +3516,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3816,18 +3526,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove a machine identity", "tags": [ "Machine Identities" @@ -3873,7 +3578,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3883,7 +3588,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3893,18 +3598,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update a machine identity details", "tags": [ "Machine Identities" @@ -3952,7 +3652,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3962,7 +3662,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -3972,18 +3672,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Initiate a machine workflow", "tags": [ "Machine Identities" @@ -4018,7 +3713,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4028,7 +3723,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4058,11 +3753,6 @@ "description": "default response" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "List Machine Types", "tags": [ "Machine Types" @@ -4088,7 +3778,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4098,18 +3788,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of all machines", "tags": [ "Machines" @@ -4142,18 +3827,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add a machine", "tags": [ "Machines" @@ -4192,7 +3872,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4202,7 +3882,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4212,18 +3892,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a machine details", "tags": [ "Machines" @@ -4253,7 +3928,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4263,7 +3938,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4273,18 +3948,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Request conditions failed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete a machine", "tags": [ "Machines" @@ -4330,7 +4000,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4340,7 +4010,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4350,18 +4020,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update a machine details", "tags": [ "Machines" @@ -4409,18 +4074,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Request conditions failed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Initiate the workflow", "tags": [ "Machines" @@ -4466,7 +4126,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4476,7 +4136,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4514,7 +4174,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4524,7 +4184,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4534,7 +4194,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4544,18 +4204,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Internal server error." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Abort active batch provisioning for a", "tags": [ "Machines" @@ -4594,7 +4249,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4604,7 +4259,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4614,18 +4269,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the discovery results for a", "tags": [ "Machines" @@ -4664,7 +4314,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4674,7 +4324,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, @@ -4684,18 +4334,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse5" + "$ref": "#/components/schemas/ErrorResponse3" } } }, "description": "Abort discovery not allowed." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Abort machine discovery", "tags": [ "Machines" @@ -4755,11 +4400,6 @@ "description": "All users" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve users matching specified criteria", "tags": [ "Users" @@ -4788,7 +4428,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserInformation1" + "$ref": "#/components/schemas/UserInformation2" } } }, @@ -4798,7 +4438,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -4808,7 +4448,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -4818,18 +4458,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Request conditions failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve user details by user ID", "tags": [ "Users" @@ -4867,7 +4502,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserInformation1" + "$ref": "#/components/schemas/UserInformation2" } } }, @@ -4877,7 +4512,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -4887,7 +4522,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -4897,18 +4532,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update user account type", "tags": [ "Users" @@ -4946,7 +4576,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserInformation1" + "$ref": "#/components/schemas/UserInformation2" } } }, @@ -4956,7 +4586,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -4966,7 +4596,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -4976,18 +4606,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Enable disable local login for user", "tags": [ "Users" @@ -5025,7 +4650,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserInformation1" + "$ref": "#/components/schemas/UserInformation2" } } }, @@ -5035,7 +4660,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5045,7 +4670,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5055,18 +4680,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update user roles", "tags": [ "Users" @@ -5102,7 +4722,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5112,7 +4732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5122,18 +4742,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve user details by username", "tags": [ "Users" @@ -5171,7 +4786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserInformation1" + "$ref": "#/components/schemas/UserInformation2" } } }, @@ -5181,7 +4796,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5191,7 +4806,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5201,18 +4816,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update if a user must change", "tags": [ "Users" @@ -5238,7 +4848,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5248,7 +4858,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5258,18 +4868,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve an authenticated user account details", "tags": [ "User Accounts" @@ -5295,7 +4900,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5305,18 +4910,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve teams for the current company", "tags": [ "Teams" @@ -5339,7 +4939,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TeamInformation1" + "$ref": "#/components/schemas/TeamInformation2" } } }, @@ -5349,7 +4949,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5359,18 +4959,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add a team", "tags": [ "Teams" @@ -5399,7 +4994,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TeamInformation1" + "$ref": "#/components/schemas/TeamInformation2" } } }, @@ -5409,7 +5004,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5419,18 +5014,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a team details", "tags": [ "Teams" @@ -5460,7 +5050,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5470,18 +5060,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "delete a team", "tags": [ "Teams" @@ -5517,7 +5102,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TeamInformation1" + "$ref": "#/components/schemas/TeamInformation2" } } }, @@ -5527,7 +5112,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5537,18 +5122,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update team details", "tags": [ "Teams" @@ -5586,7 +5166,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TeamInformation1" + "$ref": "#/components/schemas/TeamInformation2" } } }, @@ -5596,7 +5176,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5606,18 +5186,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add team members", "tags": [ "Teams" @@ -5653,7 +5228,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TeamInformation1" + "$ref": "#/components/schemas/TeamInformation2" } } }, @@ -5663,7 +5238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5673,18 +5248,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove team members", "tags": [ "Teams" @@ -5722,7 +5292,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TeamInformation1" + "$ref": "#/components/schemas/TeamInformation2" } } }, @@ -5732,7 +5302,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5742,18 +5312,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Add team owners", "tags": [ "Teams" @@ -5789,7 +5354,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TeamInformation1" + "$ref": "#/components/schemas/TeamInformation2" } } }, @@ -5799,7 +5364,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, @@ -5809,18 +5374,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse4" + "$ref": "#/components/schemas/ErrorResponse7" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove team owners", "tags": [ "Teams" @@ -5855,7 +5415,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse6" + "$ref": "#/components/schemas/ErrorResponse5" } } }, @@ -5865,18 +5425,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse6" + "$ref": "#/components/schemas/ErrorResponse5" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve count and activity log entries", "tags": [ "Event Logs" @@ -5919,12 +5474,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse6" + "$ref": "#/components/schemas/ErrorResponse5" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse6" + "$ref": "#/components/schemas/ErrorResponse5" } } }, @@ -5934,23 +5489,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse6" + "$ref": "#/components/schemas/ErrorResponse5" } }, "text/csv": { "schema": { - "$ref": "#/components/schemas/ErrorResponse6" + "$ref": "#/components/schemas/ErrorResponse5" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Export filtered event log data to", "tags": [ "Event Logs" @@ -5979,7 +5529,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse6" + "$ref": "#/components/schemas/ErrorResponse5" } } }, @@ -5989,18 +5539,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse6" + "$ref": "#/components/schemas/ErrorResponse5" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve types of activities used for", "tags": [ "Event Logs" @@ -6032,7 +5577,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6042,7 +5587,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6052,18 +5597,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Trigger manual update of Satellite Instance", "tags": [ "VSatellite" @@ -6096,11 +5636,6 @@ "description": "List of SatelliteEncryption keys" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve Satellite Encryption Keys", "tags": [ "VSatellite" @@ -6136,7 +5671,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6146,7 +5681,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6156,18 +5691,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve SatelliteEncryption Key By Id", "tags": [ "VSatellite" @@ -6200,11 +5730,6 @@ "description": "Satelliteinstances matching specified id" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve Satellite Instances", "tags": [ "VSatellite" @@ -6251,7 +5776,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6261,7 +5786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6271,18 +5796,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve Satellite Instance By Id", "tags": [ "VSatellite" @@ -6328,7 +5848,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6338,7 +5858,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6348,18 +5868,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update Satellite Instance", "tags": [ "VSatellite" @@ -6394,18 +5909,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create Pairing Code for Satellite Instance", "tags": [ "VSatellite" @@ -6440,18 +5950,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create Recovery Code for Satellite Instance", "tags": [ "VSatellite" @@ -6484,11 +5989,6 @@ "description": "List of Satellite workers" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve Satellite Workers", "tags": [ "VSatellite" @@ -6521,7 +6021,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6531,18 +6031,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request conditions failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create Satellite Worker", "tags": [ "VSatellite" @@ -6589,7 +6084,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6599,18 +6094,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request conditions failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Pair Satellite Worker with Satellite Instance", "tags": [ "VSatellite" @@ -6649,7 +6139,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6659,7 +6149,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, @@ -6669,18 +6159,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse10" + "$ref": "#/components/schemas/ErrorResponse9" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete Satellite Worker", "tags": [ "VSatellite" @@ -6703,11 +6188,6 @@ "description": "Tenant updates configuration" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve Updates configuration", "tags": [ "VSatellite" @@ -6739,11 +6219,6 @@ "description": "Updates configuration created/updated" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create or Update Configuration", "tags": [ "VSatellite" @@ -6791,7 +6266,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -6801,7 +6276,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -6811,18 +6286,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update Connector properties", "tags": [ "Webhooks" @@ -6852,7 +6322,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -6862,7 +6332,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -6872,18 +6342,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete a Connector", "tags": [ "Webhooks" @@ -6909,7 +6374,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -6919,18 +6384,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve all Connectors for a company", "tags": [ "Webhooks" @@ -6963,18 +6423,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create a Connector", "tags": [ "Webhooks" @@ -7015,7 +6470,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -7025,7 +6480,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -7035,18 +6490,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of the current", "tags": [ "Certificate Inventory Monitoring" @@ -7096,7 +6546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -7106,18 +6556,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Updates existing inventory monitoring configuratio", "tags": [ "Certificate Inventory Monitoring" @@ -7168,7 +6613,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, @@ -7178,18 +6623,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse7" + "$ref": "#/components/schemas/ErrorResponse4" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update inventory monitoring scheduler by type", "tags": [ "Certificate Inventory Monitoring" @@ -7221,11 +6661,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve the certificate expiration notification c", "tags": [ "Certificate Inventory Monitoring" @@ -7266,11 +6701,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update the certificate expiration notification con", "tags": [ "Certificate Inventory Monitoring" @@ -7308,11 +6738,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve the monitoring configuration", "tags": [ "Certificate Auto-renewal Monitoring" @@ -7353,11 +6778,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update the monitoring configuration", "tags": [ "Certificate Auto-renewal Monitoring" @@ -7380,11 +6800,6 @@ "description": "Success. The auto-renewal check process was triggered." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Attempt to initiate the certificate renewal", "tags": [ "Certificate Auto-renewal Monitoring" @@ -7413,11 +6828,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the current certificate auto-renewal monitorin", "tags": [ "Certificate Auto-renewal Monitoring" @@ -7459,11 +6869,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve the monitoring configuration", "tags": [ "Certificate Auto-renewal Monitoring" @@ -7517,11 +6922,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update the monitoring configuration", "tags": [ "Certificate Auto-renewal Monitoring" @@ -7553,11 +6953,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve the certificate expiration reports config", "tags": [ "Certificate Expiration Reports" @@ -7598,11 +6993,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update the certificate expiration reports configur", "tags": [ "Certificate Expiration Reports" @@ -7618,11 +7008,6 @@ "description": "Success. The reports check process was triggered." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Attempt to initiate the certificate reports", "tags": [ "Certificate Expiration Reports" @@ -7648,7 +7033,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -7658,18 +7043,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve all tags", "tags": [ "Tags" @@ -7704,7 +7084,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -7714,18 +7094,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create a tag", "tags": [ "Tags" @@ -7763,7 +7138,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -7773,7 +7148,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -7783,18 +7158,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve tag by name", "tags": [ "Tags" @@ -7823,7 +7193,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -7833,18 +7203,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete tag by name", "tags": [ "Tags" @@ -7882,7 +7247,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -7892,7 +7257,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -7902,18 +7267,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve values for a tag", "tags": [ "Tags" @@ -7960,7 +7320,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -7970,18 +7330,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create tag values", "tags": [ "Tags" @@ -8022,7 +7377,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -8032,18 +7387,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete a tag value", "tags": [ "Tags" @@ -8069,7 +7419,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -8079,18 +7429,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve values for all tags", "tags": [ "Tags" @@ -8127,7 +7472,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -8137,18 +7482,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create tags in bulk", "tags": [ "Tags" @@ -8178,7 +7518,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -8188,18 +7528,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete tags in bulk", "tags": [ "Tags" @@ -8236,7 +7571,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -8246,18 +7581,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Replace Add Or Delete Tags", "tags": [ "Tags" @@ -8294,7 +7624,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, @@ -8304,18 +7634,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse2" + "$ref": "#/components/schemas/ErrorResponse6" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Bulk operation to retrieve number of", "tags": [ "Tags" @@ -8350,7 +7675,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8360,18 +7685,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create a new Issuer configuration", "tags": [ "Workload Identity Manager Configurations" @@ -8395,7 +7715,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8405,18 +7725,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of all Issuer", "tags": [ "Workload Identity Manager Configurations" @@ -8453,7 +7768,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8463,7 +7778,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8473,18 +7788,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get configurations details for a specific", "tags": [ "Workload Identity Manager Configurations" @@ -8530,7 +7840,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8540,7 +7850,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8550,18 +7860,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update an Issuer configuration details", "tags": [ "Workload Identity Manager Configurations" @@ -8596,7 +7901,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8606,7 +7911,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8616,18 +7921,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove an Issuer configuration", "tags": [ "Workload Identity Manager Configurations" @@ -8664,7 +7964,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8674,18 +7974,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create a new Sub CA provider", "tags": [ "Workload Identity Manager Sub CA Providers" @@ -8709,7 +8004,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8719,18 +8014,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of all Sub", "tags": [ "Workload Identity Manager Sub CA Providers" @@ -8767,7 +8057,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8777,7 +8067,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8787,18 +8077,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a Sub CA provider details", "tags": [ "Workload Identity Manager Sub CA Providers" @@ -8844,7 +8129,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8854,7 +8139,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8864,18 +8149,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update a Sub CA provider details", "tags": [ "Workload Identity Manager Sub CA Providers" @@ -8910,7 +8190,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8920,7 +8200,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8930,18 +8210,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove a Sub CA provider", "tags": [ "Workload Identity Manager Sub CA Providers" @@ -8976,7 +8251,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -8986,18 +8261,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create a new Workload Issuance policy", "tags": [ "Workload Identity Manager Policies" @@ -9021,7 +8291,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -9031,18 +8301,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of all Workload", "tags": [ "Workload Identity Manager Policies" @@ -9079,7 +8344,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -9089,7 +8354,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -9099,18 +8364,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get a Workload Issuance policy details", "tags": [ "Workload Identity Manager Policies" @@ -9154,7 +8414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -9164,7 +8424,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -9174,18 +8434,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update a Workload Issuance policy details", "tags": [ "Workload Identity Manager Policies" @@ -9220,7 +8475,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -9230,7 +8485,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -9240,18 +8495,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove a Workload Issuance policy", "tags": [ "Workload Identity Manager Policies" @@ -9277,7 +8527,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, @@ -9287,18 +8537,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse3" + "$ref": "#/components/schemas/ErrorResponse10" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get the details of all Issuer", "tags": [ "Workload Identity Manager Intermediate Certificates" @@ -9349,7 +8594,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CertificateRequestInformation1" + "$ref": "#/components/schemas/CertificateRequestInformation2" } } }, @@ -9359,7 +8604,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9369,7 +8614,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9379,18 +8624,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Approve or reject pending certificate request", "tags": [ "Certificate Approvals" @@ -9441,7 +8681,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9451,18 +8691,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Approve or reject multiple pending approval", "tags": [ "Certificate Approvals" @@ -9499,7 +8734,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9509,18 +8744,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create an approval rule for certificate", "tags": [ "Certificate Approvals" @@ -9544,7 +8774,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9554,18 +8784,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get all approval rules", "tags": [ "Certificate Approvals" @@ -9604,7 +8829,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9614,7 +8839,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9624,18 +8849,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve approval rule by id", "tags": [ "Certificate Approvals" @@ -9681,7 +8901,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9691,7 +8911,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9701,18 +8921,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update certificate request workflow approval rule", "tags": [ "Certificate Approvals" @@ -9748,7 +8963,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9758,7 +8973,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9768,18 +8983,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete certificate request workflow approval rule", "tags": [ "Certificate Approvals" @@ -9817,7 +9027,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9827,7 +9037,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9837,18 +9047,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve approval request for specific certificate", "tags": [ "Certificate Approvals" @@ -9885,7 +9090,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9895,18 +9100,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create an approval rule for certificate", "tags": [ "Certificate Revocation Approvals" @@ -9930,7 +9130,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -9940,18 +9140,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Get all certificate revocation approval rules", "tags": [ "Certificate Revocation Approvals" @@ -9990,7 +9185,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -10000,7 +9195,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -10010,18 +9205,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve certificate revocation approval rule by", "tags": [ "Certificate Revocation Approvals" @@ -10067,7 +9257,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -10077,7 +9267,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -10087,18 +9277,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Request Conditions Failed" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update certificate revocation workflow approval ru", "tags": [ "Certificate Revocation Approvals" @@ -10134,7 +9319,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -10144,7 +9329,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, @@ -10154,18 +9339,13 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ErrorResponse9" + "$ref": "#/components/schemas/ErrorResponse8" } } }, "description": "Incomplete or malformed request." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete certificate revocation workflow approval ru", "tags": [ "Certificate Revocation Approvals" @@ -10223,11 +9403,6 @@ "description": "Success. All plugins retrieved." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve all plugins", "tags": [ "Plugins" @@ -10257,11 +9432,6 @@ "description": "Success. Plugin created." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Create a local plugin", "tags": [ "Plugins" @@ -10284,11 +9454,6 @@ "description": "Success. Plugin retrieved." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve plugin by ID", "tags": [ "Plugins" @@ -10328,11 +9493,6 @@ "description": "Forbidden" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Update a local plugin", "tags": [ "Plugins" @@ -10357,11 +9517,6 @@ "description": "No Content." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Delete a local plugin", "tags": [ "Plugins" @@ -10395,11 +9550,6 @@ "description": "Successfully disabled the plugin for the current tenant." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Disable a plugin", "tags": [ "Plugins" @@ -10424,11 +9574,6 @@ "description": "No Content. Successfully deleted the plugin disablement." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Remove plugin disablement", "tags": [ "Plugins" @@ -10462,11 +9607,6 @@ "description": "Successfully retrieved all the disabled plugins for the current tenant." } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieve all disabled plugins", "tags": [ "Plugins" @@ -10498,11 +9638,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieves all the Service Accounts the", "tags": [ "Service Accounts" @@ -10543,11 +9678,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Creates a Service Account", "tags": [ "Service Accounts" @@ -10596,11 +9726,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Gets a Service Account", "tags": [ "Service Accounts" @@ -10650,12 +9775,7 @@ "500": { "description": "InternalServerError" } - }, - "security": [ - { - "tppl-api-key": [] - } - ], + }, "summary": "Updates a Service Account", "tags": [ "Service Accounts" @@ -10695,11 +9815,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Deletes a Service Account", "tags": [ "Service Accounts" @@ -10731,11 +9846,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Retrieves all the Service Accounts Scopes", "tags": [ "Service Accounts" @@ -10784,11 +9894,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Regenerate the OCI registry token for", "tags": [ "Service Accounts" @@ -10848,11 +9953,6 @@ "description": "InternalServerError" } }, - "security": [ - { - "tppl-api-key": [] - } - ], "summary": "Updates a Service Account credentials", "tags": [ "Service Accounts" @@ -11273,7 +10373,7 @@ "$ref": "#/components/schemas/BaseActivityLogOrdering" }, "paging": { - "$ref": "#/components/schemas/Page1" + "$ref": "#/components/schemas/Page2" } }, "type": "object" @@ -11543,7 +10643,7 @@ "additionalProperties": { "description": "Product roles of the user associated with this API key.", "items": { - "$ref": "#/components/schemas/Role1" + "$ref": "#/components/schemas/Role2" }, "type": "array", "uniqueItems": true @@ -11608,6 +10708,19 @@ "description": "The application ID from the CyberArk provider.", "type": "string" }, + "AppRoleAuthenticationData": { + "properties": { + "roleId": { + "description": "The Role ID used for authentication with the underlying credentials provider.", + "type": "string" + }, + "secretId": { + "description": "The Secret ID used for authentication with the underlying credentials provider.", + "type": "string" + } + }, + "type": "object" + }, "Application": { "description": "Application ID to associate with the service account", "format": "UUID", @@ -11679,13 +10792,13 @@ }, "owningTeams": { "items": { - "$ref": "#/components/schemas/TeamInformation2" + "$ref": "#/components/schemas/TeamInformation1" }, "type": "array" }, "owningUsers": { "items": { - "$ref": "#/components/schemas/UserInformation2" + "$ref": "#/components/schemas/UserInformation1" }, "type": "array" }, @@ -12346,10 +11459,12 @@ "type": "object" }, "CMSAuthenticationType": { - "description": "The authentication type for the privileged access management:\n * `certificate` - For authentication with a Certificate bundle\n * `userPassword` - For authentication with user and password\n", + "description": "The authentication type for the privileged access management:\n * `certificate` - For authentication with a Certificate bundle\n * `userPassword` - For authentication with user and password\n * `token` - For authentication with token\n * `appRole` - For authentication with AppRole\n", "enum": [ "certificate", - "userPassword" + "userPassword", + "token", + "appRole" ], "type": "string" }, @@ -12438,7 +11553,7 @@ "type": "string" }, "keyTypeParameters": { - "$ref": "#/components/schemas/KeyTypeParameters2" + "$ref": "#/components/schemas/KeyTypeParameters1" }, "locality": { "type": "string" @@ -12507,14 +11622,7 @@ "type": "object" }, "CertificateAuthorityProductInformation1": { - "description": "Product specific for external certificate authority", - "discriminator": { - "propertyName": "certificateAuthority" - }, "properties": { - "certificateAuthority": { - "type": "string" - }, "certificateType": { "enum": [ "OTHER", @@ -12547,7 +11655,6 @@ ], "type": "string" }, - "readOnly": true, "type": "array" }, "validityPeriod": { @@ -12556,13 +11663,17 @@ "type": "string" } }, - "required": [ - "certificateAuthority" - ], "type": "object" }, "CertificateAuthorityProductInformation2": { + "description": "Product specific for external certificate authority", + "discriminator": { + "propertyName": "certificateAuthority" + }, "properties": { + "certificateAuthority": { + "type": "string" + }, "certificateType": { "enum": [ "OTHER", @@ -12595,6 +11706,7 @@ ], "type": "string" }, + "readOnly": true, "type": "array" }, "validityPeriod": { @@ -12603,6 +11715,9 @@ "type": "string" } }, + "required": [ + "certificateAuthority" + ], "type": "object" }, "CertificateCredentialData": { @@ -13283,7 +12398,7 @@ "type": "array" }, "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData2" + "$ref": "#/components/schemas/GeneralNamesData1" }, "subjectC": { "description": "A certificate subject Country", @@ -13609,30 +12724,9 @@ "csrUploadAllowed": { "type": "boolean" }, - "description": { - "type": "string" - }, - "driverGeneratedCsr": { - "type": "boolean" - }, - "driverId": { - "format": "uuid", - "type": "string" - }, "everyoneIsConsumer": { "type": "boolean" }, - "extendedKeyUsageValues": { - "items": { - "enum": [ - "SERVER", - "CLIENT" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, "id": { "format": "uuid", "type": "string" @@ -13640,10 +12734,6 @@ "keyGeneratedByVenafiAllowed": { "type": "boolean" }, - "keyPairId": { - "format": "uuid", - "type": "string" - }, "keyReuse": { "type": "boolean" }, @@ -13653,10 +12743,6 @@ }, "type": "array" }, - "locationId": { - "format": "uuid", - "type": "string" - }, "modificationDate": { "format": "date-time", "type": "string" @@ -13671,19 +12757,33 @@ "product": { "$ref": "#/components/schemas/CertificateAuthorityProductInformation1" }, + "productEntitlement": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + }, + "productEntitlements": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string", + "writeOnly": true + }, "reason": { "type": "string" }, "recommendedSettings": { "$ref": "#/components/schemas/RecommendedSettingsInformation1" }, - "referencingApplicationIds": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" - }, "resourceConsumerTeamIds": { "items": { "format": "uuid", @@ -13776,8 +12876,10 @@ "systemGenerated": { "type": "boolean" }, - "trackingData": { - "$ref": "#/components/schemas/TrackingDataInformation" + "validityPeriod": { + "description": "ISO8601 Period Format", + "example": "PnYnMnDTnHnMnS", + "type": "string" } }, "type": "object" @@ -13819,9 +12921,30 @@ "csrUploadAllowed": { "type": "boolean" }, + "description": { + "type": "string" + }, + "driverGeneratedCsr": { + "type": "boolean" + }, + "driverId": { + "format": "uuid", + "type": "string" + }, "everyoneIsConsumer": { "type": "boolean" }, + "extendedKeyUsageValues": { + "items": { + "enum": [ + "SERVER", + "CLIENT" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, "id": { "format": "uuid", "type": "string" @@ -13829,6 +12952,10 @@ "keyGeneratedByVenafiAllowed": { "type": "boolean" }, + "keyPairId": { + "format": "uuid", + "type": "string" + }, "keyReuse": { "type": "boolean" }, @@ -13838,6 +12965,10 @@ }, "type": "array" }, + "locationId": { + "format": "uuid", + "type": "string" + }, "modificationDate": { "format": "date-time", "type": "string" @@ -13852,33 +12983,19 @@ "product": { "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" }, - "productEntitlement": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string" - }, - "productEntitlements": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string", - "writeOnly": true - }, "reason": { "type": "string" }, "recommendedSettings": { "$ref": "#/components/schemas/RecommendedSettingsInformation2" }, + "referencingApplicationIds": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, "resourceConsumerTeamIds": { "items": { "format": "uuid", @@ -13971,10 +13088,8 @@ "systemGenerated": { "type": "boolean" }, - "validityPeriod": { - "description": "ISO8601 Period Format", - "example": "PnYnMnDTnHnMnS", - "type": "string" + "trackingData": { + "$ref": "#/components/schemas/TrackingDataInformation" } }, "type": "object" @@ -14041,7 +13156,7 @@ }, "keyTypes": { "items": { - "$ref": "#/components/schemas/KeyTypeParameters1" + "$ref": "#/components/schemas/KeyTypeParameters2" }, "type": "array" }, @@ -14058,7 +13173,7 @@ "type": "integer" }, "product": { - "$ref": "#/components/schemas/CertificateAuthorityProductInformation1" + "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" }, "recommendedSettings": { "$ref": "#/components/schemas/RecommendedSettingsRequest" @@ -14157,7 +13272,7 @@ "properties": { "certificateIssuingTemplates": { "items": { - "$ref": "#/components/schemas/CertificateIssuingTemplateInformation1" + "$ref": "#/components/schemas/CertificateIssuingTemplateInformation2" }, "type": "array" } @@ -14578,10 +13693,10 @@ "type": "string" }, "customAttributes": { - "$ref": "#/components/schemas/CustomAttributes2" + "$ref": "#/components/schemas/CustomAttributes1" }, "errorInformation": { - "$ref": "#/components/schemas/ErrorInformation7" + "$ref": "#/components/schemas/ErrorInformation4" }, "finalApproverId": { "description": "UUID of the final approver if configured", @@ -14653,7 +13768,7 @@ "type": "string" }, "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData2" + "$ref": "#/components/schemas/GeneralNamesData1" }, "subjectCN": { "description": "Certificate request subject CN", @@ -14732,6 +13847,42 @@ }, "CertificateRequestInformation1": { "properties": { + "apiClientInformation": { + "$ref": "#/components/schemas/ApiClientInformation" + }, + "applicationId": { + "description": "UUID of an application ID", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" + }, + "approvedIds": { + "description": "A collection of IDs of all users that have already approved", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "approverTeamIds": { + "description": "A collection of all team IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "approverUserIds": { + "description": "A collection of all user IDs that are configured as approvers", + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, "caOrderId": { "description": "A CA order ID", "example": "63364861", @@ -14755,11 +13906,6 @@ "format": "uuid", "type": "string" }, - "certificateName": { - "description": "A certificate name", - "example": "venafi.com", - "type": "string" - }, "certificateOwnerUserId": { "description": "UUID of the certificate request's owner", "example": "88932c30-8e14-11ed-87e3-755db050f29d", @@ -14770,6 +13916,25 @@ "description": "A certificate signing request (CSR) in PEM format", "type": "string" }, + "certificateUsageMetadata": { + "description": "A collection of certificate request metadata", + "example": [ + { + "appName": "venafi app1", + "automationMetadata": "automation data 008", + "nodeName": "venafi node 007" + }, + { + "appName": "venafi app2", + "automationMetadata": "automation data 0013", + "nodeName": "venafi node 005" + } + ], + "items": { + "$ref": "#/components/schemas/CertificateUsageMetadata" + }, + "type": "array" + }, "companyId": { "description": "UUID of a company", "example": "85595df0-8e14-11ed-87e3-755db050f29d", @@ -14782,23 +13947,17 @@ "format": "date-time", "type": "string" }, - "customAttributes": { - "$ref": "#/components/schemas/CustomAttributes1" - }, - "dekHash": { - "description": "A certificate dek hash", - "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", - "type": "string" - }, - "encryptedPrivateKey": { - "format": "byte", - "type": "string" - }, - "encryptionDetails": { - "$ref": "#/components/schemas/EncryptionDetails" + "customAttributesInformation": { + "$ref": "#/components/schemas/CustomAttributesInformation" }, "errorInformation": { - "$ref": "#/components/schemas/ErrorInformation9" + "$ref": "#/components/schemas/ErrorInformation4" + }, + "finalApproverId": { + "description": "UUID of the final approver if configured", + "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", + "format": "uuid", + "type": "string" }, "id": { "description": "UUID of a certificate request", @@ -14844,19 +14003,6 @@ "format": "date-time", "type": "string" }, - "product": { - "$ref": "#/components/schemas/CertificateAuthorityProductInformation1" - }, - "productEntitlement": { - "enum": [ - "ANY", - "MIRA", - "DEVOPS", - "OUTAGE_DETECTION", - "CODESIGN" - ], - "type": "string" - }, "status": { "description": "The status of a certificate request", "enum": [ @@ -14884,6 +14030,18 @@ "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", "type": "string" }, + "tags": { + "description": "A collection of tags", + "example": [ + "test", + "category:security" + ], + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, "validityPeriod": { "description": "ISO8601 Period Format", "example": "P10M", @@ -14894,42 +14052,6 @@ }, "CertificateRequestInformation2": { "properties": { - "apiClientInformation": { - "$ref": "#/components/schemas/ApiClientInformation" - }, - "applicationId": { - "description": "UUID of an application ID", - "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", - "format": "uuid", - "type": "string" - }, - "approvedIds": { - "description": "A collection of IDs of all users that have already approved", - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "approverTeamIds": { - "description": "A collection of all team IDs that are configured as approvers", - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "approverUserIds": { - "description": "A collection of all user IDs that are configured as approvers", - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, "caOrderId": { "description": "A CA order ID", "example": "63364861", @@ -14953,6 +14075,11 @@ "format": "uuid", "type": "string" }, + "certificateName": { + "description": "A certificate name", + "example": "venafi.com", + "type": "string" + }, "certificateOwnerUserId": { "description": "UUID of the certificate request's owner", "example": "88932c30-8e14-11ed-87e3-755db050f29d", @@ -14963,25 +14090,6 @@ "description": "A certificate signing request (CSR) in PEM format", "type": "string" }, - "certificateUsageMetadata": { - "description": "A collection of certificate request metadata", - "example": [ - { - "appName": "venafi app1", - "automationMetadata": "automation data 008", - "nodeName": "venafi node 007" - }, - { - "appName": "venafi app2", - "automationMetadata": "automation data 0013", - "nodeName": "venafi node 005" - } - ], - "items": { - "$ref": "#/components/schemas/CertificateUsageMetadata" - }, - "type": "array" - }, "companyId": { "description": "UUID of a company", "example": "85595df0-8e14-11ed-87e3-755db050f29d", @@ -14994,18 +14102,24 @@ "format": "date-time", "type": "string" }, - "customAttributesInformation": { - "$ref": "#/components/schemas/CustomAttributesInformation" + "customAttributes": { + "$ref": "#/components/schemas/CustomAttributes2" }, - "errorInformation": { - "$ref": "#/components/schemas/ErrorInformation7" + "dekHash": { + "description": "A certificate dek hash", + "example": "RaBDrLmQ69hACXOrPU6542RBT-M-yZOkw4XKsT-r55i=", + "type": "string" }, - "finalApproverId": { - "description": "UUID of the final approver if configured", - "example": "dc6eb020-9131-11ed-9ce4-1d9554d648cd", - "format": "uuid", + "encryptedPrivateKey": { + "format": "byte", "type": "string" }, + "encryptionDetails": { + "$ref": "#/components/schemas/EncryptionDetails" + }, + "errorInformation": { + "$ref": "#/components/schemas/ErrorInformation8" + }, "id": { "description": "UUID of a certificate request", "example": "fa4a2210-9135-11ed-a8f1-bf0e7991f912", @@ -15050,6 +14164,19 @@ "format": "date-time", "type": "string" }, + "product": { + "$ref": "#/components/schemas/CertificateAuthorityProductInformation2" + }, + "productEntitlement": { + "enum": [ + "ANY", + "MIRA", + "DEVOPS", + "OUTAGE_DETECTION", + "CODESIGN" + ], + "type": "string" + }, "status": { "description": "The status of a certificate request", "enum": [ @@ -15077,18 +14204,6 @@ "example": "cn=venafi.com,ou=devops,o=venafi,c=US,st=Utah,l=Salt Lake City", "type": "string" }, - "tags": { - "description": "A collection of tags", - "example": [ - "test", - "category:security" - ], - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, "validityPeriod": { "description": "ISO8601 Period Format", "example": "P10M", @@ -15249,7 +14364,7 @@ } ], "items": { - "$ref": "#/components/schemas/CertificateRequestInformation2" + "$ref": "#/components/schemas/CertificateRequestInformation1" }, "type": "array" } @@ -15738,7 +14853,7 @@ "type": "string" }, "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData2" + "$ref": "#/components/schemas/GeneralNamesData1" }, "subjectDN": { "description": "A certificate request subject DN", @@ -16555,7 +15670,7 @@ "type": "object" }, "CustomAttributes1": { - "description": "A certificate request custom attributes", + "description": "Certificate request custom attributes", "example": { "dnsNames": [ "www.venafi.com", @@ -16577,7 +15692,7 @@ "type": "object" }, "CustomAttributes2": { - "description": "Certificate request custom attributes", + "description": "A certificate request custom attributes", "example": { "dnsNames": [ "www.venafi.com", @@ -17239,7 +16354,7 @@ "type": "string" }, "value": { - "$ref": "#/components/schemas/AnyValue9" + "$ref": "#/components/schemas/AnyValue8" } }, "type": "object" @@ -18064,7 +17179,7 @@ "type": "array" }, "subjectAlternativeNamesByType": { - "$ref": "#/components/schemas/GeneralNamesData2" + "$ref": "#/components/schemas/GeneralNamesData1" }, "subjectC": { "description": "A certificate subject Country", @@ -18593,7 +17708,7 @@ "properties": { "domain": { "additionalProperties": { - "$ref": "#/components/schemas/AnyValue7" + "$ref": "#/components/schemas/AnyValue4" }, "type": "object" }, @@ -18610,10 +17725,6 @@ "type": "object" }, "Filter1": { - "format": "json", - "type": "string" - }, - "Filter2": { "properties": { "expression": { "$ref": "#/components/schemas/BaseFilter" @@ -18622,11 +17733,15 @@ "$ref": "#/components/schemas/BaseOrdering" }, "paging": { - "$ref": "#/components/schemas/Page2" + "$ref": "#/components/schemas/Page1" } }, "type": "object" }, + "Filter2": { + "format": "json", + "type": "string" + }, "FilterOperand": { "properties": { "operand": { @@ -18677,7 +17792,7 @@ "type": "object" }, "GeneralNamesData1": { - "description": "A certificate request subject alternative name (SAN) type", + "description": "A certificate subject alternative name by type", "example": { "dNSName": [ "www.venafi.com", @@ -18743,7 +17858,7 @@ "type": "object" }, "GeneralNamesData2": { - "description": "A certificate subject alternative name by type", + "description": "A certificate request subject alternative name (SAN) type", "example": { "dNSName": [ "www.venafi.com", @@ -18987,6 +18102,10 @@ "authType": { "$ref": "#/components/schemas/CMSAuthenticationType" }, + "namespace": { + "description": "The namespace in HashiCorp Vault to connect to.", + "type": "string" + }, "url": { "$ref": "#/components/schemas/CMSURL" } @@ -19003,6 +18122,12 @@ }, { "$ref": "#/components/schemas/UserPasswordAuthenticationData" + }, + { + "$ref": "#/components/schemas/TokenAuthenticationData" + }, + { + "$ref": "#/components/schemas/AppRoleAuthenticationData" } ] } @@ -19162,7 +18287,7 @@ "type": "boolean" }, "schedulePattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation2" + "$ref": "#/components/schemas/SchedulerPatternInformation1" }, "serviceType": { "description": "The type of an integration service", @@ -19262,7 +18387,7 @@ "type": "string" }, "schedulePattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation2" + "$ref": "#/components/schemas/SchedulerPatternInformation1" }, "schedulerEnabled": { "description": "If a integration service is scheduled for execution", @@ -19347,7 +18472,7 @@ "type": "boolean" }, "schedulePattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation2" + "$ref": "#/components/schemas/SchedulerPatternInformation1" }, "targets": { "$ref": "#/components/schemas/TargetsInformation" @@ -19396,7 +18521,7 @@ "type": "string" }, "errorInformation": { - "$ref": "#/components/schemas/ErrorInformation3" + "$ref": "#/components/schemas/ErrorInformation10" }, "fingerprint": { "description": "Intermediate certificate fingerprint", @@ -19628,7 +18753,7 @@ "IssuingTemplateDomainsSyncInformation": { "properties": { "error": { - "$ref": "#/components/schemas/ErrorInformation9" + "$ref": "#/components/schemas/ErrorInformation8" }, "issuingTemplateId": { "format": "uuid", @@ -20014,6 +19139,37 @@ "type": "object" }, "KeyTypeParameters1": { + "properties": { + "keyCurve": { + "enum": [ + "P256", + "P384", + "P521", + "ED25519", + "UNKNOWN" + ], + "type": "string" + }, + "keyLength": { + "format": "int32", + "type": "integer" + }, + "keyType": { + "enum": [ + "RSA", + "EC" + ], + "type": "string" + } + }, + "required": [ + "keyCurve", + "keyLength", + "keyType" + ], + "type": "object" + }, + "KeyTypeParameters2": { "properties": { "keyCurves": { "items": { @@ -20048,37 +19204,6 @@ ], "type": "object" }, - "KeyTypeParameters2": { - "properties": { - "keyCurve": { - "enum": [ - "P256", - "P384", - "P521", - "ED25519", - "UNKNOWN" - ], - "type": "string" - }, - "keyLength": { - "format": "int32", - "type": "integer" - }, - "keyType": { - "enum": [ - "RSA", - "EC" - ], - "type": "string" - } - }, - "required": [ - "keyCurve", - "keyLength", - "keyType" - ], - "type": "object" - }, "LastModifiedBy": { "description": "The ID of the user whom modified the credential.", "type": "string" @@ -20244,7 +19369,7 @@ "MachineCreationRequest": { "properties": { "connectionDetails": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "dekId": { "minLength": 1, @@ -20431,14 +19556,14 @@ "MachineIdentityCreationRequest": { "properties": { "binding": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "certificateId": { "format": "uuid", "type": "string" }, "keystore": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "machineId": { "format": "uuid", @@ -20461,7 +19586,7 @@ "type": "array" }, "binding": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "certificateFingerprint": { "type": "string" @@ -20490,7 +19615,7 @@ "type": "string" }, "keystore": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "lastSeenOn": { "format": "date-time", @@ -20504,7 +19629,7 @@ "type": "string" }, "metadata": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "modificationDate": { "format": "date-time", @@ -20539,7 +19664,7 @@ "MachineIdentityInformation": { "properties": { "binding": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "certificateId": { "format": "uuid", @@ -20558,7 +19683,7 @@ "type": "string" }, "keystore": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "lastSeenOn": { "format": "date-time", @@ -20569,7 +19694,7 @@ "type": "string" }, "metadata": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "modificationDate": { "format": "date-time", @@ -20618,14 +19743,14 @@ "MachineIdentityUpdateRequest": { "properties": { "binding": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "certificateId": { "format": "uuid", "type": "string" }, "keystore": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" } }, "type": "object" @@ -20664,7 +19789,7 @@ "type": "boolean" }, "batchProvisioningSchedulerPattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation1" + "$ref": "#/components/schemas/SchedulerPatternInformation2" }, "batchProvisioningStatus": { "enum": [ @@ -20687,13 +19812,13 @@ "type": "string" }, "discoveryJson": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "discoverySchedulerEnabled": { "type": "boolean" }, "discoverySchedulerPattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation1" + "$ref": "#/components/schemas/SchedulerPatternInformation2" }, "discoveryStatus": { "enum": [ @@ -20769,19 +19894,19 @@ "type": "boolean" }, "batchProvisioningSchedulerPattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation1" + "$ref": "#/components/schemas/SchedulerPatternInformation2" }, "connectionDetails": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "discoveryJson": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "discoverySchedulerEnabled": { "type": "boolean" }, "discoverySchedulerPattern": { - "$ref": "#/components/schemas/SchedulerPatternInformation1" + "$ref": "#/components/schemas/SchedulerPatternInformation2" }, "edgeInstanceId": { "format": "uuid", @@ -20809,7 +19934,7 @@ "MachineWorkflowRequest": { "properties": { "workflowInput": { - "$ref": "#/components/schemas/AnyValue5" + "$ref": "#/components/schemas/AnyValue3" }, "workflowName": { "type": "string" @@ -22254,9 +21379,6 @@ "key": { "$ref": "#/components/schemas/RecommendedSettingsKeyTypeInformation1" }, - "keyGeneratedBy": { - "type": "string" - }, "sanRegexes": { "items": { "type": "string" @@ -22292,6 +21414,9 @@ "key": { "$ref": "#/components/schemas/RecommendedSettingsKeyTypeInformation2" }, + "keyGeneratedBy": { + "type": "string" + }, "sanRegexes": { "items": { "type": "string" @@ -22545,7 +21670,7 @@ "type": "string" }, "entity": { - "$ref": "#/components/schemas/AnyValue7" + "$ref": "#/components/schemas/AnyValue4" }, "entityTag": { "$ref": "#/components/schemas/EntityTag" @@ -22553,7 +21678,7 @@ "headers": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/AnyValue7" + "$ref": "#/components/schemas/AnyValue4" }, "type": "array" }, @@ -22648,7 +21773,7 @@ "metadata": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/AnyValue7" + "$ref": "#/components/schemas/AnyValue4" }, "type": "array" }, @@ -22732,7 +21857,17 @@ } ] }, - "Role1": { + "Role1": { + "enum": [ + "SYSTEM_ADMIN", + "OUTAGE_DETECTION_PLATFORM_ADMIN", + "OUTAGE_DETECTION_PKI_ADMIN", + "OUTAGE_DETECTION_RESOURCE_OWNER", + "OUTAGE_DETECTION_GUEST" + ], + "type": "string" + }, + "Role2": { "enum": [ "SECURITY_ADMIN", "DEVOPS_LEAD", @@ -22745,21 +21880,11 @@ ], "type": "string" }, - "Role2": { - "enum": [ - "SYSTEM_ADMIN", - "OUTAGE_DETECTION_PLATFORM_ADMIN", - "OUTAGE_DETECTION_PKI_ADMIN", - "OUTAGE_DETECTION_RESOURCE_OWNER", - "OUTAGE_DETECTION_GUEST" - ], - "type": "string" - }, "RolesRequest": { "properties": { "roles": { "additionalProperties": { - "$ref": "#/components/schemas/Role1" + "$ref": "#/components/schemas/Role2" }, "type": "object" }, @@ -23781,7 +22906,7 @@ "properties": { "args": { "items": { - "$ref": "#/components/schemas/AnyValue2" + "$ref": "#/components/schemas/AnyValue6" }, "type": "array" }, @@ -24265,10 +23390,6 @@ "type": "array", "uniqueItems": true }, - "modificationDate": { - "format": "date-time", - "type": "string" - }, "name": { "type": "string" }, @@ -24280,31 +23401,47 @@ "type": "array", "uniqueItems": true }, - "productRoles": { + "ownership": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/Role1" + "format": "uuid", + "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" }, - "role": { - "$ref": "#/components/schemas/TeamRole" + "productRoles": { + "additionalProperties": { + "items": { + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" }, "systemRoles": { "items": { - "$ref": "#/components/schemas/SystemRole" + "enum": [ + "SYSTEM_ADMIN", + "CONDOR_METRICS" + ], + "type": "string" }, "type": "array", "uniqueItems": true - }, - "userMatchingRules": { - "items": { - "$ref": "#/components/schemas/UserMatchingRule" - }, - "type": "array" } }, "type": "object" @@ -24327,6 +23464,10 @@ "type": "array", "uniqueItems": true }, + "modificationDate": { + "format": "date-time", + "type": "string" + }, "name": { "type": "string" }, @@ -24338,47 +23479,31 @@ "type": "array", "uniqueItems": true }, - "ownership": { - "additionalProperties": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "type": "object" - }, "productRoles": { "additionalProperties": { "items": { - "enum": [ - "SECURITY_ADMIN", - "DEVOPS_LEAD", - "DEVOPS_USER", - "OUTAGEDETECTION_ADMIN", - "RESOURCE_OWNER", - "PKI_ADMIN", - "GUEST", - "PLATFORM_ADMIN" - ], - "type": "string" + "$ref": "#/components/schemas/Role2" }, "type": "array", "uniqueItems": true }, "type": "object" }, + "role": { + "$ref": "#/components/schemas/TeamRole" + }, "systemRoles": { "items": { - "enum": [ - "SYSTEM_ADMIN", - "CONDOR_METRICS" - ], - "type": "string" + "$ref": "#/components/schemas/SystemRole" }, "type": "array", "uniqueItems": true + }, + "userMatchingRules": { + "items": { + "$ref": "#/components/schemas/UserMatchingRule" + }, + "type": "array" } }, "type": "object" @@ -24437,7 +23562,7 @@ "properties": { "teams": { "items": { - "$ref": "#/components/schemas/TeamInformation1" + "$ref": "#/components/schemas/TeamInformation2" }, "type": "array" } @@ -24559,7 +23684,7 @@ "SYSTEM_ADMIN" ], "items": { - "$ref": "#/components/schemas/Role2" + "$ref": "#/components/schemas/Role1" }, "type": "array", "uniqueItems": true @@ -24740,6 +23865,15 @@ } ] }, + "TokenAuthenticationData": { + "properties": { + "token": { + "description": "The token used for authentication with the underlying credentials provider.", + "type": "string" + } + }, + "type": "object" + }, "TrackingDataInformation": { "discriminator": { "propertyName": "certificateAuthority" @@ -24929,7 +24063,7 @@ "$ref": "#/components/schemas/CompanyInformation" }, "user": { - "$ref": "#/components/schemas/UserInformation1" + "$ref": "#/components/schemas/UserInformation2" } }, "type": "object" @@ -24965,6 +24099,9 @@ }, "UserInformation1": { "properties": { + "admin": { + "type": "boolean" + }, "companyId": { "format": "uuid", "type": "string" @@ -24973,28 +24110,9 @@ "format": "date-time", "type": "string" }, - "deleted": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "emailAddress": { - "type": "string" - }, - "firstLoginDate": { - "format": "date-time", - "type": "string" - }, "firstname": { "type": "string" }, - "forceLocalPasswordExpiration": { - "type": "boolean" - }, - "hasPassword": { - "type": "boolean" - }, "id": { "format": "uuid", "type": "string" @@ -25002,9 +24120,6 @@ "lastname": { "type": "string" }, - "localLoginDisabled": { - "type": "boolean" - }, "memberedTeams": { "items": { "format": "uuid", @@ -25024,37 +24139,56 @@ "productRoles": { "additionalProperties": { "items": { - "$ref": "#/components/schemas/Role1" + "enum": [ + "SECURITY_ADMIN", + "DEVOPS_LEAD", + "DEVOPS_USER", + "OUTAGEDETECTION_ADMIN", + "RESOURCE_OWNER", + "PKI_ADMIN", + "GUEST", + "PLATFORM_ADMIN" + ], + "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" }, - "signupAttributes": { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "resourceOwner": { + "type": "boolean" }, - "ssoStatus": { - "$ref": "#/components/schemas/SSOStatus" + "serviceAccount": { + "type": "boolean" }, "systemRoles": { "items": { - "$ref": "#/components/schemas/SystemRole" + "enum": [ + "SYSTEM_ADMIN", + "CONDOR_METRICS" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "teamsIds": { + "items": { + "format": "uuid", + "type": "string" }, "type": "array", "uniqueItems": true }, "userAccountType": { - "$ref": "#/components/schemas/UserAccountType" + "type": "string" }, "userStatus": { - "$ref": "#/components/schemas/UserStatus" + "type": "string" }, "userType": { - "$ref": "#/components/schemas/UserType" + "type": "string" }, "username": { "type": "string" @@ -25064,9 +24198,6 @@ }, "UserInformation2": { "properties": { - "admin": { - "type": "boolean" - }, "companyId": { "format": "uuid", "type": "string" @@ -25075,9 +24206,28 @@ "format": "date-time", "type": "string" }, + "deleted": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "emailAddress": { + "type": "string" + }, + "firstLoginDate": { + "format": "date-time", + "type": "string" + }, "firstname": { "type": "string" }, + "forceLocalPasswordExpiration": { + "type": "boolean" + }, + "hasPassword": { + "type": "boolean" + }, "id": { "format": "uuid", "type": "string" @@ -25085,6 +24235,9 @@ "lastname": { "type": "string" }, + "localLoginDisabled": { + "type": "boolean" + }, "memberedTeams": { "items": { "format": "uuid", @@ -25104,56 +24257,37 @@ "productRoles": { "additionalProperties": { "items": { - "enum": [ - "SECURITY_ADMIN", - "DEVOPS_LEAD", - "DEVOPS_USER", - "OUTAGEDETECTION_ADMIN", - "RESOURCE_OWNER", - "PKI_ADMIN", - "GUEST", - "PLATFORM_ADMIN" - ], - "type": "string" + "$ref": "#/components/schemas/Role2" }, "type": "array", "uniqueItems": true }, "type": "object" }, - "resourceOwner": { - "type": "boolean" - }, - "serviceAccount": { - "type": "boolean" - }, - "systemRoles": { - "items": { - "enum": [ - "SYSTEM_ADMIN", - "CONDOR_METRICS" - ], + "signupAttributes": { + "additionalProperties": { "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "object" }, - "teamsIds": { + "ssoStatus": { + "$ref": "#/components/schemas/SSOStatus" + }, + "systemRoles": { "items": { - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/SystemRole" }, "type": "array", "uniqueItems": true }, "userAccountType": { - "type": "string" + "$ref": "#/components/schemas/UserAccountType" }, "userStatus": { - "type": "string" + "$ref": "#/components/schemas/UserStatus" }, "userType": { - "type": "string" + "$ref": "#/components/schemas/UserType" }, "username": { "type": "string" @@ -25200,7 +24334,7 @@ "properties": { "users": { "items": { - "$ref": "#/components/schemas/UserInformation1" + "$ref": "#/components/schemas/UserInformation2" }, "type": "array" } @@ -25265,7 +24399,7 @@ "description": "Connector properties for webhook-based notifications.\nWebhook notifications are delivered as HTTP POST requests with a JSON body structured as:\n```json\n{\n \"events\": [\n {\n \"eventName\": \"string\",\n \"eventType\": \"string\",\n \"message\": \"string\",\n \"criticality\": 0,\n \"createdAt\": \"2025-01-15T12:45:00Z\"\n }\n ]\n}\n```\nOnly one event is included per request. The webhook service sets `Content-Type: application/json`, `VaaS-Timestamp`, and, when a `secret` is configured in the connection, `VaaS-Signature`.\n", "properties": { "filter": { - "$ref": "#/components/schemas/Filter1" + "$ref": "#/components/schemas/Filter2" }, "target": { "$ref": "#/components/schemas/Target" @@ -25372,11 +24506,27 @@ } }, "securitySchemes": { - "tppl-api-key": { - "in": "header", - "name": "tppl-api-key", - "type": "apiKey" + "scmOAuth": { + "type": "oauth2", + "description": "Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the `client_id`, `client_secret` values associated with an IAM service account along with a scope value of `tsg_id:XXXXXXXXXX`, where `XXXXXXXXXX` is the Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`).", + "flows": { + "clientCredentials": { + "tokenUrl": "https://auth.apps.paloaltonetworks.com/oauth2/access_token", + "scopes": {} + } + } + }, + "scmToken": { + "type": "http", + "description": "Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the `client_id`, `client_secret` values associated with an IAM service account along with a scope value of `tsg_id:XXXXXXXXXX`, where `XXXXXXXXXX` is the Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`).", + "scheme": "bearer", + "bearerFormat": "JWT" } } - } + }, + "security": [ + { + "scmToken": [] + } + ] } \ No newline at end of file diff --git a/products/scm/api/config/ngts/ngts-api.md b/products/scm/api/config/ngts/ngts-api.md index 825ecef0b..7550bca54 100644 --- a/products/scm/api/config/ngts/ngts-api.md +++ b/products/scm/api/config/ngts/ngts-api.md @@ -31,9 +31,15 @@ The REST API follows best practices in API design. For example, it uses JSON for - Searching NGTS to understand what certificates have been issued by your organization. - Extracting data for custom reports based on certificate data and summary information to help track key and certificate management policy compliance. -## What about my API key? +## Authentication -The API endpoint pages let you enter your API key and run API calls directly. Simply enter your API key in the **Authentication** box for any call. +The NGTS APIs use OAuth 2.0 Client Credentials flow for authentication. To get started: + +1. Create a [Tenant Service Group (TSG)](/scm/docs/tenant-service-groups) and a [service account](/scm/docs/service-accounts) with the appropriate roles. +2. Use the service account's **Client ID** and **Client Secret** to [request an access token](/scm/docs/access-tokens). +3. Include the token as a `Bearer` token in the `Authorization` header of every API call. + +The API endpoint pages let you authorize and run API calls directly from the docs. ## Base URL